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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
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

ResponseWrapperBindingModelOfIEnumerableOfHoldsBindingModel
NameDescriptionTypeAdditional information
Results

Collection of HoldsBindingModel

None.
TotalResults

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalResults": 1,
  "Results": [
    {
      "Holds": [
        {
          "Uri": "sample string 1",
          "Legacy": {
            "SeatId": 1,
            "LabId": 2
          },
          "CandidateTimezoneOffset": "00:00:00.1234567",
          "Id": "sample string 2",
          "ExpirationDateTime": "2024-07-01T21:19:54.9317378-04: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": "2024-07-01T21:19:54.9317378-04:00",
          "Slot": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          }
        }
      ]
    },
    {
      "Holds": [
        {
          "Uri": "sample string 1",
          "Legacy": {
            "SeatId": 1,
            "LabId": 2
          },
          "CandidateTimezoneOffset": "00:00:00.1234567",
          "Id": "sample string 2",
          "ExpirationDateTime": "2024-07-01T21:19:54.9317378-04: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": "2024-07-01T21:19:54.9317378-04:00",
          "Slot": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          }
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<ResponseWrapperBindingModelOfArrayOfHoldsBindingModelKeiDFzfM 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:HoldsBindingModel>
      <d2p1:Holds>
        <d2p1:V0HoldBindingModel>
          <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2024-07-01T21:19:54.9317378-04:00</ExpirationDateTime>
          <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
          <Slot xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1: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">2024-07-01T21:19:54.9317378-04:00</ExpirationDateTime>
          <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
          <Slot xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1: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:Holds>
    </d2p1:HoldsBindingModel>
    <d2p1:HoldsBindingModel>
      <d2p1:Holds>
        <d2p1:V0HoldBindingModel>
          <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2024-07-01T21:19:54.9317378-04:00</ExpirationDateTime>
          <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
          <Slot xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1: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">2024-07-01T21:19:54.9317378-04:00</ExpirationDateTime>
          <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
          <Slot xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1: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:Holds>
    </d2p1:HoldsBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfHoldsBindingModelKeiDFzfM>