Patron Object

Click the links below to view the Patron Object properties and an example.

The Patron object includes the following result set and Patron object properties.

The result set consists of total, start, and entries.

total

integer

(Always returned in the response.)

The total number of results.

Example: 

"total": 50

start

integer (optional)

The starting position of the set. A return value of 0 indicates a starting position (offset) value wasn't defined.

Example: 

"start": 10

Entries

array

(Always returned in the response.)

The patron entries. This array consists of the Patron object, which contains the following properties:

id

integer

(Always returned in the response.)

The patron record ID.

Example: 

"id": 3159578

updatedDate

string (optional)

The date and time of the last update to the record, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ) . The system updates this field any time the record is edited or involved in a transaction.

Example: 

"updatedDate": "2007-12-14T21:03:00Z"

createdDate

string (optional)

The datetime the record was created, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ)

Example: 

"createdDate": "2004-04-22T17:34:00Z"

deletedDate

string (optional)

(Appears only if the record has been deleted.)

The date the record was deleted, in ISO 8601 format (YYYY-MM-DD)

Example: 

"deletedDate": "2009-12-11"

deleted

boolean

Specifies whether the record has been deleted.

Deleted Records

Deleted records return only their id, deletedDate, and deleted properties.

Example: 

"deleted": true

suppressed

boolean (optional)

(Returned only if requested.)

Indicates whether the record is suppressed from public display.

Example: 

"suppressed": false

names

array (optional)

(Returned only if requested.)

A list of strings, which are the patron's names.

Example: 

"names": [
  "Examplestein, GLORIA",
  "Examplestein-Einem, GLORIA"
]

barcodes

array (optional)

(Returned only if requested.)

A list of strings, which are the patron's barcodes.

Example: 

"barcodes": [
  "21197300685699"
]

expirationDate

string (optional)

The expiration date of the patron's borrowing privileges in ISO 8601 format (YYYY-MM-DD).

Example: 

"expirationDate": "2021-10-30"

birthDate

string (optional)

The patron's date of birth in ISO 8601 format (YYYY-MM-DD).

Example: 

"birthDate": "1957-09-16"

emails

array (optional)

(Returned only if requested.)

A list of strings, which are the patron's email addresses.

Example: 

"emails": [
  "weaver@example.com"
]

patronType

integer (optional)

The library-defined patron type code.

Example: 

"patronType": 13

patronCodes

object (optional)

The patronCodes property contains a Codes object, which contains the library-defined pcodes associated with the patron.

"patronCodes": {
  "pcode1": "u",
  "pcode2": "-",
  "pcode3": 68,
  "pcode4": 0
}

pcode1

string (optional)

A library-defined patron data field.

Example: 

"pcode1": "u"

pcode2

string (optional)

A library-defined patron data field.

Example: 

"pcode2": "-"

pcode3

integer (optional)

A library-defined patron data field.

Example: 

"pcode3": 68

pcode4

integer (optional)

A library-defined patron data field.

This field is available only if your organization has acquired the Consortium Management Extensions product.

Example: 

"pcode4": 0

homeLibraryCode

string (optional)

The patron's home library.

Example: 

"homeLibraryCode": "a"

message

object (optional)

The message property contains a Message object, which contains message-related data for the patron.

"message": {
  "code": "a",
  "accountMessages": [
    "weaver@example.com"
  ]
}

code

character (optional)

A code corresponding to a library-defined patron message. A value in this field causes the system to display a corresponding message text when the patron attempts to check out, renew, or hold an item. Specific values are open for local definition.

Example: 

"code": "a"

accountMessages

array (optional)

A list of strings, which are free-text patron account messages.

Example: 

"accountMessages": [
    "This patron may check out materials from the local history collection."
  ]

blockInfo

object (optional)

The blockInfo property contains a Block object, which contains patron block information.

Example: 

"blockInfo": {
  "code": "a",
  "until: "2015-02-15"
}

code

string (optional)

A manual patron block code.

Example: 

"code": "a"

until

string

The date until which the patron is blocked from using library services, in ISO 8601 format (YYYY-MM-DD).

Example: 

"until: "2015-02-15"

addresses

array (optional)

(Returned only if requested.)

The addresses property contains a list of Address objects, which contain the patron's addresses.

