Attachment #44001 for bug #13799

View | Details | Raw Unified | Return to bug 13799
Collapse All | Expand All

Lines 1-4 Link Here

(-)a/Koha/REST/V1/Patrons.pm (-1 / +1 lines)
1	package Koha::REST::V1::Patrons;	1	package Koha::REST::V1::Patron;
2		2
3	# This file is part of Koha.	3	# This file is part of Koha.
4	#	4	#




      "type": "object",
      "properties": {
        "borrowernumber": {
          "type": "string",
          "description": "internally assigned user identifier"
        },
        "cardnumber": {
          "type": ["string", "null"],
          "description": "library assigned user identifier"
        },
        "surname": {

          "description": "patron's last name"
        },
        "firstname": {
          "type": ["string", "null"],
          "description": "patron's first name"
        },
        "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": {

          "description": "first address line of patron's primary address"
        },
        "address2": {
          "type": ["string", "null"],
          "description": "second address line of patron's primary address"
        },
        "city": {

          "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": {
          "type": ["string", "null"],
          "description": "primary email address for patron's primary address"
        },
        "phone": {
          "type": ["string", "null"],
          "description": "primary phone number for patron's primary address"
        },
        "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": {

          "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"
        },
        "ethnicity": {
          "type": ["string", "null"],
          "description": "unused"
        },
        "ethnotes": {
          "type": ["string", "null"],
          "description": "unused"
        },
        "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)"
        },
        "privacy": {
- 

Return to bug 13799

Lines 2-12 Link Here

(-)a/api/v1/definitions/patron.json (-62 / +61 lines)
2	"type": "object",	2	"type": "object",
3	"properties": {	3	"properties": {
4	"borrowernumber": {	4	"borrowernumber": {
5	"type": "integer",	5	"type": "string",
6	"description": "internally assigned user identifier"	6	"description": "internally assigned user identifier"
7	},	7	},
8	"cardnumber": {	8	"cardnumber": {
9	"type": "string",	9	"type": ["string", "null"],
10	"description": "library assigned user identifier"	10	"description": "library assigned user identifier"
11	},	11	},
12	"surname": {	12	"surname": {
Lines 14-40 Link Here
14	"description": "patron's last name"	14	"description": "patron's last name"
15	},	15	},
16	"firstname": {	16	"firstname": {
17	"type": "string",	17	"type": ["string", "null"],
18	"description": "patron's first name"	18	"description": "patron's first name"
19	},	19	},
20	"title": {	20	"title": {
21	"type": "string",	21	"type": ["string", "null"],
22	"description": "patron's title"	22	"description": "patron's title"
23	},	23	},
24	"othernames": {	24	"othernames": {
25	"type": "string",	25	"type": ["string", "null"],
26	"description": "any other names associated with the patron"	26	"description": "any other names associated with the patron"
27	},	27	},
28	"initials": {	28	"initials": {
29	"type": "string",	29	"type": ["string", "null"],
30	"description": "initials of the patron"	30	"description": "initials of the patron"
31	},	31	},
32	"streetnumber": {	32	"streetnumber": {
33	"type": "string",	33	"type": ["string", "null"],
34	"description": "street number of patron's primary address"	34	"description": "street number of patron's primary address"
35	},	35	},
36	"streettype": {	36	"streettype": {
37	"type": "string",	37	"type": ["string", "null"],
38	"description": "street type of patron's primary address"	38	"description": "street type of patron's primary address"
39	},	39	},
40	"address": {	40	"address": {
Lines 42-48 Link Here
42	"description": "first address line of patron's primary address"	42	"description": "first address line of patron's primary address"
43	},	43	},
44	"address2": {	44	"address2": {
45	"type": "string",	45	"type": ["string", "null"],
46	"description": "second address line of patron's primary address"	46	"description": "second address line of patron's primary address"
47	},	47	},
48	"city": {	48	"city": {
Lines 50-132 Link Here
50	"description": "city or town of patron's primary address"	50	"description": "city or town of patron's primary address"
51	},	51	},
52	"state": {	52	"state": {
53	"type": "string",	53	"type": ["string", "null"],
54	"description": "state or province of patron's primary address"	54	"description": "state or province of patron's primary address"
55	},	55	},
56	"zipcode": {	56	"zipcode": {
57	"type": "string",	57	"type": ["string", "null"],
58	"description": "zip or postal code of patron's primary address"	58	"description": "zip or postal code of patron's primary address"
59	},	59	},
60	"country": {	60	"country": {
61	"type": "string",	61	"type": ["string", "null"],
62	"description": "country of patron's primary address"	62	"description": "country of patron's primary address"
63	},	63	},
64	"email": {	64	"email": {
65	"type": "string",	65	"type": ["string", "null"],
66	"description": "primary email address for patron's primary address"	66	"description": "primary email address for patron's primary address"
67	},	67	},
68	"phone": {	68	"phone": {
69	"type": "string",	69	"type": ["string", "null"],
70	"description": "primary phone number for patron's primary address"	70	"description": "primary phone number for patron's primary address"
71	},	71	},
72	"mobile": {	72	"mobile": {
73	"type": "string",	73	"type": ["string", "null"],
74	"description": "the other phone number for patron's primary address"	74	"description": "the other phone number for patron's primary address"
75	},	75	},
76	"fax": {	76	"fax": {
77	"type": "string",	77	"type": ["string", "null"],
78	"description": "fax number for patron's primary address"	78	"description": "fax number for patron's primary address"
79	},	79	},
80	"emailpro": {	80	"emailpro": {
81	"type": "string",	81	"type": ["string", "null"],
82	"description": "secondary email address for patron's primary address"	82	"description": "secondary email address for patron's primary address"
83	},	83	},
84	"phonepro": {	84	"phonepro": {
85	"type": "string",	85	"type": ["string", "null"],
86	"description": "secondary phone number for patron's primary address"	86	"description": "secondary phone number for patron's primary address"
87	},	87	},
88	"B_streetnumber": {	88	"B_streetnumber": {
89	"type": "string",	89	"type": ["string", "null"],
90	"description": "street number of patron's alternate address"	90	"description": "street number of patron's alternate address"
91	},	91	},
92	"B_streettype": {	92	"B_streettype": {
93	"type": "string",	93	"type": ["string", "null"],
94	"description": "street type of patron's alternate address"	94	"description": "street type of patron's alternate address"
95	},	95	},
96	"B_address": {	96	"B_address": {
97	"type": "string",	97	"type": ["string", "null"],
98	"description": "first address line of patron's alternate address"	98	"description": "first address line of patron's alternate address"
99	},	99	},
100	"B_address2": {	100	"B_address2": {
101	"type": "string",	101	"type": ["string", "null"],
102	"description": "second address line of patron's alternate address"	102	"description": "second address line of patron's alternate address"
103	},	103	},
104	"B_city": {	104	"B_city": {
105	"type": "string",	105	"type": ["string", "null"],
106	"description": "city or town of patron's alternate address"	106	"description": "city or town of patron's alternate address"
107	},	107	},
108	"B_state": {	108	"B_state": {
109	"type": "string",	109	"type": ["string", "null"],
110	"description": "state or province of patron's alternate address"	110	"description": "state or province of patron's alternate address"
111	},	111	},
112	"B_zipcode": {	112	"B_zipcode": {
113	"type": "string",	113	"type": ["string", "null"],
114	"description": "zip or postal code of patron's alternate address"	114	"description": "zip or postal code of patron's alternate address"
115	},	115	},
116	"B_country": {	116	"B_country": {
117	"type": "string",	117	"type": ["string", "null"],
118	"description": "country of patron's alternate address"	118	"description": "country of patron's alternate address"
119	},	119	},
120	"B_email": {	120	"B_email": {
121	"type": "string",	121	"type": ["string", "null"],
122	"description": "email address for patron's alternate address"	122	"description": "email address for patron's alternate address"
123	},	123	},
124	"B_phone": {	124	"B_phone": {
125	"type": "string",	125	"type": ["string", "null"],
126	"description": "phone number for patron's alternate address"	126	"description": "phone number for patron's alternate address"
127	},	127	},
128	"dateofbirth": {	128	"dateofbirth": {
129	"type": "string",	129	"type": ["string", "null"],
130	"description": "patron's date of birth"	130	"description": "patron's date of birth"
131	},	131	},
132	"branchcode": {	132	"branchcode": {
Lines 138-268 Link Here
138	"description": "code of patron's category"	138	"description": "code of patron's category"
139	},	139	},
140	"dateenrolled": {	140	"dateenrolled": {
141	"type": "string",	141	"type": ["string", "null"],
142	"description": "date the patron was added to Koha"	142	"description": "date the patron was added to Koha"
143	},	143	},
144	"dateexpiry": {	144	"dateexpiry": {
145	"type": "string",	145	"type": ["string", "null"],
146	"description": "date the patron's card is set to expire"	146	"description": "date the patron's card is set to expire"
147	},	147	},
148	"gonenoaddress": {	148	"gonenoaddress": {
149	"type": "string",	149	"type": ["string", "null"],
150	"description": "set to 1 if library marked this patron as having an unconfirmed address"	150	"description": "set to 1 if library marked this patron as having an unconfirmed address"
151	},	151	},
152	"lost": {	152	"lost": {
153	"type": "string",	153	"type": ["string", "null"],
154	"description": "set to 1 if library marked this patron as having lost his card"	154	"description": "set to 1 if library marked this patron as having lost his card"
155	},	155	},
156	"debarred": {	156	"debarred": {
157	"type": "string",	157	"type": ["string", "null"],
158	"description": "until this date the patron can only check-in"	158	"description": "until this date the patron can only check-in"
159	},	159	},
160	"debarredcomment": {	160	"debarredcomment": {
161	"type": "string",	161	"type": ["string", "null"],
162	"description": "comment on the stop of the patron"	162	"description": "comment on the stop of the patron"
163	},	163	},
164	"contactname": {	164	"contactname": {
165	"type": "string",	165	"type": ["string", "null"],
166	"description": "used for children and professionals to include surname or last name of guarantor or organization name"	166	"description": "used for children and professionals to include surname or last name of guarantor or organization name"
167	},	167	},
168	"contactfirstname": {	168	"contactfirstname": {
169	"type": "string",	169	"type": ["string", "null"],
170	"description": "used for children to include first name of guarantor"	170	"description": "used for children to include first name of guarantor"
171	},	171	},
172	"contacttitle": {	172	"contacttitle": {
173	"type": "string",	173	"type": ["string", "null"],
174	"description": "used for children to include title of guarantor"	174	"description": "used for children to include title of guarantor"
175	},	175	},
176	"guarantorid": {	176	"guarantorid": {
177	"type": "integer",	177	"type": ["string", "null"],
178	"description": "borrowernumber used for children or professionals to link them to guarantor or organizations"	178	"description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
179	},	179	},
180	"borrowernotes": {	180	"borrowernotes": {
181	"type": "string",	181	"type": ["string", "null"],
182	"description": "a note on the patron's account"	182	"description": "a note on the patron's account"
183	},	183	},
184	"relationship": {	184	"relationship": {
185	"type": "string",	185	"type": ["string", "null"],
186	"description": "used for children to include the relationship to their guarantor"	186	"description": "used for children to include the relationship to their guarantor"
187	},	187	},
188	"ethnicity": {	188	"ethnicity": {
189	"type": "string",	189	"type": ["string", "null"],
190	"description": "unused"	190	"description": "unused"
191	},	191	},
192	"ethnotes": {	192	"ethnotes": {
193	"type": "string",	193	"type": ["string", "null"],
194	"description": "unused"	194	"description": "unused"
195	},	195	},
196	"sex": {	196	"sex": {
197	"type": "string",	197	"type": ["string", "null"],
198	"description": "patron's gender"	198	"description": "patron's gender"
199	},	199	},
200	"password": {	200	"password": {
201	"type": "string",	201	"type": ["string", "null"],
202	"description": "patron's encrypted password"	202	"description": "patron's encrypted password"
203	},	203	},
204	"flags": {	204	"flags": {
205	"type": "string",	205	"type": ["string", "null"],
206	"description": "a number associated with the patron's permissions"	206	"description": "a number associated with the patron's permissions"
207	},	207	},
208	"userid": {	208	"userid": {
209	"type": "string",	209	"type": ["string", "null"],
210	"description": "patron's login"	210	"description": "patron's login"
211	},	211	},
212	"opacnote": {	212	"opacnote": {
213	"type": "string",	213	"type": ["string", "null"],
214	"description": "a note on the patron's account visible in OPAC and staff client"	214	"description": "a note on the patron's account visible in OPAC and staff client"
215	},	215	},
216	"contactnote": {	216	"contactnote": {
217	"type": "string",	217	"type": ["string", "null"],
218	"description": "a note related to patron's alternate address"	218	"description": "a note related to patron's alternate address"
219	},	219	},
220	"sort1": {	220	"sort1": {
221	"type": "string",	221	"type": ["string", "null"],
222	"description": "a field that can be used for any information unique to the library"	222	"description": "a field that can be used for any information unique to the library"
223	},	223	},
224	"sort2": {	224	"sort2": {
225	"type": "string",	225	"type": ["string", "null"],
226	"description": "a field that can be used for any information unique to the library"	226	"description": "a field that can be used for any information unique to the library"
227	},	227	},
228	"altcontactfirstname": {	228	"altcontactfirstname": {
229	"type": "string",	229	"type": ["string", "null"],
230	"description": "first name of alternate contact for the patron"	230	"description": "first name of alternate contact for the patron"
231	},	231	},
232	"altcontactsurname": {	232	"altcontactsurname": {
233	"type": "string",	233	"type": ["string", "null"],
234	"description": "surname or last name of the alternate contact for the patron"	234	"description": "surname or last name of the alternate contact for the patron"
235	},	235	},
236	"altcontactaddress1": {	236	"altcontactaddress1": {
237	"type": "string",	237	"type": ["string", "null"],
238	"description": "the first address line for the alternate contact for the patron"	238	"description": "the first address line for the alternate contact for the patron"
239	},	239	},
240	"altcontactaddress2": {	240	"altcontactaddress2": {
241	"type": "string",	241	"type": ["string", "null"],
242	"description": "the second address line for the alternate contact for the patron"	242	"description": "the second address line for the alternate contact for the patron"
243	},	243	},
244	"altcontactaddress3": {	244	"altcontactaddress3": {
245	"type": "string",	245	"type": ["string", "null"],
246	"description": "the city for the alternate contact for the patron"	246	"description": "the city for the alternate contact for the patron"
247	},	247	},
248	"altcontactstate": {	248	"altcontactstate": {
249	"type": "string",	249	"type": ["string", "null"],
250	"description": "the state for the alternate contact for the patron"	250	"description": "the state for the alternate contact for the patron"
251	},	251	},
252	"altcontactzipcode": {	252	"altcontactzipcode": {
253	"type": "string",	253	"type": ["string", "null"],
254	"description": "the zipcode for the alternate contact for the patron"	254	"description": "the zipcode for the alternate contact for the patron"
255	},	255	},
256	"altcontactcountry": {	256	"altcontactcountry": {
257	"type": "string",	257	"type": ["string", "null"],
258	"description": "the country for the alternate contact for the patron"	258	"description": "the country for the alternate contact for the patron"
259	},	259	},
260	"altcontactphone": {	260	"altcontactphone": {
261	"type": "string",	261	"type": ["string", "null"],
262	"description": "the phone number for the alternate contact for the patron"	262	"description": "the phone number for the alternate contact for the patron"
263	},	263	},
264	"smsalertnumber": {	264	"smsalertnumber": {
265	"type": "string",	265	"type": ["string", "null"],
266	"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"	266	"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
267	},	267	},
268	"privacy": {	268	"privacy": {
269	-