GET api/settings/programmes

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ServiceResponseOfListOfProgrammeDTO
NameDescriptionTypeAdditional information
HttpStatusCode

HttpStatusCode

None.

ResponseMessage

string

None.

HasError

boolean

None.

Data

Collection of ProgrammeDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "httpStatusCode": 100,
  "responseMessage": "sample string 1",
  "hasError": true,
  "data": [
    {
      "programmeID": 1,
      "programmeName": "sample string 2"
    },
    {
      "programmeID": 1,
      "programmeName": "sample string 2"
    }
  ]
}

text/html

Sample:
{"httpStatusCode":100,"responseMessage":"sample string 1","hasError":true,"data":[{"programmeID":1,"programmeName":"sample string 2"},{"programmeID":1,"programmeName":"sample string 2"}]}

text/xml

Sample:
<ServiceResponseOfArrayOfProgrammeDTOcdhACSen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApplicationPortalAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ApplicationPortalAPI.Models.DTOs.Programmes">
    <d2p1:ProgrammeDTO>
      <d2p1:ProgrammeID>1</d2p1:ProgrammeID>
      <d2p1:ProgrammeName>sample string 2</d2p1:ProgrammeName>
    </d2p1:ProgrammeDTO>
    <d2p1:ProgrammeDTO>
      <d2p1:ProgrammeID>1</d2p1:ProgrammeID>
      <d2p1:ProgrammeName>sample string 2</d2p1:ProgrammeName>
    </d2p1:ProgrammeDTO>
  </Data>
  <HasError>true</HasError>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResponseMessage>sample string 1</ResponseMessage>
</ServiceResponseOfArrayOfProgrammeDTOcdhACSen>