375 lines
12 KiB
JSON
375 lines
12 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Koha REST API",
|
|
"version": "1",
|
|
"license": {
|
|
"name": "GPL v3",
|
|
"url": "http://www.gnu.org/licenses/gpl.txt"
|
|
},
|
|
"contact": {
|
|
"name": "Koha Team",
|
|
"url": "http://koha-community.org/"
|
|
}
|
|
},
|
|
"basePath": "/api/v1",
|
|
"paths": {
|
|
"/patrons": {
|
|
"get": {
|
|
"x-mojo-controller": "Koha::REST::V1::Patrons",
|
|
"operationId": "listPatrons",
|
|
"tags": ["patrons"],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of patrons",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/patron"
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/patrons/{borrowernumber}": {
|
|
"get": {
|
|
"x-mojo-controller": "Koha::REST::V1::Patrons",
|
|
"operationId": "getPatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/parameters/borrowernumberPathParam"
|
|
}
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A patron",
|
|
"schema": {
|
|
"$ref": "#/definitions/patron"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Patron not found",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"patron": {
|
|
"type": "object",
|
|
"properties": {
|
|
"borrowernumber": {
|
|
"$ref": "#/definitions/borrowernumber"
|
|
},
|
|
"cardnumber": {
|
|
"description": "library assigned ID number for patrons",
|
|
"type": ["string", "null"]
|
|
},
|
|
"surname": {
|
|
"description": "patron's last name",
|
|
"type": ["string", "null"]
|
|
},
|
|
"firstname": {
|
|
"description": "patron's first name",
|
|
"type": ["string", "null"]
|
|
},
|
|
"title": {
|
|
"description": "patron's title",
|
|
"type": ["string", "null"]
|
|
},
|
|
"othernames": {
|
|
"description": "any other names associated with the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"initials": {
|
|
"description": "initials of the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"streetnumber": {
|
|
"description": "street number of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"streettype": {
|
|
"description": "street type of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"address": {
|
|
"description": "first address line of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"address2": {
|
|
"description": "second address line of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"city": {
|
|
"description": "city or town of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"state": {
|
|
"description": "state or province of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"zipcode": {
|
|
"description": "zip or postal code of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"country": {
|
|
"description": "country of patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"email": {
|
|
"description": "primary email address for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"phone": {
|
|
"description": "primary phone number for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"mobile": {
|
|
"description": "the other phone number for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"fax": {
|
|
"description": "fax number for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"emailpro": {
|
|
"description": "secondary email address for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"phonepro": {
|
|
"description": "secondary phone number for patron's primary address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_streetnumber": {
|
|
"description": "street number of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_streettype": {
|
|
"description": "street type of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_address": {
|
|
"description": "first address line of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_address2": {
|
|
"description": "second address line of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_city": {
|
|
"description": "city or town of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_state": {
|
|
"description": "state or province of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_zipcode": {
|
|
"description": "zip or postal code of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_country": {
|
|
"description": "country of patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_email": {
|
|
"description": "email address for patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"B_phone": {
|
|
"description": "phone number for patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"dateofbirth": {
|
|
"description": "patron's date of birth",
|
|
"type": ["string", "null"]
|
|
},
|
|
"branchcode": {
|
|
"description": "code of patron's home branch",
|
|
"type": ["string", "null"]
|
|
},
|
|
"categorycode": {
|
|
"description": "code of patron's category",
|
|
"type": ["string", "null"]
|
|
},
|
|
"dateenrolled": {
|
|
"description": "date the patron was added to Koha",
|
|
"type": ["string", "null"]
|
|
},
|
|
"dateexpiry": {
|
|
"description": "date the patron's card is set to expire",
|
|
"type": ["string", "null"]
|
|
},
|
|
"gonenoaddress": {
|
|
"description": "set to 1 if library marked this patron as having an unconfirmed address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"lost": {
|
|
"description": "set to 1 if library marked this patron as having lost his card",
|
|
"type": ["string", "null"]
|
|
},
|
|
"debarred": {
|
|
"description": "until this date the patron can only check-in",
|
|
"type": ["string", "null"]
|
|
},
|
|
"debarredcomment": {
|
|
"description": "comment on the stop of the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"contactname": {
|
|
"description": "used for children and professionals to include surname or last name of guarantor or organization name",
|
|
"type": ["string", "null"]
|
|
},
|
|
"contactfirstname": {
|
|
"description": "used for children to include first name of guarantor",
|
|
"type": ["string", "null"]
|
|
},
|
|
"contacttitle": {
|
|
"description": "used for children to include title of guarantor",
|
|
"type": ["string", "null"]
|
|
},
|
|
"guarantorid": {
|
|
"description": "borrowernumber used for children or professionals to link them to guarantor or organizations",
|
|
"type": ["string", "null"]
|
|
},
|
|
"borrowernotes": {
|
|
"description": "a note on the patron's account",
|
|
"type": ["string", "null"]
|
|
},
|
|
"relationship": {
|
|
"description": "used for children to include the relationship to their guarantor",
|
|
"type": ["string", "null"]
|
|
},
|
|
"ethnicity": {
|
|
"description": "unused",
|
|
"type": ["string", "null"]
|
|
},
|
|
"ethnotes": {
|
|
"description": "unused",
|
|
"type": ["string", "null"]
|
|
},
|
|
"sex": {
|
|
"description": "patron's gender",
|
|
"type": ["string", "null"]
|
|
},
|
|
"password": {
|
|
"description": "patron's encrypted password",
|
|
"type": ["string", "null"]
|
|
},
|
|
"flags": {
|
|
"description": "a number associated with the patron's permissions",
|
|
"type": ["string", "null"]
|
|
},
|
|
"userid": {
|
|
"description": "patron's login",
|
|
"type": ["string", "null"]
|
|
},
|
|
"opacnote": {
|
|
"description": "a note on the patron's account visible in OPAC and staff client",
|
|
"type": ["string", "null"]
|
|
},
|
|
"contactnote": {
|
|
"description": "a note related to patron's alternate address",
|
|
"type": ["string", "null"]
|
|
},
|
|
"sort1": {
|
|
"description": "a field that can be used for any information unique to the library",
|
|
"type": ["string", "null"]
|
|
},
|
|
"sort2": {
|
|
"description": "a field that can be used for any information unique to the library",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactfirstname": {
|
|
"description": "first name of alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactsurname": {
|
|
"description": "surname or last name of the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactaddress1": {
|
|
"description": "the first address line for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactaddress2": {
|
|
"description": "the second address line for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactaddress3": {
|
|
"description": "the city for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactstate": {
|
|
"description": "the state for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactzipcode": {
|
|
"description": "the zipcode for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactcountry": {
|
|
"description": "the country for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"altcontactphone": {
|
|
"description": "the phone number for the alternate contact for the patron",
|
|
"type": ["string", "null"]
|
|
},
|
|
"smsalertnumber": {
|
|
"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)",
|
|
"type": ["string", "null"]
|
|
},
|
|
"privacy": {
|
|
"description": "patron's privacy settings related to their reading history",
|
|
"type": ["string", "null"]
|
|
}
|
|
}
|
|
},
|
|
"borrowernumber": {
|
|
"description": "Patron internal identifier"
|
|
},
|
|
"error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"description": "Error message",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"borrowernumberPathParam": {
|
|
"name": "borrowernumber",
|
|
"in": "path",
|
|
"description": "Internal patron identifier",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|