Staff Profile

This application profile provides staff functionality such as circulating items and updating holds. The authenticated user associated with requests to this API must be a library staff member with the WMS circulation roles and permissions.

URLs and Supported Messages

All patron profile requests are made to the same endpoint. The different operations supported by each kind of request differ in the request message POSTed to the service. See the examples below for more details.

Operation Resource URL HTTP METHOD
SendMessage https://circ.{datacenter}.worldcat.org POST

HTTP Request & Response Formats

Request Messages

Response Messages

NCIP Message Fields

InitiationHeader Fields

Element Required? Description
InitiationHeader/FromAgencyId/@Scheme Yes

OCLC Registry Id Scheme URI

http://oclc.org/ncip/schemes/agencyid.scm

InitiationHeader/FromAgencyId Yes Registry ID of the library/branch in which the circulation operation is taking place
InitiationHeader/ToAgencyId Yes Must match the FromAgencyId
InitiationHeader/ApplicationProfileType Yes Must be set to "Version 2011"
InitiationHeader/ApplicationProfileType/@Scheme Yes

Must be the OCLC Platform NCIP Application Profile Scheme URI

http://oclc.org/ncip/schemes/application-profile/platform.scm

CheckIn

Element Required Description
ItemId/AgencyId Yes Registry Id of the institution to which the item belongs
ItemId/ItemIdentifierValue Yes Barcode of the Item
ItemElementType No Repeatable field which lists the information fields to return in the response

CheckOut

Element Required Description
ItemId/AgencyId Yes Registry Id of the institution to which the item belongs
ItemId/ItemIdentifierValue Yes Barcode of the Item
UserId/AgencyId Yes OCLC Registry ID of the institution to check the item out to or to which the user to check the item out to is associated
UserId/UserIdentifierValue Yes Barcode of the user to whom the item is being checked out
AcknowledgedFeeAmount/CurrencyCode/@Scheme No NCIP Currency Code Scheme URI
http://www.bsi-global.com/Technical+Information/Publications/
_Publications/tig90x.doc
AcknowledgedFeeAmount/CurrencyCode No Currency Code of the fee that is to be acknowledged
See http://www.currency-iso.org/dl_iso_table_a1.xls
AcknowledgedFeeAmount/MonetaryValue No Amount of the free to acknowledged based on the minor demonination of the specified currency.
For information on the minor denomination of a particular currency see See http://www.currency-iso.org/dl_iso_table_a1.xls
DesiredDueDate No Desired due date/time for the item, if different from that determined by policy,
Must be in ISO 8601 format. Eg - 2010-12-31T13:30:00Z
ItemElementType No Repeatable field which lists the information fields to return in the response

RequestItem

Element Required Description
UserId/AgencyId Yes OCLC Registry ID of the institution which the patron is associated with
UserId/UserIdentifierValue Yes Identifier of the patron (eg. barcode) placing the request
BibliographicId

Must be present if the RequestScope Type element is Bibliographic Item.

 

Repeatable

BibliographicId/BibliographicRecordId/BibliographicRecordIdentifier   OCLC Number of the object being requested. Bare number without prefix (ocm or ocn), padding such as leading zeros
BibliographicId/BibliographicRecordId/BibliographicRecordIdentifierCode/@Scheme  

Must be the NCIP Bibliographic Record Identifier Code Scheme URI

http://www.niso.org/ncip/v1_0/imp1/schemes/bibliographicrecordidentifiercode/bibliographicrecordidentifiercode.scm

BibliographicRecordId/BibliographicRecordIdentifierCode   OCLC
ItemId Must be present if the value of the RequestScopeType element is Item  
ItemId/ItemIdentifierValue   Barcode of the item
RequestType/@Scheme Yes

Must be the NCIP Request Scheme URI

http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm

RequestType Yes Hold
RequestScopeType/@Scheme Yes

Must be the NCIP Request Scope Type Scheme URI

http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm

RequestScopeType Yes

Scope of the request either:

  • Bibliographic Item
  • Item
EarliestDateNeeded No Must be in ISO 8601 format. Eg - 2010-12-31T13:30:00Z
NeedBeforeDate No Must be in ISO 8601 format. Eg - 2010-12-31T13:30:00Z
PickupLocation Yes OCLC Holding code for the location where the item should be picked up from
ItemElementType No Repeatable field which lists the information fields to return in the response

CancelRequestItem

Element Required Description
UserId/AgencyId Yes OCLC Registry ID of the institution which the patron is associated with
UserId/UserIdentifierValue Yes Identifier of the patron (eg. barcode) who placed the request
ItemId Either this or the RequestId must be present  
ItemId/AgencyId   OCLC Registry ID of the institution to which the item belongs
ItemId/ItemIdentifierValue   Barcode of the item
RequestId Either this or the ItemId must be present  
RequestId/AgencyId   OCLC Registry ID of the institution with which the request is associated
RequestId/RequestIdentifierValue   Request identifier returned as a result of the RequestItem operation
RequestType/@Scheme Yes

Must be the NCIP Request Type Scheme URI

http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm

RequestType Yes Must match the RequestType in the RequestItem request originally placed
RequestScopeType/@Scheme Yes

Must be the NCIP Request Scope Type Scheme URI

http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm

RequestScopeType Yes Item if the request was made at item-level or Bibliographic Item if request was made at bibliographic-level
ItemElementType No Repeatable field which lists the information fields to return in the response

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration. Learn more »