/attachment/list
| Method | GET | ||
|---|---|---|---|
| Path | /attachment/list | ||
| Parameters | Values | Description | |
| @ucid | String: ex. US-20100077592-A1 | Document identifier | |
Example:
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws.ificlaims.com/attachment/list?ucid=US-20100077592-A1'
Response XML
<?xml version="1.0"?>
<response method="attachment/list" status="success" time="0.652126">
<attachments>
<attachment pkey="EP-0700000-B1-20001004"
size="22886"
media="image/tiff"
path="/EP/20001004/B1/000000/70/00/00/00360001.tif"
filename="00360001.tif" />
<!-- further attachment elements -->
</attachments>
</response>
{
"status" : "success",
"time" : "0.076931"
"count" : 6,
"attachments" : [
{
"path" : "/EP/20001004/B1/000000/70/00/00/00360001.tif",
"filename" : "00360001.tif",
"media" : "image/tiff",
"pkey" : "EP-0700000-B1-20001004",
"size" : 22886
},
/* further attachment array members */
],
}
In the event that the ucid has no attachments, HTTP 204 (Not Found) will be returned. The returned JSON is an array containing anonymous structures. The keys to the anonymous structure, i.e., media, path and size, correspond identically with that of the XML response. Please see below for details.
The attribute @count is the total number of attachments residing in the data store for the corresponding ucid. If @count > 0, a list of attachment elements follows. The attributes are described below.
| @media | Internet media type i.e., text/xml and image/tiff. There are other types of attachments, e.g., ChemDraw, Chemical Expression and Mathmatica but there are currently no standard internet media types and hence, this attribute will be populated with non-standard media types. The following attachments, corresponding file name extension and internet media types are available.
| |||||||||||||||||||||
| @path | The relative path by which the attachment can be retrieved in a subsequent call using /attachment/fetch | |||||||||||||||||||||
| @size | Size, in bytes, of attachment |
/attachment/fetch
| Method | GET | ||
|---|---|---|---|
| Path | /attachment/fetch | ||
| Parameters | Values | Description | |
| @path | String: ex. /b4knn/vj86f\ /v01zz/lt6r6\ /US-20100077592-A1-20100401\ /US20100077592A1-20100401-D00000.TIF | This attribute will have been returned in a call to /attachment/list. | |
Example: /fetch
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws.ificlaims.com/attachment/fetch?\ path=/b4knn/vj86f/v01zz/lt6r6/US-20100077592-A1-20100401/US20100077592A1-20100401-D00000.TIF'
Response
The request content-type is irrelevant with regard to response format. In the event of a system failure involving attachment availability between calls to /attachment/list and /attachment/fetch, the HTTP response code 404 Not Found will be returned. If this rare situation arises, it is advised to call list to retrieve valid @path attributes.