RetrieveUserNotifications

NotificationService / RetrieveUserNotifications

Description: Retrieve current user notifications

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

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
sourceids	int	True	comma separated values, eg. sourceids=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
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
eventids	int	True	comma separated values, eg. eventids=1,2,3
eventcodes	string	True	comma separated values, eg. eventcodes=101,102,103

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

Response:

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

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

Enums:

Field	Name	Values
Status	Nexus.AppSpace.Service.Contract.Model.Enums.Notification.Status	unread = 0, read = 1, old = 2
Level	Nexus.AppSpace.Service.Contract.Model.Enums.Notification.Level	Info = 0, Warn = 1, Error = 2

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>
  <UserNotifications xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications">
    <a:UserNotification>
      <a:Datetime>2014-04-24T17:53:43.0641076Z</a:Datetime>
      <a:DatetimeTicks>String</a:DatetimeTicks>
      <a:Guid>String</a:Guid>
      <a:Id>123</a:Id>
      <a:Level>Error</a:Level>
      <a:LevelString>String</a:LevelString>
      <a:Message>String</a:Message>
      <a:Name>String</a:Name>
      <a:Status>old</a:Status>
      <a:StatusString>String</a:StatusString>
      <a:Url>String</a:Url>
    </a:UserNotification>
  </UserNotifications>
</NotificationResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"UserNotifications":[
		{
			"Datetime":"\/Date(1398362023064)\/",
			"DatetimeTicks":"String",
			"Guid":"String",
			"Id":123,
			"Level":2,
			"LevelString":"String",
			"Message":"String",
			"Name":"String",
			"Status":2,
			"StatusString":"String",
			"Url":"String"
		}
	]
}