GET api/v1/reservations/{id}/holds

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfReservationHoldsBindingModel
NameDescriptionTypeAdditional information
Results

Collection of ReservationHoldsBindingModel

None.

TotalResults

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "Results": [
    {
      "ReservationId": "sample string 1",
      "HoldId": "sample string 2",
      "StartDateTime": "2024-11-21T04:58:17.736756-05:00",
      "EndDateTime": "2024-11-21T04:58:17.736756-05:00",
      "HoldExpiresDateTime": "2024-11-21T04:58:17.736756-05:00"
    },
    {
      "ReservationId": "sample string 1",
      "HoldId": "sample string 2",
      "StartDateTime": "2024-11-21T04:58:17.736756-05:00",
      "EndDateTime": "2024-11-21T04:58:17.736756-05:00",
      "HoldExpiresDateTime": "2024-11-21T04:58:17.736756-05:00"
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseWrapperBindingModelOfArrayOfReservationHoldsBindingModelPqHIzYRC 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:ReservationHoldsBindingModel>
      <d2p1:EndDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:EndDateTime>
      <d2p1:HoldExpiresDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:HoldExpiresDateTime>
      <d2p1:HoldId>sample string 2</d2p1:HoldId>
      <d2p1:ReservationId>sample string 1</d2p1:ReservationId>
      <d2p1:StartDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:StartDateTime>
    </d2p1:ReservationHoldsBindingModel>
    <d2p1:ReservationHoldsBindingModel>
      <d2p1:EndDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:EndDateTime>
      <d2p1:HoldExpiresDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:HoldExpiresDateTime>
      <d2p1:HoldId>sample string 2</d2p1:HoldId>
      <d2p1:ReservationId>sample string 1</d2p1:ReservationId>
      <d2p1:StartDateTime>2024-11-21T04:58:17.736756-05:00</d2p1:StartDateTime>
    </d2p1:ReservationHoldsBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfReservationHoldsBindingModelPqHIzYRC>