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

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.
programId	string	None.

Body Parameters

None.

Response Information

Resource Description

ProgramBindingModel

Name	Type	Additional information
Id	string	None.
Href	string	None.
Code	string	None.
Name	string	None.
IsCandidateCentric	boolean	None.
Schedule	ScheduleBindingModel	None.
Client	ResourceReferenceOfString	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Href": "sample string 3",
  "Code": "sample string 4",
  "Name": "sample string 5",
  "IsCandidateCentric": true,
  "Schedule": {
    "StartDate": "2025-11-04T00:36:04.7142982-05:00",
    "EndDate": "2025-11-04T00:36:04.7142982-05:00"
  },
  "Client": {
    "Id": "sample string 1",
    "Href": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ProgramBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Programs">
  <Client xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:Href>sample string 2</d2p1:Href>
    <d2p1:Id>sample string 1</d2p1:Id>
  </Client>
  <Code>sample string 4</Code>
  <Href>sample string 3</Href>
  <Id>sample string 1</Id>
  <IsCandidateCentric>true</IsCandidateCentric>
  <Name>sample string 5</Name>
  <Schedule>
    <EndDate>2025-11-04T00:36:04.7142982-05:00</EndDate>
    <StartDate>2025-11-04T00:36:04.7142982-05:00</StartDate>
  </Schedule>
  <Uri>sample string 2</Uri>
</ProgramBindingModel>