GET api/v1/reservations?Name={Name}&ProviderId={ProviderId}&SiteCode={SiteCode}&ProgramId={ProgramId}&StartDate={StartDate}&EndDate={EndDate}&ClientId={ClientId}&ExamId={ExamId}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

Name	Type	Additional information
Name	string	None.
ProviderId	string	None.
SiteCode	string	None.
ProgramId	string	None.
StartDate	string	None.
EndDate	string	None.
ClientId	string	None.
ExamId	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

ResponseWrapperBindingModelOfIEnumerableOfReservationBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Id": "sample string 1",
      "Name": "sample string 3",
      "SiteCode": "sample string 4",
      "ProviderName": "sample string 5",
      "ProgramName": "sample string 6",
      "ProgramCode": "sample string 7",
      "TestCenterName": "sample string 8",
      "DaysToExpire": 9,
      "SalesforceTicketNumber": 10,
      "Notes": "sample string 11",
      "Exam": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      },
      "Provider": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      },
      "Holds": [
        {
          "Id": "sample string 1",
          "Href": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Href": "sample string 2"
        }
      ],
      "ReservationHolds": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 3",
      "SiteCode": "sample string 4",
      "ProviderName": "sample string 5",
      "ProgramName": "sample string 6",
      "ProgramCode": "sample string 7",
      "TestCenterName": "sample string 8",
      "DaysToExpire": 9,
      "SalesforceTicketNumber": 10,
      "Notes": "sample string 11",
      "Exam": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      },
      "Provider": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      },
      "Holds": [
        {
          "Id": "sample string 1",
          "Href": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Href": "sample string 2"
        }
      ],
      "ReservationHolds": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfReservationBindingModelPqHIzYRC 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.Reservation">
    <d2p1:ReservationBindingModel>
      <d2p1:DaysToExpire>9</d2p1:DaysToExpire>
      <d2p1:Exam>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Exam>
      <d2p1:Holds>
        <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:Holds>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Notes>sample string 11</d2p1:Notes>
      <d2p1:ProgramCode>sample string 7</d2p1:ProgramCode>
      <d2p1:ProgramName>sample string 6</d2p1:ProgramName>
      <d2p1:Provider>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Provider>
      <d2p1:ProviderName>sample string 5</d2p1:ProviderName>
      <d2p1:ReservationHolds>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:ReservationHolds>
      <d2p1:SalesforceTicketNumber>10</d2p1:SalesforceTicketNumber>
      <d2p1:SiteCode>sample string 4</d2p1:SiteCode>
      <d2p1:TestCenterName>sample string 8</d2p1:TestCenterName>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ReservationBindingModel>
    <d2p1:ReservationBindingModel>
      <d2p1:DaysToExpire>9</d2p1:DaysToExpire>
      <d2p1:Exam>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Exam>
      <d2p1:Holds>
        <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:Holds>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Notes>sample string 11</d2p1:Notes>
      <d2p1:ProgramCode>sample string 7</d2p1:ProgramCode>
      <d2p1:ProgramName>sample string 6</d2p1:ProgramName>
      <d2p1:Provider>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:Provider>
      <d2p1:ProviderName>sample string 5</d2p1:ProviderName>
      <d2p1:ReservationHolds>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
      </d2p1:ReservationHolds>
      <d2p1:SalesforceTicketNumber>10</d2p1:SalesforceTicketNumber>
      <d2p1:SiteCode>sample string 4</d2p1:SiteCode>
      <d2p1:TestCenterName>sample string 8</d2p1:TestCenterName>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ReservationBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfReservationBindingModelPqHIzYRC>