Recommended Tasks Updated
Integration point URL
- URL:
<SPCIntegrationAPIUrl>/Claim/RecommendedTasks - HTTP METHOD:
PUT - URL Example:
https://servicepartnercompany.com/ecbintegration/Claim/RecommendedTasks
Request structure
- Schema:
RecommendedTasksUpdatedRequest.schema.json - Example:
RecommendedTasksUpdatedRequest.example.json
Root object
| Property | Description |
|---|---|
securityToken* | Pre-shared secret string key that is used to authenticate SPC and ECB to each other |
timestamp* | Message generation UTC date/time. Should be in ISO 8601 format without time zone. Note: Can be used to restore messages original order (per claim) – due to network/server errors it’s not guaranteed that messages will arrive in the order they were generated |
payload* | Payload object with integration endpoint specific data |
Payload object
| Property | Description |
|---|---|
claim* | Claim object |
tasks* | Collection of Task objects |
Claim object
| Property | Description |
|---|---|
id* | Claim unique identifier in ECB |
number* | Claim number |
url* | URL to Claim Details in ECB |
damageServiceDetails.referenceNumber | Claim reference number in SPC internal system |
deductible | Current deductible value |
claimEmailAddress | Email address dedicated to a claim. |
Task object
| Property | Description |
|---|---|
name* | Recommended task name in ECB (in insurance company locale) |
deadline | Recommended task deadline in ECB. Should be in ISO 8601 format without time zone (always treated as date/time in tenant local time zone) |
service | ServiceData object |
ServiceData object
| Property | Description |
|---|---|
status | Service status |
startDate | Repair start date. For inspection service: date of service request. |
endDate | Estimated repair end date. For inspection service: date of service completion. |
visitDate | Date of scheduled visit |
inspectionDate | Date of scheduled inspection |
Response structure
- Schema:
RecommendedTasksUpdatedResponse.schema.json - Example:
RecommendedTasksUpdatedResponse.example.json
Root object
| Property | Description |
|---|---|
success* | Boolean flag representing if request is processed successfully |
errorDescription | Description of errors, if any |
Implementation notes
ECB might send “Recommended tasks updated” request to SPC internal system without preceding “New responsibilities assigned” request. Request handler on SPC internal system side should be able to correctly handle such requests.
It is possible to use ECB test application to test integration
NewResponsibilities:
<server>/ecx/AutomaticPaymentsTestApp/IntegrationApi/Index#/NewResponsibilitiesAssigned/restClient
NewTasks:
<server>/ecx/AutomaticPaymentsTestApp/IntegrationApi/Index#/RecommendedTasksUpdated/restClient
DamageServiceReport:
<server>/ecx/AutomaticPaymentsTestApp/IntegrationApi/Index#/SubmitDamageServiceReportDraft/restClient
Last updated on