| GET | /galaxy/vehicle/list | Retrieve a list of a user's vehicles. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel.Vehicles;
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.Vehicles
{
public partial class GetVehicleList
: ApiServiceRequest
{
///<summary>
///ID Number of the user making this request.
///</summary>
[ApiMember(Description="ID Number of the user making this request.", IsRequired=true)]
public virtual string IdNumber { get; set; }
}
public partial class VehicleData
{
///<summary>
///The ID of the vehicle.
///</summary>
[ApiMember(Description="The ID of the vehicle.")]
public virtual int Id { get; set; }
///<summary>
///Whether the vehicle has license disk information.
///</summary>
[ApiMember(Description="Whether the vehicle has license disk information.")]
public virtual bool HasLicense { get; set; }
///<summary>
///The vehicle license number.
///</summary>
[ApiMember(Description="The vehicle license number.")]
public virtual string LicenseNumber { get; set; }
///<summary>
///The vehicle registration number.
///</summary>
[ApiMember(Description="The vehicle registration number.")]
public virtual string RegistrationNumber { get; set; }
///<summary>
///The vehicle VIN number.
///</summary>
[ApiMember(Description="The vehicle VIN number.")]
public virtual string Vin { get; set; }
///<summary>
///The vehicle make.
///</summary>
[ApiMember(Description="The vehicle make.")]
public virtual string Make { get; set; }
///<summary>
///The vehicle series.
///</summary>
[ApiMember(Description="The vehicle series.")]
public virtual string Series { get; set; }
///<summary>
///The vehicle colour.
///</summary>
[ApiMember(Description="The vehicle colour.")]
public virtual string Colour { get; set; }
///<summary>
///The vehicle license expiry date in ISO 8601 format.
///</summary>
[ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")]
public virtual string Expiry { get; set; }
///<summary>
///True if this vehicle's licence expiring soon.
///</summary>
[ApiMember(Description="True if this vehicle's licence expiring soon.")]
public virtual bool ExpiresSoon { get; set; }
///<summary>
///True if this vehicle's license expired.
///</summary>
[ApiMember(Description="True if this vehicle's license expired.")]
public virtual bool Expired { get; set; }
}
public partial class VehicleListResponse
: ApiServiceResponse
{
public virtual IEnumerable<VehicleData> Vehicles { get; set; }
}
}
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.
GET /galaxy/vehicle/list HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}