GET api/Bookings/GetBookingHistory/{PersonID}/{StartDate}/{EndDate}/{AccountCode}/{Source}/{Status}

Allows a client to request a hist of a customers bookings based on a person ID or account code. Allows filtering based on a date range, booking source and booking status.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PersonID

The ID of the person to load the history for.

integer

Required

StartDate

The start date to filter the bookings by based on their visit date.

date

Required

EndDate

The end date to filter the bookings by based on their visit date.

date

Required

AccountCode

The account code of the person or company to load the history for.

string

Default value is

Source

The booking source to filter the bookings by.

string

Default value is

Status

The booking status to filter the bookings by.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample:
[{"BookingRef":0,"BookingSource":"","ResourceName":"","VisitDate":"0001-01-01T00:00:00","FullPrice":0.0,"BookingLeader":"","BookingStatus":"","Adults":0,"Children":0}]

application/xml, text/xml

Sample:
<?xml version="1.0" encoding="utf-16"?>
<ArrayOfAPIBookingHistoryDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIBookingHistoryDetail>
    <BookingRef>0</BookingRef>
    <BookingSource />
    <ResourceName />
    <VisitDate>0001-01-01T00:00:00</VisitDate>
    <FullPrice>0</FullPrice>
    <BookingLeader />
    <BookingStatus />
    <Adults>0</Adults>
    <Children>0</Children>
  </APIBookingHistoryDetail>
</ArrayOfAPIBookingHistoryDetail>