| GET, POST | /pickmeup/history | Get the user's recent history of bookings. |
|---|
namespace CommonService.Api.Models.Base
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
member val Description:String = null with get,set
member val Heading:String = null with get,set
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ModelState:Object = null with get,set
[<AllowNullLiteral>]
type BookingLocation() =
///<summary>
///Latitude of the pickup/drop-off location.
///</summary>
[<ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)>]
member val Latitude:Double = new Double() with get,set
///<summary>
///Longitude of the pickup/drop-off location.
///</summary>
[<ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)>]
member val Longitude:Double = new Double() with get,set
///<summary>
///Address of the pickup/drop-off location.
///</summary>
[<ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)>]
member val Address:String = null with get,set
[<AllowNullLiteral>]
type PickMeUpBookingItem() =
///<summary>
///Date and Time of the pickup in ISO 8601 format.
///</summary>
[<ApiMember(Description="Date and Time of the pickup in ISO 8601 format.")>]
member val BookingTime:String = null with get,set
///<summary>
///The booking reference number returned by the service provider. To be shown to the client.
///</summary>
[<ApiMember(Description="The booking reference number returned by the service provider. To be shown to the client.")>]
member val ReferenceNumber:String = null with get,set
///<summary>
///Date and Time the booking request was made in ISO 8601 format.
///</summary>
[<ApiMember(Description="Date and Time the booking request was made in ISO 8601 format.")>]
member val DateCreated:String = null with get,set
///<summary>
///Status of the booking as returned by the service provider.
///</summary>
[<ApiMember(Description="Status of the booking as returned by the service provider.")>]
member val Status:String = null with get,set
///<summary>
///Name of contact person at pickup.
///</summary>
[<ApiMember(Description="Name of contact person at pickup.", IsRequired=true)>]
member val ContactName:String = null with get,set
///<summary>
///Contact number of contact person at pickup.
///</summary>
[<ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)>]
member val ContactNumber:String = null with get,set
///<summary>
///The number of people to be picked up.
///</summary>
[<ApiMember(Description="The number of people to be picked up.", IsRequired=true)>]
member val PassengerCount:String = null with get,set
///<summary>
///The location details of where the clients are to be picked up.
///</summary>
[<ApiMember(Description="The location details of where the clients are to be picked up.", IsRequired=true)>]
member val PickupLocation:BookingLocation = null with get,set
///<summary>
///The location details of where the clients are to be dropped off.
///</summary>
[<ApiMember(Description="The location details of where the clients are to be dropped off.", IsRequired=true)>]
member val DropoffLocation:BookingLocation = null with get,set
[<AllowNullLiteral>]
type PickMeUpHistoryResponse() =
inherit ApiServiceResponse()
///<summary>
///Is the requested product set up and enabled on Galaxy.
///</summary>
[<ApiMember(Description="Is the requested product set up and enabled on Galaxy.")>]
member val ProductAvailable:Boolean = new Boolean() with get,set
///<summary>
///Does the user have access to this product, based on their Galaxy profile.
///</summary>
[<ApiMember(Description="Does the user have access to this product, based on their Galaxy profile.")>]
member val UserHasAccess:Boolean = new Boolean() with get,set
///<summary>
///List of booking history items for the Pick Me Up service.
///</summary>
[<ApiMember(Description="List of booking history items for the Pick Me Up service.")>]
member val PickMeUpHistory:ResizeArray<PickMeUpBookingItem> = new ResizeArray<PickMeUpBookingItem>() with get,set
///<summary>
///List of booking history items for the Take Me Home service.
///</summary>
[<ApiMember(Description="List of booking history items for the Take Me Home service.")>]
member val TakeMeHomeHistory:ResizeArray<PickMeUpBookingItem> = new ResizeArray<PickMeUpBookingItem>() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
[<AllowNullLiteral>]
type PickMeUpHistoryRequest() =
inherit ApiServiceRequest()
///<summary>
///ID Number of the user's history to retrieve.
///</summary>
[<ApiMember(Description="ID Number of the user's history to retrieve.", IsRequired=true)>]
member val IdNumber:String = null with get,set
F# PickMeUpHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IdNumber: String,
ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ProductAvailable: False,
UserHasAccess: False,
PickMeUpHistory:
[
{
}
],
TakeMeHomeHistory:
[
{
}
],
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}