RetrieveEvents

 

NotificationService / RetrieveEvents

 

Description: Retrieve events

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

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
eventnames string True comma separated values, eg. eventnames=event1,event2
eventlevels string True comma separated values, eg. eventlevels=info,warn,error
page int True page number
rpp int True records per page, default = 50, max = 500
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/events?eventnames=string&eventlevels=string&page=100


Response:

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

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

Enums:
Field Name Values
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>
  <CurrentPage>123</CurrentPage>
  <Events xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Notifications">
    <a:Event>
      <a:Code>String</a:Code>
      <a:GlobalizationDictionaryKey>String</a:GlobalizationDictionaryKey>
      <a:Id>123</a:Id>
      <a:Level>Error</a:Level>
      <a:Name>String</a:Name>
      <a:Template>String</a:Template>
    </a:Event>
  </Events>
  <Rpp>123</Rpp>
  <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,
	"Events":[
		{
			"Code":"String",
			"GlobalizationDictionaryKey":"String",
			"Id":123,
			"Level":2,
			"Name":"String",
			"Template":"String"
		}
	],
	"Rpp":123,
	"TotalPages":123
}