Logo
Swift API Sandbox Collections API Documentation

A Participant can communicate his temporary unavailability.

PUT {{baseUrl}}/communicationOfUnavailability/:senderBic

The Communication of unavailability request allows the Participant to communicate his temporary unavailability. Using this API, RT1 user can inform the system about the unavailability or the resumption of availability. It is possible to indicate the time of those events and to send a new message to update a previous one (e.g. to indicate that the expected duration of the unavailability will be shorter / longer). Optionally, RT1 users can indicate whether all the other RT1 users shall be informed. In such a case, all RT1 users can access to the information.

 

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", "unavailableBic": "IPSDID21XXX" }

Curl
curl -X PUT 'https://sandbox.swift.com/ebacl-rt1/v1/communicationOfUnavailability/: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":{"eventCode":"INS","unavailableBic":"IPSDID21XXX","messageId":"-PUN.iNNx9O4dg.","startDateTime":"2019-05-02T22:22:00.123-01:10","endDateTime":"2019-05-02T22:22:00.123-01:10","broadcastingToRT1Community":"0","eventDescription":"6"}}'

ENDPOINTS