Name Titles

Get Name Title

GET /api/.../nametitles/{id}

Return a single name title id.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the name title. Used to return a single object.

Response Information

Example
application/json, text/json 
{
    "NameTitleID":1,
    "Description":"Mr."
}

HTTP Response Codes

Code Description
200 OK. Success

List Patron Name Titles

GET /api/.../nametitles

Return a list of all name titles in the system.

GET /api/.../nametitles?includeEmptyObject=true

Return a list of name titles. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
includeEmptyObject Boolean No Set to 'true' to return an empty object with NameTitleID set to '0' and Description set to '(none)'. This may be used when populating a listbox for a user selection.

Response Information

Example
application/json, text/json 
[
    {
        "NameTitleID":0,
        "Description":"(none)"
    },
    {
        "NameTitleID":1,
        "Description":"Mr."
    },
    {
        "NameTitleID":2,
        "Description":"Miss"
    },
    {
        "NameTitleID":3,
        "Description":"Mrs."
    },
    {
        "NameTitleID":4,
        "Description":"Ms."
    },
    {
        "NameTitleID":5,
        "Description":"Dr."
    }
]

HTTP Response Codes

Code Description
200 OK. Success