POST api/masters/GetParameterValue

Request Information

URI Parameters

None.

Body Parameters

GetParameterValueRequest
NameDescriptionTypeAdditional information
ParameterName

string

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

Sample:
{
  "ParameterName": "sample string 1",
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<GetParameterValueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IMS.Entities.Masters.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/IMS.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <ParameterName>sample string 1</ParameterName>
</GetParameterValueRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetParameterValueResponse
NameDescriptionTypeAdditional information
ParameterValue

string

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "ParameterValue": "sample string 1",
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetParameterValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IMS.Entities.Masters.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/IMS.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
  <ParameterValue>sample string 1</ParameterValue>
</GetParameterValueResponse>