OCLC Policy Directory Web Service

Parameters

1. instSymbol

   
   The instSymbol URI parameter can be used in lieu of including the inst in the URI path. For example, the following are equivalent URIs.
   
   
   • https://illpolicies.oclc.org/illpolicies/servicePolicy/{inst}
   • https://illpolicies.oclc.org/illpolicies/servicePolicy?instSymbol={instSymbol}
   
   If both the inst and instSymbol are provided and they represent different institutions, an HTTP 400 (Bad Request) error is returned.
   

2. inst

   
   The inst URI parameter can be used in the Service Policy Aggregate Fees requests. Multiple inst parameters are accepted. Example:
   
   
   • https://illpolicies.oclc.org/illpolicies/servicePolicy/servicePolicyAggregateFees?inst={inst}
   • https://illpolicies.oclc.org/illpolicies/servicePolicy/servicePolicyAggregateFees?inst={inst},{inst}
   
   If no inst parameters are provided, the request's body will be examined and comma separated institution ids or symbols will be accepted.
   Otherwise HTTP 400 (Bad Request) error is returned.
   

3. groupSymbol

   
   The groupSymbol URI parameter can be used in lieu of including the groupId in the URI path. For example, the following are equivalent URIs.
   
   
   • https://illpolicies.oclc.org/illpolicies/servicePolicyGroup/{groupId}
   • https://illpolicies.oclc.org/illpolicies/servicePolicyGroup/?groupSymbol={groupSymbol}
   
   If both the groupId and groupSymbol are provided and they represent different groups, an HTTP 400 (Bad Request) error is returned.
   

4. serviceType

   
   This URI parameter is used to limit Service Policy Policy queries to a given service type. Supported values:
   
   
   • COPY
   • LOAN
   • COPY_LOAN
   
   

5. policyType

   
   This URI parameter is used to limit Service Policy Policy queries to a given policy type. Supported values:
   
   
   • SHARING
   • DEFLECTION
   • DEFLECTION_LAST_RESORT
   • DEFLECTION_DISABLED
   
   

6. wskey

   
   The wskey parameter overrides the wskey value passed in the HTTP header. For security reasons, it is strongly recommend passing the token via the HTTP header.
   
   The web service requires a wskey token authorized for the "policiesDirectoryAPI" service.

7. updatedMin and updatedMax

   
   The lower bound is inclusive, whereas the upper bound is exclusive. Use RFC 3339 Timestamp Format.
   Example:
   
   
   updatedMin=2009-11-30T15:00:09.375-05:00&updatedMax=2011-11-30T15:00:09.375-05:00
   
   

8. q

   
   The search query parameter. Supported search criteria:
   
   
   • NAME - institution name. Use quotes with multi-word names. Limited to 1 name per query
   • GROUP - group affiliation name. Use quotes with multi-word names. Limited to 1 group per query
   • SUPPLIER - Y or N
   • STATE - full region/state name or state code. Use underscores in place of spaces
   • COUNTRY - full country name or two digits ISO code. Use underscores in place of spaces
   • FORMAT - format name. Use underscores in place of spaces
   • FEE - numeric fee (2 or 2.50). Limited to 1 fee per query
   • CURRENCY - three letter ISO code or full currency name. Use underscores in place of spaces
   • DELIVERYMETHOD - 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 - 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.
   • DAYSTORESPOND - the following values are supported: 8, 12, 16, and 20.
   • TYPE - used for group search, the following values are supported: GAC, GAC_UL, UL, REFERRAL, NON_REFERRAL.
   
   Example:
   
   
   q=state:MA%20AND%20state:OH%20AND%20supplier:Y