| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Products:
[
{
Product: String,
Make: String,
Model: String,
Year: String,
RegistrationNumber: String,
PulsitModuleId: String,
LatestStatus:
{
PulsitModuleId: String,
Latitude: 0,
Longitude: 0,
EventDescription: String,
EventTime: 0001-01-01,
Status: String,
PulsitStartId: 0
}
}
],
Devices:
[
{
PulsitModuleId: String,
Product: String,
Description: String,
Type: 0,
TypeString: Lock
}
],
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}