| POST | /pickmeup/takemehome | Request a booking for the Take Me Home service. |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public ApiKey: string;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class BookingLocation
{
/** @description Latitude of the pickup/drop-off location. */
// @ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)
public Latitude: number;
/** @description Longitude of the pickup/drop-off location. */
// @ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)
public Longitude: number;
/** @description Address of the pickup/drop-off location. */
// @ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)
public Address: string;
public constructor(init?: Partial<BookingLocation>) { (Object as any).assign(this, init); }
}
export class PickMeUpActivationRequest extends ApiServiceRequest
{
/** @description ID Number of the user making this request. */
// @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
public IdNumber: string;
/** @description The number of people to be picked up. */
// @ApiMember(Description="The number of people to be picked up.", IsRequired=true)
public PassengerCount: number;
/** @description Date and Time of the pickup in ISO 8601 format. */
// @ApiMember(Description="Date and Time of the pickup in ISO 8601 format.", IsRequired=true)
public BookingDate: string;
/** @description Name of contact person at pickup. */
// @ApiMember(Description="Name of contact person at pickup.", IsRequired=true)
public ContactName: string;
/** @description Contact number of contact person at pickup. */
// @ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)
public ContactNumber: string;
/** @description The location details of where the clients are to be picked up. */
// @ApiMember(DataType="BookingLocation", Description="The location details of where the clients are to be picked up.", IsRequired=true)
public PickupLocation: BookingLocation;
/** @description The location details of where the clients are to be dropped off. */
// @ApiMember(DataType="BookingLocation", Description="The location details of where the clients are to be dropped off.", IsRequired=true)
public DropoffLocation: BookingLocation;
public constructor(init?: Partial<PickMeUpActivationRequest>) { super(init); (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
public Description: string;
public Heading: string;
public WasSuccessful: boolean;
public ModelState: Object;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export class PickMeUpResponse extends ApiServiceResponse
{
/** @description Is the requested product set up and enabled on Galaxy. */
// @ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
public ProductAvailable: boolean;
/** @description Does the user have access to this product, based on their Galaxy profile. */
// @ApiMember(Description="Does the user have access to this product, based on their Galaxy profile.")
public UserHasAccess: boolean;
/** @description This indicates that the pickup location is outside of the service area of the service provider. */
// @ApiMember(Description="This indicates that the pickup location is outside of the service area of the service provider.")
public PickupOutOfBounds: boolean;
/** @description This indicates that the dropoff location is outside of the service area of the service provider. */
// @ApiMember(Description="This indicates that the dropoff location is outside of the service area of the service provider.")
public DropoffOutOfBounds: boolean;
/** @description 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. */
// @ApiMember(Description="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.")
public PickupTooSoon: boolean;
/** @description The booking reference number returned by the service provider. To be shown to the client. */
// @ApiMember(Description="The booking reference number returned by the service provider. To be shown to the client.")
public ReferenceNumber: string;
/** @description Error message from service provider. */
// @ApiMember(Description="Error message from service provider.")
public ErrorMessage: string;
/** @description Error code from service provider. */
// @ApiMember(Description="Error code from service provider.")
public ErrorCode: number;
public constructor(init?: Partial<PickMeUpResponse>) { super(init); (Object as any).assign(this, init); }
}
export class TakeMeHomeRequest extends PickMeUpActivationRequest
{
public constructor(init?: Partial<TakeMeHomeRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript TakeMeHomeRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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/jsonl
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":{}}