XML patron data loading

Required
Not repeatable

Required
Not repeatable

1. Top level element of XSD structure; does not contain data of its own; contains all other elements

Optional
Repeatable

Required if using a non-OCLC authentication system.

Optional
Repeatable

Required if using a non-OCLC authentication system.

1. Contains the identification of the user at the external system to allow correlation with an IDM user for update if one exists (the idAtSource) and possibly a login username to assist the user.
2. Examples of external systems: PeopleSoft, Banner, LDAP, Shibboleth, CAS, etc.

1. This is the user's login name for the use only in OCLC-managed authentication.
2. Depending on your institution's configuration, barcode and User Name may be linked.
3. Ignored if authentication is performed by the institution or a third party (in which case OCLC does not store login credentials).
4. Must be unique.

1. If you are using basic WorldShare  authentication, the date on which the access to certain OCLC-provided services expires; the user will no longer be authenticated or permitted to use services such as circulation or ILL after this date. Note: If you are using third-party authentication (e.g., LDAP/CAS/SAML), this field does not have an effect. 
2. Use this format date and time:
   YYYY-MM-DDThh:mm:ss
   2016-12-31T00:00:00
3. If no default expiration period has been configured, no expiration date will appear.
4. If a default expiration period has been configured, but no date is provided, the expiration date will be set to 60 months (five years) by default.
5. If a timestamp component is included, it will be discarded as the oclcExpirationDate is stored as a date without a timestamp component.
6. If present, this date may also be used by WorldShare Circulation to calculate item due date during checkout

1. Top-level element for all name fields. Does not contain data of its own.

1. Alternate name, does not include salutation or epithets like PhD.
2. Does not display in patron record in WorldShare Admin or Circulation modules but is indexed for searching.

1. Date of birth in the year-month-day format: YYYY-MM-DD

1. If present, must contain one of these values:
   FEMALE
   MALE
   UNKNOWN
   
    Note:
   • All values are case sensitive
      
2. Default value is UNKNOWN if left blank.

1. WorldShare Circulation functionality only.
2. WorldShare Circulation specific information about patrons.

Required
Not repeatable

1. Tipasa functionality only.
2. ILL specific information about patrons.

Optional
Repeatable

1. An address, telephone number, or email address.
2. At least one piece of contact information, postal address, email or phone number is required.

notification
DeliveryDestination

Notification
DeliveryDestination

Optional
Repeatable

 Note: If a mobile number is present in this field (when paired with the deliveryService value SMS) does not validate, the patron load will be rejected.

1. Tipasa functionality only.
2. One or more destination (e.g. email address, telephone number for voicemail, mobile number for SMS text messages, etc.) to which notifications from various OCLC services are desired to be delivered.
3. Note that the preference service is used to specify which delivery notification service to use for the different OCLC notifications.
4. If notificationDeliveryDestination is used, the two sub-elements deliveryService and destination are required.

1. A note about the patron.

1. Optional data fields that could be used to store many kinds of custom data and can differ by institution.

1. A URL which displays or links to the user's photo.
2. The photo is displayed in the patron's profile in the WorldShare Admin and Circulation modules.
3. OCLC does not currently store photos.
4. The institution may provide security for the photo by hosting on a secure server. Consult your institution's policies regarding security for linked photo files.

1. Prefix or title, such as Ms, Dr, Sir.

Required
Not repeatable

givenName or familyName is required

Required
Not repeatable

givenName or familyName is required

1. First name of patron.
2. givenName or familyName is required.

1. Middle name of patron.

Required
Not repeatable

givenName or familyName is required

Required
Not repeatable

givenName or familyName is required

1. Last name of patron.
2. givenName or familyName is required.

1. A generation indicator such as Jr, III, and/or an epithet such as PhD, FRS.

1. Indicates that a user may manage the name themselves for future functionality.
2. Supported values are:
   True
   False
3. Default value is false.

Not applicable

(barcode can be sent as illID)

1. WorldShare Circulation functionality only.
2. A unique identifier per patron.
3. Can contain letters or numbers.
4. Spaces within the barcode string are acceptable, but leading and trailing spaces are problematic.
5. Matching on patron updates starts with idAtSource and sourceSystem (if supplied) and then matches on barcode.
6. For more information, see Patron data file reference.

1. Personal Identification Number.
2. Used to authorize operations that another user is not authorized to do (overrides). Not a user's WorldShare Circulation password.
3. May be used with the SIP/NCIP service.

Not applicable

(illPatronType can be used)

1. WorldShare Circulation functionality only.
2. Category or borrower (patron type) proved by the library.
3. Used to set circulation policies.
4. New values can be provided in patron update files and also added in OCLC Service Configuration.
5. Examples: Student, Adult, Faculty, Staff, etc.

circRegistration

Date

1. WorldShare Circulation functionality only.
2. Date the patron account was created.
3. Use this format for date:
   YYYY-MM-DD
4. If no date is provided, the date the record was added will be added by default.

1. WorldShare Circulation functionality only.
2. Branch ID of the patron's home branch, which is a numeric code (not the holding library code).
3. Branch IDs are provided by your OCLC Implementation Manager.
4. The value can be found in OCLC Service Configuration > Holdings Code Translation Table.

1. WorldShare Circulation functionality only.
2. Blocked users have their library privileges suspended. Patron is not allowed to borrow items.
3. Two values: true/false

