Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/api/v1/swagger/definitions/patron.json
Lari Taskula 7b8c7b038f Bug 16699: Move Swagger-related files to api/v1/swagger 
This patch separates Swagger-specifications and the minifySwagger.pl from other
api-files by moving specifications & minifier into api/v1/swagger.

Signed-off-by: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>

My name is Olli-Antti Kivilahti and I approve this commit.
We have been using the Swagger2.0-driven REST API on Mojolicious for 1 year now
in production and I am certain we have a pretty good idea on how to work with
the limitations of Swagger2.0
We participated in the development of the Mojolicious::Plugin::Swagger and know
it well. We have made an extension to the plugin to provide full CORS support
and have been building all our in-house features on the new REST API.

Signed-off-by: Johanna Raisa <johanna.raisa@gmail.com>

My name is Johanna Räisä and I approve this commit.
We have been using Swagger2.0-driven REST API in production successfully.

Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
2016-08-26 12:08:52 +00:00

274 lines
8.7 KiB
JSON
Raw Blame History

{
"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": {
"$ref": "../x-primitives.json#/branchcode"
},
"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"
},
"gonenoaddress": {
"type": ["string", "null"],
"description": "set to 1 if library marked this patron as having an unconfirmed address"
},
"lost": {
"type": ["string", "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": ["string", "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": ["string", "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": ["string", "null"],
"description": "the provider of the mobile phone number defined in smsalertnumber"
},
"privacy": {
"type": "string",
"description": "patron's privacy settings related to their reading history"
},
"privacy_guarantor_checkouts": {
"type": "string",
"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",
"description": "time of last change could be useful for synchronization with external systems (among others)"
}
}
}
View git blame Copy permalink