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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Logs details of an event(crash,error,unexpected result) and the device status at the time of the event.
    ///</summary>
    [Api(Description="Logs details of an event(crash,error,unexpected result) and the device status at the time of the event.")]
    public partial class LogDeviceStatus
    {
        ///<summary>
        ///Guid of the Appliance this Device is logging an event status for.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the Appliance this Device is logging an event status for.", IsRequired=true, Name="ApplianceId", ParameterType="query")]
        public virtual Guid ApplianceId { get; set; }

        ///<summary>
        ///Guid representing the saved Device
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the saved Device", IsRequired=true, Name="DeviceId", ParameterType="query")]
        public virtual Guid DeviceId { get; set; }

        ///<summary>
        ///The latitude the device was last located at.
        ///</summary>
        [ApiMember(DataType="double", Description="The latitude the device was last located at.", IsRequired=true, Name="Latitude", ParameterType="query")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///The longitude the device was last located at.
        ///</summary>
        [ApiMember(DataType="double", Description="The longitude the device was last located at.", IsRequired=true, Name="Longitude", ParameterType="query")]
        public virtual double Longitude { get; set; }

        ///<summary>
        ///Name of the event we're logging.
        ///</summary>
        [ApiMember(DataType="string", Description="Name of the event we're logging.", Name="EventName", ParameterType="query")]
        public virtual string EventName { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail1", ParameterType="query")]
        public virtual string EventDetail1 { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail2", ParameterType="query")]
        public virtual string EventDetail2 { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail3", ParameterType="query")]
        public virtual string EventDetail3 { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail4", ParameterType="query")]
        public virtual string EventDetail4 { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="EventDetail5", ParameterType="query")]
        public virtual string EventDetail5 { get; set; }

        ///<summary>
        ///Details of the event up to (255 char).
        ///</summary>
        [ApiMember(DataType="string", Description="Details of the event up to (255 char).", Name="Orientation", ParameterType="query")]
        public virtual string Orientation { get; set; }

        ///<summary>
        ///The device internet connection status.
        ///</summary>
        [ApiMember(DataType="string", Description="The device internet connection status.", Name="InternetConnectionStatus", ParameterType="query")]
        public virtual string InternetConnectionStatus { get; set; }

        ///<summary>
        ///Unlimited text field for logging details of the event.
        ///</summary>
        [ApiMember(DataType="string", Description="Unlimited text field for logging details of the event.", Name="Log", ParameterType="query")]
        public virtual string Log { get; set; }

        ///<summary>
        ///Date and Time of the event.
        ///</summary>
        [ApiMember(DataType="DateTime", Description="Date and Time of the event.", Name="Event", ParameterType="query")]
        public virtual DateTime Event { get; set; }

        ///<summary>
        ///True if the device is in portrait mode.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the device is in portrait mode.", Name="IsInPortrait", ParameterType="query")]
        public virtual bool IsInPortrait { get; set; }

        ///<summary>
        ///True if the device is in landscape mode.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the device is in landscape mode.", Name="IsInLandscape", ParameterType="query")]
        public virtual bool IsInLandscape { get; set; }

        ///<summary>
        ///True if cellular data is enabled.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if cellular data is enabled.", Name="CellularDataEnabled", ParameterType="query")]
        public virtual bool CellularDataEnabled { get; set; }

        ///<summary>
        ///True if data roaming is enabled.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if data roaming is enabled.", Name="DataRoamingEnabled", ParameterType="query")]
        public virtual bool DataRoamingEnabled { get; set; }

        ///<summary>
        ///True if the network is available.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the network is available.", Name="IsNetworkAvailable", ParameterType="query")]
        public virtual bool IsNetworkAvailable { get; set; }

        ///<summary>
        ///True if the device can send an sms.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the device can send an sms.", Name="CanSendSMS", ParameterType="query")]
        public virtual bool CanSendSMS { get; set; }

        ///<summary>
        ///True if the battery is charging.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if the battery is charging.", Name="BatteryCharging", ParameterType="query")]
        public virtual bool BatteryCharging { get; set; }

        ///<summary>
        ///The amount of battery life left as a percentage.
        ///</summary>
        [ApiMember(DataType="int", Description="The amount of battery life left as a percentage.", Name="BatteryLevel", ParameterType="query")]
        public virtual int BatteryLevel { get; set; }

        ///<summary>
        ///The Guid of a saved Media Object.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId1", ParameterType="query")]
        public virtual Guid MediaFileId1 { get; set; }

        ///<summary>
        ///The Guid of a saved Media Object.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The Guid of a saved Media Object.", Name="MediaFileId2", ParameterType="query")]
        public virtual Guid MediaFileId2 { get; set; }
    }

}

C# LogDeviceStatus DTOs

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

HTTP + JSV

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

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

{
	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-01,
	IsInPortrait: False,
	IsInLandscape: False,
	CellularDataEnabled: False,
	DataRoamingEnabled: False,
	IsNetworkAvailable: False,
	CanSendSMS: False,
	BatteryCharging: False,
	BatteryLevel: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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