Platform API

<back to all web services

LogDeviceStatuses

Logs multiple device event details. Details include an event(crash,error,unexpected result) and the device status at the time of the event.

Requires Authentication 

/** @description Logs details of an event(crash,error,unexpected result) and the device status at the time of the event. */
// @Api(Description="Logs details of an event(crash,error,unexpected result) and the device status at the time of the event.")
export class LogDeviceStatus
{
    /** @description Guid of the Appliance this Device is logging an event status for. */
    // @ApiMember(DataType="Guid", Description="Guid of the Appliance this Device is logging an event status for.", IsRequired=true, Name="ApplianceId", ParameterType="query")
    public ApplianceId: string;

    /** @description Guid representing the saved Device */
    // @ApiMember(DataType="Guid", Description="Guid representing the saved Device", IsRequired=true, Name="DeviceId", ParameterType="query")
    public DeviceId: string;

    /** @description The latitude the device was last located at. */
    // @ApiMember(DataType="double", Description="The latitude the device was last located at.", IsRequired=true, Name="Latitude", ParameterType="query")
    public Latitude: number;

    /** @description The longitude the device was last located at. */
    // @ApiMember(DataType="double", Description="The longitude the device was last located at.", IsRequired=true, Name="Longitude", ParameterType="query")
    public Longitude: number;

    /** @description Name of the event we're logging. */
    // @ApiMember(DataType="string", Description="Name of the event we're logging.", Name="EventName", ParameterType="query")
    public EventName: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail1", ParameterType="query")
    public EventDetail1: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail2", ParameterType="query")
    public EventDetail2: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail3", ParameterType="query")
    public EventDetail3: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail4", ParameterType="query")
    public EventDetail4: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail5", ParameterType="query")
    public EventDetail5: string;

    /** @description Details of the event up to (255 char). */
    // @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="Orientation", ParameterType="query")
    public Orientation: string;

    /** @description The device internet connection status. */
    // @ApiMember(DataType="string", Description="The device internet connection status.", Name="InternetConnectionStatus", ParameterType="query")
    public InternetConnectionStatus: string;

    /** @description Unlimited text field for logging details of the event. */
    // @ApiMember(DataType="string", Description="Unlimited text field for logging details of the event.", Name="Log", ParameterType="query")
    public Log: string;

    /** @description Date and Time of the event. */
    // @ApiMember(DataType="DateTime", Description="Date and Time of the event.", Name="Event", ParameterType="query")
    public Event: string;

    /** @description True if the device is in portrait mode. */
    // @ApiMember(DataType="bool", Description="True if the device is in portrait mode.", Name="IsInPortrait", ParameterType="query")
    public IsInPortrait: boolean;

    /** @description True if the device is in landscape mode. */
    // @ApiMember(DataType="bool", Description="True if the device is in landscape mode.", Name="IsInLandscape", ParameterType="query")
    public IsInLandscape: boolean;

    /** @description True if cellular data is enabled. */
    // @ApiMember(DataType="bool", Description="True if cellular data is enabled.", Name="CellularDataEnabled", ParameterType="query")
    public CellularDataEnabled: boolean;

    /** @description True if data roaming is enabled. */
    // @ApiMember(DataType="bool", Description="True if data roaming is enabled.", Name="DataRoamingEnabled", ParameterType="query")
    public DataRoamingEnabled: boolean;

    /** @description True if the network is available. */
    // @ApiMember(DataType="bool", Description="True if the network is available.", Name="IsNetworkAvailable", ParameterType="query")
    public IsNetworkAvailable: boolean;

    /** @description True if the device can send an sms. */
    // @ApiMember(DataType="bool", Description="True if the device can send an sms.", Name="CanSendSMS", ParameterType="query")
    public CanSendSMS: boolean;

    /** @description True if the battery is charging. */
    // @ApiMember(DataType="bool", Description="True if the battery is charging.", Name="BatteryCharging", ParameterType="query")
    public BatteryCharging: boolean;

    /** @description The amount of battery life left as a percentage. */
    // @ApiMember(DataType="int", Description="The amount of battery life left as a percentage.", Name="BatteryLevel", ParameterType="query")
    public BatteryLevel: number;

    /** @description The Guid of a saved Media Object. */
    // @ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId1", ParameterType="query")
    public MediaFileId1: string;

    /** @description The Guid of a saved Media Object. */
    // @ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId2", ParameterType="query")
    public MediaFileId2: string;

    public constructor(init?: Partial<LogDeviceStatus>) { (Object as any).assign(this, init); }
}

/** @description Logs multiple device event details.  Details include an event(crash,error,unexpected result) and the device status at the time of the event. */
// @Api(Description="Logs multiple device event details.  Details include an event(crash,error,unexpected result) and the device status at the time of the event.")
export class LogDeviceStatuses
{
    /** @description A list of logged event statuses for a device. */
    // @ApiMember(DataType="int", Description="A list of logged event statuses for a device.", IsRequired=true, Name="DeviceStatuses", ParameterType="query")
    public DeviceStatuses: LogDeviceStatus[] = [];

    public constructor(init?: Partial<LogDeviceStatuses>) { (Object as any).assign(this, init); }
}

TypeScript LogDeviceStatuses 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 /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>