| GET, POST | /pickmeup/history | Get the user's recent history of bookings. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel.PickMeUp;
using WebService.ClientServiceModel.Base;
using CommonService.Api.Models.Base;
namespace CommonService.Api.Models.Base
{
public partial class ApiServiceResponse
: IServiceResponse
{
public virtual string Description { get; set; }
public virtual string Heading { get; set; }
public virtual bool WasSuccessful { get; set; }
public virtual Object ModelState { get; set; }
}
}
namespace WebService.ClientServiceModel.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
}
}
namespace WebService.ClientServiceModel.PickMeUp
{
public partial class BookingLocation
{
///<summary>
///Latitude of the pickup/drop-off location.
///</summary>
[ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)]
public virtual double Latitude { get; set; }
///<summary>
///Longitude of the pickup/drop-off location.
///</summary>
[ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)]
public virtual double Longitude { get; set; }
///<summary>
///Address of the pickup/drop-off location.
///</summary>
[ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)]
public virtual string Address { get; set; }
}
public partial class 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.")]
public virtual string BookingTime { 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.")]
public virtual string ReferenceNumber { 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.")]
public virtual string DateCreated { 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.")]
public virtual string Status { get; set; }
///<summary>
///Name of contact person at pickup.
///</summary>
[ApiMember(Description="Name of contact person at pickup.", IsRequired=true)]
public virtual string ContactName { get; set; }
///<summary>
///Contact number of contact person at pickup.
///</summary>
[ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)]
public virtual string ContactNumber { get; set; }
///<summary>
///The number of people to be picked up.
///</summary>
[ApiMember(Description="The number of people to be picked up.", IsRequired=true)]
public virtual string PassengerCount { 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)]
public virtual BookingLocation PickupLocation { 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)]
public virtual BookingLocation DropoffLocation { get; set; }
}
public partial class PickMeUpHistoryRequest
: 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)]
public virtual string IdNumber { get; set; }
}
public partial class PickMeUpHistoryResponse
: ApiServiceResponse
{
public PickMeUpHistoryResponse()
{
PickMeUpHistory = new List<PickMeUpBookingItem>{};
TakeMeHomeHistory = new List<PickMeUpBookingItem>{};
}
///<summary>
///Is the requested product set up and enabled on Galaxy.
///</summary>
[ApiMember(Description="Is the requested product set up and enabled on Galaxy.")]
public virtual bool ProductAvailable { 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.")]
public virtual bool UserHasAccess { 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.")]
public virtual List<PickMeUpBookingItem> PickMeUpHistory { 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.")]
public virtual List<PickMeUpBookingItem> TakeMeHomeHistory { get; set; }
}
}
C# PickMeUpHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/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":{}}