Data types reference > Web Services data types > Patron service > UserSuspensionInfo

UserSuspensionInfo

The UserSuspensionInfo type displays information about a patron's suspension.

Ancestors

None

Relevant operations

lookupMyAccountInfo
lookupPatronInfo

Contents

This type has the following elements:

Element

Type

Occ.

Description

dateSuspended

xs:date

1

Displays the date that the suspension started.

dateSuspensionEnds

xs:date

1

Displays the date on which the patron can resume borrowing materials.

suspensionKey

xs:long

1

Displays the internal key assigned to the suspension record.

linkedSuspensionKey

xs:string

1

Displays the internal key that links the user to the suspension record.

suspensionLibraryID

xs:string

1

Displays the ID of the library in which the suspension was generated.

suspensionLibraryDescription

xs:string

1

Displays the descriptive name of the library in which the suspension was generated.

suspensionReasonID

xs:string

1

Displays the reason ID for the temporary suspension of a user's borrowing privileges. These reasons may include OVERDUE, LOST, or DAMAGE.

suspensionReasonDescription

xs:string

1

Displays the reason description for the temporary suspension of a user's borrowing privileges.

suspensionType

xs:string

1

Displays the type of suspension. The suspension type is determined by policies. Examples of suspension types include Overdue or Damage.

numberOfUnits

xs:int

1

Displays the number of suspension units in effect for this suspension.

title

xs:string

0..1

Displays the title of the item, if any, for which the suspension was assessed.

itemID

xs:string

0..1

Displays the item ID of the item, if any, for which the suspension was assessed.

 


© 2009-2012 SirsiDynix