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.
"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Heading;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {Object} */
    ModelState;
}
export class BookingLocation {
    /** @param {{Latitude?:number,Longitude?:number,Address?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Latitude of the pickup/drop-off location. */
    Latitude;
    /**
     * @type {number}
     * @description Longitude of the pickup/drop-off location. */
    Longitude;
    /**
     * @type {string}
     * @description Address of the pickup/drop-off location. */
    Address;
}
export class PickMeUpBookingItem {
    /** @param {{BookingTime?:string,ReferenceNumber?:string,DateCreated?:string,Status?:string,ContactName?:string,ContactNumber?:string,PassengerCount?:string,PickupLocation?:BookingLocation,DropoffLocation?:BookingLocation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Date and Time of the pickup in ISO 8601 format. */
    BookingTime;
    /**
     * @type {string}
     * @description The booking reference number returned by the service provider. To be shown to the client. */
    ReferenceNumber;
    /**
     * @type {string}
     * @description Date and Time the booking request was made in ISO 8601 format. */
    DateCreated;
    /**
     * @type {string}
     * @description Status of the booking as returned by the service provider. */
    Status;
    /**
     * @type {string}
     * @description Name of contact person at pickup. */
    ContactName;
    /**
     * @type {string}
     * @description Contact number of contact person at pickup. */
    ContactNumber;
    /**
     * @type {string}
     * @description The number of people to be picked up. */
    PassengerCount;
    /**
     * @type {BookingLocation}
     * @description The location details of where the clients are to be picked up. */
    PickupLocation;
    /**
     * @type {BookingLocation}
     * @description The location details of where the clients are to be dropped off. */
    DropoffLocation;
}
export class PickMeUpHistoryResponse extends ApiServiceResponse {
    /** @param {{ProductAvailable?:boolean,UserHasAccess?:boolean,PickMeUpHistory?:PickMeUpBookingItem[],TakeMeHomeHistory?:PickMeUpBookingItem[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description Is the requested product set up and enabled on Galaxy. */
    ProductAvailable;
    /**
     * @type {boolean}
     * @description Does the user have access to this product, based on their Galaxy profile. */
    UserHasAccess;
    /**
     * @type {PickMeUpBookingItem[]}
     * @description List of booking history items for the Pick Me Up service. */
    PickMeUpHistory;
    /**
     * @type {PickMeUpBookingItem[]}
     * @description List of booking history items for the Take Me Home service. */
    TakeMeHomeHistory;
}
export class PickMeUpHistoryRequest extends ApiServiceRequest {
    /** @param {{IdNumber?:string,ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID Number of the user's history to retrieve. */
    IdNumber;
}

JavaScript PickMeUpHistoryRequest DTOs

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