RetrieveRoles

UserService / RetrieveRoles

Description: Retrieve roles

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

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

Request Query Parameters:

Parameter	Type	Nullable	Description
rpp	int	True	records per page, default = 50, max = 500
name	string	True
roleids	int[]	True	comma separated values, eg. roleids=1,2,3
page	int	True	page number

Example: http://{your-server-url}/api/v1/core/users/roles?rpp=100&name=string&roleids=1,2,3

Response:

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

Parameter	Type
Response.Roles	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users.Role[]
Response.TotalPages	int
Response.CurrentPage	int
Response.Rpp	int

Enums:

Field	Name	Values
Rights	Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights	Undefined = 0, Portal_Management = 1, Account_Management = 4, Network_Management = 8, Application_Management = 16, Account_Owner = 32, Basic = 64, Content_Management = 128, Schedule_Management = 256, Widget_Management = 512, Campaign_Administration = 1024, Campaign_Management = 2048, Widget_Schedule_Management = 4096

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>
  <Roles xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:Role>
      <a:Description>String</a:Description>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:Rights>Widget_Schedule_Management</a:Rights>
    </a:Role>
  </Roles>
  <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,
	"Roles":[
		{
			"Description":"String",
			"Id":123,
			"Name":"String",
			"Rights":4096
		}
	],
	"Rpp":123,
	"TotalPages":123
}