The following section describes the field tags for ResCenter:
Patron Field Tags
|
Field Tag |
Value |
Description |
|
IDNUMBER |
Alphanumeric string |
•REQUIRED tag. •Identifies patron associated with this record. •If the PATRONLOOKUPTYPE value in the Header Section is set to ID, then the following is true: o ID length varies per institution and is set at installation. o Patron is added if the ID does not already exist in the system and the ADDTOHMS option is not set to zero (0). •If the PATRONLOOKUPTYPE value in the Header Section is set to ALTID, the following is true: o Exactly one patron record must exist in the system for the given Alternate ID o If the system is unable to find any patron record by the alternate ID (or more than one patron is found), then the record fails. •Relates to: CARDNUMBER |
|
NEW_IDNUMBER |
Alphanumeric string |
•Change patron’s ID to the ID number. •Up to 250 characters. •The NEW_IDNUMBER must match the institution’s defined ID length (same length as IDNUMBER). |
|
ALT_IDNUMBER |
Alphanumeric string |
•Alternate ID for the patron. •Up to 250 characters. |
|
FIRSTNAME |
Text |
•Patron’s first name. •Up to 40 characters. •Relates to: MIDDLENAME, LASTNAME, NICKNAME, PREFERREDNAME |
|
MIDDLENAME |
Text |
•Patron’s middle name. •Up to 40 characters. •Relates to: MIDDLENAME, LASTNAME, NICKNAME, PREFERREDNAME |
|
LASTNAME |
Text |
•Patron’s last name. •Up to 40 characters. •Relates to: MIDDLENAME, LASTNAME, NICKNAME, PREFERREDNAME |
|
NICKNAME |
Text |
•Patron’s nickname. •Up to 40 characters. •Relates to: FIRSTNAME, MIDDLENAME, LASTNAME, PREFERREDNAME |
|
BIRTHDAY |
Date string |
•Patron’s date of birth. •8 characters. •Format as: MMDDYYYY |
|
SEX |
M or F |
•Patron’s gender. •1 character. •May also use the abbreviation of each custom gender. |
|
|
Text |
•Patron’s email address. •Up to 250 characters. •Relates to: HOMEPAGE |
|
HOMEPAGE |
Text |
•URL for the patron’s homepage. •Up to 250 characters. •Relates to: EMAIL |
|
PREFERREDNAME |
Text |
•Patron’s preferred name. •Up to 40 characters. •Relates to: FIRSTNAME, MIDDLENAME, LASTNAME, NICKNAME |
Patron Address Field Tags
|
Field Tag |
Value |
Description |
|
ADDRID |
Integer in range: 1 to 99999 |
•Address Type’s ID for the address fields that follow. •Up to 5 characters. •May specify more than once to provide several addresses. •Address tags may appear in any order, but each set must start with ADDRID. •When ADDRACTION is set to: o “U”, blank address fields are NOT updated. o “R”, blank address fields are imported. •Relates to: ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRACTION |
U |
•Indicates the action to take. •This tag must be preceded by an ADDRID tag. •1 character. •U represents UPDATE. •If nothing is specified, the action defaults to UPDATE. •Relates to: ADDRID, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRNAME |
Text |
•Address to: name. •Up to 40 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRLN1 |
Text |
•First address line for the last specified •address ID. •Up to 40 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRLN2 |
Text |
•Second address line for the last specified address ID. •Up to 40 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
CITY |
Text |
•City for the last specified address ID. •Up to 40 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
STATE |
Text |
•State or province for the last specified •address ID. •Up to 3 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ZIP |
Text |
•ZIP or postal code for the last specified address ID. •Up to 10 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
COUNTRY |
Text |
•Country for the last specified address ID. •Up to 20 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRPHONE |
Text |
•Phone number for the last specified •address ID. •Up to 14 characters. •This tag must be preceded by an ADDRID tag. •Format as: n-nnn-nnn-nnnn. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDREXT |
Text |
•Phone extension for the last specified •address ID. •Up to 4 characters. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDRFAX, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRFAX |
Text |
•Fax number associated with the last specified address ID. •Up to 14 characters. •This tag must be preceded by an ADDRID tag. •Format as: n-nnn-nnn-nnnn. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRPUBLISHPHONE, ADDRPRIMARYPHONE |
|
ADDRPUBLISHPHONE |
Y or N |
•Indicates if the last specified address ID may be published. •Up to 1 character. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPRIMARYPHONE |
|
ADDRPRIMARYPHONE |
Y or N |
•Indicates whether the phone number and extension in this address are used for the Occupancy Address phone number and extension. •Up to 1 character. •This tag must be preceded by an ADDRID tag. •Relates to: ADDRID, ADDRACTION, ADDRNAME, ADDRLN1, ADDRLN2, CITY, STATE, ZIP, COUNTRY, ADDRPHONE, ADDREXT, ADDRFAX, ADDRPUBLISHPHONE |
Patron Custom Attribute Tags
|
Field Tag |
Value |
Description |
|
CUSTATTR |
Integer in range: 1 to 99999 |
•REQUIRED if importing patron attributes. •ID for the following patron attribute that will be assigned a value. •Attribute IDs may be shared between HMS and PCS, but values are specified and stored separately for each system. •Up to 4 characters. •This tag may be specified more than once to assign multiple attribute values to a patron. •Attribute tags may appear in any order, but each set must start with CUSTATTR. •Relates to: DELCUSTATTR, ATTRSTART, ATTREND, ATTRVALUE |
|
ATTRSTART |
Date |
•REQUIRED when importing HMS patron attributes. If the ATTRSTART tag is omitted, it is assumed that the CUSTATTR is for PCS. •Start date of the attribute identified by the previous CUSTATTR tag. •Up to 8 characters. •Must be preceded by the CUSTATTR tag or the DELCUSTATTR tag. •Format as MMDDYYYY. •Relates to: CUSTATTR, DELCUSTATTR, ATTREND, ATTRVALUE |
|
ATTREND |
Date |
•End date of the attribute identified by the previous CUSTATTR tag. •Must be preceded by the CUSTATTR tag or the DELCUSTATTR tag. •When ATTREND is omitted or blank, the preference applies indefinitely. •Up to 8 characters. •Format as MMDDYYYY. •Relates to: CUSTATTR, DELCUSTATTR, ATTRSTART, ATTRVALUE |
|
ATTRVALUE |
Text Integer Floating Point Value Date String Time String Date-Time String Yes or No |
•REQUIRED if importing patron attributes. •Value of the attribute identified by the previous CUSTATTR tag. •Must be preceded by a CUSTATTR tag. •Relates to: CUSTATTR, DELCUSTATTR, ATTRSTART •Text: Up to 500 characters. •Integer: Up to 6 characters. •Floating Point Value: Up to 11 characters. •Date String: Format as YYYY-MM-DD. •Time String: Format as hh:mm. •Date-Time String: Format as: YYYY-MM-DD hh:mm. •Yes or No: Format as YES or NO. |