UpdateDevice

 

DeviceService / UpdateDevice

 

Description: Update device by id or guid

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

Method: PUT

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:

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

Parameter Type Nullable Comment
Request.Device Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.V1.Networks.Player False PlayerType - value must be Standard_Player or Others. Tags - If tags is null, it would not update the tags and if it has values, it will remove tags and replace with new tags. Set tags to empty if would like remove all tags from device.

Response:

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

Parameter Type
Response.Device Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.V1.Networks.Player

Enums:
Field Name Values
PlayerType Nexus.AppSpace.Service.Contract.Model.Enums.Network.PlayerType Undefined = 0, Standard_Player = 1, Video_Wall_NEXMPV5 = 2, Cisco_DMP = 3, Video_Wall_NEXMPV6 = 4, Video_Wall_NEXMPV10 = 5, Video_Wall_NEXMPV12 = 6, Video_Wall_NEXMPV24 = 7, Others = 8
Status Nexus.AppSpace.Service.Contract.Model.Enums.Network.Status Online = 0, Offline = 1, Failed = 2, Communication_Lost = 3

The following is an example request Xml body: 
<DeviceRequest xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Device" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Device xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
    <a:ApplicationId>123</a:ApplicationId>
    <a:Description>String</a:Description>
    <a:IP>String</a:IP>
    <a:InSync>true</a:InSync>
    <a:IsAutoIP>true</a:IsAutoIP>
    <a:IsSuperNode>true</a:IsSuperNode>
    <a:Name>String</a:Name>
    <a:NetworkId>123</a:NetworkId>
    <a:PlayerDesc>
      <a:CompressedSize>123</a:CompressedSize>
      <a:FileCount>123</a:FileCount>
      <a:FileSize>123</a:FileSize>
      <a:IsDownloaded>true</a:IsDownloaded>
      <a:PlayerId>123</a:PlayerId>
      <a:ScriptCount>123</a:ScriptCount>
      <a:TimeStamp>2015-04-30T16:46:19.4284839Z</a:TimeStamp>
      <a:UncompressedSize>123</a:UncompressedSize>
    </a:PlayerDesc>
    <a:PlayerGroupId>123</a:PlayerGroupId>
    <a:PlayerType>Others</a:PlayerType>
    <a:Properties xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Properties">
      <b:Property>
        <b:Disable>true</b:Disable>
        <b:Key>String</b:Key>
        <b:ResourceId>123</b:ResourceId>
        <b:ResourceType>Player</b:ResourceType>
        <b:Value>String</b:Value>
      </b:Property>
    </a:Properties>
    <a:Status>Communication_Lost</a:Status>
    <a:Tags>String</a:Tags>
  </Device>
</DeviceRequest>

The following is an example request Json body: 
{
	"Device":{
		"ApplicationId":123,
		"Description":"String",
		"IP":"String",
		"InSync":true,
		"IsAutoIP":true,
		"IsSuperNode":true,
		"Name":"String",
		"NetworkId":123,
		"PlayerDesc":{
			"CompressedSize":123,
			"FileCount":123,
			"FileSize":123,
			"IsDownloaded":true,
			"PlayerId":123,
			"ScriptCount":123,
			"TimeStamp":"\/Date(1430412379428)\/",
			"UncompressedSize":123
		},
		"PlayerGroupId":123,
		"PlayerType":8,
		"Properties":[
			{
				"Disable":true,
				"Key":"String",
				"ResourceId":123,
				"ResourceType":3,
				"Value":"String"
			}
		],
		"Status":3,
		"Tags":"String"
	}
}

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>
  <Device xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
    <a:ApplicationId>123</a:ApplicationId>
    <a:CreatedDate>2015-04-30T16:46:19.4284839Z</a:CreatedDate>
    <a:Description>String</a:Description>
    <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
    <a:IP>String</a:IP>
    <a:Id>123</a:Id>
    <a:InSync>true</a:InSync>
    <a:IsAutoIP>true</a:IsAutoIP>
    <a:IsSuperNode>true</a:IsSuperNode>
    <a:LastUpdate>2015-04-30T16:46:19.4284839Z</a:LastUpdate>
    <a:Name>String</a:Name>
    <a:NetworkId>123</a:NetworkId>
    <a:PlayerDesc>
      <a:CompressedSize>123</a:CompressedSize>
      <a:FileCount>123</a:FileCount>
      <a:FileSize>123</a:FileSize>
      <a:IsDownloaded>true</a:IsDownloaded>
      <a:PlayerId>123</a:PlayerId>
      <a:ScriptCount>123</a:ScriptCount>
      <a:TimeStamp>2015-04-30T16:46:19.4284839Z</a:TimeStamp>
      <a:UncompressedSize>123</a:UncompressedSize>
    </a:PlayerDesc>
    <a:PlayerGroupId>123</a:PlayerGroupId>
    <a:PlayerType>Others</a:PlayerType>
    <a:Properties xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Properties">
      <b:Property>
        <b:Disable>true</b:Disable>
        <b:Id>123</b:Id>
        <b:Key>String</b:Key>
        <b:ResourceId>123</b:ResourceId>
        <b:ResourceType>Player</b:ResourceType>
        <b:Value>String</b:Value>
      </b:Property>
    </a:Properties>
    <a:Status>Communication_Lost</a:Status>
    <a:Tags>String</a:Tags>
  </Device>
</DeviceResponse>

The following is an example response Json body: 
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Device":{
		"ApplicationId":123,
		"CreatedDate":"\/Date(1430412379428)\/",
		"Description":"String",
		"Guid":"11111111-1111-1111-1111-111111111111",
		"IP":"String",
		"Id":123,
		"InSync":true,
		"IsAutoIP":true,
		"IsSuperNode":true,
		"LastUpdate":"\/Date(1430412379428)\/",
		"Name":"String",
		"NetworkId":123,
		"PlayerDesc":{
			"CompressedSize":123,
			"FileCount":123,
			"FileSize":123,
			"IsDownloaded":true,
			"PlayerId":123,
			"ScriptCount":123,
			"TimeStamp":"\/Date(1430412379428)\/",
			"UncompressedSize":123
		},
		"PlayerGroupId":123,
		"PlayerType":8,
		"Properties":[
			{
				"Disable":true,
				"Id":123,
				"Key":"String",
				"ResourceId":123,
				"ResourceType":3,
				"Value":"String"
			}
		],
		"Status":3,
		"Tags":"String"
	}
}