Patron Registration Defaults

Default values for registration

GET /api/.../patrondefaults?type={type}&orgid={id}

Return the default value for patron registration data fields. There are two types of default data. (1) normal and (2) express. Express registration is typically used to register a new library member during the check out process.

Request Information

Parameters
Name Type Required Description
orgid Integer No Return default values for a specific organization id. If not supplied, the base URL's logged on organization ID will be used.
type String No normal - return normal patron registration defaults
express - return express patron registration defaults

If not supplied, the normal defaults will be returned.

Response Information

Field descriptions

Field Description
OrganizationID Numeric organization ID that maps to a branch organization. If 0 is returned, no default is supplied.
PatronCodeID Numeric patron code ID that maps to the list of patron codes.
ExpirationTerm Type of interval for setting expiration date. 1 - Exact date, 2 - Months, 3 - Years. Note: this field does not map directly to a patron registration field.
ExpirationValue If ExpirationTerm is 1, this field is ignored.
If ExpirationTerm is 2 or 3, this is the number of months or years. Note: this field does not map directly to a patron registration field.
ExpirationExactDate If ExpirationTerm is 1, this field is the exact date to use as a default.
If ExpirationTerm is 2 or 3, this is field is ignored. Note: this field does not map directly to a patron registration field.
AddressCheckTerm Type of interval for setting address check term. 1 - Exact date, 2 - Months, 3 - Years. Note: this field does not map directly to a patron registration field.
AddressCheckValue If AddressCheckTerm is 1, this field is ignored.
If AddressCheckTerm is 2 or 3, this is the number of months or years. Note: this field does not map directly to a patron registration field.
AddressCheckExactDate If AddressCheckTerm is 1, this field is the exact date to use as a default.
If AddressCheckTerm is 2 or 3, this is field is ignored. Note: this field does not map directly to a patron registration field.
AddressLabelID Defaults to 1. This label ID is used to match an address to the "Notices address" option.
AddressLabelDescription Defaults to "Home".
PostalCode String value.
CountryID Numeric country ID that maps to the list of countries.
City String value. If a postal code is supplied, the matching city will be included.
County String value. If a postal code is supplied, the matching county will be included.
State String value. If a postal code is supplied, the matching state will be included.
DeliveryOptionID Numeric delivery option ID (notification option) that maps to the list of delivery options.
RegistrationDate A default UTC date that may be used to populate the registration date field.
DeletionExempt Boolean value. Do not delete patron record. Not controlled by system administration.
eReceiptOptionID Numeric value that represents which type of eReceipts the patron would like to opt in on.
0 - None
2 - Email
8 - TXT
100 - TXT and Email
AreaCodePrefix This value should be used to pre-populate the Phone 1 area code.
LanguageID Numeric language ID that maps to the list of languages.
ExcludeFromOverdues Boolean value. Exclude from overdue notice. Not controlled by system administration.
ReadingListEnabled Boolean value. Is reading history enabled?
StatisticalClassID Numeric statistical class ID that maps to a patron stat class code. If 0 is returned, no default is supplied.
CollectionExempt Boolean value. Exclude from collection agency. Not controlled by system administration.
ExcludeFromHolds Boolean value. Exclude from hold notice. Not controlled by system administration.
ExcludeFromBills Boolean value. Exclude from billing. Not controlled by system administration.
EmailFormatID Email notices in plain text.
0 - HTML
1 - Plain text
User1 Default string value for user defined field #1.
User2 Default string value for user defined field #2.
User3 Default string value for user defined field #3.
User4 Default string value for user defined field #4.
User5 Default string value for user defined field #5.
PatronCustomData Default list of patron custom data.
DisplayPatronPhotoEnabled Boolean value. Is display of patron photo enabled?
Example
application/json, text/json 
{
    "OrganizationID":3,
    "PatronCodeID":1,
    "ExpirationTerm":3,
    "ExpirationValue":3,
    "ExpirationExactDate":null,
    "AddressCheckTerm":1,
    "AddressCheckValue":3,
    "AddressCheckExactDate":null,
    "AddressLabelID": 1,
    "AddressLabelDescription":"Home",
    "PostalCode":"13090",
    "CountryID":1,
    "City":"BAYBERRY",
    "County":"ONONDAGA",
    "State":"NY",
    "DeliveryOptionID":1,
    "RegistrationDate":"2013-08-14T13:48:30.2969296-04:00",
    "DeletionExempt":false,
    "eReceiptOptionID":0,
    "AreaCodePrefix":"518",
    "LanguageID":1,
    "ExcludeFromOverdues":false,
    "ReadingListEnabled":true,
    "StatisticalClassID":0,
    "CollectionExempt":false,
    "ExcludeFromHolds":false,
    "ExcludeFromBills":false,
    "EmailFormatID":0,
    "User1":"999999",
    "User2":"",
    "User3":"",
    "User4":"",
    "User5":"",
    "PatronCustomData":
    [
        {
            "PatronID":0,
            "PatronCustomDataDefinitionID":8,
            "PatronDataLabelValue":"Parent/Guardian",
            "PolarisCustomDataTypeID":2,
            "CustomDataEntry":null,
            "DefaultValue":"Jack Smith",
            "IsRequired":true,
            "IsEnabled":false,
            "IsDataChanged":false
        },
        {
            "PatronID":0,
            "PatronCustomDataDefinitionID":9,
            "PatronDataLabelValue":"Parent/Guardian birth date",
            "PolarisCustomDataTypeID":3,
            "CustomDataEntry":null,
            "DefaultValue":null,
            "IsRequired":true,
            "IsEnabled":false,
            "IsDataChanged":false
        },
        {
            "PatronID":0,
            "PatronCustomDataDefinitionID":11,
            "PatronDataLabelValue":
            "Numeric text box",
            "PolarisCustomDataTypeID":1,
            "CustomDataEntry":null,
            "DefaultValue":1,
            "IsRequired":false,
            "IsEnabled":false,
            "IsDataChanged":false
        },
        {
        "PatronID":0,
        "PatronCustomDataDefinitionID":10,
        "PatronDataLabelValue":"Restricted patron",
        "PolarisCustomDataTypeID":4,
        "CustomDataEntry":null,
        "DefaultValue":true,
        "IsRequired":false,
        "IsEnabled":false,
        "IsDataChanged":false
        }
    ],
    "DisplayPatronPhotoEnabled":true
    }
}