RetrieveAccountsByAccountGroup

 

AccountService / RetrieveAccountsByAccountGroup

 

Description: Retrieve accounts for a account group

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

Method: GET

Token Required: True


Request Headers: 
content-type: application/json or content-type: application/xml
token: {token}
Required Roles:

Portal Administrator, Account Administrator

Rights:

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

Right Require Comment
Portal_Management Optional Optional but need to have at least one
Account_Management Optional

Request Query Parameters:
Parameter Type Nullable Description
includelicenseusedresources bool True response include license used resources is set to false by default
rpp int True records per page, default = 50, max = 500
page int True page number

Example: http://{your-server-url}/api/v1/core/accounts/groups/{groupid}/accounts?rpp=100&page=100


Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account.AccountResponse

Parameter Type
Response.Accounts Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Accounts.Account[]

Enums:
Field Name Values
Type Nexus.AppSpace.Service.Contract.Model.Enums.Account.Type Undefined = 0, Trial = 1, Full = 2, Server = 3
Status Nexus.AppSpace.Service.Contract.Model.Enums.Account.Status Undefined = 0, Active = 1, Disabled = 2, Pending_Activation = 3, Deleted = 4

The following is an example response Xml body: 
<AccountResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Account" 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 i:nil="true" />
      <Message i:nil="true" />
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <Accounts xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Accounts">
    <a:Account>
      <a:APIKey>11111111-1111-1111-1111-111111111111</a:APIKey>
      <a:Applications xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Applications">
        <b:Application>
          <b:AppClassId>123</b:AppClassId>
          <b:CreatedDate>2015-01-05T14:45:30.3770466Z</b:CreatedDate>
          <b:Id>123</b:Id>
          <b:NetworkId>123</b:NetworkId>
          <b:Type>VideoWall</b:Type>
        </b:Application>
      </a:Applications>
      <a:CreatedDate>2015-01-05T14:45:30.3770466Z</a:CreatedDate>
      <a:DateCommenced>2015-01-05T14:45:30.3770466Z</a:DateCommenced>
      <a:DateExpired>2015-01-05T14:45:30.3770466Z</a:DateExpired>
      <a:GroupId>123</a:GroupId>
      <a:HomeNetworkId>123</a:HomeNetworkId>
      <a:Id>123</a:Id>
      <a:License>
        <a:ApplicationUsed>123</a:ApplicationUsed>
        <a:ContentSizeUsed>0</a:ContentSizeUsed>
        <a:Continent>South_America</a:Continent>
        <a:DMPPlayerUsed>123</a:DMPPlayerUsed>
        <a:Duration>123</a:Duration>
        <a:Edition>Team</a:Edition>
        <a:Feature>Developer</a:Feature>
        <a:Language>String</a:Language>
        <a:MaxApplications>123</a:MaxApplications>
        <a:MaxBandwidth>123</a:MaxBandwidth>
        <a:MaxDMPPlayers>123</a:MaxDMPPlayers>
        <a:MaxNetworks>123</a:MaxNetworks>
        <a:MaxPlayers>123</a:MaxPlayers>
        <a:MaxSmartHubs>123</a:MaxSmartHubs>
        <a:MaxTotalContentSize>123</a:MaxTotalContentSize>
        <a:MaxUsers>123</a:MaxUsers>
        <a:MaxVideowall_NEXMPV10Players>123</a:MaxVideowall_NEXMPV10Players>
        <a:MaxVideowall_NEXMPV12Players>123</a:MaxVideowall_NEXMPV12Players>
        <a:MaxVideowall_NEXMPV24Players>123</a:MaxVideowall_NEXMPV24Players>
        <a:MaxVideowall_NEXMPV5Players>123</a:MaxVideowall_NEXMPV5Players>
        <a:MaxVideowall_NEXMPV6Players>123</a:MaxVideowall_NEXMPV6Players>
        <a:NetworkUsed>123</a:NetworkUsed>
        <a:PlayerUsed>123</a:PlayerUsed>
        <a:SmartHubUsed>123</a:SmartHubUsed>
        <a:TimeZone>String</a:TimeZone>
        <a:UserUsed>123</a:UserUsed>
        <a:Videowall_NEXMPV10PlayerUsed>123</a:Videowall_NEXMPV10PlayerUsed>
        <a:Videowall_NEXMPV12PlayerUsed>123</a:Videowall_NEXMPV12PlayerUsed>
        <a:Videowall_NEXMPV24PlayerUsed>123</a:Videowall_NEXMPV24PlayerUsed>
        <a:Videowall_NEXMPV5PlayerUsed>123</a:Videowall_NEXMPV5PlayerUsed>
        <a:Videowall_NEXMPV6PlayerUsed>123</a:Videowall_NEXMPV6PlayerUsed>
      </a:License>
      <a:Name>String</a:Name>
      <a:OwnerId>123</a:OwnerId>
      <a:Players xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
        <b:Player>
          <b:ApplicationId>123</b:ApplicationId>
          <b:Id>123</b:Id>
          <b:NetworkId>123</b:NetworkId>
          <b:PlayerDesc>
            <b:CompressedSize>123</b:CompressedSize>
            <b:FileCount>123</b:FileCount>
            <b:FileSize>123</b:FileSize>
            <b:IsDownloaded>true</b:IsDownloaded>
            <b:PlayerId>123</b:PlayerId>
            <b:ScriptCount>123</b:ScriptCount>
            <b:TimeStamp>2015-01-05T14:45:30.3770466Z</b:TimeStamp>
            <b:UncompressedSize>123</b:UncompressedSize>
          </b:PlayerDesc>
          <b:PlayerGroupId>123</b:PlayerGroupId>
        </b:Player>
      </a:Players>
      <a:Registration>
        <a:Company>String</a:Company>
        <a:ContactNo>String</a:ContactNo>
        <a:Email>String</a:Email>
        <a:FirstName>String</a:FirstName>
        <a:LastName>String</a:LastName>
        <a:RegistrationEmail>String</a:RegistrationEmail>
        <a:TempPassword>String</a:TempPassword>
      </a:Registration>
      <a:Status>Deleted</a:Status>
      <a:Type>Server</a:Type>
      <a:Users xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
        <b:User>
          <b:AccountId>123</b:AccountId>
          <b:CreatedDate>2015-01-05T14:45:30.3780473Z</b:CreatedDate>
          <b:Email>String</b:Email>
          <b:EntitlementIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <c:int>123</c:int>
          </b:EntitlementIds>
          <b:FirstName>String</b:FirstName>
          <b:GroupId>123</b:GroupId>
          <b:HomeNetworkId>123</b:HomeNetworkId>
          <b:Id>123</b:Id>
          <b:ImagePath>String</b:ImagePath>
          <b:LastAccess>2015-01-05T14:45:30.3770466Z</b:LastAccess>
          <b:Lastname>String</b:Lastname>
          <b:MobileNo>String</b:MobileNo>
          <b:Password>String</b:Password>
          <b:RoleIds xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <c:int>123</c:int>
          </b:RoleIds>
          <b:SecretAnswer>String</b:SecretAnswer>
          <b:SecretQuestion>String</b:SecretQuestion>
          <b:Status>Locked</b:Status>
          <b:UserDN>String</b:UserDN>
          <b:Username>String</b:Username>
          <b:WorkNo>String</b:WorkNo>
        </b:User>
      </a:Users>
    </a:Account>
  </Accounts>
