GET Booking/GetBooking?StartDate={StartDate}&EndDate={EndDate}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}&custID={custID}&bookGuid={bookGuid}
Returns booking data.
Request Information
URI Parameters
| Name | Description | Type | Additional 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 |
| custID |
Filter the list of bookings by the Customer ID on the splits (optional) |
string |
Default value is string.Empty |
| bookGuid |
Filter the list of bookings by the BookGuid (optional) |
string |
Default value is string.Empty |
Body Parameters
Response Information
Resource Description
Returns booking data.
AgvBooking| Name | Description | Type | Additional 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
{
"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": "4fb57809-9d96-43d0-b5dd-7053506fd073",
"BookingRecordHeaderDetails": null,
"BookingRecordSplitDetails": [],
"BookingRecordLineItemDetails": [],
"BookingRecordAnalysisDetails": []
},
{
"BookDate": "sample string 1",
"BookLocation": "sample string 2",
"BookNumber": "sample string 3",
"BookGuid": "4fb57809-9d96-43d0-b5dd-7053506fd073",
"BookingRecordHeaderDetails": null,
"BookingRecordSplitDetails": [],
"BookingRecordLineItemDetails": [],
"BookingRecordAnalysisDetails": []
}
]
}