GET api/v1/exams/{Id}?ProgramId={ProgramId}&CountryId={CountryId}&ClientId={ClientId}&HoldId={HoldId}&isPublished={isPublished}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ProgramId

string

None.

CountryId

string

None.

Id

string

None.

ClientId

string

None.

HoldId

integer

None.

isPublished

boolean

Default value is False

id

string

None.

Body Parameters

None.

Response Information

Resource Description

ExamBindingModel
NameDescriptionTypeAdditional information
Id

string

None.

Href

string

None.

Code

string

None.

Name

string

None.

Program

ResourceReferenceOfString

None.

Schedule

ScheduleRelationBindingModel

None.

Testing

TestingRelationBindingModel

None.

Countries

Collection of ResourceReferenceOfString

None.

Demographics

Collection of ResourceReferenceOfString

None.

TestingAccommodations

Collection of ResourceReferenceOfString

None.

Policies

Collection of ResourceReferenceOfString

None.

Sites

Collection of ResourceReferenceOfString

None.

DeliveryMode

string

None.

ExamSet

ExamSetBindingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Href": "sample string 2",
  "Code": "sample string 3",
  "Name": "sample string 4",
  "Program": {
    "Id": "sample string 1",
    "Href": "sample string 2"
  },
  "Schedule": {
    "StartDate": "2024-07-02T02:16:22.2196942+01:00",
    "EndDate": "2024-07-02T02:16:22.2196942+01:00",
    "Methods": [
      "Internet",
      "Internet"
    ],
    "Duration": 3,
    "Sessions": 4
  },
  "Testing": {
    "StartDate": "2024-07-02T02:16:22.2196942+01:00",
    "EndDate": "2024-07-02T02:16:22.2196942+01:00"
  },
  "Countries": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Demographics": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "TestingAccommodations": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Policies": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Sites": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "DeliveryMode": "sample string 5",
  "ExamSet": {
    "Id": "sample string 1",
    "Href": "sample string 2",
    "Exams": [
      {
        "Id": "sample string 1",
        "Href": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    ],
    "Attributes": {
      "RequiredSchedule": true,
      "RequiredReSchedule": true,
      "RequiredCancel": true,
      "B2b": {
        "BufferTime": 1,
        "MaxDuration": 2
      }
    }
  }
}

application/xml, text/xml

Sample:
<ExamBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Exam">
  <Countries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
  </Countries>
  <DeliveryMode>sample string 5</DeliveryMode>
  <Demographics xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
  </Demographics>
  <ExamSet>
    <Attributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.ExamSet">
      <d3p1:B2b>
        <d3p1:BufferTime>1</d3p1:BufferTime>
        <d3p1:MaxDuration>2</d3p1:MaxDuration>
      </d3p1:B2b>
      <d3p1:RequiredCancel>true</d3p1:RequiredCancel>
      <d3p1:RequiredReSchedule>true</d3p1:RequiredReSchedule>
      <d3p1:RequiredSchedule>true</d3p1:RequiredSchedule>
    </Attributes>
    <Exams xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
      <d3p1:ResourceReferenceOfstring>
        <d3p1:Href>sample string 2</d3p1:Href>
        <d3p1:Id>sample string 1</d3p1:Id>
      </d3p1:ResourceReferenceOfstring>
      <d3p1:ResourceReferenceOfstring>
        <d3p1:Href>sample string 2</d3p1:Href>
        <d3p1:Id>sample string 1</d3p1:Id>
      </d3p1:ResourceReferenceOfstring>
    </Exams>
    <Href>sample string 2</Href>
    <Id>sample string 1</Id>
  </ExamSet>
  <Href>sample string 2</Href>
  <Id>sample string 1</Id>
  <Name>sample string 4</Name>
  <Policies xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
  </Policies>
  <Program 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>
  </Program>
  <Schedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
    <d2p1:Duration>3</d2p1:Duration>
    <d2p1:EndDate>2024-07-02T02:16:22.2196942+01:00</d2p1:EndDate>
    <d2p1:Methods>
      <d2p1:ScheduleMethodBindingModel>Internet</d2p1:ScheduleMethodBindingModel>
      <d2p1:ScheduleMethodBindingModel>Internet</d2p1:ScheduleMethodBindingModel>
    </d2p1:Methods>
    <d2p1:Sessions>4</d2p1:Sessions>
    <d2p1:StartDate>2024-07-02T02:16:22.2196942+01:00</d2p1:StartDate>
  </Schedule>
  <Sites xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
  </Sites>
  <Testing xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
    <d2p1:EndDate>2024-07-02T02:16:22.2196942+01:00</d2p1:EndDate>
    <d2p1:StartDate>2024-07-02T02:16:22.2196942+01:00</d2p1:StartDate>
  </Testing>
  <TestingAccommodations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
    <d2p1:ResourceReferenceOfstring>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
    </d2p1:ResourceReferenceOfstring>
  </TestingAccommodations>
</ExamBindingModel>