PatronRegistrationUpdate

Update Patron Registration information.

This method supports patron requests to change address. If this option is set in the Polaris Administration PAC profile Patron Access Options - Contact info, Patron can request address change and the patron requests a change, an email message confirming the request is sent to the patron. If this option is set in the Patron Access Options profile, a Verify Patron block is placed on the patron record, and an email message is sent to a staff member. An error message (Address changerequest not permitted, -501) is sent if the Patron can request address change option is not set.

You can remove an email address by sending a blank EmailAddress or Altemail address in the request body; for example: <EmailAddress><\EmailAddress> would remove whatever was in the record.

Note: Incoming phone number formats are validated against customer-defined rules in Polaris System Administration.

  PUT /public/1/patron/{PatronBarcode}  

Authorization required?

Yes

Public Method?

Yes

URI Parameters

Name

Required

Description/Notes

PatronBarcode

Yes

Barcode of patron

Query String Parameters

Name

Required

Description/Notes

Ignoresa

No

Indicates whether or not to validate patron update against policies set up in System Administration.

true - Don't check policies, just save the updated information, regardless.

false - Only save patron registration update if data meets system validation checks.

Request Body XML

Important: XML elements must be in the order shown below.

<PatronUpdateData>

<LogonBranchID/>

<LogonUserID/>

<LogonWorkstationID/>

<ReadingListFlag/>

<EmailFormat/>

<DeliveryOptionID/>

<EmailAddress/>

<PhoneVoice1/>

<Password/>

</PatronUpdateData>

XML Body Elements

Name

Required

Description/Notes

LogonBranchID

Yes

Current Branch (can default to System [1])

LogonUserID

Yes

Current User (can default to PolarisExec)

LogonWorkstationID

Yes

Current Workstation (can default to OPACDefault)

ReadingListFlag

No

Enable or disable reading list

EmailFormat

No

Format of email:

1 - Plain Text
2 - HTML

DeliveryOptionID

No

Delivery options:

0 - None
1 - Mailing address
2 - Email address
3 - Telephone 1
4 - Telephone 2
5 - Telephone 3
6 - FAX
7 - EDI
8 - TXT Messaging
DeliveryOption No ID of how notification should be delivered:

1 - Mailing Address
2 - Email Address
3 - Phone 1
4 - Phone 2
5 - Phone 3
6 - FAX
7 - EDI
8 - TXT Messaging

Email Address

No

Email address

AltEmail address

No

Alternate email address

EnableSMS

 

Enable additional text messages

0 or False - Do not send additional text notice
1 or True - Send additional text notice
PhoneVoice1 No Primary phone number

PhoneVoice2

No

Telephone 2 number

PhoneVoice3

No

Telephone 3 number

Phone1CarrierID

No

Mobile carrier for Telephone 1

A value of -2 indicates the carrier is unspecified.

Note: The -2 value is supported if the patron's branch has "Notice: Export text message" enabled in System Administration.

Sample list from SA_Mobilephonecarriers table:

1 - AT&T
2 - Bell Canada
8 - Sprint
9 - T_Mobile
10 - Tracfone
11 - Verizon
17 - Boost Mobile
22 - Rogers Canada

Phone2CarrierID

No

Mobile carrier for Telephone 2

A value of -2 indicates the carrier is unspecified.

Note: The -2 value is supported if the patron's branch has "Notice: Export text message" enabled in System Administration.

Phone3CarrierID

No

Mobile carrier for Telephone 3

A value of -2 indicates the carrier is unspecified.

Note: The -2 value is supported if the patron's branch has "Notice: Export text message" enabled in System Administration.

TxtPhoneNumber

No

Mobile number for text messaging:

1 - PhoneVoice1
2 - PhoneVoice2
3 - PhoneVoice3

Unspecified - Indicates no phone number is specified

EReceiptOptionID

No

0 - None
2 - Email receipt
8 - Text message receipt

