GalaxyMobile Client API

<back to all web services

ProtectMeHistoryRequest

import Foundation
import ServiceStack

public class ProtectMeHistoryRequest : BaseActivationHistoryRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class BaseActivationHistoryRequest : ApiServiceRequest
{
    /**
    * ID Number of the user making this request.
    */
    // @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
    public var idNumber:String

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

    private enum CodingKeys : String, CodingKey {
        case idNumber
    }

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

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

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 ActivationHistoryResponse : ApiServiceResponse
{
    /**
    * Is the requested product set up and enabled on Galaxy.
    */
    // @ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
    public var productAvailable:Bool

    /**
    * Does the user have access to this product, based on their Galaxy profile.
    */
    // @ApiMember(Description="Does the user have access to this product, based on their Galaxy profile.")
    public var userHasAccess:Bool

    /**
    * A list of activation history instances, ordered by most recent first.
    */
    // @ApiMember(Description="A list of activation history instances, ordered by most recent first.")
    public var activationHistory:[ActivationHistoryData] = []

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

    private enum CodingKeys : String, CodingKey {
        case productAvailable
        case userHasAccess
        case activationHistory
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        productAvailable = try container.decodeIfPresent(Bool.self, forKey: .productAvailable)
        userHasAccess = try container.decodeIfPresent(Bool.self, forKey: .userHasAccess)
        activationHistory = try container.decodeIfPresent([ActivationHistoryData].self, forKey: .activationHistory) ?? []
    }

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

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 ActivationHistoryData : Codable
{
    /**
    * Date and Time of the activation in ISO 8601 format.
    */
    // @ApiMember(Description="Date and Time of the activation in ISO 8601 format.")
    public var dateActivated:String

    /**
    * Latitude of the activation location.
    */
    // @ApiMember(Description="Latitude of the activation location.")
    public var latitude:Double

    /**
    * Longitude of the activation location.
    */
    // @ApiMember(Description="Longitude of the activation location.")
    public var longitude:Double

    required public init(){}
}

Swift ProtectMeHistoryRequest DTOs

GET /protectme/history 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

{"ProductAvailable":false,"UserHasAccess":false,"ActivationHistory":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}