RetrieveTargetedResources

NotificationService / RetrieveTargetedResources

Description: Retrieve notification targeted resources

URL: http://{your-server-url}/api/v1/core/notifications/targetedresources

Method: GET

Token Required: True

Request Headers:

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

Rights:

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

Right	Require	Comment
Account_Management	Optional	User who does not have Account_Management right only able to retrieve own notifications

Request Query Parameters:

Parameter	Type	Nullable	Description
roleids	int	True	comma separated values, eg. roleids=1,2,3
resourceids	int	True	comma separated values, eg. resourceids=1,2,3
resourcetypes	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope	True	comma separated values, eg. resourcetypes=Portal,Accounts
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500
targetedresourceids	int	True	comma separated values, eg. targetedresourceids=1,2,3
notificationguids	int	True	comma separated values, eg. notificationguids=1,2,3

Example: http://{your-server-url}/api/v1/core/notifications/targetedresources?roleids=100&resourceids=100&page=100

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Notification.NotificationResponse

Parameter	Type
Response.CurrentPage	int
Response.TargetedResources	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications.TargetedResource[]
Response.TotalPages	int
Response.Rpp	int

Enums:

Field	Name	Values
ResourceType	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:

<NotificationResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Notification" 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>
  <TargetedResources xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications">
    <a:TargetedResource>
      <a:CreatedDateTime>2014-04-24T17:53:43.0771168Z</a:CreatedDateTime>
      <a:Id>123</a:Id>
      <a:NotificationId>123</a:NotificationId>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceType>Player_Groups</a:ResourceType>
      <a:RoleId>123</a:RoleId>
    </a:TargetedResource>
  </TargetedResources>
  <TotalPages>123</TotalPages>
</NotificationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"TargetedResources":[
		{
			"CreatedDateTime":"\/Date(1398362023077)\/",
			"Id":123,
			"NotificationId":123,
			"ResourceId":123,
			"ResourceType":23,
			"RoleId":123
		}
	],
	"TotalPages":123
}