POST api/{programid}/Service/GetDescription

Returns the service description based on a service code

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

Program Id

string

Required

Body Parameters

GetDescription Request Parameters

GetServiceDescriptionRequest
NameDescriptionTypeAdditional information
ServiceCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceCode": "sample string 1"
}

application/xml, text/xml

Sample:
<GetServiceDescriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Services">
  <ServiceCode>sample string 1</ServiceCode>
</GetServiceDescriptionRequest>

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

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>