NCIP Reponses
NCIP responses take the form of an XML document containing the appropriate information. Each message returns a specific set of fields and information, some of these fields can be configured based on the NCIP request.
All responses must include the following fields
| Element | Required? | Description |
|---|---|---|
| ResponseHeader/FromAgencyId/@Scheme | Yes | OCLC Registry Id Scheme URI http://oclc.org/ncip/schemes/agencyid.scm |
| ResponseHeader/FromAgencyId | Yes | Registry ID of the library/branch in which the circulation operation is taking place |
| ResponseHeader/ToAgencyId | Yes | Must match the FromAgencyId |
CheckIn
| 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 | The OCLC registry ID of the institution that the item was previously checked out to. |
| UserId/UserIdentifierValue | Yes | The barcode of the user that the item was previously checked out to. |
| FiscalTransactionInformation | If bill is created as result of operation | |
| RoutingInformation | Yes | Details about what the next action that should occur to the item is. |
| RoutingInformation / RoutingInstructions | Yes | Information about what the next action should be:
|
| RoutingInformation / UserId / UserIdentifierValue | if the item is being routed for a request | The barcode of the user that the item was requested for |
| RoutingInformation / Destination / Location / LocationType / @Scheme | Yes | Must be the NCIP Location Type Scheme URI http://www.niso.org/ncip/v1_0/imp1/schemes/ locationtype/locationtype.scm |
| RoutingInformation / Destination / Location / LocationType | Yes | The literal string “Current”. |
| RoutingInformation / Destination / Location / LocationName / LocationNameInstance / LocationNameLevel | Yes | Level 1: the holding code Level 2: the shelving location |
| RoutingInformation / Destination / Location / LocationName / LocationNameInstance / LocationNameValue | Yes | The location information. |
| RoutingInformation / Destination / Location | Yes | Level 1: the holding code associated with a branch that is the destination for the item. Level 2: the shelving location at the branch that is the destination for the item (optional). |
| RoutingInformation / Name Information | If the item is being routed to satisfy a request | The name of the individual or institution that the item is for. The name of the individual will be in the fields of the PersonNameInformation / StructuredPersonalUserName field. The name of the institution will be in the OrganizationNameInformation / OrganizationName field. |
| RoutingInformation / RequestType / @Scheme | If the item is being routed to satisfy a request | Must be the NCIP Request Type Scheme URI http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm |
| RoutingInformation / RequestType | If the item is being routed to satisfy a request | The type of request if the item is being routed to satisfy a request.
|
| RoutingInformation / UserId /AgencyId | If the item is being routed to satisfy a request | The OCLC registry ID of the institution that the item was requested for |
| ItemOptionalFields | No | Requested optional item fields |
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 |
| DueDate | Yes | The date/time that the item is due to be returned by Must be in ISO 8601 format. Eg - 2010-12-31T13:30:00Z |
| FiscalTransactionInformation | If a bill is created as a result of the operation | |
| RenewalCount | Yes | Number of times the items has been renewed. |
| ItemOptionalFields | No | Requested optional item fields |
RequestItem
| Element | Required | Description |
|---|---|---|
| RequestId | Present if the responding system was unable to determine the item that will be used to fill this request at the time the service was invoked. The value will be the same as the value of RequestId of the associated request. | |
| RequestId/AgencyId/@Scheme | Yes | Must be the OCLC Regstry Id Scheme URI (see Section 10 of this Profile). |
| RequestId/AgencyId | Yes | Must be the Regstry Id of the library with which the RequestIdentifierValue is associated. |
| RequestId/RequestIdentifierValue | Yes | Must be the same value as the RequestId / RequestIdentifierValue of the associated request. |
| UserId/AgencyId | Yes | Must be identical to the UserId in the Request Item message that invoked the service. |
| UserId/UserIdentifierValue | Yes | Must be identical to the UserId in the Request Item message that invoked the service. |
| RequestType/@Scheme | Yes | Must be the NCIP Request Scheme URI http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm |
| RequestType | Yes | Must be identical to the RequestType in the Request Item message that invoked the service. |
| 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 | Must be “Item” if the responding system was able to determine the item that will be used to fill this request at the time the service was invoked; otherwise “Bibliographic Item”. |
| ItemOptionalFields | No | Requested optional item fields |
CancelRequestItem
| Element | Required | Description |
|---|---|---|
| UserId | Yes | Must be identical to the UserId in the Cancel Request Item message that invoked the service. |
| UserId/AgencyId | Yes | |
| UserId/UserIdentifierValue | Yes | |
| ItemId | Either this or the RequestId must be present | Must be identical to the ItemId in the Cancel Request Item message that invoked the service. |
| ItemId/AgencyId | ||
| ItemId/ItemIdentifierValue | ||
| RequestId | Either this or the ItemId must be present | Must be identical to the RequestId in the Cancel Request Item message that invoked the service. |
| RequestId/AgencyId | ||
| RequestId/RequestIdentifierValue | ||
| ItemOptionalFields | No | Requested optional item fields |
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: