| POST | /pickmeup/pickmeup | Request a booking for the Pick Me Up service. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class PickMeUpRequest : PickMeUpActivationRequest()
{
}
open class PickMeUpActivationRequest : ApiServiceRequest()
{
/**
* ID Number of the user making this request.
*/
@ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
var IdNumber:String? = null
/**
* The number of people to be picked up.
*/
@ApiMember(Description="The number of people to be picked up.", IsRequired=true)
var PassengerCount:Int? = null
/**
* Date and Time of the pickup in ISO 8601 format.
*/
@ApiMember(Description="Date and Time of the pickup in ISO 8601 format.", IsRequired=true)
var BookingDate: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 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)
var PickupLocation:BookingLocation? = null
/**
* 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)
var DropoffLocation:BookingLocation? = 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 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
}
open class PickMeUpResponse : 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
/**
* 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.")
var PickupOutOfBounds:Boolean? = null
/**
* 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.")
var DropoffOutOfBounds:Boolean? = null
/**
* 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.")
var PickupTooSoon:Boolean? = 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
/**
* Error message from service provider.
*/
@ApiMember(Description="Error message from service provider.")
var ErrorMessage:String? = null
/**
* Error code from service provider.
*/
@ApiMember(Description="Error code from service provider.")
var ErrorCode:Int? = null
}
open class ApiServiceResponse : IServiceResponse
{
var Description:String? = null
var Heading:String? = null
var WasSuccessful:Boolean? = null
var ModelState:Object? = null
}
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/pickmeup HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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: {}
}