</AccountResponse>

The following is an example response Json body: 
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":null,
			"Message":null
		}
	],
	"Status":1,
	"Accounts":[
		{
			"APIKey":"11111111-1111-1111-1111-111111111111",
			"Applications":[
				{
					"AppClassId":123,
					"CreatedDate":"\/Date(1420469130377)\/",
					"Id":123,
					"NetworkId":123,
					"Type":3
				}
			],
			"CreatedDate":"\/Date(1420469130377)\/",
			"DateCommenced":"\/Date(1420469130377)\/",
			"DateExpired":"\/Date(1420469130377)\/",
			"GroupId":123,
			"HomeNetworkId":123,
			"Id":123,
			"License":{
				"ApplicationUsed":123,
				"ContentSizeUsed":0,
				"Continent":7,
				"DMPPlayerUsed":123,
				"Duration":123,
				"Edition":2,
				"Feature":8,
				"Language":"String",
				"MaxApplications":123,
				"MaxBandwidth":123,
				"MaxDMPPlayers":123,
				"MaxNetworks":123,
				"MaxPlayers":123,
				"MaxSmartHubs":123,
				"MaxTotalContentSize":123,
				"MaxUsers":123,
				"MaxVideowall_NEXMPV10Players":123,
				"MaxVideowall_NEXMPV12Players":123,
				"MaxVideowall_NEXMPV24Players":123,
				"MaxVideowall_NEXMPV5Players":123,
				"MaxVideowall_NEXMPV6Players":123,
				"NetworkUsed":123,
				"PlayerUsed":123,
				"SmartHubUsed":123,
				"TimeZone":"String",
				"UserUsed":123,
				"Videowall_NEXMPV10PlayerUsed":123,
				"Videowall_NEXMPV12PlayerUsed":123,
				"Videowall_NEXMPV24PlayerUsed":123,
				"Videowall_NEXMPV5PlayerUsed":123,
				"Videowall_NEXMPV6PlayerUsed":123
			},
			"Name":"String",
			"OwnerId":123,
			"Players":[
				{
					"ApplicationId":123,
					"Id":123,
					"NetworkId":123,
					"PlayerDesc":{
						"CompressedSize":123,
						"FileCount":123,
						"FileSize":123,
						"IsDownloaded":true,
						"PlayerId":123,
						"ScriptCount":123,
						"TimeStamp":"\/Date(1420469130377)\/",
						"UncompressedSize":123
					},
					"PlayerGroupId":123
				}
			],
			"Registration":{
				"Company":"String",
				"ContactNo":"String",
				"Email":"String",
				"FirstName":"String",
				"LastName":"String",
				"RegistrationEmail":"String",
				"TempPassword":"String"
			},
			"Status":4,
			"Type":3,
			"Users":[
				{
					"AccountId":123,
					"CreatedDate":"\/Date(1420469130378)\/",
					"Email":"String",
					"EntitlementIds":[
						123
					],
					"FirstName":"String",
					"GroupId":123,
					"HomeNetworkId":123,
					"Id":123,
					"ImagePath":"String",
					"LastAccess":"\/Date(1420469130377)\/",
					"Lastname":"String",
					"MobileNo":"String",
					"Password":"String",
					"RoleIds":[
						123
					],
					"SecretAnswer":"String",
					"SecretQuestion":"String",
					"Status":2,
					"UserDN":"String",
					"Username":"String",
					"WorkNo":"String"
				}
			]
		}
	]
}