Services and Operations > Security service > lookupUserInfo

lookupUserInfo

The lookupUserInfo operation is used to retrieve user information for a user that you specify.

Users who request another user’s information must have a privilege level of STAFF or higher, and will need to have access command code rights to command “Display 2 User.” For sites with accountability turned on, only accountable users can lookup other users with clearance settings.

Synopsis

Service

Security service

Namespace

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

Prerequisites

Valid clientID (see clientID)
sessionToken (see sessionToken)

Request

LookupUserInfoRequest

Response

LookupUserInfoResponse

Operation faults

None (see also Faults)

LookupUserInfoRequest

LookupUserInfoRequest has the following request parameters:

Parameter

Type

Description

Required?

userID

xs:string

Specifies which user’s information to pull.

userID is typically a barcode, but depending on the ILS configuration, could be any string.

Y

includeAccountability

xs:boolean

Indicates if the LookupUserInfoResponse should include accountability information (true) or not (false).

If you do not specify a value, the system assumes “false” by default.

N

includeAllowedCommands

xs:boolean

Indicates if the LookupUserInfoResponse should include a list of allowed commands (true) or not (false).

If you do not specify a value, the system assumes “false” by default.

N

LookupUserInfoResponse

The LookupUserInfoResponse returns the following elements:

Element

Type

Occ.

Description

userID

xs:string

1

Displays the actual ILS user identifier.

userID is typically a barcode, but depending on the ILS configuration, could be any string.

displayName

xs:string

1

Displays the user’s full name.

displayName is a string (see xs:string).

privilegeLevel

PrivilegeLevel

1

Displays the enumerated value for the user’s user level on the Symphony server.

sharedLogin

xs:boolean

1

The ILS server limits operations that can be performed by a user account with access type SHARED.

The sharedLogin element specifies if the user account that was used to start a Web Services session is a shared account (true) or not (false).

validUser

xs:boolean

1

The validUser element will always return true.

libraryID

xs:string

1

Displays the ID of the user’s assigned library policy.

accessID

xs:string

1

Displays the ID of the user’s assigned access policy. This designates what access rights the user has been granted.

environmentID

xs:string

1

Displays the ID of the user’s assigned environment policy.

allowedCommand

xs:string

0..*

If you used includeAllowedCommands in the LookupUserInfoRequest, then a list of all enabled command codes for the user will be returned in the LookupUserInfoResponse.

This response also references the following elements:

Element

Occ.

Description

AccountabilityInfo

0..1

If you used includeAccountability in the LookupUserInfoRequest, then several AccountabilityInfo elements may be returned in the LookupUserInfoResponse.

Related topics 

 


© 2009-2012 SirsiDynix