1. WorldShare Circulation functionality only.
2. Patron fines are not moved to collections (patron is exempt from having account sent to collection agency).
3. Two values: true/false

1. Future WorldShare Circulation functionality.
2. Fines are not charged to patron's account (patron is exempt from accruing fines).
3. Two values: true/false.

Optional
Not repeatable

1. WorldShare Circulation functionality only.
2. Indicates whether patron's identity established via acceptable ID (driver's license, etc.).
3. Two values: true/false.

ContactInfo

Note: At least one piece of information, postalAddress, email or phone number is required.

1. See PostalAddress for description.

1. See EmailAddress for description.

1. See Phone for description.

1. A label indicating the nature or intended use of this element.
2. The administration panel provides elements stored as "home", "work", and "other" for all choices.
3. The panel also uses "mobile" for phone values.
4. Data loading of alternative labels is supported, e.g. "fax", and the user interface will display that label.

1. If present, must contain one of these values to indicate whether email, phone or postal address is valid:
   true
   false

PostalAddress 

Note: At least one piece of contact information, postalAddress, email or phone number is required.

1. Street address line 1.

1. Street address line 2 (if applicable).

1. City or location.

1. State or province.
2. For US states, use the United States Post Office abbreviations.

1. US zip code or non-US postal code.

1. Country.
2. Do not abbreviate. Use United States, not United States of America or USA.

1. Only one postal address can be primary.
2. If present, must contain one of these values to indicate whether an address is primary:
   true
   false

1. A user can have only one permanent address. For example, a student's permanent home address, as opposed to a campus address.
2. If present, must contain one of these values to indicate whether an address is permanent:
   true
   false

1. Future functionality.
2. Date from which the Physical Location is valid.

EmailAddress

Note: At least one piece of contact information, postalAddress, email or phone number is required.

1. An email address is required for the patron access via OCLC Authentication.
2. For patrons without email addresses, it is best to provide a default value (can use any value).

1. Only one email address can be primary.
2. If present, must contain one of these values to indicate whether the email address is primary:
   true
   false

Phone

Note: At least one piece of contact information, postalAddress, email or phone number is required.

1. Telephone number.
2. Mobile telephone number.

1. Only one phone number can be primary.
2. If present, must contain one of these values to indicate whether the phone number is primary:
   true
   false

Optional
Repeatable

Required if using a non-OCLC authentication system.

Optional
Repeatable

Required if using a non-OCLC authentication system.

1. URN identifying the external authentication system (e.g. urn:mace:oclc:idm:testlibrary.ldap).
2. Supplied by OCLC (e.g. LDAP) or institution (e.g. Shibboleth).
3. If present, idAtSource must also be present.
4. For more information, see Patron data file reference.

Optional
Repeatable

Required if using a non-OCLC authentication system.

Optional
Repeatable

Required if using a non-OCLC authentication system.

1. ID of a user in the external system (e.g. ILS, PeopleSoft, Banner, CAS) from which the data is being migrated.
2. If your system is not case sensitive, these must be unique and in lowercase.
3. If present, sourceSystem must also be present.
4. For more information, see Patron data file reference.

1. Body of the note.
2. If ongoing data loads contain new notes that exactly match existing notes, the new notes are ignored.
3. If ongoing data loads contain new notes that do not exactly match existing notes, the new notes are added.

1. If present, use value:
   Circulation_Info

1. Use for up to four pieces of custom data, must contain one of these values:
   customdata1
   customdata2
   customdata3
   customdata4

1. Can match predefined values in OCLC Service Configuration or be free text (not entered in OCLC Service Configuration).
2. Custom data fields from ongoing data loads that are not identical to previously-loaded fields, will replace the previously-loaded value.
3. Custom data fields from ongoing data loads that are identical to previously-loaded fields are ignored.
4. Custom data fields left blank in ongoing data loads are ignored and the previous value, if one exists, is maintained.
5. Custom data fields can be deleted in the WorldShare Admin or WorldShare Circulation modules.

NotificationDelivery
Destination

Note: If notificationDelivery
Destination is used, the two sub-elements deliveryService and destination are required.

Optional
Not repeatable

1. Tipasa functionality only
2. If present, must contain one of these values:
   Email
   SMS

1. Tipasa functionality only.
2. Patron's email address.
3. Full international format including country code is required (e.g. +1 232-456-5678 for a US number,  +44 20 4961 5678 for a UK number, or +61 (0) 3 9929 0800 for an Australian number). For more information, see Notation for national and international telephone numbers, e-mail addresses and web addresses.
4. Causes errors if the + is missing.

1. Tipasa functionality only.
2. A unique identifier for the user in the Tipasa system.
3. It may, but need not be, the user's library barcode. 

    Note: WMS Circ-Tipasa integration only works if the user's illld and barcode value are the same.

4. For more information, see Patron data file reference.

1. Tipasa functionality only.
2. Allows libraries to pre-approve or block patrons for Tipasa via the patron load or change patrons' approval status for Tipasa.
3. Supported values are:
   New
   Approved
   Blocked
4. If the value is left blank on the first load of a patron and there is an illID value in the patron file, the default value will be set to "New".
5. If value is left blank on updates to existing patrons, the existing value set in the database will be retained.

1. Tipasa functionality only.
2. This value will automatically populate in the Status field on Patron Request Workforms if field values are configured there to match values sent in patron data records.
3. If the patron status field is included on Patron Request Workforms, the data from illPatronType is captured in ILL usage statistics.