RetrieveUsergroup

UserService / RetrieveUsergroup

Description: Retrieve usergroup

URL: http://{your-server-url}/api/v1/core/users/usergroups/{usergroupIdOrGuid}

Method: GET

Token Required: True

Request Headers:

currentaccountid: {accountid - optional and default value is user's own account}
token: {token}
content-type: application/json or content-type: application/xml

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User.UserResponse

Parameter	Type
Response.TotalPages	int
Response.Rpp	int
Response.Usergroup	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Usergroup
Response.CurrentPage	int

Enums:

Field	Name	Values
Status	Nexus.AppSpace.Service.Contract.Model.Enums.User.Status	Disabled = 0, Active = 1, Locked = 2, Undefined = -1

The following is an example response Xml body:

<UserResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.User" 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>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</UserResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TotalPages":123
}