POST api/parameters/values

Add a new parameter value.

Request Information

URI Parameters

None.

Body Parameters

ParameterValueRequestDTO
NameDescriptionTypeAdditional information
ParameterId

ID uniquely identifying the parameter.

integer

None.

ParameterLevel

Parameter level.

ParameterLevel

None.

DepartmentId

ID of the department to set the parameter of.

integer

None.

Value

Value of the parameter to set.

string

None.

ValidFrom

Date from which the parameter becomes valid (UTC).

date

None.

ValidTo

Date from which the parameter ceases to become valid (UTC).

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ParameterId": 1,
  "ParameterLevel": 1,
  "DepartmentId": 1,
  "Value": "sample string 2",
  "ValidFrom": "2025-06-26T02:36:27.6232323+00:00",
  "ValidTo": "2025-06-26T02:36:27.6232323+00:00"
}

text/html

Sample:
{"ParameterId":1,"ParameterLevel":1,"DepartmentId":1,"Value":"sample string 2","ValidFrom":"2025-06-26T02:36:27.6232323+00:00","ValidTo":"2025-06-26T02:36:27.6232323+00:00"}

application/xml, text/xml

Sample:
<ParameterValueRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DepartmentId>1</DepartmentId>
  <ParameterId>1</ParameterId>
  <ParameterLevel>Global</ParameterLevel>
  <ValidFrom>2025-06-26T02:36:27.6232323+00:00</ValidFrom>
  <ValidTo>2025-06-26T02:36:27.6232323+00:00</ValidTo>
  <Value>sample string 2</Value>
</ParameterValueRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ParameterValueRequestDTO'.

Response Information

Resource Description

AddParameterValueResponseDTO
NameDescriptionTypeAdditional information
ParameterValueId

Id uniquely identifying the paramater value.

integer

None.

ParameterId

ID uniquely identifying the parameter.

integer

None.

DepartmentId

ID of the department to set the parameter of.

integer

None.

Value

Value of the parameter to set.

string

None.

ValidFrom

Date from which the parameter becomes valid (UTC).

date

None.

ValidTo

Date from which the parameter ceases to become valid (UTC).

date

None.

Response Formats

application/json, text/json

Sample:
{
  "ParameterValueId": 1,
  "ParameterId": 2,
  "DepartmentId": 1,
  "Value": "sample string 3",
  "ValidFrom": "2025-06-26T02:36:27.6428448+00:00",
  "ValidTo": "2025-06-26T02:36:27.6428448+00:00"
}

text/html

Sample:
{"ParameterValueId":1,"ParameterId":2,"DepartmentId":1,"Value":"sample string 3","ValidFrom":"2025-06-26T02:36:27.6428448+00:00","ValidTo":"2025-06-26T02:36:27.6428448+00:00"}

application/xml, text/xml

Sample:
<AddParameterValueResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DepartmentId>1</DepartmentId>
  <ParameterId>2</ParameterId>
  <ParameterValueId>1</ParameterValueId>
  <ValidFrom>2025-06-26T02:36:27.6428448+00:00</ValidFrom>
  <ValidTo>2025-06-26T02:36:27.6428448+00:00</ValidTo>
  <Value>sample string 3</Value>
</AddParameterValueResponseDTO>