GET api/v1/exams?programId={programId}&countryId={countryId}&code={code}&isPublished={isPublished}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}&scheduleMethod={scheduleMethod}

Request Information

URI Parameters

Name	Type	Additional information
programId	string	None.
countryId	string	None.
code	string	None.
isPublished	boolean	Default value is False
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0
scheduleMethod	ScheduleMethod	Default value is Internet

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfExamBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "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": "2025-08-19T12:04:26.4537204+01:00",
        "EndDate": "2025-08-19T12:04:26.4537204+01:00",
        "Methods": [
          "Internet",
          "Internet"
        ],
        "Duration": 3,
        "Sessions": 4
      },
      "Testing": {
        "StartDate": "2025-08-19T12:04:26.4537204+01:00",
        "EndDate": "2025-08-19T12:04:26.4537204+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
          }
        }
      }
    },
    {
      "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": "2025-08-19T12:04:26.4537204+01:00",
        "EndDate": "2025-08-19T12:04:26.4537204+01:00",
        "Methods": [
          "Internet",
          "Internet"
        ],
        "Duration": 3,
        "Sessions": 4
      },
      "Testing": {
        "StartDate": "2025-08-19T12:04:26.4537204+01:00",
        "EndDate": "2025-08-19T12:04:26.4537204+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:

<ResponseWrapperBindingModelOfArrayOfExamBindingModelwRUuANL0 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.Exam">
    <d2p1:ExamBindingModel>
      <d2p1:Countries>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Countries>
      <d2p1:DeliveryMode>sample string 5</d2p1:DeliveryMode>
      <d2p1:Demographics>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Demographics>
      <d2p1:ExamSet>
        <d2p1:Attributes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.ExamSet">
          <d5p1:B2b>
            <d5p1:BufferTime>1</d5p1:BufferTime>
            <d5p1:MaxDuration>2</d5p1:MaxDuration>
          </d5p1:B2b>
          <d5p1:RequiredCancel>true</d5p1:RequiredCancel>
          <d5p1:RequiredReSchedule>true</d5p1:RequiredReSchedule>
          <d5p1:RequiredSchedule>true</d5p1:RequiredSchedule>
        </d2p1:Attributes>
        <d2p1:Exams>
          <ResourceReferenceOfstring>
            <Href>sample string 2</Href>
            <Id>sample string 1</Id>
          </ResourceReferenceOfstring>
          <ResourceReferenceOfstring>
            <Href>sample string 2</Href>
            <Id>sample string 1</Id>
          </ResourceReferenceOfstring>
        </d2p1:Exams>
        <d2p1:Href>sample string 2</d2p1:Href>
        <d2p1:Id>sample string 1</d2p1:Id>
      </d2p1:ExamSet>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Policies>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Policies>
      <d2p1:Program>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Program>
      <d2p1:Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Duration>3</d4p1:Duration>
        <d4p1:EndDate>2025-08-19T12:04:26.4537204+01:00</d4p1:EndDate>
        <d4p1:Methods>
          <d4p1:ScheduleMethodBindingModel>Internet</d4p1:ScheduleMethodBindingModel>
          <d4p1:ScheduleMethodBindingModel>Internet</d4p1:ScheduleMethodBindingModel>
        </d4p1:Methods>
        <d4p1:Sessions>4</d4p1:Sessions>
        <d4p1:StartDate>2025-08-19T12:04:26.4537204+01:00</d4p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Sites>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Sites>
      <d2p1:Testing xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:EndDate>2025-08-19T12:04:26.4537204+01:00</d4p1:EndDate>
        <d4p1:StartDate>2025-08-19T12:04:26.4537204+01:00</d4p1:StartDate>
      </d2p1:Testing>
      <d2p1:TestingAccommodations>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:TestingAccommodations>
    </d2p1:ExamBindingModel>
    <d2p1:ExamBindingModel>
      <d2p1:Countries>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Countries>
      <d2p1:DeliveryMode>sample string 5</d2p1:DeliveryMode>
      <d2p1:Demographics>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Demographics>
      <d2p1:ExamSet>
        <d2p1:Attributes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.ExamSet">
          <d5p1:B2b>
            <d5p1:BufferTime>1</d5p1:BufferTime>
            <d5p1:MaxDuration>2</d5p1:MaxDuration>
          </d5p1:B2b>
          <d5p1:RequiredCancel>true</d5p1:RequiredCancel>
          <d5p1:RequiredReSchedule>true</d5p1:RequiredReSchedule>
          <d5p1:RequiredSchedule>true</d5p1:RequiredSchedule>
        </d2p1:Attributes>
        <d2p1:Exams>
          <ResourceReferenceOfstring>
            <Href>sample string 2</Href>
            <Id>sample string 1</Id>
          </ResourceReferenceOfstring>
          <ResourceReferenceOfstring>
            <Href>sample string 2</Href>
            <Id>sample string 1</Id>
          </ResourceReferenceOfstring>
        </d2p1:Exams>
        <d2p1:Href>sample string 2</d2p1:Href>
        <d2p1:Id>sample string 1</d2p1:Id>
      </d2p1:ExamSet>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Policies>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Policies>
      <d2p1:Program>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Program>
      <d2p1:Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Duration>3</d4p1:Duration>
        <d4p1:EndDate>2025-08-19T12:04:26.4537204+01:00</d4p1:EndDate>
        <d4p1:Methods>
          <d4p1:ScheduleMethodBindingModel>Internet</d4p1:ScheduleMethodBindingModel>
          <d4p1:ScheduleMethodBindingModel>Internet</d4p1:ScheduleMethodBindingModel>
        </d4p1:Methods>
        <d4p1:Sessions>4</d4p1:Sessions>
        <d4p1:StartDate>2025-08-19T12:04:26.4537204+01:00</d4p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Sites>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:Sites>
      <d2p1:Testing xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:EndDate>2025-08-19T12:04:26.4537204+01:00</d4p1:EndDate>
        <d4p1:StartDate>2025-08-19T12:04:26.4537204+01:00</d4p1:StartDate>
      </d2p1:Testing>
      <d2p1:TestingAccommodations>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
        <ResourceReferenceOfstring>
          <Href>sample string 2</Href>
          <Id>sample string 1</Id>
        </ResourceReferenceOfstring>
      </d2p1:TestingAccommodations>
    </d2p1:ExamBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfExamBindingModelwRUuANL0>