List Portfolio Notifications

Request

Get all notificationEvents based on the portfolio id, optionally filter with query parameters.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

Query

searchQuerystring

Return notificationEvents that match the given value

sortBystring

Sort results by this column. Null values of sort column are listed after non-nulls.

Default:"eventId"

Enum:"companyName""countryCode""eventId""eventDate"

sortDirstring

The direction that you wish to sort results by.

Default:"asc"

Enum:"asc""desc"

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

pageinteger

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

Default:0

startDatestring, (date-time)

The start date on which results are filtered.

endDatestring, (date-time)

The end date on which results are filtered.

filterByCreatedDateboolean

Set to true to filter the Notification Events of the "createdDate" field when using startDate and endDate parameters. By default this is set to false, with the date parameters filtering using the "eventDate" field.

Default:false

Enum:falsetrue

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents?searchQuery=string&sortBy=companyName&sortDir=asc&pageSize=0&page=0&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&filterByCreatedDate=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"

totalCountnumber

The total number of events returned for the given company.

Example:36

dataArray of objects

pagingobject(ConnectMonitoringPaging)

Paging parameters.

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "totalCount": 36,
  "data": [
    { … }
  ],
  "paging": {
    "size": 10,
    "prev": 0,
    "next": 2,
    "last": 3
  }
}