Data interface: Acknowledgement of receipt external system
General
A customer interface is to be addressed in COGLAS for interface feedback for service configuration. The message type is configured and is signalled.
The external system reports the acknowledgement of receipt.
Confirmation of receipt COGLAS to interface partners
How does the COGLAS interface work?
COGLAS receives data.
Response to the interface partner is made with a SUCCESS or ERRORS in JSON format.
Example: Reception ok and processing ok:
StatusCode : 200
StatusDescription : OK
Content : { "Success": true }
Example: Reception OK and processing error:
StatusCode : 200
StatusDescription : OK
Content : { "Errors": ["No data found"], "Success": false }
Acknowledgement of receipt from interface partner to COGLAS
Response from an interface partner is expected in JSON format.
Message as object IF Ok:
{
"Success":true
}
Message as object IF error:
{
"Success":false,
"Errors":[
"An error has occurred",
"Please check xyz."]
}
Example
Reference is made here to the external system. COGLAS has no knowledge of this.
If there are settings in the external system to send a confirmation of receipt, then this must be set to the above JSON format.
Warning message
Warning message | Description |
---|---|
Interface history:
| The external system reports a confirmation of receipt which COGLAS does not understand. The scope and format must be set up correctly in JSON format in the external system according to the above definition. |
→ back to COGLAS processes
→ back to COGLAS menu