GalaxyMobile Client API

<back to all web services

SendSecurityCommand

The following routes are available for this service:
POST/pulsit/sendsecuritycommand
import Foundation
import ServiceStack

public class SendSecurityCommand : ApiServiceRequest
{
    public var idNumber:String
    public var pulsitModuleId:String
    public var type:DeviceType

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

    private enum CodingKeys : String, CodingKey {
        case idNumber
        case pulsitModuleId
        case type
    }

    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)
        pulsitModuleId = try container.decodeIfPresent(String.self, forKey: .pulsitModuleId)
        type = try container.decodeIfPresent(DeviceType.self, forKey: .type)
    }

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

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 enum DeviceType : Int, Codable
{
    case Lock = 0
    case HomeSecurity = 1
}

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 SendSecurityCommand 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.

POST /pulsit/sendsecuritycommand HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendSecurityCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientApi.Services">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <IdNumber>String</IdNumber>
  <PulsitModuleId>String</PulsitModuleId>
  <Type>Lock</Type>
</SendSecurityCommand>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <ModelState />
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>