RetrieveDeviceProperties

DeviceService / RetrieveDeviceProperties

Description: Retrieve device properties

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

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
appids	int[]	True	comma separated values, eg. appids=1,2,3
deviceids	int[]	True	comma separated values, eg. deviceids=1,2,3
networkids	int[]	True	comma separated values, eg. networkids=1,2,3
devicegroupids	int[]	True	comma separated values, eg. devicegroupids=1,2,3
devicename	string	True	device name
propids	int[]	True	comma separated values, eg. propertyids=1,2,3
propname	string	True	property name
propvalue	string	True	property value
includeappisnull	bool	True	include player with application is null, default = false
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/devices/properties?appids=1,2,3&deviceids=1,2,3&networkids=1,2,3

Response:

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

Parameter	Type
Response.DeviceProperties	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.V1.Properties.Property[]

Enums:

Field	Name	Values
ResourceType	Nexus.AppSpace.Service.Contract.Model.Enums.Property.ResourceType	System = 0, Network = 1, Application = 2, Player = 3

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>
  <DeviceProperties xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Properties">
    <a:Property>
      <a:Disable>true</a:Disable>
      <a:Id>123</a:Id>
      <a:Key>String</a:Key>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceType>Player</a:ResourceType>
      <a:Value>String</a:Value>
    </a:Property>
  </DeviceProperties>
</DeviceResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"DeviceProperties":[
		{
			"Disable":true,
			"Id":123,
			"Key":"String",
			"ResourceId":123,
			"ResourceType":3,
			"Value":"String"
		}
	]
}