GalaxyMobile Client API

<back to all web services

PulsitTripHistoryDetailRequest

The following routes are available for this service:
GET/pulsit/triphistorydetail
import Foundation
import ServiceStack

public class PulsitTripHistoryDetailRequest : ApiServiceRequest
{
    public var pulsitModuleId:String
    public var pulsitStartId:Int
    public var pulsitStopId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case pulsitModuleId
        case pulsitStartId
        case pulsitStopId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        pulsitModuleId = try container.decodeIfPresent(String.self, forKey: .pulsitModuleId)
        pulsitStartId = try container.decodeIfPresent(Int.self, forKey: .pulsitStartId)
        pulsitStopId = try container.decodeIfPresent(Int.self, forKey: .pulsitStopId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if pulsitModuleId != nil { try container.encode(pulsitModuleId, forKey: .pulsitModuleId) }
        if pulsitStartId != nil { try container.encode(pulsitStartId, forKey: .pulsitStartId) }
        if pulsitStopId != nil { try container.encode(pulsitStopId, forKey: .pulsitStopId) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    required public init(){}
}

public class PulsitTripHistoryDetailResponse : ApiServiceResponse
{
    public var distance:Double
    public var events:[PulsitTripHistoryEvent] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case distance
        case events
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        distance = try container.decodeIfPresent(Double.self, forKey: .distance)
        events = try container.decodeIfPresent([PulsitTripHistoryEvent].self, forKey: .events) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if distance != nil { try container.encode(distance, forKey: .distance) }
        if events.count > 0 { try container.encode(events, forKey: .events) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class PulsitTripHistoryEvent : Codable
{
    public var latitude:Double
    public var longitude:Double
    public var address:String
    public var speed:Int
    public var heading:Int
    public var vehicleBatteryVolts:Int
    public var moduleBatteryVolts:Int
    public var eventDescription:String
    public var eventTime:Date

    required public init(){}
}


Swift PulsitTripHistoryDetailRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /pulsit/triphistorydetail 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

{
	Distance: 0,
	Events: 
	[
		{
			Latitude: 0,
			Longitude: 0,
			Address: String,
			Speed: 0,
			Heading: 0,
			VehicleBatteryVolts: 0,
			ModuleBatteryVolts: 0,
			EventDescription: String,
			EventTime: 0001-01-01
		}
	],
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ModelState: {}
}