POST api/{programid}/NVPConfig/GetNVPValue

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

string

Required

Body Parameters

GetNVPValueParams
NameDescriptionTypeAdditional information
ProgramRoleId

integer

None.

PageFunctionName

string

None.

NameValuePairName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ProgramRoleId": 1,
  "PageFunctionName": "sample string 2",
  "NameValuePairName": "sample string 3"
}

application/xml, text/xml

Sample:
<GetNVPValueParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.CommonConfiguration">
  <NameValuePairName>sample string 3</NameValuePairName>
  <PageFunctionName>sample string 2</PageFunctionName>
  <ProgramRoleId>1</ProgramRoleId>
</GetNVPValueParams>

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 'GetNVPValueParams'.

Response Information

Resource Description

NameValuePair
NameDescriptionTypeAdditional information
NameValuePairName

string

None.

NameValuePairValue

string

None.

IsVisible

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "NameValuePairName": "sample string 1",
  "NameValuePairValue": "sample string 2",
  "IsVisible": true
}

application/xml, text/xml

Sample:
<NameValuePair xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Common">
  <IsVisible>true</IsVisible>
  <NameValuePairName>sample string 1</NameValuePairName>
  <NameValuePairValue>sample string 2</NameValuePairValue>
</NameValuePair>