"addresses": [
  {
    "lines": [
      "5850 Shellmound Way",
      "Emeryville, CA 94608 USA"
    ],
    "type": "a"
  },
  {
    "lines": [
      "5775 Golden Gate Parkway",
      "San Francisco, CA 94129 USA"
    ],
    "type": "h"
  }
]

lines

array (optional)

A list of strings, which are the lines of an address.

Example: 

"lines": [
  "1234 Anywhere Street",
  "Emeryville, CA 94608 USA"
]

type

character (optional)

The address type (a - primary address, h - alternate address).

Example: 

"type": "a"

phones

array (optional)

(Returned only if requested.)

The phones property contains a list of Phone objects, which contain the patron's telephone numbers.

"phones": [
  {
    "number": "510-655-6200",
    "type": "t"
  }
]

number

string

A telephone number.

Example: 

"number": "510-655-6200"

type

character

The telephone number type:

  • t - primary phone
  • p - alternate phone
  • o - mobile phone

Example: 

"type": "t"

uniqueIds

array (optional)

(Returned only if requested.)

The patron's unique IDs.

Example: 

"uniqueIds": [
  "201617200"
  "201617201"
  "pcode3": 0
]

moneyOwed

number (optional)

The amount of money the patron owes in fines and charges.

Clients should interpret this value as a floating point number.

Example: 

"moneyOwed": 3

pMessage

string (optional)

The patron's message,

Example: 

"pMessage": "e"

langPref

string (optional)

The patron's language preference,

Example: 

"langPref": "eng"

fixedFields

object

(Returned only if requested.)

The fixedFields property contains a map of FixedField objects, which contain fixed-length data fields from the patron record.

Example:

See fixedFields Object.

varFields

array

(Returned only if requested.)

The varFields property contains a list of VarField objects, which contain variable-length data fields from the patron record.

Example:

See varFields Array.

The preceding list order reflects the sequence in which the data returns.

Default Response Contents

The default query response for patron records includes the following fields:

id

patronType

message

expirationDate

patronCodes

blockInfo

birthDate

homeLibraryCode

moneyOwed

You must specify any other patron data using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/items/1042514?fields=fixedFields

Returns the id property and fixedFields object for a single patron record.

When you use the fields parameter, the API returns only the ID and specified properties. You can specify the value "default" to retrieve all default properties in addition to any explicitly specified properties, such as fixedFields. For example:

https://example-library.edu/iii/sierra-api/v6/items/1042514?fields=default,fixedFields

