Patron Profile

This application profile provides patron functionality such as viewing user account information, hold management and renewing materials.

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://{WorldCat_Registry_ID}.share.worldcat.org/ncip/circ-patron POST

HTTP Request & Response Formats

All NCIP XML will conform to the NCIP specification and OCLC's extensions:

Request Messages

Response Messages

NCIP Message Fields

InititationHeader Values

The messages posted to the WMS NCIP API will expect a few pre-defined values for certain fields in the InitiationHeader element.

Element Required? Description Expected Value
InitiationHeader/FromAgencyId/@Scheme Yes OCLC Registry Id Scheme URI http://oclc.org/ncip/schemes/agencyid.scm
InitiationHeader/FromAgencyId Yes Library/branch in which the circulation operation is taking place {WorldCat_Registry_ID}
InitiationHeader/ToAgencyId Yes Presently, the same value as the FromAgencyId {WorldCat_Registry_ID}
InitiationHeader/ApplicationProfileType Yes -- need description -- Version 2011
InitiationHeader/ApplicationProfileType/@Scheme Yes Must be the OCLC Platform NCIP Application Profile Scheme URI http://oclc.org/ncip/schemes/application-profile/wcl.scm

Lookup User Fields

Element Required Description Expected/Sample Values
UserId/UserIdentifierValue Yes Identifier representing the patron placing the request {OCLC_Principal_ID}
LoanedItemsDesired

No

Flag field to indicate whether or not to show the LoanedItems in the Response

The presence of this field indicates to show this information.

(blank node)
RequestItemsDesired No Flag field to indicate whether or not to show the RequestItems in the Response. The presence of this field indicates to show this information. (blank node)
UserFiscalAccountDesired No Flag field to indicate whether or not to show the UserFiscalAccount information in the Response. The presence of this field indicates to show this information. (blank node)
Ext No Extension elements -- need examples --
Ext/ResponseElementControl No
-- need description --

One of

  • LoanedItemsDesired
  • RequestedItemsDesired
  • UserFiscalAccountDesired
Ext/ResponseElementControl/ElementType No
 

The element that you are setting start, maximiumCount, SortField, and SortOrderType for

One of
  • Account Details
  • Loaned Items
  • Requested Item
Ext/ResponseElementControl/ElementType/@Scheme No -- need description -- http://worldcat.org/ncip/schemes/v2/extensions/elementtype.scm
Ext/ResponseElementControl/StartElement No The record to start showing items on 11
Ext/ResponseElementControl/MaximiumCount No The number of records to display 20
Ext/ResponseElementControl/SortField No The field to sort by -- need examples --
Ext/ResponseElementControl/SortField/@Scheme No -- need description -- http://worldcat.org/ncip/schemes/v2/extensions/accountdetailselementtype.scm
Ext/ResponseElementControl/SortOrderType No The sort order

One of

  • Ascending
  • Descending
Ext/ResponseElementControl/SortOrderType/@Scheme No -- need description -- http://worldcat.org/ncip/schemes/v2/extensions/sortordertype.scm

Renew Item Fields

Element Required Description Expected/Sample Values
UserId/AgencyId Yes Library/branch ID of the institution with which the patron is associated {WorldCat_Registry_ID}
UserId/UserIdentifierValue Yes Identifier representing the patron placing the request {OCLC_Principal_ID}
ItemId/AgencyId Yes Library/branch ID of the institution with which the circulating item is associated {WorldCat_Registry_ID}
ItemId/AgencyId Yes Library/branch ID of the institution with which the request is associated {WorldCat_Registry_ID}

Request Item Fields

Element Required Description Expected/Sample Values
UserId/AgencyId Yes Library/branch ID of the institution which the patron is associated with {WorldCat_Registry_ID}
UserId/UserIdentifierValue Yes Identifier representing the patron placing the request {OCLC_Principal_ID}
BibliographicId

Yes

The identifier data for the item being requested.

This element is repeatable.

(see child nodes)
BibliographicId/BibliographicRecordId/BibliographicRecordIdentifier Yes OCLC Number of the object being requested. Bare number without prefix (ocm or ocn), padding such as leading zeros {OCLC_number}
BibliographicId/BibliographicRecordId/BibliographicRecordIdentifierCode/@Scheme Yes The NCIP Bibliographic Record Identifier Code Scheme URI http://www.niso.org/ncip/v1_0/imp1/schemes/bibliographicrecordidentifiercode/bibliographicrecordidentifiercode.scm
BibliographicRecordId/AgencyId Yes OCLC Registry ID of the institution which the record is associated with {WorldCat_Registry_ID}
RequestType/@Scheme Yes The NCIP Request Scheme URI http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm
RequestType Yes The type of NCIP request being made Hold
RequestScopeType/@Scheme Yes 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

Bibliographic Item
EarliestDateNeeded No ISO 8601 formatted earliest date needed. The request should not be fulfilled prior to this date.
2010-12-31T13:30:00Z
NeedBeforeDate No ISO 8601 formatted date needed before. The request will be canceled if not fulfilled by this date.
2010-12-31T13:30:00Z
PickupLocation Yes

The BranchID for the OCLC Holding code for the location where the item should be picked up from.

To see a list of holding codes for a given insitution use the OCLC Config web service and make a holding code request.

{WorldCat_Registry_ID}
ItemElementType No Repeatable field which lists the information fields to return in the response -- need examples --

Update Request Item Fields

Element Required Description Expected/Sample Values
UserId/AgencyId Yes Library/branch ID of the institution which the patron is associated with {WorldCat_Registry_ID}
UserId/UserIdentifierValue Yes Identifier representing the patron placing the request {OCLC_Principal_ID}
RequestId Yes The identifier data for an existing request (child nodes)
RequestId/AgencyId Yes OCLC Registry ID of the institution for which the request is associated with {WorldCat_Registry_ID}
RequestId/RequestIdentifierValue Yes Request identifier returned as a result of the RequestItem operation or in the LookupUser response {WMS_Request_UUID}
DeleteRequestFields No

The fields which you want to be deleted from the request

Either DeleteRequestFields or AddRequestFields must be present

One of

  • PickupLocation
  • EarliestDateNeeded
  • NeedBefore
  • SuspensionStartDate
  • SuspensionEndDate
AddRequestFields No

The fields which you want to add to the request

Either DeleteRequestFields or AddRequestFields must be present

One of

  • PickupLocation
  • EarliestDateNeeded
  • NeedBefore
  • SuspensionStartDate
  • SuspensionEndDate
ItemElementType No Repeatable field which lists the information fields to return in the response -- needs example --

Cancel Request Item Fields

Element Required Description Expected/Sample Values
UserId/AgencyId Yes Library/branch ID of the institution which the patron is associated with {WorldCat_Registry_ID}
UserId/UserIdentifierValue Yes Identifier representing the patron placing the request {OCLC_Principal_ID}
RequestId Yes The identifier data for an existing request (child nodes)
RequestId/AgencyId Yes OCLC Registry ID of the institution for which the request is associated with {WorldCat_Registry_ID}
RequestId/RequestIdentifierValue Yes Request identifier returned as a result of the RequestItem operation or in the LookupUser response {WMS_Request_UUID}
RequestType Yes The type of NCIP request being made Hold
RequestScopeType/@Scheme Yes 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

Bibliographic Item
RequestScopeType/@Scheme Yes

The NCIP Request Scope Type Scheme URI

 

http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm
ItemElementType No Repeatable field which lists the information fields to return in the response -- need examples --

Notes

All requests to the service must set the an HTTP Content-Type header with a value of "application/xml".

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 »