Page tree
Skip to end of metadata
Go to start of metadata

This bulk download service provides access to complete copies of recently published attachments packaged in a convenient archive. If you are interested in accessing this service, please contact your sales representative.

/check

Check the availability of attachment packages.

MethodGET
Path/update/attachments/check
Parameter
ValuesDescription

@max_attachment_file_idinteger: e.g., 20190826193341The attachment_file_id from which to check if subsequent packages are available

@limitinteger: e.g., 10Number of attachment file structures to return. Default: 10

Example

Request

wget -O- -q \
  --header 'x-user:x' --header 'x-password:y' \
'http://cdws21.ificlaims.com/update/attachments/check?max_attachment_file_id=20190826193341&limit=1'

Response

{
   "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 MemberDescription
statusRequest status (success | failed)
timeTime, in seconds, to complete the request
attachment_files_countTotal number of available packages
attachment_filesAn array of attachment file structures. Members described below.
.countryPublishing country of attachments
.checksumMD5 checksum of attachment file
.created_stampTimestamp of file creation
.attachment_file_idIdentifier of attachment file
.url

Signed URL of attachment file

.sizeSize, in bytes, of attachment file

/next

Fetch the next available attachments file.

MethodGET
Path/update/attachments/next
Parameter
ValuesDescription

@max_attachment_file_idInteger: e.g., 20190826193341The maximum attachment_file_id from which to check if subsequent files are available

Example

Request

wget -O- -q  \
  --header 'x-user:x' --header 'x-password:y' \
'http://cdws21.ificlaims.com/update/attachments/next?max_attachment_file_id=20190826193341'

Response

{
   "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.

MethodGET
Path/update/attachments/info
Parameter
ValuesDescription

@attachment_file_idInteger: e.g., 20190826193341The attachment_file_id  of interest

Example

Request

wget -O- -q  \
  --header 'x-user:x' --header 'x-password:y' \
'http://cdws21.ificlaims.com/update/attachments/info?attachment_file_id=20190826193341'

Response

{
   "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.


  • No labels