RetrieveEntitlements

UserService / RetrieveEntitlements

Description: Retrieve entitlements for user and usergroup

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

Method: GET

Token Required: True

Request Headers:

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

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Network Administrator

Request Query Parameters:

Parameter	Type	Nullable	Description
entitlementids	int[]	True	comma separated values, eg. entitlementids=1,2,3
userids	int[]	True	comma separated values, eg. userids=1,2,3
ugids	int[]	True	comma separated values, eg. ugids=1,2,3
roleids	int[]	True	comma separated values, eg. roleids=1,2,3
rolename	string	True
resourcescope	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope	True
resourceids	int[]	True	comma separated values, eg. resourceids=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/users/entitlements?entitlementids=1,2,3&userids=1,2,3&ugids=1,2,3

Response:

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

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

Enums:

Field	Name	Values
RoleRights	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
ResourceScope	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope	Undefined = 0, Portal = 1, Account_Groups = 2, Accounts = 3, Networks = 4, Applications = 5, Players = 6, User_Groups = 7, Users = 8, Zones = 9, DataSources = 10, ContentSize = 11, Server = 12, Content = 13, Campaign = 14, Client = 15, Site = 16, Widget = 17, LayoutSchedule = 18, CampaignEntity = 19, ContentFolders = 20, Layouts = 21, MediaZone = 22, Player_Groups = 23, Space = 24

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>
  <Entitlements xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Users">
    <a:Entitlement>
      <a:EntitleToId>123</a:EntitleToId>
      <a:EntitlementType i:nil="true" />
      <a:Id>123</a:Id>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceScope>Player_Groups</a:ResourceScope>
      <a:RoleDescription>String</a:RoleDescription>
      <a:RoleId>123</a:RoleId>
      <a:RoleName>String</a:RoleName>
      <a:RoleRights>Widget_Schedule_Management</a:RoleRights>
    </a:Entitlement>
  </Entitlements>
  <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,
	"Entitlements":[
		{
			"EntitleToId":123,
			"EntitlementType":null,
			"Id":123,
			"ResourceId":123,
			"ResourceScope":23,
			"RoleDescription":"String",
			"RoleId":123,
			"RoleName":"String",
			"RoleRights":4096
		}
	],
	"Rpp":123,
	"TotalPages":123
}