Request Types
All types of requests to the API require a valid Authorization header containing a valid HMAC signature.
Uploading a Document
A successful upload request to the Article Exchange API is constructed using the following url pattern:
https://ill.sd00.worldcat.org/articleexchange/?autho=[ID]&password=[password]
The API will only accept requests via the HTTP POST method with a multipart HTTP Content-Type Header
multipart/form-data
The multipart HTTP request consists of binary file being uploaded with one of the following MIME Types.You must set the content-type within the body of the multipart request and it must match one of the following MIME Types:
- image/jpeg
- image/jp2
- image/jpx
- image/jpm
- image/tiff
- image/png
- image/gif
- image/bmp
- application/pdf
- image/vnd.ms-modi
- application/zip
Description of Parameters
In addition to the file itself, the request also may include parameters
| Parameter | description |
|---|---|
| autho | OCLC authorization number. (REQUIRED) |
| password | OCLC password. (REQUIRED) |
| requesterInstSymbol | Requester OCLC symbol |
| requesterEmail | Requester email address |
| oclcRequestId | OCLC ILL Request number |
| illiadRequestId | Illiad transaction number |
| vdxRequestId | VDX request number |
| jTitle | Journal Title |
| aTitle | Article Title |
| aAuthor | Article Author |
| aVolume | Article Volume |
| aIssue | Article Issue |
| aDate | Article Date |
| aPages | Article Pages |
Example
POST /articleexchange//articleexchange/?autho=102-900-527&password=test HTTP/1.1
Host: ill.sd00.worldcat.org
Connection: close
User-Agent: Platform PHP Test Client
Accept: application/atom+xml
Authorization: http://www.worldcat.org/wskey/v2/hmac/v1 clientId="tsFsoBXToV1uR8GEMJCcxz9NYpVvutsA5cJAD9cnKUc4FGYEntM6UkcIVlYp4ZhYFteVLAxOWJDUV85W", timestamp="1362760533", nonce="44543195", signature="jgyjfRoPEzDotNq+yEzjRXydp/sFGxWtOPJQ2gBnnQE="
Content-Type: multipart/form-data; boundary=---HTTPCLIENT-364df2d228844ecc0b45d28d93758f98
Content-Length: 245
-----HTTPCLIENT-364df2d228844ecc0b45d28d93758f98
Content-Disposition: form-data; name="Article Upload"; filename="test_pdf.pdf"
Content-Type: application/pdf
Article Upload
-----HTTPCLIENT-364df2d228844ecc0b45d28d93758f98--
Downloading a Document
A successful download request to the Article Exchange API is constructed using the following URK:
https://ill.sd00.worldcat.org/articleexchange/?shorturl=[url]&password=[password]
This returns the file in the format it was originally uploaded.
Description of Parameters
| Parameter | description |
|---|---|
| shorturl | Short url for accessing the document. (REQUIRED) |
| password | Password for accessing document. (REQUIRED) |
Accept Header
Clients can specify the type of document they are willing to accept using the HTTP Accept Header. The following Accept Headers are valid:
- image/jpeg
- image/jp2
- image/jpx
- image/jpm
- image/tiff
- image/png
- image/gif
- image/bmp
The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »
© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates
Follow the OCLC Developer Network: