Patron User-defined Fields

List Field Configuration

GET /api/.../patronudfs/config?orgid={id}

GET /api/.../patronudfs/config?orgid={id}&includeEmptyObject=None

Returns configuration information for the five Polaris user-defined patron fields. Only valid active user-defined fields are returned.

The DisplayOrder attribute is based on the organization's 'Patron Services' parameter SA settings for 'Check-out: Optional patron data'. A value of 0 indicates the field should not be displayed for patron check-out data.

If the Values attribute in the returned objects contains values, the field is restricted to only those values.

Refer to the Patron Registration Required and Patron Registration Defaults to determine if each user-defined field is required and what the default value should be for new registration entry.

Request Information

Parameters
Name Type Required Description
orgid Integer Yes The organization id of the patron's registered branch.
includeEmptyObject String No Set to the text to return UDF list values with an initial value set to that text. Example would be: 'None'. This may be used when populating a listbox for a user selection. Must be used with the orgid parameter.

Response Information

Example
application/json, text/json 
[
    {
        "PatronUdfID": 1,
        "Label": "ID Number",
        "DisplayOrder": 1,
        "Values": []
    },
    {
        "PatronUdfID": 2,
        "Label": "Privileges / Restrictions",
        "DisplayOrder": 0,
        "Values": []
    },
    {
        "PatronUdfID": 3,
        "Label": "Voter Registration",
        "DisplayOrder": 3,
        "Values": []
    },
    {
        "PatronUdfID": 4,
        "Label": "CybraryN Use Only (XXX,YYY)",
        "DisplayOrder": 2,
        "Values": []
    },
    {
        "PatronUdfID": 5,
        "Label": "Favorite Brady",
        "DisplayOrder": 4,
        "Values":
            [
                "Mike",
                "Carol",
                "Greg",
                "Marcia",
                "Peter",
                "Jan",
                "Bobby",
                "Cindy",
                "Alice",
                "Sam the Butcher",
                "Cousin Oliver",
                "Johnny Bravo"
            ]
    }
]

HTTP Response Codes

Code Description
200 OK. Success