Get Pickups
Retrieves a list of available Pickup locations and times for a Booking.
Request Profile Table
Element | @Attribute |
Description/Contents |
GetPickups / GetPickupsRequest |
Root element of message. |
BookingID |
ProCharter Booking ID of the booking to retrieve Pickups for |
Scenario:
You want to retrieve the list of available Pickups for Booking 78857.
Example message:
<GetPickups>
<GetPickupsRequest>
<BookingID>78857</BookingID>
</GetPickupsRequest>
</GetPickups>
Response Profile Table
Element | @Attribute |
Description/Contents |
GetPickupsResponse / GetPickupsResult |
Root element of message. |
PickupLocations |
Collection of PickupsLocation objects |
PickupLocation |
Element representing a PickupLocation |
@Code |
Pickup Code |
@Description |
Pickup Description |
@PickupTime |
Pickup Time. Note: This is returned as a date/time |
Example message:
<GetPickupsResponse xmlns="ResLink">
<GetPickupsResult>
<TimeStamp>2016-01-11T15:42:57.4430816+10:00</TimeStamp>
<Status Code="0" Message=""/>
<Errors/>
<Warnings/>
<PickupLocations>
<PickupLocation Code="P01" Description="Bus Stop A" PickupTime="0001-01-01T07:55:00"/>
<PickupLocation Code="P02" Description="Bus Stop B" PickupTime="0001-01-01T08:00:00"/>
<PickupLocation Code="P03" Description="Bus Stop C" PickupTime="0001-01-01T08:05:00"/>
</PickupLocations>
</GetPickupsResult>
</GetPickupsResponse>