Files Available Event
Integration point URL
- URL:
<SPCIntegrationAPIUrl>/File/FilesAvailable - HTTP METHOD:
PUT - URL Example:
https://servicepartnercompany.com/ecbintegration/File/FilesAvailable
Request structure
- Schema:
FilesAvailableEventRequest.schema.json - Example:
FilesAvailableEventRequest.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 – 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 |
|---|---|
files* | Collection of Files objects |
Files object
| Property | Description |
|---|---|
id* | File unique identifier in Scalepoint system. Can be used to download file contents with Get File Content request |
name* | File name |
mimeType* | File MIME type. For example, “image/jpeg”, “text/html” |
size | Original file size in bytes, before Base64 encoding |
description | Free text file description |
claim | Claim object to which file is attached |
Claim object
| Property | Description |
|---|---|
id* | Claim unique identifier in Scalepoint system |
number* | Claim number |
Response structure
- Schema:
FilesAvailableEventResponse.schema.json - Example:
FilesAvailableEventResponse.example.json
Root object
| Property | Description |
|---|---|
success* | Boolean flag representing if request is processed successfully |
errorDescription | Description of errors, if any |
Last updated on