"use strict";
export class LogDeviceStatus {
/** @param {{ApplianceId?:string,DeviceId?:string,Latitude?:number,Longitude?:number,EventName?:string,EventDetail1?:string,EventDetail2?:string,EventDetail3?:string,EventDetail4?:string,EventDetail5?:string,Orientation?:string,InternetConnectionStatus?:string,Log?:string,Event?:string,IsInPortrait?:boolean,IsInLandscape?:boolean,CellularDataEnabled?:boolean,DataRoamingEnabled?:boolean,IsNetworkAvailable?:boolean,CanSendSMS?:boolean,BatteryCharging?:boolean,BatteryLevel?:number,MediaFileId1?:string,MediaFileId2?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Guid of the Appliance this Device is logging an event status for. */
ApplianceId;
/**
* @type {string}
* @description Guid representing the saved Device */
DeviceId;
/**
* @type {number}
* @description The latitude the device was last located at. */
Latitude;
/**
* @type {number}
* @description The longitude the device was last located at. */
Longitude;
/**
* @type {string}
* @description Name of the event we're logging. */
EventName;
/**
* @type {string}
* @description Details of the event up to (255 char). */
EventDetail1;
/**
* @type {string}
* @description Details of the event up to (255 char). */
EventDetail2;
/**
* @type {string}
* @description Details of the event up to (255 char). */
EventDetail3;
/**
* @type {string}
* @description Details of the event up to (255 char). */
EventDetail4;
/**
* @type {string}
* @description Details of the event up to (255 char). */
EventDetail5;
/**
* @type {string}
* @description Details of the event up to (255 char). */
Orientation;
/**
* @type {string}
* @description The device internet connection status. */
InternetConnectionStatus;
/**
* @type {string}
* @description Unlimited text field for logging details of the event. */
Log;
/**
* @type {string}
* @description Date and Time of the event. */
Event;
/**
* @type {boolean}
* @description True if the device is in portrait mode. */
IsInPortrait;
/**
* @type {boolean}
* @description True if the device is in landscape mode. */
IsInLandscape;
/**
* @type {boolean}
* @description True if cellular data is enabled. */
CellularDataEnabled;
/**
* @type {boolean}
* @description True if data roaming is enabled. */
DataRoamingEnabled;
/**
* @type {boolean}
* @description True if the network is available. */
IsNetworkAvailable;
/**
* @type {boolean}
* @description True if the device can send an sms. */
CanSendSMS;
/**
* @type {boolean}
* @description True if the battery is charging. */
BatteryCharging;
/**
* @type {number}
* @description The amount of battery life left as a percentage. */
BatteryLevel;
/**
* @type {string}
* @description The Guid of a saved Media Object. */
MediaFileId1;
/**
* @type {string}
* @description The Guid of a saved Media Object. */
MediaFileId2;
}
export class LogDeviceStatuses {
/** @param {{DeviceStatuses?:LogDeviceStatus[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {LogDeviceStatus[]}
* @description A list of logged event statuses for a device. */
DeviceStatuses = [];
}
JavaScript LogDeviceStatuses 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.
POST /xml/reply/LogDeviceStatuses HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<LogDeviceStatuses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<DeviceStatuses>
<LogDeviceStatus>
<ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
<BatteryCharging>false</BatteryCharging>
<BatteryLevel>0</BatteryLevel>
<CanSendSMS>false</CanSendSMS>
<CellularDataEnabled>false</CellularDataEnabled>
<DataRoamingEnabled>false</DataRoamingEnabled>
<DeviceId>00000000-0000-0000-0000-000000000000</DeviceId>
<Event>0001-01-01T00:00:00</Event>
<EventDetail1>String</EventDetail1>
<EventDetail2>String</EventDetail2>
<EventDetail3>String</EventDetail3>
<EventDetail4>String</EventDetail4>
<EventDetail5>String</EventDetail5>
<EventName>String</EventName>
<InternetConnectionStatus>String</InternetConnectionStatus>
<IsInLandscape>false</IsInLandscape>
<IsInPortrait>false</IsInPortrait>
<IsNetworkAvailable>false</IsNetworkAvailable>
<Latitude>0</Latitude>
<Log>String</Log>
<Longitude>0</Longitude>
<MediaFileId1>00000000-0000-0000-0000-000000000000</MediaFileId1>
<MediaFileId2>00000000-0000-0000-0000-000000000000</MediaFileId2>
<Orientation>String</Orientation>
</LogDeviceStatus>
</DeviceStatuses>
</LogDeviceStatuses>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>