receiveQualityNotification
Receives a new quality notification
- application/json
Request Body
header object required
notificationId uuid requiredA UUIDv4 to uniquely identify a quality notification.
senderBPN string requiredThe business partner number (BPN) of the sender.
senderAddress uri requiredThe Eclipse Dataspace Connector (EDC) URL of the sender.
recipientBPN string requiredThe business partner number (BPN) of the receiver.
classification string requiredPossible values: [
QM-Investigation
,QM-Alert
]The classification defines the type of quality notification.
severity string requiredPossible values: [
MINOR
,MAJOR
,CRITICAL
,LIFE-THREATENING
]The severity of the quality notification describes its criticality.
relatedNotificationId uuidA UUIDv4 to uniquely identify a related quality notification.
status string requiredPossible values: [
CREATED
,SENT
,RECEIVED
,ACKNOWLEDGED
,ACCEPTED
,DECLINED
,CLOSED
]The status of the quality notification.
targetDate date-timeThe date and time when a processing of the notification is expected by the sender.
messageId uuid requiredA UUIDv4 to uniquely identify an individual quality notification message. In case of an initial sending of a notification the messageId has to be a newly generated UUIDv4.
content object required
information stringPossible values:
<= 1000 characters
listOfAffectedItems string[] required
- 201
- 400
- 401
- 403
- 405
- 409
- 422
Quality notification was received successfully
Request body was malformed
Not authorized
Forbidden
Method not allowed
Could not accept the send quality notification, because a quality notification with that notificationId already exists
Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver).