getQualityNotification
Resolves a quality notification
- application/json
Request Body
- notificationId uuid required
A UUIDv4 to uniquely identify a quality notification.
- senderBPN string required
The business partner number (BPN) of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check.
- senderAddress uri required
The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check.
- recipientBPN string required
The business partner number (BPN) of the receiver. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check.
- messageId uuid
A UUIDv4 to uniquely identify an individual quality notification message. If this parameter is provided, the message for this messageId is resolved. If this parameter is not provided, then the last available message is resolved.
- 200
- 400
- 401
- 403
- 404
- 405
Quality notification was resolved successfully
- application/json
- Schema
- Example (from schema)
Schema
- notificationId uuid
A UUIDv4 to uniquely identify a quality notification.
- senderBPN string
The business partner number (BPN) of the sender.
- senderAddress uri
The Eclipse Dataspace Connector (EDC) URL of the sender.
- recipientBPN string
The business partner number (BPN) of the receiver.
- severity string
Possible values: [
MINOR
,MAJOR
,CRITICAL
,LIFE-THREATENING
]The severity of the quality notification describes its criticality.
- status string
Possible values: [
CREATED
,SENT
,RECEIVED
,ACKNOWLEDGED
,ACCEPTED
,DECLINED
,CLOSED
]The status of the quality notification.
- targetDate date-time
The date and time when a processing of the notification is expected by the sender.
- messageId uuid
A UUIDv4 to uniquely identify an individual quality notification message.
{
"notificationId": "a7954026-3aff-4b6c-92bf-04671ef2fa46",
"senderBPN": "BPNL00000003BW3S",
"senderAddress": "https://edc.company-xyz.io/BPNL00000003BW3S",
"recipientBPN": "BPNL00000003BV4H",
"severity": "CRITICAL",
"status": "SENT",
"targetDate": "2022-07-28T14:41:13.214Z",
"messageId": "c2801472-5f87-41a7-9a25-b0939c4e0dff"
}
Request body was malformed
Not authorized
Forbidden
Could not resolve the quality notification, because a quality notification with that notificationId does not exist
Method not allowed