GET 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

ResponseWrapperBindingModelOfIEnumerableOfV0HoldBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Uri": "sample string 1",
      "Legacy": {
        "SeatId": 1,
        "LabId": 2
      },
      "CandidateTimezoneOffset": "00:00:00.1234567",
      "Id": "sample string 2",
      "ExpirationDateTime": "2025-11-04T00:37:02.0743093-05:00",
      "Slot": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    },
    {
      "Uri": "sample string 1",
      "Legacy": {
        "SeatId": 1,
        "LabId": 2
      },
      "CandidateTimezoneOffset": "00:00:00.1234567",
      "Id": "sample string 2",
      "ExpirationDateTime": "2025-11-04T00:37:02.0743093-05:00",
      "Slot": {
        "Id": "sample string 1",
        "Href": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfV0HoldBindingModelKeiDFzfM 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:V0HoldBindingModel>
      <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2025-11-04T00:37:02.0743093-05:00</ExpirationDateTime>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</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:CandidateTimezoneOffset>PT0.1234567S</d2p1:CandidateTimezoneOffset>
      <d2p1:Legacy>
        <d2p1:LabId>2</d2p1:LabId>
        <d2p1:SeatId>1</d2p1:SeatId>
      </d2p1:Legacy>
      <d2p1:Uri>sample string 1</d2p1:Uri>
    </d2p1:V0HoldBindingModel>
    <d2p1:V0HoldBindingModel>
      <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2025-11-04T00:37:02.0743093-05:00</ExpirationDateTime>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</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:CandidateTimezoneOffset>PT0.1234567S</d2p1:CandidateTimezoneOffset>
      <d2p1:Legacy>
        <d2p1:LabId>2</d2p1:LabId>
        <d2p1:SeatId>1</d2p1:SeatId>
      </d2p1:Legacy>
      <d2p1:Uri>sample string 1</d2p1:Uri>
    </d2p1:V0HoldBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfV0HoldBindingModelKeiDFzfM>