GET Booking/GetBooking?StartDate={StartDate}&EndDate={EndDate}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}

Returns booking data.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
StartDate

Start date of bookings to return. Format MM-dd-yyyy.

string

Required

EndDate

End date of bookings to return. Format MM-dd-yyyy.

string

Required

lastModifiedOnOrAfterUtc

Filter the list of bookings to those changed on or after the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss

string

Default value is string.Empty

lastModifiedOnOrBeforeUtc

Filter the list of bookings to those changed on or before the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns booking data.

AgvBooking
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
ErrorList

List of error messages of the API call.

Collection of string
Count

Count of how many Bookings.

string
BookingRecords

JSON dictionary of BookRecords.

Collection of clsAPIBook

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "BookingRecords": [
    {
      "BookDate": "sample string 1",
      "BookLocation": "sample string 2",
      "BookNumber": "sample string 3",
      "BookGuid": "a99e1742-8555-46b7-bd3c-df7fcf2acae7",
      "BookingRecordHeaderDetails": null,
      "BookingRecordSplitDetails": [],
      "BookingRecordLineItemDetails": [],
      "BookingRecordAnalysisDetails": []
    },
    {
      "BookDate": "sample string 1",
      "BookLocation": "sample string 2",
      "BookNumber": "sample string 3",
      "BookGuid": "a99e1742-8555-46b7-bd3c-df7fcf2acae7",
      "BookingRecordHeaderDetails": null,
      "BookingRecordSplitDetails": [],
      "BookingRecordLineItemDetails": [],
      "BookingRecordAnalysisDetails": []
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.