...
| Method | GET | ||
|---|---|---|---|
| Path | /attachment/list | ||
| Parameters | Values | Description | |
| @ucid | String: ex. US-20100077592-A1 | Document identifier | |
| @multi | Boolean: ex 1|0 | Specifies an alternative response format suitable for mulit-ucid input. Ex, ?ucid=US-5551212-A,EP-0700000-A2 | |
Example:
| Code Block |
|---|
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws.ificlaims.com/attachment/list?ucid=US-20100077592-A1' |
Response XML
| Code Block | ||
|---|---|---|
| ||
<?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> |
| Code Block |
|---|
{
"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 */
],
} |
Example ( multi=1 )
| Code Block |
|---|
wget -O- \
--header 'x-user:x' \
--header 'x-password: y' \
'http://cdws.ificlaims.com/attachment/list?ucid=EP-0700000-A2,EP-0700000-B1&multi=1' |
| Code Block |
|---|
{ "count" : 2, "status" : "success", "time" : "0.152457", "attachments" : [ { "EP-0700000-A2" : { "count" : 7, "attachments" : [ { "path" : "/EP/19960306/A2/000000/70/00/00/EP0700000A219960306.pdf", "filename" : "EP0700000A219960306.pdf", "pkey" : "EP-0700000-A2-19960306", "media" : "application/pdf", "size" : 710278 }, ; etc ... ] } }, { "EP-0700000-B1" : { "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 }, ; etc ... ] } } ], } |
Response XML
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?>
<response method="attachment/list" time="0.081054" status="success">
<attachment-listing ucid-count="1">
<attachments ucid="EP-0700000-A2" count="7">
<attachment filename="EP0700000A219960306.pdf" media="application/pdf" path="/EP/19960306/A2/000000/70/00/00/EP0700000A219960306.pdf" pkey="EP-0700000-A2-19960306" size="710278"/>
<attachment filename="imgaf001.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgaf001.tif" pkey="EP-0700000-A2-19960306" size="7365"/>
<attachment filename="imgf0001.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgf0001.tif" pkey="EP-0700000-A2-19960306" size="22135"/>
<attachment filename="imgf0002.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgf0002.tif" pkey="EP-0700000-A2-19960306" size="21904"/>
<attachment filename="imgf0003.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgf0003.tif" pkey="EP-0700000-A2-19960306" size="11082"/>
<attachment filename="imgf0004.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgf0004.tif" pkey="EP-0700000-A2-19960306" size="22929"/>
<attachment filename="imgf0005.tif" media="image/tiff" path="/EP/19960306/A2/000000/70/00/00/imgf0005.tif" pkey="EP-0700000-A2-19960306" size="12493"/>
</attachments>
</attachment-listing>
</response>
|
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. | |
...