/check
Check the availability of attachment packages.
| Method | GET | ||
|---|---|---|---|
| Path | /update/attachments/check | ||
| Parameter | Values | Description | |
| @max_attachment_file_id | integer: e.g., 20190826193341 | The attachment_file_id from which to check if subsequent packages are available | |
| @limit | integer: e.g., 10 | Number of attachment file structures to return. Default: 10 | |
Example
Request
| language | text |
|---|
wget -O- -q \ |
|
|
Response
| Code Block | ||
|---|---|---|
| ||
{
"attachment_files_count" : 9,
"attachment_files" : [
{
"country" : "CN",
"checksum" : "b444a0bb07d8154de36f46cc146b607d",
"created_stamp" : "2019-08-29 01:36:27.800122",
"attachment_file_id" : 20190829010502,
"url" : "https://bulk-attachments.s3.amazonaws.com/20190829/20190829...",
"size" : 2036161157
}
],
"status" : "success",
"time" : "0.139"
} |
Details
| JSON Member | Description |
|---|---|
| status | Request status (success | failed) |
| time | Time, in seconds, to complete the request |
| attachment_files_count | Total number of available packages |
| attachment_files | An array of attachment file structures. Members described below. |
| .country | Publishing country of attachments |
| .checksum | MD5 checksum of attachment file |
| .created_stamp | Timestamp of file creation |
| .attachment_file_id | Identifier of attachment file |
| .url | Signed URL of attachment file |
| .size | Size, in bytes, of attachment file |
/next
Fetch the next available attachments file.
| Method | GET | ||
|---|---|---|---|
| Path | /update/attachments/next | ||
| Parameter | Values | Description | |
| @max_attachment_file_id | Integer: e.g., 20190826193341 | The maximum attachment_file_id from which to check if subsequent files are available | |
Example
Request
| Code Block | ||
|---|---|---|
| ||
wget -O- -q \
--header 'x-user:x' \
--header 'x-password:y' \
'https://cdws21.ificlaims.com/update/attachments/next?max_attachment_file_id=20190826193341' |
Response
| Code Block | ||
|---|---|---|
| ||
{
"status" : "success",
"time" : "0.130",
"attachment_file" : {
"country" : "CN",
"checksum" : "b444a0bb07d8154de36f46cc146b607d",
"created_stamp" : "2019-08-29 01:36:27.800122",
"attachment_file_id" : 20190829010502,
"url" : "https://bulk-attachments.s3.amazonaws.com/20190829/20190829010502.tar....",
"size" : 2036161157
}
} |
Please see above for a detailed description of the response members.
/info
Fetch information pertaining to a particular attachment-file-id.
| Method | GET | ||
|---|---|---|---|
| Path | /update/attachments/info | ||
| Parameter | Values | Description | |
| @attachment_file_id | Integer: e.g., 20190826193341 | The attachment_file_id of interest | |
Example
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
wget -O- -q \
--header 'x-user:x' \
--header 'x-password:y' \
'https://cdws21.ificlaims.com/update/attachments/info?attachment_file_id=20190826193341' |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"status" : "success",
"time" : "0.094",
"attachment_file" : {
"country" : "CN",
"checksum" : "b444a0bb07d8154de36f46cc146b607d",
"created_stamp" : "2019-08-29 01:36:27.800122",
"attachment_file_id" : 20190829010502,
"url" : "https://bulk-attachments.s3.amazonaws.com/20190829/201908290...",
"size" : 2036161157
}
} |
Please see above for a detailed description of the response members.
| Info | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
There is an IDX file inside the package specifically to map ucids to paths. To find the path for specific attachments: 1. Download the compressed file:
2. Extract the files:
3. Display the content of the
4. This will provide the path:
|