This document describes the CWA Claim Page API. This API is used by Claim Page to retrieve all needed data.
In order to send data to CWA Claim Page API endpoints the access_token is required. This token can be obtained from the Authentication Endpoint. Please refer to the documentation about details of authentication process.
Almost every endpoint requires to send userGlobalId parameter, in order to check if user has access to the requested resource. This is always an id of the claimant, because Claim Page returns only data in claimant scope.
However, if API is used by claim handler user, it is needed to send claim handler's id in claimHandlerUserGlobalId header.
userGlobalId request parameter |
claimHandlerUserGlobalId header |
|
|---|---|---|
| Claim Handler | Claimant's id | Claim handler's id |
| Claimant | Claimant's id | Empty |
If API is used by claimant, but claimHandlerUserGlobalId had been set to his id, then CWA would treat that user as claim handler, which will always result in 404 HTTP error (claimant is not IC user, so it cannot be found).
| Endpoint | Method | Description | CP equivalent endpoint |
|---|---|---|---|
| api/case/{caseId}/attachments | POST | Uploads attachment file | /api/claims/{claimId}/attachment |
| api/case/{caseId}/attachments/{attachmentId} | DELETE | Deletes attachment file | /api/claims/{claimId}/attachment |
| api/case/{caseId}/case-data | GET | Returns dynamic data object, used in further calls to Communcation Designer | |
| api/case/claims | GET | Returns list of claims | /api/claims |
| api/case/companies/{subCompanyAlias} | GET | Returns subcompany's details | /api/companies |
| api/case/{caseId}/contacts | GET | Returns list of contacts | /api/claims/{claimId}/contacts |
| api/case/contacts/{contactId} | POST | Updates contact details of logged user | /api/contacts/{contactId} |
| api/case/{caseId}/contacts/mobilePhonePrefixes | GET | Returns list of mobile phone prefixes | /api/claims/{claimId}/contacts/mobilePhonePrefixes |
| api/case/{caseId}/craftsmanInvitation | POST | Sends invitation to external crafstman (repair service) | /api/claims/{claimId}/craftsman-invitation |
| api/case/{caseId}/details | GET | Returns basic case's data | /api/claims/{claimId}/details/information |
| api/case/{caseId}/details/lineOfBusiness | GET | Returns line of business (case type) for the case | |
| api/case/{caseId}/externalUrls/shop | GET | Returns URL of the shop | /api/claims/{claimId}/externalUrls/shop |
| api/case/{caseId}/externalUrls/selfService | GET | Returns URL of the self service | /api/claims/{claimId}/externalUrls/selfService |
| api/case/{caseId}/features | GET | Used to determine sections that user can access within the claim | /api/claims/{claimId}/features |
| api/case/{caseId}/userRole | GET | Returns user role in scope of CP, for further BI calls | |
| api/case/{caseId}/files | GET | Returns files attached to the case | /api/claims/{claimId}/files/files |
| api/case/{caseId}/files | PUT | Marks files as viewed | /api/claims/{claimId}/files/files/viewed |
| api/case/{caseId}/files/documents | GET | Returns documents attached to the claim | /api/claims/{claimId}/files/documents |
| api/case/{caseId}/files/download | GET | Returns content of the file | /api/claims/{claimId}/files/download |
| api/case/{caseId}/financialOverview | GET | Returns content of financial overview tab | /api/claims/{claimId}/financial-overview |
| api/case/{caseId}/history | GET | Returns content of the messages tab | /api/claims/{claimId}/history |
| api/case/{caseId}/history | PUT | Marks messages as viewed | /api/claims/{claimId}/history |
| api/case/images/{attachmentInfoId}/thumbnail | GET | Returns thumbnail of the attachment | api/images/{attachmentInfoId}/thumbnail |
| api/case/images/{attachmentInfoId}/preview | GET | Returns preview of the attachment | api/images/{attachmentInfoId}/preview |
| api/case/{caseId}/messages | POST | Sends message to all selected recipients | /api/claims/{claimId}/messages |
| api/case/{caseId}/services | GET | Returns content of the 3rd-party providers tab | /api/claims/{claimId}/services |
| api/case/{caseId}/state | GET | Returns claim's progress bar steps | /api/claims/{claimId}/state |
Swagger doesn't exist for this API, but it possible to check Claim Page API for parameters and return types, using CP equivalent endpoint column.