GalaxyMobile Client API

<back to all web services

PickMeUpHistoryRequest

The following routes are available for this service:
GET, POST/pickmeup/historyGet the user's recent history of bookings.
PickMeUpHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
IdNumberbodystringYesID Number of the user's history to retrieve.
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
PickMeUpHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
ProductAvailableformboolNoIs the requested product set up and enabled on Galaxy.
UserHasAccessformboolNoDoes the user have access to this product, based on their Galaxy profile.
PickMeUpHistoryformList<PickMeUpBookingItem>NoList of booking history items for the Pick Me Up service.
TakeMeHomeHistoryformList<PickMeUpBookingItem>NoList of booking history items for the Take Me Home service.
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
PickMeUpBookingItem Parameters:
NameParameterData TypeRequiredDescription
BookingTimeformstringNoDate and Time of the pickup in ISO 8601 format.
ReferenceNumberformstringNoThe booking reference number returned by the service provider. To be shown to the client.
DateCreatedformstringNoDate and Time the booking request was made in ISO 8601 format.
StatusformstringNoStatus of the booking as returned by the service provider.
ContactNameformstringYesName of contact person at pickup.
ContactNumberformstringYesContact number of contact person at pickup.
PassengerCountformstringYesThe number of people to be picked up.
PickupLocationformBookingLocationYesThe location details of where the clients are to be picked up.
DropoffLocationformBookingLocationYesThe location details of where the clients are to be dropped off.
BookingLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleYesLatitude of the pickup/drop-off location.
LongitudeformdoubleYesLongitude of the pickup/drop-off location.
AddressformstringYesAddress 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

HTTP + JSON

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":{}}