| GET, POST | /pickmeup/history | Get the user's recent history of bookings. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | body | string | Yes | ID Number of the user's history to retrieve. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProductAvailable | form | bool | No | Is the requested product set up and enabled on Galaxy. |
| UserHasAccess | form | bool | No | Does the user have access to this product, based on their Galaxy profile. |
| PickMeUpHistory | form | List<PickMeUpBookingItem> | No | List of booking history items for the Pick Me Up service. |
| TakeMeHomeHistory | form | List<PickMeUpBookingItem> | No | List of booking history items for the Take Me Home service. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookingTime | form | string | No | Date and Time of the pickup in ISO 8601 format. |
| ReferenceNumber | form | string | No | The booking reference number returned by the service provider. To be shown to the client. |
| DateCreated | form | string | No | Date and Time the booking request was made in ISO 8601 format. |
| Status | form | string | No | Status of the booking as returned by the service provider. |
| ContactName | form | string | Yes | Name of contact person at pickup. |
| ContactNumber | form | string | Yes | Contact number of contact person at pickup. |
| PassengerCount | form | string | Yes | The number of people to be picked up. |
| PickupLocation | form | BookingLocation | Yes | The location details of where the clients are to be picked up. |
| DropoffLocation | form | BookingLocation | Yes | The location details of where the clients are to be dropped off. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Latitude | form | double | Yes | Latitude of the pickup/drop-off location. |
| Longitude | form | double | Yes | Longitude of the pickup/drop-off location. |
| Address | form | string | Yes | Address of the pickup/drop-off location. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /pickmeup/history HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"IdNumber":"String","ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ProductAvailable":false,"UserHasAccess":false,"PickMeUpHistory":[{}],"TakeMeHomeHistory":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}