api/v1/swagger/definitions/library.yaml

   1 ---
   2 type: object
   3 properties:
   4   library_id:
   5     type: string
   6     description: internally assigned library identifier
   7     maxLength: 10
   8     minLength: 1
   9   name:
  10     type: string
  11     description: Printable name of library
  12   address1:
  13     type:
  14       - string
  15       - "null"
  16     description: the first address line of the library
  17   address2:
  18     type:
  19       - string
  20       - "null"
  21     description: the second address line of the library
  22   address3:
  23     type:
  24       - string
  25       - "null"
  26     description: the third address line of the library
  27   postal_code:
  28     type:
  29       - string
  30       - "null"
  31     description: the postal code of the library
  32   city:
  33     type:
  34       - string
  35       - "null"
  36     description: the city or province of the library
  37   state:
  38     type:
  39       - string
  40       - "null"
  41     description: the reqional state of the library
  42   country:
  43     type:
  44       - string
  45       - "null"
  46     description: the county of the library
  47   phone:
  48     type:
  49       - string
  50       - "null"
  51     description: the primary phone of the library
  52   fax:
  53     type:
  54       - string
  55       - "null"
  56     description: the fax number of the library
  57   email:
  58     type:
  59       - string
  60       - "null"
  61     description: the primary email address of the library
  62   illemail:
  63     type:
  64       - string
  65       - "null"
  66     description: the ILL staff email address of the library
  67   reply_to_email:
  68     type:
  69       - string
  70       - "null"
  71     description: the email to be used as a Reply-To
  72   return_path_email:
  73     type:
  74       - string
  75       - "null"
  76     description: the email to be used as Return-Path
  77   url:
  78     type:
  79       - string
  80       - "null"
  81     description: the URL for your library or branch's website
  82   ip:
  83     type:
  84       - string
  85       - "null"
  86     description: the IP address for your library or branch
  87   notes:
  88     type:
  89       - string
  90       - "null"
  91     description: notes related to your library or branch
  92   geolocation:
  93     type:
  94       - string
  95       - "null"
  96     description: geolocation of your library
  97   marc_org_code:
  98     type:
  99       - string
 100       - "null"
 101     description: MARC Organization Code, see
 102       http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults
 103       to syspref MARCOrgCode
 104   pickup_location:
 105     type: boolean
 106     description: If the library can act as a pickup location
 107   public:
 108     type: boolean
 109     description: If the library is visible to the public
 110   smtp_server:
 111     type:
 112       - object
 113       - "null"
 114     description: The library effective SMTP server
 115   needs_override:
 116     type: boolean
 117     description: If the library needs an override to act as pickup location for a hold
 118   library_hours:
 119     type:
 120       - array
 121       - "null"
 122     description: The open and close times for a library on any given day
 123   cash_registers:
 124     type:
 125       - array
 126       - "null"
 127     description: The library's defined cash registers (x-koha-embed)
 128   desks:
 129     type:
 130       - array
 131       - "null"
 132     description: The library's defined desks (x-koha-embed)
 133 additionalProperties: false
 134 required:
 135   - library_id
 136   - name