Services and Operations > Standard service > lookupTitleInfo

lookupTitleInfo

The lookupTitleInfo operation allows you to retrieve information about the number of items that are available to be checked out for titles you specify. Optionally, you can also retrieve information about a title’s items (such as owning library, call number, number of copies, current location, due dates, and so on).

Synopsis

Service

Standard service

Namespace

http://schemas.sirsidynix.com/symws/standard

Prerequisites

Valid clientID (see clientID)

Request

LookupTitleInfoRequest

Response

LookupTitleInfoResponse

Operation faults

None (see also Faults)

LookupTitleInfoRequest

Parameter

Type

Description

Required?

libraryFilter

xs:string

Specifies a library ID or Search Library group ID to use in order to limit returned data to a specific library or group of libraries. When you include libraryFilter in the request, the response includes information only for items owned by the specified library or group of libraries.

Values for this element are specific to the ILS system.

This element is optional. If you do not specify a library filter, information will be returned for all libraries in the system that own the specified title.

N

titleID and itemID are a choice. Specify a value for one or the other.

titleID

xs:long

Specifies the catalog key for a specific title in the library catalog.

You may include more than one titleID in a request.

At least one titleID (or itemID) is required.

Note: You only need to specify a titleID or an itemID. If you do not specify an itemID, you must specify a titleID.

Y

itemID

xs:string

Specifies the item ID of the specific title.

You man include more than one itemID in a request.

At least one itemID (or titleID) is required.

Note: You only need to specify an itemID or a titleID.If you do not specify a titleID you must specify an itemID.

All the “include” parameters are assumed false by default if you do not specify a value.

includeAvailabilityInfo

xs:boolean

Specifies whether you want to include availability information for each specified title in the response (true) or not (false).

N

includeItemInfo

xs:boolean

Specifies if you want to include item information for each specified title in the response (true) or not (false).

N

includeCatalogingInfo

xs:boolean

Specifies if you want to include cataloging information for each specified title in the response (true) or not (false).

N

includeOrderInfo

xs:boolean

Specifies if you want to include order information for each specified title in the response (true) or not (false).

N

includeOPACInfo

xs:boolean

Specifies if you want to include OPAC information for each specified title in the response (true) or not (false).

N

includeBoundTogether

xs:boolean

Specifies if you want to include items that are bound together in the response (true) or not (false).

N

includeMarcHoldings

xs:boolean

Specifies if you want to include MARC holdings in the response (true) or not (false).

N

marcEntryFilter

xs:string

Specifies one of the following enumeration values:

ALL
BRIEF
FULL
NONE
TEMPLATE

Note: If you do not specify a marcEntryFilter value, “NONE” is assumed by default.

N

marcEntryID

xs:string

Specifies the title MARC entry ID.

N

includeRelatedSearchInfo

xs:boolean

Specifies if you want to include related search information (true) or not (false).

N

includeCallNumberSummary

xs:boolean

Specifies if you want to include call number information (true) or not (false). This is useful for determining whether a volume-level hold request must be made on the title. For more information, see Volume holds.

N

LookupTitleInfoResponse

The LookupTitleInfoResponse references the following elements:

Element

Occ.

Description

TitleInfo

1..*

Displays title information for each title you specify in the request.

The response will include one titleInfo object for each titleID you specify.

The information that returns in LookupTitleInfoResponse may be limited to a specific library or group of libraries. For example, if you specified EAST as a libraryFilter in the request, LookupTitleInfoResponse will only display information and counts for items in the EAST library.

If the library filter or title ID specified in the request is invalid, or if there are no items for a title (for example, because it is on order and the library has not yet received copies), availability counts will be zero and there will be no callInfo.

Related topics 

 


© 2009-2012 SirsiDynix