GalaxyMobile Client API

GetVehicleList

The following routes are available for this service:
GET	/galaxy/vehicle/list	Retrieve a list of a user's vehicles.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel.Vehicles
Imports WebService.ClientServiceModel.Base
Imports CommonService.Api.Models.Base

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace WebService.ClientServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String
        End Class
    End Namespace

    Namespace WebService.ClientServiceModel.Vehicles

        Public Partial Class GetVehicleList
            Inherits ApiServiceRequest
            '''<Summary>
            '''ID Number of the user making this request.
            '''</Summary>
            <ApiMember(Description:="ID Number of the user making this request.", IsRequired:=true)>
            Public Overridable Property IdNumber As String
        End Class

        Public Partial Class VehicleData
            '''<Summary>
            '''The ID of the vehicle.
            '''</Summary>
            <ApiMember(Description:="The ID of the vehicle.")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''Whether the vehicle has license disk information.
            '''</Summary>
            <ApiMember(Description:="Whether the vehicle has license disk information.")>
            Public Overridable Property HasLicense As Boolean

            '''<Summary>
            '''The vehicle license number.
            '''</Summary>
            <ApiMember(Description:="The vehicle license number.")>
            Public Overridable Property LicenseNumber As String

            '''<Summary>
            '''The vehicle registration number.
            '''</Summary>
            <ApiMember(Description:="The vehicle registration number.")>
            Public Overridable Property RegistrationNumber As String

            '''<Summary>
            '''The vehicle VIN number.
            '''</Summary>
            <ApiMember(Description:="The vehicle VIN number.")>
            Public Overridable Property Vin As String

            '''<Summary>
            '''The vehicle make.
            '''</Summary>
            <ApiMember(Description:="The vehicle make.")>
            Public Overridable Property Make As String

            '''<Summary>
            '''The vehicle series.
            '''</Summary>
            <ApiMember(Description:="The vehicle series.")>
            Public Overridable Property Series As String

            '''<Summary>
            '''The vehicle colour.
            '''</Summary>
            <ApiMember(Description:="The vehicle colour.")>
            Public Overridable Property Colour As String

            '''<Summary>
            '''The vehicle license expiry date in ISO 8601 format.
            '''</Summary>
            <ApiMember(Description:="The vehicle license expiry date in ISO 8601 format.")>
            Public Overridable Property Expiry As String

            '''<Summary>
            '''True if this vehicle's licence expiring soon.
            '''</Summary>
            <ApiMember(Description:="True if this vehicle's licence expiring soon.")>
            Public Overridable Property ExpiresSoon As Boolean

            '''<Summary>
            '''True if this vehicle's license expired.
            '''</Summary>
            <ApiMember(Description:="True if this vehicle's license expired.")>
            Public Overridable Property Expired As Boolean
        End Class

        Public Partial Class VehicleListResponse
            Inherits ApiServiceResponse
            Public Overridable Property Vehicles As IEnumerable(Of VehicleData)
        End Class
    End Namespace
End Namespace

VB.NET GetVehicleList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VehicleListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles">
  <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>
  <Vehicles i:nil="true" />
</VehicleListResponse>