Notification ACK Service

Notification ACK API definition

The purpose of this endpoint is to notify that a message has been processed

Method	Endpoint	URI Parameters	Request Headers	Request Body	Response Body	Security
POST	https://[host]/partners/services/api/v1/notification/ack	NA	receiptHandle: Identifier of the message org_id : Organization OID x-origin-request-id: Request unique id, generated by EMR middleware client_id : Public identifier for organizations generated by Roche DC client_secret : Client related secret known only to the EMR and Roche DC Content-Type: Default value application/json	NA	Please check Response Definition	Mutual TLS Authentication (mTLS)

Complete Services API Specification here

Request Definition

Please find Example cURL Request here

Response Definition

Success response: HTTP Status Code 200 Message was notified successfully

Error response:

Please find Error handling details here

Example Request

Example cURL Request:

curl -L -X POST 'https://api-services-demo.rochedcplatform-sandbox.com/partners/services/api/v1/notification/ack' -H 'client_id: {CLIENT_ID}' -H 'client_secret: {CLIENT_SECRET}' -H 'org_id: {ORG_ID}' -H 'Content-Type: application/json' -H 'receiptHandle: {RECEIPT_HANDLE}' -H 'Accept: application/json' --data-raw ''

Error handling

Error codes Response:

401 Unauthorized:

Invalid Client Id / Secret.

{
    "error": "Invalid Client"
}

403 Forbidden:

Certificate validation failed.

{
    "status": "error",
    "detail": "Validation policy error: Certificate validation failed."
}

400 Bad Request:

Example:

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "The input receipt handle \"BQEBt7GUE0+VK\" is not a valid receipt handle."
      }
    }
  ]
}

405 Method Not Allowed
500 Internal Server Error
501 Not Implemented