Overview

The Delete Case API allows delete case by number or Scalepoint unified case token.

Please refer to the Case Integration API documentation for details on the unified case token.

Warning Claims matched with claim number will be deleted from all Scalpoint systems. This action cannot be undone.

Authentication

You need an access token with case:delete scope in order to send data to the endpoint. This access token can be obtained from the Authentication Endpoint. Please refer to the documentation about details of authentication process.

Hub Property Delete Case API

Hub Property provides synchronous REST API for case deletion.

Endpoint URL has the following format:

https://<hostname>/<tenant>/api/integration/<version>/case

Example of the endpoint URL for production environment:

https://entry.scalepoint.com/ecx/tenantname/api/integration/v1/case

The API is available between 4 p.m. and 8 a.m. UTC. While called in business hours, HTTP 503 Service unavailable response with Retry-After header will be returned.

Example

Request

DELETE https://entry.scalepoint.com/ecx/<tenant>/api/integration/v1/case HTTP/1.1
Authorization: Bearer <access_token>
Accept-charset: utf-8
Accept: application/json
Content-Type: application/json
{
    "caseIdentifierType" : "CaseNumberRequest",
    "execute": true,
    "caseNumber": "CN10000"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
    "requestId": "00000000-0000-0000-0000-000000000000",
    "found": true,
    "deleted": true
}

Dry run mode

You can use Delete Case API in dry run mode to verify if case exists and if its state allows deletion. This does not affect your live data.

To use dry-run pass "execute": false in payload.

{
    "caseIdentifierType" : "CaseNumberRequest",
    "caseNumber": "CN408439",
    "execute": false
}

Rate limits

The maximum number of requests that are allowed is based on a time interval.

Default request limit is 5 per second and not more then 100 per minute. When limit is exceeded then 429 Too Many Requests response is returned. Please contact if you need higher limit.

Errors

400 Bad Request - The request was unacceptable, because of invalid syntax or missing a required parameter.

401 Unauthorized - No valid API key provided.

403 Forbidden - Deleting the case is forbidden because of its state (e.g. case has pending payments or depreciation is not settled).

404 Not Found - Requested case doesn't exist.

409 Conflict - Another deletion for requested case is already in progress.

429 Too Many Requests - Rate limit exceeded.

500 Internal Server Error - Unexpected error in Scalepoint system.

Error response example

HTTP/1.1 404 Not Found
{
    "requestId": "00000000-0000-0000-0000-000000000000",
    "found": false,
    "deleted": false,
    "errors": [
        "Case number CN39983 not found"
    ]
}

Recovery from error

It might happen that deletion failed because of case state forbids to delete it or some other internal error. In this scenario case will be partially deleted. To complete the deletion, please provide requestId from response of failed request. The deletion will continue from point where it failed.

DELETE https://entry.scalepoint.com/ecx/<tenant>/api/integration/v1/case HTTP/1.1
Authorization: Bearer <access_token>
Accept-charset: utf-8
Accept: application/json
Content-Type: application/json
{
    "requestId": "00000000-0000-0000-0000-000000000000",
    "caseIdentifierType" : "CaseNumberRequest",
    "execute": true,
    "caseNumber": "CN10000"
}

Appendix A - Case Deletion Request

Appendix B - Case Deletion Response

ClaimShop Delete Case API

ClaimShop provides synchronous REST API for case deletion.

Endpoint URL has the following format:

https://<hostname>/webapp/ScalePoint/<country>/<version>/case/<tenant>/delete

Example of the endpoint URL for production environment:

https://www.scalepoint.com/webapp/ScalePoint/dk/v1/case/tenantName/delete

The API is available between 4 p.m. and 8 a.m. UTC. While called in business hours, HTTP 503 Service unavailable response with error message specifying currently set business hours will be returned.

Example

Request

DELETE https://www.scalepoint.com/webapp/ScalePoint/dk/v1/case/<tenant>/delete HTTP/1.1
Authorization: Bearer <access_token>
Accept-charset: utf-8
Accept: application/json
Content-Type: application/json
{
    "caseIdentifierType" : "CaseNumberRequest",
    "execute": true,
    "caseNumber": "CN10000"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
    "found": true,
    "deleted": true,
    "errors": []
}

Dry run mode

You can use Delete Case API in dry run mode to verify if case exists and if its state allows deletion. This does not affect your live data.

To use dry-run pass "execute": false in payload.

{
    "caseIdentifierType" : "CaseNumberRequest",
    "caseNumber": "CN408439",
    "execute": false
}

Rate limits

The maximum number of requests that are allowed is based on current load.

Default request limit is 5 simultaneous requests (for all clients). When limit is exceeded then 429 Too Many Requests response is returned. Please try again after some time.

Errors

400 Bad Request - The request was unacceptable, because of invalid syntax or missing a required parameter.

401 Unauthorized - No valid API key provided.

403 Forbidden - Deleting the case is forbidden because of its state (e.g. case has pending payments or depreciation is not settled).

404 Not Found - Requested case doesn't exist.

429 Too Many Requests - Rate limit exceeded.

500 Internal Server Error - Unexpected error in Scalepoint system.

Error response example

HTTP/1.1 500 Internal Server Error
{
    "found": false,
    "deleted": false,
    "errors": [
        "Unexpected error during deletion"
    ]
}

Appendix A - Case Deletion Request

Appendix B - Case Deletion Response