GalaxyMobile Client API

<back to all web services

PickMeUpHistoryRequest

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 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 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 PickMeUpBookingItem
{
    /** @description Date and Time of the pickup in ISO 8601 format. */
    // @ApiMember(Description="Date and Time of the pickup in ISO 8601 format.")
    public BookingTime: string;

    /** @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 Date and Time the booking request was made in ISO 8601 format. */
    // @ApiMember(Description="Date and Time the booking request was made in ISO 8601 format.")
    public DateCreated: string;

    /** @description Status of the booking as returned by the service provider. */
    // @ApiMember(Description="Status of the booking as returned by the service provider.")
    public Status: 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 number of people to be picked up. */
    // @ApiMember(Description="The number of people to be picked up.", IsRequired=true)
    public PassengerCount: string;

    /** @description The location details of where the clients are to be picked up. */
    // @ApiMember(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(Description="The location details of where the clients are to be dropped off.", IsRequired=true)
    public DropoffLocation: BookingLocation;

    public constructor(init?: Partial<PickMeUpBookingItem>) { (Object as any).assign(this, init); }
}

export class PickMeUpHistoryResponse 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 List of booking history items for the Pick Me Up service. */
    // @ApiMember(Description="List of booking history items for the Pick Me Up service.")
    public PickMeUpHistory: PickMeUpBookingItem[];

    /** @description List of booking history items for the Take Me Home service. */
    // @ApiMember(Description="List of booking history items for the Take Me Home service.")
    public TakeMeHomeHistory: PickMeUpBookingItem[];

    public constructor(init?: Partial<PickMeUpHistoryResponse>) { super(init); (Object as any).assign(this, init); }
}

export class PickMeUpHistoryRequest extends ApiServiceRequest
{
    /** @description ID Number of the user's history to retrieve. */
    // @ApiMember(Description="ID Number of the user's history to retrieve.", IsRequired=true)
    public IdNumber: string;

    public constructor(init?: Partial<PickMeUpHistoryRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript PickMeUpHistoryRequest DTOs

POST /pickmeup/history HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"IdNumber":"String","ApiKey":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ProductAvailable":false,"UserHasAccess":false,"PickMeUpHistory":[{}],"TakeMeHomeHistory":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}