api/v1/swagger/definitions/library.json

   1 {
   2   "type": "object",
   3   "properties": {
   4     "library_id": {
   5       "$ref": "../x-primitives.json#/library_id"
   6     },
   7     "name": {
   8       "type": "string",
   9       "description": "Printable name of library"
  10     },
  11     "address1": {
  12       "type": ["string", "null"],
  13       "description": "the first address line of the library"
  14     },
  15     "address2": {
  16       "type": ["string", "null"],
  17       "description": "the second address line of the library"
  18     },
  19     "address3": {
  20       "type": ["string", "null"],
  21       "description": "the third address line of the library"
  22     },
  23     "postal_code": {
  24       "type": ["string", "null"],
  25       "description": "the postal code of the library"
  26     },
  27     "city": {
  28       "type": ["string", "null"],
  29       "description": "the city or province of the library"
  30     },
  31     "state": {
  32       "type": ["string", "null"],
  33       "description": "the reqional state of the library"
  34     },
  35     "country": {
  36       "type": ["string", "null"],
  37       "description": "the county of the library"
  38     },
  39     "phone": {
  40       "type": ["string", "null"],
  41       "description": "the primary phone of the library"
  42     },
  43     "fax": {
  44       "type": ["string", "null"],
  45       "description": "the fax number of the library"
  46     },
  47     "email": {
  48       "type": ["string", "null"],
  49       "description": "the primary email address of the library"
  50     },
  51     "illemail": {
  52       "type": ["string", "null"],
  53       "description": "the ILL staff email address of the library"
  54     },
  55     "reply_to_email": {
  56       "type": ["string", "null"],
  57       "description": "the email to be used as a Reply-To"
  58     },
  59     "return_path_email": {
  60       "type": ["string", "null"],
  61       "description": "the email to be used as Return-Path"
  62     },
  63     "url": {
  64       "type": ["string", "null"],
  65       "description": "the URL for your library or branch's website"
  66     },
  67     "ip": {
  68       "type": ["string", "null"],
  69       "description": "the IP address for your library or branch"
  70     },
  71     "notes": {
  72       "type": ["string", "null"],
  73       "description": "notes related to your library or branch"
  74     },
  75     "opac_info": {
  76       "type": ["string", "null"],
  77       "description": "HTML that displays in OPAC"
  78     },
  79     "geolocation": {
  80       "type": ["string", "null"],
  81       "description": "geolocation of your library"
  82     },
  83     "marc_org_code": {
  84         "type": [ "string", "null" ],
  85         "description": "MARC Organization Code, see http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults to syspref MARCOrgCode"
  86     },
  87     "pickup_location": {
  88         "type": "boolean",
  89         "description": "If the library can act as a pickup location"
  90     },
  91     "smtp_server": {
  92         "type": ["object", "null"],
  93         "description": "The library effective SMTP server"
  94     },
  95     "needs_override": {
  96         "type": "boolean",
  97         "description": "If the library needs an override to act as pickup location for a hold"
  98     }
  99   },
 100   "additionalProperties": false,
 101   "required": ["library_id", "name"]
 102 }