| GET, POST | /pickmeup/history | Get the user's recent history of bookings. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class PickMeUpHistoryRequest : ApiServiceRequest()
{
/**
* ID Number of the user's history to retrieve.
*/
@ApiMember(Description="ID Number of the user's history to retrieve.", IsRequired=true)
var IdNumber:String? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
open class PickMeUpHistoryResponse : ApiServiceResponse()
{
/**
* Is the requested product set up and enabled on Galaxy.
*/
@ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
var ProductAvailable:Boolean? = null
/**
* 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.")
var UserHasAccess:Boolean? = null
/**
* List of booking history items for the Pick Me Up service.
*/
@ApiMember(Description="List of booking history items for the Pick Me Up service.")
var PickMeUpHistory:ArrayList<PickMeUpBookingItem> = ArrayList<PickMeUpBookingItem>()
/**
* List of booking history items for the Take Me Home service.
*/
@ApiMember(Description="List of booking history items for the Take Me Home service.")
var TakeMeHomeHistory:ArrayList<PickMeUpBookingItem> = ArrayList<PickMeUpBookingItem>()
}
open class ApiServiceResponse : IServiceResponse
{
var Description:String? = null
var Heading:String? = null
var WasSuccessful:Boolean? = null
var ModelState:Object? = null
}
open class PickMeUpBookingItem
{
/**
* Date and Time of the pickup in ISO 8601 format.
*/
@ApiMember(Description="Date and Time of the pickup in ISO 8601 format.")
var BookingTime:String? = null
/**
* 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.")
var ReferenceNumber:String? = null
/**
* 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.")
var DateCreated:String? = null
/**
* Status of the booking as returned by the service provider.
*/
@ApiMember(Description="Status of the booking as returned by the service provider.")
var Status:String? = null
/**
* Name of contact person at pickup.
*/
@ApiMember(Description="Name of contact person at pickup.", IsRequired=true)
var ContactName:String? = null
/**
* Contact number of contact person at pickup.
*/
@ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)
var ContactNumber:String? = null
/**
* The number of people to be picked up.
*/
@ApiMember(Description="The number of people to be picked up.", IsRequired=true)
var PassengerCount:String? = null
/**
* 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)
var PickupLocation:BookingLocation? = null
/**
* 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)
var DropoffLocation:BookingLocation? = null
}
open class BookingLocation
{
/**
* Latitude of the pickup/drop-off location.
*/
@ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)
var Latitude:Double? = null
/**
* Longitude of the pickup/drop-off location.
*/
@ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)
var Longitude:Double? = null
/**
* Address of the pickup/drop-off location.
*/
@ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)
var Address:String? = null
}
Kotlin 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: {}
}