RetrieveGroup

DeviceService / RetrieveGroup

Description: Get group

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

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

Response:

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

Parameter	Type
Response.Group	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.V1.Networks.PlayerGroup

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 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>
  <Group xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
    <a:AccountId>123</a:AccountId>
    <a:Description>String</a:Description>
    <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
    <a:Id>123</a:Id>
    <a:Name>String</a:Name>
    <a:NetworkId>123</a:NetworkId>
    <a:ParentId>123</a:ParentId>
  </Group>
</DeviceResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Group":{
		"AccountId":123,
		"Description":"String",
		"Guid":"11111111-1111-1111-1111-111111111111",
		"Id":123,
		"Name":"String",
		"NetworkId":123,
		"ParentId":123
	}
}