Platform API

<back to all web services

LogDeviceStatus

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

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* 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.")
open class LogDeviceStatus
{
    /**
    * 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")
    open var ApplianceId:UUID? = null

    /**
    * Guid representing the saved Device
    */
    @ApiMember(DataType="Guid", Description="Guid representing the saved Device", IsRequired=true, Name="DeviceId", ParameterType="query")
    open var DeviceId:UUID? = null

    /**
    * 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")
    open var Latitude:Double? = null

    /**
    * 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")
    open var Longitude:Double? = null

    /**
    * Name of the event we're logging.
    */
    @ApiMember(DataType="string", Description="Name of the event we're logging.", Name="EventName", ParameterType="query")
    open var EventName:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail1", ParameterType="query")
    open var EventDetail1:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail2", ParameterType="query")
    open var EventDetail2:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail3", ParameterType="query")
    open var EventDetail3:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail4", ParameterType="query")
    open var EventDetail4:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail5", ParameterType="query")
    open var EventDetail5:String? = null

    /**
    * Details of the event up to (255 char).
    */
    @ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="Orientation", ParameterType="query")
    open var Orientation:String? = null

    /**
    * The device internet connection status.
    */
    @ApiMember(DataType="string", Description="The device internet connection status.", Name="InternetConnectionStatus", ParameterType="query")
    open var InternetConnectionStatus:String? = null

    /**
    * 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")
    open var Log:String? = null

    /**
    * Date and Time of the event.
    */
    @ApiMember(DataType="DateTime", Description="Date and Time of the event.", Name="Event", ParameterType="query")
    open var Event:Date? = null

    /**
    * True if the device is in portrait mode.
    */
    @ApiMember(DataType="bool", Description="True if the device is in portrait mode.", Name="IsInPortrait", ParameterType="query")
    open var IsInPortrait:Boolean? = null

    /**
    * True if the device is in landscape mode.
    */
    @ApiMember(DataType="bool", Description="True if the device is in landscape mode.", Name="IsInLandscape", ParameterType="query")
    open var IsInLandscape:Boolean? = null

    /**
    * True if cellular data is enabled.
    */
    @ApiMember(DataType="bool", Description="True if cellular data is enabled.", Name="CellularDataEnabled", ParameterType="query")
    open var CellularDataEnabled:Boolean? = null

    /**
    * True if data roaming is enabled.
    */
    @ApiMember(DataType="bool", Description="True if data roaming is enabled.", Name="DataRoamingEnabled", ParameterType="query")
    open var DataRoamingEnabled:Boolean? = null

    /**
    * True if the network is available.
    */
    @ApiMember(DataType="bool", Description="True if the network is available.", Name="IsNetworkAvailable", ParameterType="query")
    open var IsNetworkAvailable:Boolean? = null

    /**
    * True if the device can send an sms.
    */
    @ApiMember(DataType="bool", Description="True if the device can send an sms.", Name="CanSendSMS", ParameterType="query")
    open var CanSendSMS:Boolean? = null

    /**
    * True if the battery is charging.
    */
    @ApiMember(DataType="bool", Description="True if the battery is charging.", Name="BatteryCharging", ParameterType="query")
    open var BatteryCharging:Boolean? = null

    /**
    * 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")
    open var BatteryLevel:Int? = null

    /**
    * The Guid of a saved Media Object.
    */
    @ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId1", ParameterType="query")
    open var MediaFileId1:UUID? = null

    /**
    * The Guid of a saved Media Object.
    */
    @ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId2", ParameterType="query")
    open var MediaFileId2:UUID? = null
}

Kotlin LogDeviceStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/LogDeviceStatus HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000","DeviceId":"00000000-0000-0000-0000-000000000000","Latitude":0,"Longitude":0,"EventName":"String","EventDetail1":"String","EventDetail2":"String","EventDetail3":"String","EventDetail4":"String","EventDetail5":"String","Orientation":"String","InternetConnectionStatus":"String","Log":"String","Event":"0001-01-01T00:00:00.0000000","IsInPortrait":false,"IsInLandscape":false,"CellularDataEnabled":false,"DataRoamingEnabled":false,"IsNetworkAvailable":false,"CanSendSMS":false,"BatteryCharging":false,"BatteryLevel":0,"MediaFileId1":"00000000-0000-0000-0000-000000000000","MediaFileId2":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}