GET api/v1/programs?Code={Code}&IsCandidateCentric={IsCandidateCentric}&IsPublished={IsPublished}&ClientId={ClientId}&ProgramId={ProgramId}&ExamId={ExamId}&EligibilityId={EligibilityId}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

Name	Type	Additional information
Code	string	None.
IsCandidateCentric	boolean	None.
IsPublished	boolean	None.
ClientId	string	None.
ProgramId	string	None.
ExamId	string	None.
EligibilityId	string	None.
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfProgramBindingModel

Name	Description	Type	Additional information
Results		Collection of ProgramBindingModel	None.
TotalResults		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Id": "sample string 1",
      "Href": "sample string 3",
      "Code": "sample string 4",
      "Name": "sample string 5",
      "IsCandidateCentric": true,
      "Schedule": {
        "StartDate": "2024-07-02T01:53:44.5560666+01:00",
        "EndDate": "2024-07-02T01:53:44.5560666+01:00"
      },
      "Client": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 3",
      "Code": "sample string 4",
      "Name": "sample string 5",
      "IsCandidateCentric": true,
      "Schedule": {
        "StartDate": "2024-07-02T01:53:44.5560666+01:00",
        "EndDate": "2024-07-02T01:53:44.5560666+01:00"
      },
      "Client": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfProgramBindingModelLFakkDP1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
  <TotalResults>1</TotalResults>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Programs">
    <d2p1:ProgramBindingModel>
      <d2p1:Client>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Client>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Href>sample string 3</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsCandidateCentric>true</d2p1:IsCandidateCentric>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:Schedule>
        <d2p1:EndDate>2024-07-02T01:53:44.5560666+01:00</d2p1:EndDate>
        <d2p1:StartDate>2024-07-02T01:53:44.5560666+01:00</d2p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ProgramBindingModel>
    <d2p1:ProgramBindingModel>
      <d2p1:Client>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Client>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Href>sample string 3</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsCandidateCentric>true</d2p1:IsCandidateCentric>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:Schedule>
        <d2p1:EndDate>2024-07-02T01:53:44.5560666+01:00</d2p1:EndDate>
        <d2p1:StartDate>2024-07-02T01:53:44.5560666+01:00</d2p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ProgramBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfProgramBindingModelLFakkDP1>