The attachment service is used to retrieve attachments such as clipped images, drawings, chemistry files, full page images, and other non-textual files delivered by patent offices from the CLAIMS Direct data warehouse.

Table of Contents

Panel

title	Related Pages

Attachment Server Description and Coverage

/attachment/list

Method	GET
Path	`/attachment/list`

Parameter

Parameters		Values	Description
	@ucid	String:

ex

e.g., US-20100077592-A1	Document identifier
@multi	Boolean: 1\|0	Specifies an alternative response format suitable for multi-ucid input, e.g., ?ucid=US-5551212-A,EP-0700000-A2

Single UCID

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws21.ificlaims.com/attachment/list?ucid=US-20100077592-A1'

Response JSON

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 */
   ],
}

Response XML

Code Block

language	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>

Multiple UCIDs

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws21.ificlaims.com/attachment/list?ucid=EP-0700000-A2,EP-0700000-B1&multi=1'

Response JSON

Code Block

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

language	xml

<?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, the HTTP 204 (response code 404 Not Found ) will be returned if the @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.

File	Extension	@media
Tagged Image Format	TIF(F)	image/tiff
Extensible Markup Language	XML	text/xml
Chemical Expression	MOL	application/chemexpres
Mathmatica	NB	application/mathmatica
ChemDraw	CDX	application/chemdraw
Portable Document Format	PDF	application/pdf
PostScript	POS	application/postscript
JPEG	JPG	image/jpeg
Portable Network Graphics	PNG	image/png

@path

The relative path by which the attachment can be retrieved in a subsequent call using /attachment/fetch

@size Size, in bytes, of attachment

@filename Name of file as stored in the attachments server

/attachment/fetch

Method	GET
Path	`/attachment/fetch`

Parameter

Parameters Values Description

@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

Request

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password: y' \ 'http://cdws21.ificlaims.com/attachment/fetch?path=/EP/19960306/A2/000000/70/00/00/imgaf001.tif'

Response

The request Accept header 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.

/attachment/fetchall

Method	GET
Path	`/attachment/fetchall`
Parameters		Values	Description
Parameters	@ucid	String: e.g., EP-0700000-B1	Document identifier

Request

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/attachment/fetchall?ucid=EP-0700000-B1'

Response

The request Accept header is irrelevant with regard to response format. In the event of a system failure involving attachment availability between calls to /attachment/list and /attachment/fetchfetchall, 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 or be certain the ucid has attachments. Content-Type returned is application/zip.

/attachment/pdf

Method	GET
Path	`/attachment/pdf`

Parameter

Parameters		Values	Description
Parameters	@ucid	String: e.g., EP-0700000-B1	Document identifier

Request

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/attachment/pdf?ucid=US-20160000001-A1'

Response

If the request is successful, an HTTP response code of 200 along with data of type application/pdf will be returned. If no PDF file is available for the requested ucid, an the HTTP response code of 204 No Content will be returned.

/attachment/abimage

Method	GET
Path	`/attachment/abimage`

Parameter

Parameters		Values	Description
Parameters	@ucid	String: e.g., US-20160000001-A1	Document identifier

Request

Code Block
wget -O- \ --header 'x-user:x' \ --header 'x-password:y' \ 'http://cdws21.ificlaims.com/attachment/abimage?ucid=US-20160000001-A1'

Response

An Accept header during the request is allowed but not required. If the request is successful, an HTTP response code of 200 along with the abstract or first image will be returned. If no specific image type was requested via the Accept header, the returned data will be in the original format which will be listed in the Content-Type response header. If no images are available for the requested ucid, a the HTTP response code of 204 No Content will be returned.

Page tree

Versions Compared

Old Version 14

New Version 15

Key

/attachment/list

Single UCID

Response JSON

Response XML

Multiple UCIDs

Response JSON

Response XML

/attachment/fetch

Request

Response

/attachment/fetchall

Request

Response

/attachment/pdf

Request

Response

/attachment/abimage

Request

Response

Page tree

Page History

Versions Compared

Old Version 14

New Version 15

Key

/attachment/list

Single UCID

Response JSON

Response XML

Multiple UCIDs

Response JSON

Response XML

/attachment/fetch

Request

Response

/attachment/fetchall

Request

Response

/attachment/pdf

Request

Response

/attachment/abimage

Request

Response