Selecting patron self-edit fields in Web Services for Horizon
This topic describes the attributes in Web Services associated with patron contact information. Each field can be set to one of the following values:
- Disabled – Patron users cannot see or modify the field.
- Read-only – Patron users can see the field's value, but cannot modify it.
- Editable – Patron users can see and modify the field's value.
You may want to make some of these fields editable by the patron and keep the patron from editing other fields. For example, you may want to allow patrons to change their email addresses (emailAddress), but you probably do not want them to have control over whether they have been approved to check out items (approved). The patron information associated with each field is listed below to help you make those decisions.
Enterprise recognizes which fields are enabled and disabled for editing in the Web Services Admin console and only allows patrons to enter information into editable fields.
Most of the fields are automatically displayed in the patron interface with user-friendly labels. However, for certain fields, you must set user-friendly labels the same way you would make any other custom label change. For more information on this, contact SirsiDynix Customer Support.
| |
Because of an issue in Web Services 2016.08.1, when the code and data fields are set to hidden within Web Services but any of the Policy Key values are set to something other than Hidden, an error occurs that causes never-ending loading spinners within the patron information tab in My Account. This problem will be fixed in a later release of Web Services. |
| |
Setting the patron self-edit options may require coordination with your Web Services administrator. To learn how to set each of these fields as editable, see the "Resource Security Configuration" help topic in the Horizon Web Services Admin Guide. |
/user/patron
The following table contains fields that are associated with general patron information:
| Field | Description |
|---|---|
|
alternateID |
Specifies the alternate ID of the patron user. |
|
approved |
Specifies whether or not the patron user has been permitted to perform circulation actions, if the patron user was self-registered. |
|
birthDate |
Specifies the date of birth of the patron user. |
|
displayName |
Specifies how the patron user wants his or her name to display in library communications. |
|
grade |
Specifies the grade in school to which the patron user belongs, if applicable. |
|
homeroom |
Specifies the homeroom of the patron user, if applicable. |
|
language |
Specifies the language the patron user wants to use for library communications. |
|
lastCKODate |
Specifies the last date the patron user checked out any library materials. |
|
lastUpdateDate |
Specifies the last date a modification was made to the patron user's record. |
|
LDAPDN |
Specifies the Distinguished Name level to which the patron user belongs, if LDAP has been configured. |
|
library |
Specifies the library to which the patron user belongs. |
|
note |
Specifies any notes the patron user wants to make on his or her record. |
|
noticeToGuardian |
Specifies whether or not the library system can send notices intended for the patron user to the patron user's specified guardian. |
|
numberOfCKO |
Specifies the number of items the patron user currently has checked out. |
|
parentGuardianName |
Specifies the name of the patron user's parent or guardian, if applicable. |
|
patronType |
Specifies the type of patron. |
|
privilegeExpiresDate |
Specifies the date on which the patron user's circulation privileges expire. |
|
registeredDate |
Specifies the date on which the patron user was registered in the library system. |
|
selfRegistered |
Specifies whether or not the patron user registered using self-registration. |
|
teacher |
Specifies the name of the patron user's teacher, if applicable. |
/user/patron/address
The following table contains fields that are associated with patron contact information:
| Field | Description |
|---|---|
|
beginDate |
Specifies the date on which the library should begin to use this address. |
|
cityST |
Specifies the city and state of the patron user's address. |
|
emailAddress |
Specifies the patron user's email address. |
|
emailName |
Specifies a name for the system to use in email correspondence. Usually the patron user's name. |
|
endDate |
Specifies the date on which the library should no longer continue to use this address. |
|
line1 |
Specifies the first line of the patron user's address. |
|
line2 |
Specifies the second line of the patron user's address. |
|
line3 |
Specifies the third line of the patron user's address. |
|
line4 |
Specifies the fourth line of the patron user's address. |
|
mailSortType |
Specifies the way mail to the address is sorted. |
|
noticeBy |
Specifies whether notices are sent to this address by standard mail or by email. |
|
postalCode |
Specifies the postal code of the patron user's address. |
|
preOverdue |
Specifies whether or not the patron user has opted into receiving pre-overdue notices. |
|
type |
Specifies the type of address. |
user/patron/phone
The following table contains fields that are associated with information about the patron's availability by phone:
| Field | Description |
|---|---|
|
countryCode |
Specifies the country code of the patron user's phone number. |
|
general |
Specifies whether or not the patron user has opted into receiving general notices via phone. |
|
holds |
Specifies whether or not the patron user has opted into receiving hold notices via phone. |
|
number |
Specifies the phone number of the patron user. |
|
overdues |
Specifies whether or not the patron user has opted into receiving overdue notices via phone. |
|
phoneType |
Specifies the type of phone associated with the phone number. |
|
preOverdues |
Specifies whether or not the patron user has opted into receiving pre-overdue notices via phone. |