| POST | /pickmeup/pickmeup | Request a booking for the Pick Me Up service. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | form | string | Yes | ID Number of the user making this request. |
| PassengerCount | form | int | Yes | The number of people to be picked up. |
| BookingDate | form | string | Yes | Date and Time of the pickup in ISO 8601 format. |
| ContactName | form | string | Yes | Name of contact person at pickup. |
| ContactNumber | form | string | Yes | Contact number of contact person at pickup. |
| 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 |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| 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. |
| 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. |
| PickupOutOfBounds | form | bool | No | This indicates that the pickup location is outside of the service area of the service provider. |
| DropoffOutOfBounds | form | bool | No | This indicates that the dropoff location is outside of the service area of the service provider. |
| PickupTooSoon | form | bool | No | This indicates that the pickup time is not far enough in the future. The time needs to be at least 60 minutes in the future, or 90 minutes during peak times. See the documentation for more details. |
| ReferenceNumber | form | string | No | The booking reference number returned by the service provider. To be shown to the client. |
| ErrorMessage | form | string | No | Error message from service provider. |
| ErrorCode | form | int | No | Error code from service provider. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /pickmeup/pickmeup HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"IdNumber":"String","PassengerCount":0,"BookingDate":"String","ContactName":"String","ContactNumber":"String","PickupLocation":{"Latitude":0,"Longitude":0,"Address":"String"},"DropoffLocation":{"Latitude":0,"Longitude":0,"Address":"String"},"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ProductAvailable":false,"UserHasAccess":false,"PickupOutOfBounds":false,"DropoffOutOfBounds":false,"PickupTooSoon":false,"ReferenceNumber":"String","ErrorMessage":"String","ErrorCode":0,"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}