api/v1/definitions/patron.json

   1 {
   2   "type": "object",
   3   "properties": {
   4     "borrowernumber": {
   5       "type": "string",
   6       "description": "internally assigned user identifier"
   7     },
   8     "cardnumber": {
   9       "type": ["string", "null"],
  10       "description": "library assigned user identifier"
  11     },
  12     "surname": {
  13       "type": "string",
  14       "description": "patron's last name"
  15     },
  16     "firstname": {
  17       "type": ["string", "null"],
  18       "description": "patron's first name"
  19     },
  20     "title": {
  21       "type": ["string", "null"],
  22       "description": "patron's title"
  23     },
  24     "othernames": {
  25       "type": ["string", "null"],
  26       "description": "any other names associated with the patron"
  27     },
  28     "initials": {
  29       "type": ["string", "null"],
  30       "description": "initials of the patron"
  31     },
  32     "streetnumber": {
  33       "type": ["string", "null"],
  34       "description": "street number of patron's primary address"
  35     },
  36     "streettype": {
  37       "type": ["string", "null"],
  38       "description": "street type of patron's primary address"
  39     },
  40     "address": {
  41       "type": "string",
  42       "description": "first address line of patron's primary address"
  43     },
  44     "address2": {
  45       "type": ["string", "null"],
  46       "description": "second address line of patron's primary address"
  47     },
  48     "city": {
  49       "type": "string",
  50       "description": "city or town of patron's primary address"
  51     },
  52     "state": {
  53       "type": ["string", "null"],
  54       "description": "state or province of patron's primary address"
  55     },
  56     "zipcode": {
  57       "type": ["string", "null"],
  58       "description": "zip or postal code of patron's primary address"
  59     },
  60     "country": {
  61       "type": ["string", "null"],
  62       "description": "country of patron's primary address"
  63     },
  64     "email": {
  65       "type": ["string", "null"],
  66       "description": "primary email address for patron's primary address"
  67     },
  68     "phone": {
  69       "type": ["string", "null"],
  70       "description": "primary phone number for patron's primary address"
  71     },
  72     "mobile": {
  73       "type": ["string", "null"],
  74       "description": "the other phone number for patron's primary address"
  75     },
  76     "fax": {
  77       "type": ["string", "null"],
  78       "description": "fax number for patron's primary address"
  79     },
  80     "emailpro": {
  81       "type": ["string", "null"],
  82       "description": "secondary email address for patron's primary address"
  83     },
  84     "phonepro": {
  85       "type": ["string", "null"],
  86       "description": "secondary phone number for patron's primary address"
  87     },
  88     "B_streetnumber": {
  89       "type": ["string", "null"],
  90       "description": "street number of patron's alternate address"
  91     },
  92     "B_streettype": {
  93       "type": ["string", "null"],
  94       "description": "street type of patron's alternate address"
  95     },
  96     "B_address": {
  97       "type": ["string", "null"],
  98       "description": "first address line of patron's alternate address"
  99     },
 100     "B_address2": {
 101       "type": ["string", "null"],
 102       "description": "second address line of patron's alternate address"
 103     },
 104     "B_city": {
 105       "type": ["string", "null"],
 106       "description": "city or town of patron's alternate address"
 107     },
 108     "B_state": {
 109       "type": ["string", "null"],
 110       "description": "state or province of patron's alternate address"
 111     },
 112     "B_zipcode": {
 113       "type": ["string", "null"],
 114       "description": "zip or postal code of patron's alternate address"
 115     },
 116     "B_country": {
 117       "type": ["string", "null"],
 118       "description": "country of patron's alternate address"
 119     },
 120     "B_email": {
 121       "type": ["string", "null"],
 122       "description": "email address for patron's alternate address"
 123     },
 124     "B_phone": {
 125       "type": ["string", "null"],
 126       "description": "phone number for patron's alternate address"
 127     },
 128     "dateofbirth": {
 129       "type": ["string", "null"],
 130       "description": "patron's date of birth"
 131     },
 132     "branchcode": {
 133       "type": "string",
 134       "description": "code of patron's home branch"
 135     },
 136     "categorycode": {
 137       "type": "string",
 138       "description": "code of patron's category"
 139     },
 140     "dateenrolled": {
 141       "type": ["string", "null"],
 142       "description": "date the patron was added to Koha"
 143     },
 144     "dateexpiry": {
 145       "type": ["string", "null"],
 146       "description": "date the patron's card is set to expire"
 147     },
 148     "gonenoaddress": {
 149       "type": ["string", "null"],
 150       "description": "set to 1 if library marked this patron as having an unconfirmed address"
 151     },
 152     "lost": {
 153       "type": ["string", "null"],
 154       "description": "set to 1 if library marked this patron as having lost his card"
 155     },
 156     "debarred": {
 157       "type": ["string", "null"],
 158       "description": "until this date the patron can only check-in"
 159     },
 160     "debarredcomment": {
 161       "type": ["string", "null"],
 162       "description": "comment on the stop of the patron"
 163     },
 164     "contactname": {
 165       "type": ["string", "null"],
 166       "description": "used for children and professionals to include surname or last name of guarantor or organization name"
 167     },
 168     "contactfirstname": {
 169       "type": ["string", "null"],
 170       "description": "used for children to include first name of guarantor"
 171     },
 172     "contacttitle": {
 173       "type": ["string", "null"],
 174       "description": "used for children to include title of guarantor"
 175     },
 176     "guarantorid": {
 177       "type": ["string", "null"],
 178       "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
 179     },
 180     "borrowernotes": {
 181       "type": ["string", "null"],
 182       "description": "a note on the patron's account"
 183     },
 184     "relationship": {
 185       "type": ["string", "null"],
 186       "description": "used for children to include the relationship to their guarantor"
 187     },
 188     "sex": {
 189       "type": ["string", "null"],
 190       "description": "patron's gender"
 191     },
 192     "password": {
 193       "type": ["string", "null"],
 194       "description": "patron's encrypted password"
 195     },
 196     "flags": {
 197       "type": ["string", "null"],
 198       "description": "a number associated with the patron's permissions"
 199     },
 200     "userid": {
 201       "type": ["string", "null"],
 202       "description": "patron's login"
 203     },
 204     "opacnote": {
 205       "type": ["string", "null"],
 206       "description": "a note on the patron's account visible in OPAC and staff client"
 207     },
 208     "contactnote": {
 209       "type": ["string", "null"],
 210       "description": "a note related to patron's alternate address"
 211     },
 212     "sort1": {
 213       "type": ["string", "null"],
 214       "description": "a field that can be used for any information unique to the library"
 215     },
 216     "sort2": {
 217       "type": ["string", "null"],
 218       "description": "a field that can be used for any information unique to the library"
 219     },
 220     "altcontactfirstname": {
 221       "type": ["string", "null"],
 222       "description": "first name of alternate contact for the patron"
 223     },
 224     "altcontactsurname": {
 225       "type": ["string", "null"],
 226       "description": "surname or last name of the alternate contact for the patron"
 227     },
 228     "altcontactaddress1": {
 229       "type": ["string", "null"],
 230       "description": "the first address line for the alternate contact for the patron"
 231     },
 232     "altcontactaddress2": {
 233       "type": ["string", "null"],
 234       "description": "the second address line for the alternate contact for the patron"
 235     },
 236     "altcontactaddress3": {
 237       "type": ["string", "null"],
 238       "description": "the city for the alternate contact for the patron"
 239     },
 240     "altcontactstate": {
 241       "type": ["string", "null"],
 242       "description": "the state for the alternate contact for the patron"
 243     },
 244     "altcontactzipcode": {
 245       "type": ["string", "null"],
 246       "description": "the zipcode for the alternate contact for the patron"
 247     },
 248     "altcontactcountry": {
 249       "type": ["string", "null"],
 250       "description": "the country for the alternate contact for the patron"
 251     },
 252     "altcontactphone": {
 253       "type": ["string", "null"],
 254       "description": "the phone number for the alternate contact for the patron"
 255     },
 256     "smsalertnumber": {
 257       "type": ["string", "null"],
 258       "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
 259     },
 260     "sms_provider_id": {
 261       "type": ["string", "null"],
 262       "description": "the provider of the mobile phone number defined in smsalertnumber"
 263     },
 264     "privacy": {
 265       "type": "string",
 266       "description": "patron's privacy settings related to their reading history"
 267     },
 268     "privacy_guarantor_checkouts": {
 269       "type": "string",
 270       "description": "controls if relatives can see this patron's checkouts"
 271     },
 272     "checkprevcheckout": {
 273       "type": "string",
 274       "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'"
 275     },
 276     "updated_on": {
 277       "type": "string",
 278       "description": "time of last change could be useful for synchronization with external systems (among others)"
 279     }
 280   }
 281 }