Koha/api/v1/swagger/definitions/patron.json

{
  "type": "object",
  "properties": {
    "borrowernumber": {
      "$ref": "../x-primitives.json#/borrowernumber"
    },
    "cardnumber": {
      "$ref": "../x-primitives.json#/cardnumber"
    },
    "surname": {
      "$ref": "../x-primitives.json#/surname"
    },
    "firstname": {
      "$ref": "../x-primitives.json#/firstname"
    },
    "title": {
      "type": ["string", "null"],
      "description": "patron's title"
    },
    "othernames": {
      "type": ["string", "null"],
      "description": "any other names associated with the patron"
    },
    "initials": {
      "type": ["string", "null"],
      "description": "initials of the patron"
    },
    "streetnumber": {
      "type": ["string", "null"],
      "description": "street number of patron's primary address"
    },
    "streettype": {
      "type": ["string", "null"],
      "description": "street type of patron's primary address"
    },
    "address": {
      "type": "string",
      "description": "first address line of patron's primary address"
    },
    "address2": {
      "type": ["string", "null"],
      "description": "second address line of patron's primary address"
    },
    "city": {
      "type": "string",
      "description": "city or town of patron's primary address"
    },
    "state": {
      "type": ["string", "null"],
      "description": "state or province of patron's primary address"
    },
    "zipcode": {
      "type": ["string", "null"],
      "description": "zip or postal code of patron's primary address"
    },
    "country": {
      "type": ["string", "null"],
      "description": "country of patron's primary address"
    },
    "email": {
      "$ref": "../x-primitives.json#/email"
    },
    "phone": {
      "$ref": "../x-primitives.json#/phone"
    },
    "mobile": {
      "type": ["string", "null"],
      "description": "the other phone number for patron's primary address"
    },
    "fax": {
      "type": ["string", "null"],
      "description": "fax number for patron's primary address"
    },
    "emailpro": {
      "type": ["string", "null"],
      "description": "secondary email address for patron's primary address"
    },
    "phonepro": {
      "type": ["string", "null"],
      "description": "secondary phone number for patron's primary address"
    },
    "B_streetnumber": {
      "type": ["string", "null"],
      "description": "street number of patron's alternate address"
    },
    "B_streettype": {
      "type": ["string", "null"],
      "description": "street type of patron's alternate address"
    },
    "B_address": {
      "type": ["string", "null"],
      "description": "first address line of patron's alternate address"
    },
    "B_address2": {
      "type": ["string", "null"],
      "description": "second address line of patron's alternate address"
    },
    "B_city": {
      "type": ["string", "null"],
      "description": "city or town of patron's alternate address"
    },
    "B_state": {
      "type": ["string", "null"],
      "description": "state or province of patron's alternate address"
    },
    "B_zipcode": {
      "type": ["string", "null"],
      "description": "zip or postal code of patron's alternate address"
    },
    "B_country": {
      "type": ["string", "null"],
      "description": "country of patron's alternate address"
    },
    "B_email": {
      "type": ["string", "null"],
      "description": "email address for patron's alternate address"
    },
    "B_phone": {
      "type": ["string", "null"],
      "description": "phone number for patron's alternate address"
    },
    "dateofbirth": {
      "type": ["string", "null"],
      "description": "patron's date of birth"
    },
    "branchcode": {
      "type": "string",
      "description": "code of patron's home branch"
    },
    "categorycode": {
      "type": "string",
      "description": "code of patron's category"
    },
    "dateenrolled": {
      "type": ["string", "null"],
      "description": "date the patron was added to Koha"
    },
    "dateexpiry": {
      "type": ["string", "null"],
      "description": "date the patron's card is set to expire"
    },
    "date_renewed": {
      "type": ["string", "null"],
      "description": "date the patron's card was last renewed"
    },
    "gonenoaddress": {
      "type": ["boolean", "null"],
      "description": "set to 1 if library marked this patron as having an unconfirmed address"
    },
    "lost": {
      "type": ["boolean", "null"],
      "description": "set to 1 if library marked this patron as having lost his card"
    },
    "debarred": {
      "type": ["string", "null"],
      "description": "until this date the patron can only check-in"
    },
    "debarredcomment": {
      "type": ["string", "null"],
      "description": "comment on the stop of the patron"
    },
    "contactname": {
      "type": ["string", "null"],
      "description": "used for children and professionals to include surname or last name of guarantor or organization name"
    },
    "contactfirstname": {
      "type": ["string", "null"],
      "description": "used for children to include first name of guarantor"
    },
    "contacttitle": {
      "type": ["string", "null"],
      "description": "used for children to include title of guarantor"
    },
    "guarantorid": {
      "type": ["integer", "null"],
      "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
    },
    "borrowernotes": {
      "type": ["string", "null"],
      "description": "a note on the patron's account"
    },
    "relationship": {
      "type": ["string", "null"],
      "description": "used for children to include the relationship to their guarantor"
    },
    "sex": {
      "type": ["string", "null"],
      "description": "patron's gender"
    },
    "password": {
      "type": ["string", "null"],
      "description": "patron's encrypted password"
    },
    "flags": {
      "type": ["integer", "null"],
      "description": "a number associated with the patron's permissions"
    },
    "userid": {
      "type": ["string", "null"],
      "description": "patron's login"
    },
    "opacnote": {
      "type": ["string", "null"],
      "description": "a note on the patron's account visible in OPAC and staff client"
    },
    "contactnote": {
      "type": ["string", "null"],
      "description": "a note related to patron's alternate address"
    },
    "sort1": {
      "type": ["string", "null"],
      "description": "a field that can be used for any information unique to the library"
    },
    "sort2": {
      "type": ["string", "null"],
      "description": "a field that can be used for any information unique to the library"
    },
    "altcontactfirstname": {
      "type": ["string", "null"],
      "description": "first name of alternate contact for the patron"
    },
    "altcontactsurname": {
      "type": ["string", "null"],
      "description": "surname or last name of the alternate contact for the patron"
    },
    "altcontactaddress1": {
      "type": ["string", "null"],
      "description": "the first address line for the alternate contact for the patron"
    },
    "altcontactaddress2": {
      "type": ["string", "null"],
      "description": "the second address line for the alternate contact for the patron"
    },
    "altcontactaddress3": {
      "type": ["string", "null"],
      "description": "the city for the alternate contact for the patron"
    },
    "altcontactstate": {
      "type": ["string", "null"],
      "description": "the state for the alternate contact for the patron"
    },
    "altcontactzipcode": {
      "type": ["string", "null"],
      "description": "the zipcode for the alternate contact for the patron"
    },
    "altcontactcountry": {
      "type": ["string", "null"],
      "description": "the country for the alternate contact for the patron"
    },
    "altcontactphone": {
      "type": ["string", "null"],
      "description": "the phone number for the alternate contact for the patron"
    },
    "smsalertnumber": {
      "type": ["string", "null"],
      "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
    },
    "sms_provider_id": {
      "type": ["integer", "null"],
      "description": "the provider of the mobile phone number defined in smsalertnumber"
    },
    "privacy": {
      "type": "integer",
      "description": "patron's privacy settings related to their reading history"
    },
    "privacy_guarantor_checkouts": {
      "type": "integer",
      "description": "controls if relatives can see this patron's checkouts"
    },
    "checkprevcheckout": {
      "type": "string",
      "description": "produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'"
    },
    "updated_on": {
      "type": ["string", "null"],
      "description": "time of last change could be useful for synchronization with external systems (among others)"
    },
    "lastseen": {
      "type": ["string", "null"],
      "description": "last time a patron has been seen (connected at the OPAC or staff interface)"
    },
    "lang": {
      "type": ["string", "null"],
      "description": "lang to use to send notices to this patron"
    },
    "login_attempts": {
      "type": ["integer", "null"],
      "description": "number of failed login attemps"
    },
    "overdrive_auth_token": {
      "type": ["string", "null"],
      "description": "persist OverDrive auth token"
    }
  }
}