Every SOAP request you submit to Web Services must include a SirsiDynix header (SdHeader element, header.xsd). SdHeader includes these elements:
Element |
Description |
The clientID element specifies the client identifier for your application. Your client must provide a valid clientID with each request. If the clientID is invalid, the request will be rejected. Contact the library system administrator to obtain a clientID for your application. clientID is a string (see xs:string). |
|
locale |
The locale element specifies the locale that Web Services should use when returning the response. This may be a language code only (for example, “fr”) or a language and country code (for example, “fr_CA”). Case is significant. Language codes are lowercase, country codes uppercase. (For more information, see Language.) locale is a string (see xs:string). This element is optional. |
The sessionToken element identifies an active Web Services session for a specific user with specific privileges and (optionally) a specific station policy (workstationID). A valid session token must be included in the message header for all privileged operations (see Privileged operations). A Web Services client obtains a session token by using the loginUser operation (see loginUser). You end a session using LogoutUserRequest (see logoutUser). sessionToken is a string (see xs:string). |
The following shows a sample SOAP request, including the required header:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:head="http://www.sirsidynix.com/xmlns/common/header"
xmlns:sec="http://schemas.sirsidynix.com/symws/security">
<soapenv:Header>
<head:SdHeader>
<head:clientID>SampleClientID</head:clientID>
<head:locale>en</head:locale>
<head:sessionToken>a9e4341c-2697-4ac6-bb04-596940215e01<
head:sessionToken>
</head:SdHeader>
</soapenv:Header>
<soapenv:Body>
<sec:LookupUserInfoRequest>
<sec:userID>USER</sec:userID>
</sec:LookupUserInfoRequest>
</soapenv:Body>
</soapenv:Envelope>
Other elements defined in SdHeader (params, param, and version) are reserved for future expansion and are not currently implemented in Web Services. For information on how to implement this header in your application, see the sample applications or refer to the information in Searching the Catalog using Perl and Interacting with patron data using Perl.
Related topics
© 2009-2012 SirsiDynix