PatronRegistrationCreate

Create a new patron registration record. Basic patron duplicate detection (name, username, barcode) is performed. If "PSPARMDUPDETLEGALPAC" (Patron > Name on ID > PAC) is configured in Polaris System Administration Parameters, then Polaris also compares Name on ID for duplicate detection. If there is a possible duplicate in the database, the following error appears: "Duplicate patron name on identification is specified."

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

POST

/public//patron

Authorization required?

Yes

XML Elements 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
Barcode	Patron barcode (can be input also if known ahead of time)
PatronID	Polaris patron ID for newly created patron
StatisticalClassID	Statistical classes are defined by the library as a way of collecting statistics according to whatever categories they'd like to track. Quite often they're used for geographic areas like counties, towns, or school districts.

XML Body Elements

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

Name	Required	Description/Notes
LogonBranchID	Yes	Transaction processing field
LogonUserID	Yes	Transaction processing field
LogonWorkstationID	Yes	Transaction processing field
PatronBranchID	Yes	Patron's registering branch
PostalCode	No	Patron postal code
ZipPlusFour	No	Four digit code added to end of ZIP code
City	No	Patron city
State	No	Patron state Note: If a State field is not required for your county, it can be left undefined. This requires StateRequired to be set to no in the System Administration Countries table.
County	No	Patron county
CountryID	No	Patron country
StreetOne	No	Patron street one
StreetTwo	No	Patron street two
StreetThree	No	Patron street three
NameFirst	Yes	Patron first name
NameLast	Yes	Patron last name
NameMiddle	No	Patron middle name
User1	No	System-defined field for patron data
User2	No	System-defined field for patron data
User3	No	System-defined field for patron data
User4	No	System-defined field for patron data
User5	No	System-defined field for patron data
Gender	No	Use M, F, or N (not applicable)
Birthdate	No	Patron birth date
PhoneVoice1	No	Patron phone
PhoneVoice2	No	Patron phone
PhoneVoice3	No	Patron phone
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.
EmailAddress	No	Patron email
AltEmailAddress	No	Patron alternate email
LanguageID	No	Patron languageID - From Languages table 1 - English 2 - Spanish 3 - German 4 - French
UserName	No	Online user name
Password	No	Patron password
Password2	No	Patron password duplicate (for verification)
DeliveryOptionID	No	1 - Mail 2 - Email 3 - Telephone 1 4 - Telephone 2 5 - Telephone 3 6 - FAX 7 - EDI 8 - TXT messaging
EnableSMS	No	Enable additional text messages: 0 or False - Do not send additional text notice 1 or True - Send additional text notice
TxtPhoneNumber	No	Phone number for TXT messaging: 1 - PhoneVoice1 2 - PhoneVoice2 3 - PhoneVoice3 Unspecified - Indicates no phone number is specified
Barcode	No	Patron barcode (if not auto-assigning)
EReceiptOptionID	No	Ereceipt option ID [4.1 only]: 2 - Email Address 8 - TXT Messaging 100 - All
PatronCode	No	ID of patron code assigned to patron. Default used when ID not provided.
ExpirationDate	No	Patron card expiration date. Default used when date not provided.
AddrCheckDate	No	Patron card address check date. Default used when date not provided.
GenderID	No	Unique code identifying the patron's gender: 1- None (NULL) 2 - Female 3 - Male If an invalid gender is assigned, PAPI error code -3536 is returned.
LegalNameFirst	No	Patron's legal first name
LegalNameLast	No	Patron's legal last name
LegalNameMiddle	No	Patron's legal middle name
UseLegalNameOnNotices	No	Indicates whether the legal name is used on library print and phone notices: true - Legal name used false - Legal name not used
RequestPickupBranchID	No	Branch ID of the patron's preferred pickup location for holds

Example

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

Body

<City>Liverpool</City>

<StreetOne>100 Main Street</StreetOne>

<NameLast>Smith</NameLast>

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

<UserName>PolarisDude</UserName>

<LegalNameFirst>Johnathan</LegalNameFirst>

<LegalNameLast>Smith</LegalNameLast>

<LegalNameMiddle>Edward</LegalNameMiddle>

<LegalFullName>Johnathan Edward Smith</LegalFullName>

</PatronRegistrationCreateData>

Return - Success

HTTP/1.1 200 OK

<PatronRegistrationCreateResult

xmlns:i="http://www.w3.org/2001/XMLSchemainstance">

<Barcode>PACREG357166</Barcode>

</PatronRegistrationCreateResult>

Return - Failed

<PatronRegistrationCreateResult

xmlns:i="http://www.w3.org/2001/XMLSchemainstance">

<ErrorMessage>Procedure or function 'PAPI_PatronRegistrationCreate' expects parameter '@nPatronBranchID', which was not supplied.</ErrorMessage>

</PatronRegistrationCreateResult>