Lookup Item Set
Sample XML request and responses for Lookup Item Set service.
Lookup User
Sample XML request and responses for Lookup User service.
XC NCIP Provider
The XC NCIP Provider module facilitates the communication between the eXtensible Catalog Drupal Toolkit and XC NCIP Toolkit. The module implements hooks provided by the XC Authentication and XC Account modules and returns values to the XC ILS module to perform some critical roles tasks:
- logging users into remote authentication systems via NCIP
- fetching personal account information with the Drupal Toolkit
- fetching and displaying circulation status
NCIP applications
The XC NCIP Provider module utilizes APIs within the NCIP module to create two NCIP applications (xc_ncip_provider and xc_ncip2_provider), in order to manage multiple connections between the Drupal Toolkit and multiple instances of the NCIP Toolkit. The application used to connect to an instance of the NCIP Toolkit is determined by the major versions of both NCIP and the NCIP Toolkit.
Configuring NCIP Toolkits
The module also manages configured NCIP servers or NCIP Toolkit instances to which Drupal may connect. Each configuration must have a protocol, host, path, and port for connecting as well as a specified version, in order for the XC NCIP Toolkit module to determine which NCIP application it will use for connections. Other properties, such as the "to" agency ID can also be configured.
NCIP services
The following NCIP services are supported by the XC NCIP Provider module for connections to NCIP Toolkits. Although there is some support for version 1, we strongly recommend using version 2, unless you are already using version 1 of NCIP.
| Service name | Version 1 | Version 2 | Notes |
|---|---|---|---|
| Authenticate User | Yes | No | This service is supported in version 1 only and requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard |
| Lookup Version | Yes | Maybe | Although the appropriate XML request may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Lookup Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Lookup Item Set | No | Yes | This service is an extension to the NCIP protocol for version 2 only |
| Lookup User | Yes | Yes | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard |
| Check Out Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Check In Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Request Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Recall Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| Renew Item | Yes | Maybe | Requests to and responses from version 1 of the NCIP Toolkit may not fully comply with the NCIP protocol standard and, although the appropriate XML requests may be generated for version 2, the service is not currently supported by the NCIP Toolkit |
| XC Get Availability | Yes | No | This service is an extension to the NCIP protocol for version 1 only |
XML construction and parsing
The XC NCIP Provider module constructs XML using message objects provided by the NCIP module. The message constructed and sent, then subsequently received, parsed, and delivered as structured information to other modules, such as the XC ILS, XC Search, XC Authentication, and XC Account modules.
Testing
Testing NCIP messages (requests and responses) can be accomplished through the test interface for each NCIP server configured with the XC NCIP Provider module. Click on one of the highlighted services above or visit the NCIP Toolkit project page on Google Code for sample XML requests to use on this interface. Responses are returned as XML.
Other resources
For more information about the NCIP Toolkit, including sample XML requests and responses, visit the project page (for version 2) on Google Code: http://code.google.com/p/xcncip2toolkit.
Guide maintainers
