GalaxyMobile Client API

<back to all web services

PulsitModuleStatusRequest

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

public class PulsitModuleStatusRequest : ApiServiceRequest
{
    public var pulsitModuleIds:[String] = []

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

    private enum CodingKeys : String, CodingKey {
        case pulsitModuleIds
    }

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

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

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 PulsitModuleStatusResponse : ApiServiceResponse
{
    public var moduleStatuses:[PulsitModuleStatusItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case moduleStatuses
    }

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

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

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 PulsitModuleStatusItem : Codable
{
    public var pulsitModuleId:String
    public var latitude:Double
    public var longitude:Double
    public var eventDescription:String
    public var eventTime:Date
    public var status:String
    public var pulsitStartId:Int

    required public init(){}
}


Swift PulsitModuleStatusRequest DTOs

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

HTTP + CSV

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

GET /pulsit/modulestatus HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ModuleStatuses":[{"PulsitModuleId":"String","Latitude":0,"Longitude":0,"EventDescription":"String","EventTime":"0001-01-01T00:00:00.0000000","Status":"String","PulsitStartId":0}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}