GET api/v1/sites/{siteId}/holds?properties={properties}&orderBy={orderBy}&skip={skip}&take={take}

Request Information

URI Parameters

Name	Type	Additional information
siteId	string	Required
properties	string	None.
orderBy	string	None.
skip	integer	Default value is 0
take	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfHoldBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Href": "sample string 1",
      "ProctorTimeZone": "sample string 2",
      "ProctorStart": "2025-11-04T00:34:26.9243838-05:00",
      "Id": "sample string 4",
      "ExpirationDateTime": "2025-11-04T00:34:26.9243838-05:00",
      "Slot": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    },
    {
      "Href": "sample string 1",
      "ProctorTimeZone": "sample string 2",
      "ProctorStart": "2025-11-04T00:34:26.9243838-05:00",
      "Id": "sample string 4",
      "ExpirationDateTime": "2025-11-04T00:34:26.9243838-05:00",
      "Slot": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfHoldBindingModelKeiDFzfM 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.Hold">
    <d2p1:HoldBindingModel>
      <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2025-11-04T00:34:26.9243838-05:00</ExpirationDateTime>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</Id>
      <Slot xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Href>sample string 2</d4p1:Href>
        <d4p1:Id>sample string 1</d4p1:Id>
      </Slot>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:ProctorStart>2025-11-04T00:34:26.9243838-05:00</d2p1:ProctorStart>
      <d2p1:ProctorTimeZone>sample string 2</d2p1:ProctorTimeZone>
    </d2p1:HoldBindingModel>
    <d2p1:HoldBindingModel>
      <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2025-11-04T00:34:26.9243838-05:00</ExpirationDateTime>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</Id>
      <Slot xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Href>sample string 2</d4p1:Href>
        <d4p1:Id>sample string 1</d4p1:Id>
      </Slot>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:ProctorStart>2025-11-04T00:34:26.9243838-05:00</d2p1:ProctorStart>
      <d2p1:ProctorTimeZone>sample string 2</d2p1:ProctorTimeZone>
    </d2p1:HoldBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfHoldBindingModelKeiDFzfM>