Institution Resource
What is the Institution Resource?
The Institution Resource will allow access to a specific institution's institution data, return the supplier status, and allow institutions to be searched by a variety of indices.
URLs and Supported Requests
The Institution Resource supports three operations.
Operation |
Resource URL | HTTP METHOD |
|---|---|---|
| Read | https://ill.sd00.worldcat.org/illpolicies/servicePolicy/{institution ID}/servicePolicyInstitution/ | GET |
| Supplier Status | https://ill.sd00.worldcat.org/illpolicies/servicePolicy/{institution ID}/servicePolicyInstitution/supplier | GET |
| Search | https://ill.sd00.worldcat.org/illpolicies/institutionsearch?q={query} | GET |
HTTP Accept Types
- Read: application/atom+xml
- Supplier Status: application/atom+xml
- Search: application/atom+xml
Parameters for Search
| Parameter | Required | Notes |
|---|---|---|
| name |
No | Institution name. Use quotes with multi-word names. Limited to 1 name per query |
| group | No | Group affiliation name. Use quotes with multi-word names. Limited to 1 group per query |
| supplier | No | Y or N |
| state | No | Full region/state name or state code. Use underscores in place of spaces |
| country | No |
Full country name or two digits ISO code. Use underscores in place of spaces |
| format | No | Format name. Use underscores in place of spaces |
| fee | No | Numeric fee (2 or 2.50). Limited to 1 fee per query |
| currency | No | Three letter ISO code or full currency name. Use underscores in place of spaces |
| deliverymethod | No | the following values are supported: OTHER, AIR_MAIL, ARIEL_EMAIL, ARIEL_FTP, BORROWER_PICKUP, EMAIL, COURIER, FAX_LOCAL, ILLIAD_ODYSSEY, MAIL, POST_ON_FTP_SERVER, POST_ON_WEB_SERVER, PROSPERO, ARTICLE_EXCHANGE |
| billingmethod | No | the following values are supported: BILLS_NOT_ISSUED, EFTS, INVOICE_MONTHLY, INVOICE_PERIODICALLY, INVOICE_TO_FOLLOW, INVOICE_WITH_ITEM, OCLC_IFM, CREDIT_CARD, IFLA_VOUCHER. |
Example Url
To return institution data for an institution that has the ID 117623:
GET https://ill.sd00.worldcat.org/illpolicies/servicePolicy/117623/servicePolicyInstitution/
To return supplier status data for an institution that has the ID 117623:
GET https://ill.sd00.worldcat.org/illpolicies/servicePolicy/117623/servicePolicyInstitution/supplier
To search and return a list of institutions that are suppliers in Massachusetts (MA):
GET https://ill.sd00.worldcat.org/illpolicies/institutionsearch/q=state:MA AND supplier:Y
Example Queries
To search for the institution name 'American':
q=name:American
To search institutions in the group AMINET:
q=group:AMINET
To search for suppliers in the state of MA:
q=state:MA AND supplier:Y
To search for institutions in Afghanistan and Albania:
q=country:AF AND country:AL
To search for format:book and fee:0 in the state of MA:
q=format:book AND fee:0 and state:MA
To search for suppliers in the state of MA with currency USD and EU_EURO:
q=state:MA AND supplier:Y AND currency:USD and currency:EU_EURO
To search for suppliers in the state of MA with the delivery method AIR_MAIL and ARTICLE_EXCHANGE:
q=state:MA AND supplier:Y AND deliveryMethod:AIR_MAIL AND deliveryMethod:ARTICLE_EXCHANGE
To search for suppliers in the state of MA with the billing method CREDIT_CARD and OCLC_IFM:
q=state:MA AND supplier:Y AND billingMethod:CREDIT_CARD AND billingMethod:OCLC_IFM
Notes
Search queries must be url encoded. So q=state:MA AND supplier:Y becomes q=state:MA%20AND%20supplier:Y
The only operator supported at this time is AND.