RetrieveDeviceSystemInfos

 

DeviceService / RetrieveDeviceSystemInfos

 

Description: Retrieve device system infos

URL: http://{your-server-url}/api/v1/core/devices/systeminfos

Method: GET

Token Required: True


Request Headers:
content-type: application/json or content-type: application/xml
token: {token}
currentaccountid: {accountid - optional and default value is user's own account}
Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right Require
Network_Management Yes

Request Query Parameters:
Parameter Type Nullable Description
status Nexus.AppSpace.Service.Contract.Model.Enums.Network.Status True Online, Offline, Failed, Communication_Lost eg. status=online
page int True page number
rpp int True records per page, default = 50, max = 500
includeappisnull bool True include player with application is null, default = false
deviceids int[] True comma separated values, eg. deviceids=1,2,3

Example: http://{your-server-url}/api/v1/core/devices/systeminfos?page=100&rpp=100&deviceids=1,2,3


Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Device.DeviceResponse

Parameter Type
Response.DeviceSystemInfos Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.V1.Networks.DeviceSystemInfo[]

The following is an example response Xml body:
<DeviceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Device" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <DeviceSystemInfos xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
    <a:PlayerSystemInfo>
      <a:AppStatus>Communication_Lost</a:AppStatus>
      <a:AppStatusTime>2015-04-30T16:46:19.4325034Z</a:AppStatusTime>
      <a:FanCPU1>123</a:FanCPU1>
      <a:FanCPU2>123</a:FanCPU2>
      <a:FanChassis1>123</a:FanChassis1>
      <a:FanChassis2>123</a:FanChassis2>
      <a:PlayerId>123</a:PlayerId>
      <a:StatusMessage>String</a:StatusMessage>
      <a:SystemTempTime>2015-04-30T16:46:19.4325034Z</a:SystemTempTime>
      <a:TempCPU1>123</a:TempCPU1>
      <a:TempCPU2>123</a:TempCPU2>
      <a:TempSystem>123</a:TempSystem>
      <a:TouchStatus>NotAvailable</a:TouchStatus>
      <a:TouchStatusTime>2015-04-30T16:46:19.4325034Z</a:TouchStatusTime>
    </a:PlayerSystemInfo>
  </DeviceSystemInfos>
</DeviceResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"DeviceSystemInfos":[
		{
			"AppStatus":3,
			"AppStatusTime":"\/Date(1430412379432)\/",
			"FanCPU1":123,
			"FanCPU2":123,
			"FanChassis1":123,
			"FanChassis2":123,
			"PlayerId":123,
			"StatusMessage":"String",
			"SystemTempTime":"\/Date(1430412379432)\/",
			"TempCPU1":123,
			"TempCPU2":123,
			"TempSystem":123,
			"TouchStatus":2,
			"TouchStatusTime":"\/Date(1430412379432)\/"
		}
	]
}