PatronValidate Version 2

Validate that a patron is part of the Polaris database with API authentication only to avoid interfering with the existing PatronValidate authorization flow. This endpoint uses AuthType.API within the controller and shares the same underlying public method used by the Public V1 PatronValidate endpoint for database operations.

  GET /public/1/patron/{PatronBarcode}  

Authorization required?

Yes

URI Parameters

Name

Required

Description/Notes

PatronBarcode

Yes

Barcode of patron

PreferAssociatedPatron

No

 When true, if the patron has an associated patron registered at the requested organization, return that associated patron’s data instead.
Default value : false

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's barcode

ValidPatron

Does patron exist in the Polaris database?

false - No
true - Yes

PatronID

Patron's record ID

PatronCodeID

Patron’s patron code ID

AssignedBranchID

ID of the branch to which the patron is assigned
PatronBarcode Barcode of patron.

AssignedBranchName

Name of the branch to which the patron is assigned

ExpirationDate

Patron's registration expiration date

OverridePasswordUsed

Was the staff override passwordused. Set only if nValidationTypeID = 3.

Example

Copy 
http://localhost/PAPIService/REST/public/v2/1033/100/1/patron/21756003332022?PreferAssociatedPatron=true

Return - Success

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<PatronValidateResult>
    <PAPIErrorCode>0</PAPIErrorCode>
    <ErrorMessage>string</ErrorMessage>
    <Barcode>string</Barcode>
    <ValidPatron>true</ValidPatron>
    <PatronID>0</PatronID>
    <PatronCodeID>0</PatronCodeID>
    <AssignedBranchID>0</AssignedBranchID>
    <PatronBarcode>string</PatronBarcode>
    <AssignedBranchName>string</AssignedBranchName>
    <ExpirationDate>2026-05-26T09:40:57.725Z</ExpirationDate>
    <OverridePasswordUsed>true</OverridePasswordUsed>
</PatronValidateResult>