GalaxyMobile Client API

<back to all web services

ProtectMeUpdateLocationRequest

The following routes are available for this service:
POST/protectme/locationUpdate the location of an in-progress panic request.
import Foundation
import ServiceStack

public class ProtectMeUpdateLocationRequest : ApiServiceRequest
{
    /**
    * The ID of the panic log. This is the ID returned by the panic provider when the service was activated.
    */
    // @ApiMember(Description="The ID of the panic log. This is the ID returned by the panic provider when the service was activated.", IsRequired=true)
    public var panicId:Int

    /**
    * Latitude of the panic location.
    */
    // @ApiMember(Description="Latitude of the panic location.", IsRequired=true)
    public var latitude:Double

    /**
    * Longitude of the panic location.
    */
    // @ApiMember(Description="Longitude of the panic location.", IsRequired=true)
    public var longitude:Double

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

    private enum CodingKeys : String, CodingKey {
        case panicId
        case latitude
        case longitude
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        panicId = try container.decodeIfPresent(Int.self, forKey: .panicId)
        latitude = try container.decodeIfPresent(Double.self, forKey: .latitude)
        longitude = try container.decodeIfPresent(Double.self, forKey: .longitude)
    }

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

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 ProtectMeActivationResponse : 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

    /**
    * The ID of the panic log. This is the ID returned by the panic provider. Used to get panic detail later.
    */
    // @ApiMember(Description="The ID of the panic log. This is the ID returned by the panic provider. Used to get panic detail later.")
    public var panicId:Int

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

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

    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)
        panicId = try container.decodeIfPresent(Int.self, forKey: .panicId)
    }

    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 panicId != nil { try container.encode(panicId, forKey: .panicId) }
    }
}

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(){}
}


Swift ProtectMeUpdateLocationRequest DTOs

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

HTTP + OTHER

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

POST /protectme/location HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PanicId":0,"Latitude":0,"Longitude":0,"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ProductAvailable":false,"UserHasAccess":false,"PanicId":0,"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}