Swift API Sandbox Collections API Documentation
A Participant can inquiry the list of unavailable Participants.
POST {{baseUrl}}/inquiryUnavailability/:senderBic
The Inquiry unavailability request allows the RT1 user to inquiry the unavailability of the participants, due to what communicated with the function Communication of Unavailability.
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",
"list": [
{
"status": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"startDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"endDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"durationOfUnavailability": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"broadcastingToRT1Community": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"generationDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"unavailableBic": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"eventDescription": {
"value": "<Error: Too many levels of nesting t Curl curl -X POST 'https://sandbox.swift.com/ebacl-rt1/v1/inquiryUnavailability/: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":{"unavailableBic":"IPSDID21XXX","broadcasting":"1"}}' ENDPOINTS |