GalaxyMobile Client API

<back to all web services

SendSecurityCommand

The following routes are available for this service:
POST/pulsit/sendsecuritycommand
"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Heading;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {Object} */
    ModelState;
}
/** @typedef {number} */
export var DeviceType;
(function (DeviceType) {
    DeviceType[DeviceType["Lock"] = 0] = "Lock"
    DeviceType[DeviceType["HomeSecurity"] = 1] = "HomeSecurity"
})(DeviceType || (DeviceType = {}));
export class SendSecurityCommand extends ApiServiceRequest {
    /** @param {{IdNumber?:string,PulsitModuleId?:string,Type?:DeviceType,ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    PulsitModuleId;
    /** @type {DeviceType} */
    Type;
}

JavaScript 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>