Services and Operations > Request service > lookupRequestTemplate

lookupRequestTemplate

The lookupRequestTemplate operation allows you to retrieve a Request Template for determining how to display the request, how to qualify entries, and how to populate a new request.

This is the only Request service operation that does not require a valid sessionToken from a user with staff level or higher privileges.

Synopsis

Service

Request service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

LookupRequestTemplateRequest

Response

LookupRequestTemplateResponse

Operation faults

None (see also Faults)

LookupRequestTemplateRequest

The LookupRequestTemplateRequest has the following request parameter:

Parameter

Type

Description

Required?

requestTypeID

xs:string

Specifies the policy ID of the Request Template. You can get a list of templates and policy IDs through the lookupRequestTypePolicyList operation.

Y

LookupRequestTemplateResponse

The LookupRequestTemplateResponse returns the following elements:

Element

Type

Occ.

Description

userIDRequired

RequiredType

1

Displays whether the user ID or alternate ID is optional, required, or ignored.

catalogKeyRequired

RequiredType

1

Displays whether the catalog key is optional, required, or ignored. The catalog key may be an item ID, call number, or catalog key.

defaultStatusID

xs:string

0..1

Displays the default status ID for the request.

defaultStatusDescription

xs:string

0..1

Displays the description of the default status for the request.

specialUse

SpecialUseType

1

Displays whether a request template is used or not.

requestEntryInfo

RequestEntryTemplateInfo

0..*

Displays additional information about each request entry for the template.

Related topics 

 


© 2009-2012 SirsiDynix