Logo
Swift API Sandbox Collections API Documentation

A Participant can inquiry the alerts that were generated by the SCT Inst for that Participant.

POST {{baseUrl}}/listAlerts/:senderBic

The ListAlerts Request allows the Participant to get all the alerts that were generated by the SCT Inst for the Participant. The Participant can use filtering criteria to restrict the number of alerts listed. If the Participant is an LP, in the full set of the returned Alerts there are also the ones regarding the liquidity change of the positions of the LSPs on whose behalf such LP is configured to perform liquidity management functions. The response contains the list of all Alerts that match the criteria and is sorted by AlertDate. The response contains a maximum of 1000 Alerts

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
ivUserKey
string The subscription key of a Participant. Following the format cn=<SSO+BIC+UserId+T>,o=BIC8,o=swift. SSO is a fixed string, last character is for environment (P for production and T for test) eg SSOUNCRITMMAPI12345P, o=uncritmm,o=swift
ivUserBic
string
Content-Type
string
Accept
string




RESPONSES

status OK

{ "dateTime": "2019-06-21T23:20:50.000001", "numAlerts": 6386156932, "endOfList": "0", "alertList": [ { "alertDate": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "description": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "eventType": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, { "alertDate": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "description": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "eventType": { "value": "<Error: Too many levels of nesting to fake this schema>" } } ], "offset": "quis ani" }



Curl
curl -X POST 'https://sandbox.swift.com/ebacl-rt1/v1/listAlerts/:senderBic' -H 'ivUserKey: quis fugiat aute dolore' -H 'ivUserBic: IPSDID21' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","criteria":{"alertDateFrom":"2019-06-21T23:20:50.000001","alertDateTo":"2019-06-21T23:20:50.000001","alertCode":"","alertDescription":"dolore enim nisi ut"},"offset":"veniam cillum labore"}'

ENDPOINTS