api/v1/swagger/definitions/library.json

   1 {
   2   "type": "object",
   3   "properties": {
   4     "branchcode": {
   5       "$ref": "../x-primitives.json#/branchcode"
   6     },
   7     "branchname": {
   8       "type": "string",
   9       "description": "Printable name of library"
  10     },
  11     "branchaddress1": {
  12       "type": ["string", "null"],
  13       "description": "the first address line of the library"
  14     },
  15     "branchaddress2": {
  16       "type": ["string", "null"],
  17       "description": "the second address line of the library"
  18     },
  19     "branchaddress3": {
  20       "type": ["string", "null"],
  21       "description": "the third address line of the library"
  22     },
  23     "branchzip": {
  24       "type": ["string", "null"],
  25       "description": "the zip or postal code of the library"
  26     },
  27     "branchcity": {
  28       "type": ["string", "null"],
  29       "description": "the city or province of the library"
  30     },
  31     "branchstate": {
  32       "type": ["string", "null"],
  33       "description": "the reqional state of the library"
  34     },
  35     "branchcountry": {
  36       "type": ["string", "null"],
  37       "description": "the county of the library"
  38     },
  39     "branchphone": {
  40       "type": ["string", "null"],
  41       "description": "the primary phone of the library"
  42     },
  43     "branchfax": {
  44       "type": ["string", "null"],
  45       "description": "the fax number of the library"
  46     },
  47     "branchemail": {
  48       "type": ["string", "null"],
  49       "description": "the primary email address of the library"
  50     },
  51     "branchreplyto": {
  52       "type": ["string", "null"],
  53       "description": "the email to be used as a Reply-To"
  54     },
  55     "branchreturnpath": {
  56       "type": ["string", "null"],
  57       "description": "the email to be used as Return-Path"
  58     },
  59     "branchurl": {
  60       "type": ["string", "null"],
  61       "description": "the URL for your library or branch's website"
  62     },
  63     "issuing": {
  64       "type": ["integer", "null"],
  65       "description": "unused in Koha"
  66     },
  67     "branchip": {
  68       "type": ["string", "null"],
  69       "description": "the IP address for your library or branch"
  70     },
  71     "branchprinter": {
  72       "type": ["string", "null"],
  73       "description": "unused in Koha"
  74     },
  75     "branchnotes": {
  76       "type": ["string", "null"],
  77       "description": "notes related to your library or branch"
  78     },
  79     "opac_info": {
  80       "type": ["string", "null"],
  81       "description": "HTML that displays in OPAC"
  82     },
  83     "geolocation": {
  84       "type": ["string", "null"],
  85       "description": "geolocation of your library"
  86     }
  87   },
  88   "additionalProperties": false,
  89   "required": ["branchcode", "branchname"]
  90 }