Password

 No

Patron’s password
PatronCode No Patron code assigned to patron
ExpirationDate No Patron card expiration date
AddrCheckDate No Patron's address check date
ExcludeFromAlmostOverdueAutoRenew No Exclude patron from almost overdue/auto-renew reminder notices
ExcludeFromPatronRecExpiration No Exclude patron from patron record expiration reminder notices
ExcludeFromInactivePatron No Exclude from inactive patron reminder notices

AddressID

 No Address ID of requested patron address change

FreeTextLabel

 No Address type label (for example, Home or School) of requested patron address change

StreetOne

 No Patron street one
StreetTwo No Patron street two
StreetThree No Patron street three
City No City of patron address change

State

 No

State of requested patron address change

Note: If a State field is not required for your country, it can be left unidentified. This requires "StateRequired" to be set to no in the System Administration "Countries" table.

County

 No County of requested patron address change

PostalCode

 No Postal code of requested patron address change
ZipPlusFour No Four digit code added to end of ZIP code

Country

 No Country of the requested patron address change
CountryID No Country ID of the requested patron address change

AddressTypeID

 No

Address type of requested patron address change:

1 - Generic
2 - Notices
RequestPickupBranchID No Branch ID of the patron's preferred pickup location for holds

XML Elements Returned

The following XML elements are returned.

Name

Description/Notes
PAPIErrorCode

PAPI Error code: Negative values represent errors and are defined elsewhere.

Note: On successful completion, the PAPI error code is populated with a positive integer representing the number of rows returned.
ErrorMessage Error or information message

Example

http://localhost/PAPIService/REST/public/v1/1033/100/1/patron/21756003332022

Body

<PatronUpdateData>

<LogonBranchID>1</LogonBranchID>

<LogonUserID>1</LogonUserID>

<LogonWorkstationID>1</LogonWorkstationID>

<ReadingListFlag>1</ReadingListFlag>

<EmailFormat>2</EmailFormat>

<DeliveryOptionID>3</DeliveryOptionID>

<EmailAddress>dude@hotmail.com</EmailAddress>

<PhoneVoice1>315-555-3188</PhoneVoice1>

<Password>12345</Password>

<User1>2</User1>

<User2>100</User2>

<User3>10</User3>

<User4>1234</User4>

<User5>Bobby</User5>

</PatronUpdateData>

Return - Success

HTTP/1.1 200 OK

<PatronUpdateResult

xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<PAPIErrorCode>0</PAPIErrorCode>

<ErrorMessage/>

</PatronUpdateResult>

Return - Failed

HTTP/1.1 401 Unauthorized

WWW-Authenticate: PWS realm="Polaris API"

Error Messages

Code Description
-501 Patron personal information change is not allowed
-3000 Invalid PatronID specified
-3518 Invalid Email address
-3519 Invalid DeliveryMethod Value (No Address for Patron)
-3520 Invalid delivery method value (no email address for patron).
-3521 Invalid DeliveryMethod Value (No PhoneVoice1 for Patron)
-3522 Invalid DeliveryMethod Value (No PhoneVoice2 for Patron)
-3523 Invalid DeliveryMethod Value (No PhoneVoice3 for Patron)
-3524 Invalid DeliveryMethod Value (No PhoneFax for Patron)
-3525 Invalid DeliveryMethod Value
-3526 Invalid EmailFormat Value
-3527 Invalid ReadingList Value
-3532 Invalid PhoneVoice1
-3533 Invalid Patron Password format
-3534 Invalid Password Length
-3535 Patron password change is not allowed
-3612 Invalid PatronCodeID
-3613 Invalid PhoneVoice2
-3614 Invalid PhoneVoice3
-3615 Invalid Alt Email Address
-3616 Invalid TXTPhoneNumber
-3617 Invalid PhoneCarrier
-3619 Invalid DeliveryMethod No Phone
-3620 Invalid Email Address for EReceipt