...
Method | GET | ||
---|---|---|---|
Path: | /attachment/list | ||
Parameters: | Values | Description | |
@ucid | String: ex. US-20100077592-A1 | Document identifier | |
@multi | Boolean: 1|0 | Specifies an alternative response format suitable for mulitmulti-ucid input. Ex, ?ucid=US-5551212-A,EP-0700000-A2 |
...
In the event that the ucid has no attachments, HTTP 204 (Not Found) will be returned if @multi attribute is not specified, otherwise, an empty JSON attachment list with count : 0
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.
Key | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@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 | SizrSize, in bytes, of attachment | |||||||||||||||||||||||||||
@filename | Name of file as stored in the attachments server |
...
Method | GET | ||
---|---|---|---|
Path: | /attachment/fetch | ||
Parameters: | @path | String: e.g., /EP/19960306/A2/000000/70/00/00/imgaf001.tif | The path of the attachment to fetch as returned in the response to /attachment/list |
...
Method: | GET | ||
---|---|---|---|
Path: | /attachment/pdf | ||
Parameters: | |||
@ucid | String: e.g., EP-0700000-B1 | Document indentiferidentifier |
Request
Code Block |
---|
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/attachment/pdf?ucid=US-20160000001-A1' |
...