latestSwagger 2.02026-08-172560124.6 KB

6863a5956792

reservation-enquiries

Get reservation enquiry by id

This endpoint allows an agent to get an reservation enquiry by id. The id is agent-specific. The agent needs to be authenticated.

The endpoint will return HTTP 404 - Not Found if the reservation enquiry with the specified id could not be found.

It will return HTTP 403 - Forbidden if the agent is not authenticated, if the agent doesn't have permissions or the reservation enquiry doesn't belong to the authenticated agent.

####Request:

  • reservationEnquiryId: Agent-specific ID of the requested reservation enquiry

####Response:

  • id: The agent-dependent unique id of the reservation enquiry
  • merchantId: The ID of the merchant at which this reservation enquiry was made
  • customerId: The ID of the customer to which this reservation enquiry belongs
  • capacity: The capacity (people count) of the reservation enquiry
  • startDateTime: The start date time of the reservation enquiry. Format: yyyy-MM-ddTHH:mm:ssZ
  • endDateTime: The end date time of the reservation enquiry. Format: yyyy-MM-ddTHH:mm:ssZ
  • status: The status of the reservation enquiry which can be one of: NEW, IN_PROGRESS, ACCEPTED or REJECTED

Example curl:

curl https://{host}/v{X}/reservation-enquiries/07f53b36-3f48-11e5-a151-feff819cdc9f

Example response:

{
  "id": "07f53b36-3f48-11e5-a151-feff819cdc9f",
  "merchantId": 1384,
  "customerId": "35fff464-142c-48ac-a0c6-ed72a1615664",
  "capacity": 4,
  "startTime": "2015-06-22T12:00:00+00:00",
  "endTime": "2015-06-22T13:00:00+00:00",
  "status": "NEW"
}
get/v1/reservation-enquiries/{reservationEnquiryId}

Path parameters

reservationEnquiryIdstring required

Id of the reservation enquiry

Response

OK