Services and Operations > Standard service > searchInfoDesk

searchInfoDesk

The searchInfoDesk operation allows you to execute a keyword search of the library catalog using an Info Desk lookup.

Synopsis

Service

Standard service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

SearchCatalogRequest

Response

SearchCatalogResponse

Operation faults

None (see also Faults)

SearchInfoDeskRequest

The SearchInfoDeskRequest has the following request parameters:

Parameter

Type

Description

Required?

infoDesk and customInfoDesk are a choice. Specify a value for one or the other.

infoDesk

InfoDesk

Specifies the enumerated info desk value.

Note: You only need to specify an infoDesk or a customInfoDesk value. If you do not specify an infoDesk value, you must specify a customInfoDesk value.

Y

customInfoDesk

xs:string

Specifies any custom info desk value for a search that was previously created and saved in Symphony.

Note: You only need to specify a customInfoDesk or an infoDesk value. If you do not specify a customInfoDesk value, you must specify an infoDesk value.

hitsToDisplay

xs:nonNegativeInteger

Specifies the maximum number of results to return in the response.

N

filters

SearchCatalogFilters

Specifies any filters you want to apply to your catalog search.

N

includeAvailabilityInfo

xs:boolean

Specifies if you want to include title availability information (see TitleAvailabilityInfo) in the response (true), or not (false).

Note: If you do not specify a value, the system will assume “false” by default.

N

SearchInfoDeskResponse

The SearchInfoDeskResponse returns a SearchCatalogResult data type (see SearchCatalogResult).

If you set includeAvailabilityInfo to “true,” then TitleAvailabilityInfo will be included for each title on the hitlist. (For more information, see TitleAvailabilityInfo.)

Related topics 

 


© 2009-2012 SirsiDynix