GalaxyMobile Client API

TakeMeHomeRequest

The following routes are available for this service:
POST	/pickmeup/takemehome	Request a booking for the Take Me Home service.

**PickMeUpActivationRequest** Parameters:
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.

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication

**BookingLocation** Parameters:
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.

**PickMeUpResponse** Parameters:
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.

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /pickmeup/takemehome HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TakeMeHomeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.PickMeUp">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <BookingDate>String</BookingDate>
  <ContactName>String</ContactName>
  <ContactNumber>String</ContactNumber>
  <DropoffLocation>
    <Address>String</Address>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </DropoffLocation>
  <IdNumber>String</IdNumber>
  <PassengerCount>0</PassengerCount>
  <PickupLocation>
    <Address>String</Address>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </PickupLocation>
</TakeMeHomeRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PickMeUpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.PickMeUp">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <DropoffOutOfBounds>false</DropoffOutOfBounds>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <PickupOutOfBounds>false</PickupOutOfBounds>
  <PickupTooSoon>false</PickupTooSoon>
  <ProductAvailable>false</ProductAvailable>
  <ReferenceNumber>String</ReferenceNumber>
  <UserHasAccess>false</UserHasAccess>
</PickMeUpResponse>