RetrieveNotifications

NotificationService / RetrieveNotifications

Description: Retrieve notifications

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

Method: GET

Token Required: True

Request Headers:

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

Request Query Parameters:

Parameter	Type	Nullable	Description
eventids	int	True	comma separated values, eg. eventids=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
sourceids	int	True	comma separated values, eg. sourceids=1,2,3
eventcodes	string	True	comma separated values, eg. eventcodes=101,102,103
max	int	True	maximum number of the notifications to return, default = 20
guids	Guid	True	comma separated values, eg. guids=xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx

Example: http://{your-server-url}/api/v1/core/notifications?eventids=100&resourceids=100&sourceids=100

Response:

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

Parameter	Type
Response.Notifications	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications.Notification[]

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>
  <Notifications xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications">
    <a:Notification>
      <a:AllowRedundant>true</a:AllowRedundant>
      <a:CreatedDateTime>2014-04-24T17:53:43.0450945Z</a:CreatedDateTime>
      <a:CustomTemplate>String</a:CustomTemplate>
      <a:CustomTemplateGlobalizationDictionaryKey>String</a:CustomTemplateGlobalizationDictionaryKey>
      <a:EventCode>String</a:EventCode>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:Id>123</a:Id>
      <a:LifeSpan>PT0S</a:LifeSpan>
      <a:Metadata xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:Metadata>
      <a:NotificationStatusIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:NotificationStatusIds>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceType>Player_Groups</a:ResourceType>
      <a:Source>String</a:Source>
      <a:SourceId>123</a:SourceId>
      <a:TargetedResourceIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <b:int>123</b:int>
      </a:TargetedResourceIds>
    </a:Notification>
  </Notifications>
</NotificationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Notifications":[
		{
			"AllowRedundant":true,
			"CreatedDateTime":"\/Date(1398362023045)\/",
			"CustomTemplate":"String",
			"CustomTemplateGlobalizationDictionaryKey":"String",
			"EventCode":"String",
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"LifeSpan":"PT0S",
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"NotificationStatusIds":[
				123
			],
			"ResourceId":123,
			"ResourceType":23,
			"Source":"String",
			"SourceId":123,
			"TargetedResourceIds":[
				123
			]
		}
	]
}