| Table of Contents | ||||
|---|---|---|---|---|
|
...
Link | https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/main/cancelComposition |
Resource | /patients/composition/{compositionId}/cancel |
Scope | composition:cancel |
Components | |
Using Dictionaries | API paragraph not found |
Using Microservices | API paragraph not found |
Protocol type | REST |
Request type | PATCH |
Sync/Async | Async |
Public/Private/Internal | Public |
Logic
...
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
compositionId | String ($uuid) (path) | Composition object ID |
Request structure
...
89edcfb2-3479-4565-885b-d0ce7f9d081e | |||
Request body | String($uuid) | Request body with signed |
...
Example
...
| title | Request body example |
|---|
...
composition. | { |
...
"string" |
...
|
Request structure
Authorize
API paragraph not found
Headers
...
Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}
Validation data request
API paragraph not found
...
API paragraph not found
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
...
HTTP status code | Message | What caused the error |
|---|---|---|
200 | In case of successful cancellation of the Composition | Successful cancellation |
400 | Invalid request format | Error during formation or incorrect use of parameters in the request |
401 | The user role does not allow the operation to be performed | The role or scopes assigned to the user who generated the request do not allow such an operation to be done. |
404 | The object of the Composition was not found | The object of the Composition was not found or incorrect ID |
500 | Subordinate service error | Subordinate service error |
...