Returns the default properties plus the fixedFields object for a single patron record.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/patrons/1042514?
fields=default,updatedDate,createdDate,deleted,suppressed,names,
barcodes,emails,addresses,phones,universityId,fixedFields,varFields
{
  "id": 1042514,
  "updatedDate": "2015-04-29T18:08:54Z",
  "createdDate": "2003-07-04T04:21:00Z",
  "deleted": false,
  "suppressed": false
  "names": [
    "Examplestein, GLORIA"
  ],
  "barcodes": [
    "21197300685699"
  ],
  "expirationDate": "2021-10-30",
  "birthDate": "1957-09-16",
  "emails": [
    "weaver@example.com"
  ],
  "patronType": 13,
  "patronCodes": {
    "pcode1": "u",
    "pcode2": "-",
    "pcode3": 68,
    "pcode4": 0
  },
  "homeLibraryCode": "a",
  "message": {
    "code": " ",
    "accountMessages": [
      "This patron may check out materials from the local history 
collection."
    ]
  },
  "blockInfo": {
    "code": "-"
  },
  "addresses": [
    {
      "lines": [
        "123 Anywhere St.",
        "Emeryville, CA 94608 USA"
      ],
      "type": "a"
    },
    {
      "lines": [
        "123 Anywhere St.",
        "Emeryville, CA 94608 USA"
      ],
      "type": "h"
    }
  ],
  "phones": [
    {
      "number": "510-655-6200",
      "type": "t"
    }
  ],
  "universityId": "000012156",
  "moneyOwed": 3,
  "fixedFields": {
    "43": {
      "label": "EXP DATE",
      "value": "2021-10-30T11:00:00Z"
    },
    "44": {
      "label": "GENDER",
      "value": "u"
    },
    "45": {
      "label": "PCODE2",
      "value": "-"
    },
    "46": {
      "label": "PCODE3",
      "value": "68"
    },
    "47": {
      "label": "P TYPE",
      "value": "13"
    },
    "48": {
      "label": "TOT CHKOUT",
      "value": 90
    },
    "49": {
      "label": "TOT RENWAL",
      "value": 63
    },
    "50": {
      "label": "CUR CHKOUT",
      "value": 2
    },
    "51": {
      "label": "BIRTH DATE",
      "value": "1957-09-16"
    },
    "53": {
      "label": "HOME LIBR",
      "value": "a    "
    },
    "54": {
      "label": "PMESSAGE",
      "value": " "
    },
    "55": {
      "label": "HLODUES",
      "value": 0
    },
    "56": {
      "label": "MBLOCK",
      "value": "-"
    },
    "80": {
      "label": "REC TYPE",
      "value": "p"
    },
    "81": {
      "label": "RECORD #",
      "value": "1042514"
    },
    "83": {
      "label": "CREATED",
      "value": "2003-07-04T04:21:00Z"
    },
    "84": {
      "label": "UPDATED",
      "value": "2015-04-29T18:08:54Z"
    },
    "85": {
      "label": "REVISIONS",
      "value": "248"
    },
    "86": {
      "label": "AGENCY",
      "value": "1",
      "display": "Academic"
    },
    "95": {
      "label": "CL RTRND",
      "value": 1
    },
    "96": {
      "label": "MONEY OWED",
      "value": 300
    },
    "98": {
      "label": "PDATE",
      "value": "2015-04-28T20:11:00Z"
    },
    "99": {
      "label": "FIRM",
      "value": "     "
    },
    "102": {
      "label": "CUR SJPL 3wk",
      "value": 0
    },
    "103": {
      "label": "CUR VIDEO/DVD",
      "value": 0
    },
    "104": {
      "label": "PIUSE",
      "value": 0
    },
    "105": {
      "label": "OD PENALTY",
      "value": 0
    },
    "122": {
      "label": "ILL REQUES",
      "value": 0
    },
    "123": {
      "label": "DEBIT BAL",
      "value": 0
    },
    "124": {
      "label": "CUR RESERVES",
      "value": 0
    },
    "125": {
      "label": "CUR ITEMD",
      "value": 0
    },
    "126": {
      "label": "RESIDENCY ",
      "value": "0"
    },
    "158": {
      "label": "PAT AGENCY",
      "value": "0"
    },
    "163": {
      "label": "CIRCACTIVE",
      "value": "2015-04-28T20:10:58Z"
    },
    "263": {
      "label": "LANG PREF",
      "value": "   "
    },
    "268": {
      "label": "Notice Preference",
      "value": "z"
    },
    "269": {
      "label": "Registrations on Record",
      "value": 0
    },
    "270": {
      "label": "Total Registrations",
      "value": 0
    },
    "271": {
      "label": "Total Programs Attended",
      "value": 0
    },
    "297": {
      "label": "Waitlists on Record",
      "value": 0
    }
  },
  "varFields": [
    {
      "fieldTag": "=",
      "content": "V.F9jyFn9YmQM"
    },
    {
      "fieldTag": "b",
      "content": "21197300685699"
    },
    {
      "fieldTag": "m",
      "content": "30800024639947 NOS 6/30/06 @KL mp"
    },
    {
      "fieldTag": "s",
      "content": "21197300685699"
    },
    {
      "fieldTag": "u",
      "content": "000012156"
    },
    {
      "fieldTag": "x",
      "content": "Wed Nov 10 2010: $90.00 paid by .p10425147"
    },
    {
      "fieldTag": "z",
      "content": "weaver@example.com"
    },
    {
      "fieldTag": "a",
      "content": 1234 Anywhere St.$Emeryville, CA 94608 USA"
    },
    {
      "fieldTag": "h",
      "content": "1234 Anywhere St.$Emeryville, CA 94608 USA"
    },
    {
      "fieldTag": "n",
      "content": "Examplestein, GLORIA"
    },
    {
      "fieldTag": "t",
      "content": "510-655-6200"
    }
  ]
}