| GET | /pulsit/profile |
|---|
"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;
}
export class PulsitModuleStatusItem {
/** @param {{PulsitModuleId?:string,Latitude?:number,Longitude?:number,EventDescription?:string,EventTime?:string,Status?:string,PulsitStartId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PulsitModuleId;
/** @type {number} */
Latitude;
/** @type {number} */
Longitude;
/** @type {string} */
EventDescription;
/** @type {string} */
EventTime;
/** @type {string} */
Status;
/** @type {number} */
PulsitStartId;
}
export class PulsitProfileProductItem {
/** @param {{Product?:string,Make?:string,Model?:string,Year?:string,RegistrationNumber?:string,PulsitModuleId?:string,LatestStatus?:PulsitModuleStatusItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Product;
/** @type {string} */
Make;
/** @type {string} */
Model;
/** @type {string} */
Year;
/** @type {string} */
RegistrationNumber;
/** @type {string} */
PulsitModuleId;
/** @type {PulsitModuleStatusItem} */
LatestStatus;
}
/** @typedef {number} */
export var DeviceType;
(function (DeviceType) {
DeviceType[DeviceType["Lock"] = 0] = "Lock"
DeviceType[DeviceType["HomeSecurity"] = 1] = "HomeSecurity"
})(DeviceType || (DeviceType = {}));
export class PulsitProfileDeviceItem {
/** @param {{PulsitModuleId?:string,Product?:string,Description?:string,Type?:DeviceType,TypeString?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PulsitModuleId;
/** @type {string} */
Product;
/** @type {string} */
Description;
/** @type {DeviceType} */
Type;
/** @type {string} */
TypeString;
}
export class PulsitProfileResponse extends ApiServiceResponse {
/** @param {{Products?:PulsitProfileProductItem[],Devices?:PulsitProfileDeviceItem[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {PulsitProfileProductItem[]} */
Products;
/** @type {PulsitProfileDeviceItem[]} */
Devices;
}
export class PulsitProfileRequest extends ApiServiceRequest {
/** @param {{IdNumber?:string,ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
IdNumber;
}
JavaScript PulsitProfileRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /pulsit/profile HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PulsitProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientApi.Services">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<Devices>
<PulsitProfileDeviceItem>
<Description>String</Description>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<Type>Lock</Type>
</PulsitProfileDeviceItem>
</Devices>
<Products>
<PulsitProfileProductItem>
<LatestStatus>
<EventDescription>String</EventDescription>
<EventTime>0001-01-01T00:00:00</EventTime>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<PulsitModuleId>String</PulsitModuleId>
<PulsitStartId>0</PulsitStartId>
<Status>String</Status>
</LatestStatus>
<Make>String</Make>
<Model>String</Model>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<RegistrationNumber>String</RegistrationNumber>
<Year>String</Year>
</PulsitProfileProductItem>
</Products>
</PulsitProfileResponse>