| POST | /pickmeup/pickmeup | Request a booking for the Pick Me Up service. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class PickMeUpRequest extends PickMeUpActivationRequest
{
}
public static class PickMeUpActivationRequest extends ApiServiceRequest
{
/**
* ID Number of the user making this request.
*/
@ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
public String IdNumber = null;
/**
* The number of people to be picked up.
*/
@ApiMember(Description="The number of people to be picked up.", IsRequired=true)
public Integer PassengerCount = 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)
public String BookingDate = null;
/**
* Name of contact person at pickup.
*/
@ApiMember(Description="Name of contact person at pickup.", IsRequired=true)
public String ContactName = null;
/**
* Contact number of contact person at pickup.
*/
@ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)
public String ContactNumber = 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)
public BookingLocation PickupLocation = 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)
public BookingLocation DropoffLocation = null;
public String getIdNumber() { return IdNumber; }
public PickMeUpActivationRequest setIdNumber(String value) { this.IdNumber = value; return this; }
public Integer getPassengerCount() { return PassengerCount; }
public PickMeUpActivationRequest setPassengerCount(Integer value) { this.PassengerCount = value; return this; }
public String getBookingDate() { return BookingDate; }
public PickMeUpActivationRequest setBookingDate(String value) { this.BookingDate = value; return this; }
public String getContactName() { return ContactName; }
public PickMeUpActivationRequest setContactName(String value) { this.ContactName = value; return this; }
public String getContactNumber() { return ContactNumber; }
public PickMeUpActivationRequest setContactNumber(String value) { this.ContactNumber = value; return this; }
public BookingLocation getPickupLocation() { return PickupLocation; }
public PickMeUpActivationRequest setPickupLocation(BookingLocation value) { this.PickupLocation = value; return this; }
public BookingLocation getDropoffLocation() { return DropoffLocation; }
public PickMeUpActivationRequest setDropoffLocation(BookingLocation value) { this.DropoffLocation = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static class BookingLocation
{
/**
* Latitude of the pickup/drop-off location.
*/
@ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)
public Double Latitude = null;
/**
* Longitude of the pickup/drop-off location.
*/
@ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)
public Double Longitude = null;
/**
* Address of the pickup/drop-off location.
*/
@ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)
public String Address = null;
public Double getLatitude() { return Latitude; }
public BookingLocation setLatitude(Double value) { this.Latitude = value; return this; }
public Double getLongitude() { return Longitude; }
public BookingLocation setLongitude(Double value) { this.Longitude = value; return this; }
public String getAddress() { return Address; }
public BookingLocation setAddress(String value) { this.Address = value; return this; }
}
public static class PickMeUpResponse extends ApiServiceResponse
{
/**
* Is the requested product set up and enabled on Galaxy.
*/
@ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
public Boolean ProductAvailable = 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.")
public Boolean UserHasAccess = 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.")
public Boolean PickupOutOfBounds = 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.")
public Boolean DropoffOutOfBounds = 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.")
public Boolean PickupTooSoon = 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.")
public String ReferenceNumber = null;
/**
* Error message from service provider.
*/
@ApiMember(Description="Error message from service provider.")
public String ErrorMessage = null;
/**
* Error code from service provider.
*/
@ApiMember(Description="Error code from service provider.")
public Integer ErrorCode = null;
public Boolean isProductAvailable() { return ProductAvailable; }
public PickMeUpResponse setProductAvailable(Boolean value) { this.ProductAvailable = value; return this; }
public Boolean isUserHasAccess() { return UserHasAccess; }
public PickMeUpResponse setUserHasAccess(Boolean value) { this.UserHasAccess = value; return this; }
public Boolean isPickupOutOfBounds() { return PickupOutOfBounds; }
public PickMeUpResponse setPickupOutOfBounds(Boolean value) { this.PickupOutOfBounds = value; return this; }
public Boolean isDropoffOutOfBounds() { return DropoffOutOfBounds; }
public PickMeUpResponse setDropoffOutOfBounds(Boolean value) { this.DropoffOutOfBounds = value; return this; }
public Boolean isPickupTooSoon() { return PickupTooSoon; }
public PickMeUpResponse setPickupTooSoon(Boolean value) { this.PickupTooSoon = value; return this; }
public String getReferenceNumber() { return ReferenceNumber; }
public PickMeUpResponse setReferenceNumber(String value) { this.ReferenceNumber = value; return this; }
public String getErrorMessage() { return ErrorMessage; }
public PickMeUpResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
public Integer getErrorCode() { return ErrorCode; }
public PickMeUpResponse setErrorCode(Integer value) { this.ErrorCode = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PickMeUpRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.PickMeUp">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<BookingDate>String</BookingDate>
<ContactName>String</ContactName>
<ContactNumber>String</ContactNumber>
<DropoffLocation>
<Address>String</Address>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</DropoffLocation>
<IdNumber>String</IdNumber>
<PassengerCount>0</PassengerCount>
<PickupLocation>
<Address>String</Address>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</PickupLocation>
</PickMeUpRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <PickMeUpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.PickMeUp"> <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description> <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading> <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" /> <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful> <DropoffOutOfBounds>false</DropoffOutOfBounds> <ErrorCode>0</ErrorCode> <ErrorMessage>String</ErrorMessage> <PickupOutOfBounds>false</PickupOutOfBounds> <PickupTooSoon>false</PickupTooSoon> <ProductAvailable>false</ProductAvailable> <ReferenceNumber>String</ReferenceNumber> <UserHasAccess>false</UserHasAccess> </PickMeUpResponse>