RetrieveAccountGroups

AccountService / RetrieveAccountGroups

Description: Retrieve account groups

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

Method: GET

Token Required: True

Request Headers:

content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner

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 owner have the rights to deactiavte account but not allow to reactivate account.
Account_Management	Optional
Account_Owner	Optional

Request Query Parameters:

Parameter	Type	Nullable	Description
groupids	int[]	True	comma separated values, eg. groupid=1,2,3
name	string	True
description	string	True
parentids	int[]	True	comma separated values, eg. parentid=1,2,3
grouptypes	int[]	True	comma separated values, eg. grouptype=1,2,3
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/accounts/groups?groupids=1,2,3&name=string&description=string

Response:

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

Parameter	Type
Response.Groups	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Accounts.Group[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
GroupType	Nexus.AppSpace.Service.Contract.Model.Enums.Account.GroupType	Undefined = 0, Default_Trial = 1, Normal = 2, Server = 3

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>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>
  <CurrentPage>123</CurrentPage>
  <Groups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Accounts">
    <a:Group>
      <a:Description>String</a:Description>
      <a:GroupType>Server</a:GroupType>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
    </a:Group>
  </Groups>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</AccountResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Groups":[
		{
			"Description":"String",
			"GroupType":3,
			"Id":123,
			"Name":"String"
		}
	],
	"Rpp":123,
	"TotalPages":123
}