spectacle 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +22 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +13 -0
- data/Rakefile +10 -0
- data/certs/gem-public_cert.pem +21 -0
- data/config/routes.rb +3 -0
- data/lib/spectacle.rb +5 -0
- data/lib/spectacle/config.rb +79 -0
- data/lib/spectacle/dsl.rb +337 -0
- data/lib/spectacle/engine.rb +8 -0
- data/lib/spectacle/task.rb +7 -0
- data/lib/spectacle/version.rb +3 -0
- data/lib/tasks/spectacle.rake +10 -0
- data/spec/fixtures/tommy.json +2469 -0
- data/spec/lib/spectacle/dsl_spec.rb +13 -0
- data/spec/spec_helper.rb +56 -0
- data/spectacle.gemspec +30 -0
- metadata +137 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
namespace :spectacle do
|
|
2
|
+
|
|
3
|
+
desc "Generate Spectacle static documentation"
|
|
4
|
+
task docs: [:environment] do |t,args|
|
|
5
|
+
# results = Spectacle::Generator.write_docs(Spectacle::Config.registered_apis)
|
|
6
|
+
# results.each do |k,v|
|
|
7
|
+
# puts "#{k}: #{v[:processed].count} processed / #{v[:skipped].count} skipped"
|
|
8
|
+
# end
|
|
9
|
+
end
|
|
10
|
+
end
|
|
@@ -0,0 +1,2469 @@
|
|
|
1
|
+
{
|
|
2
|
+
"swagger": "2.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "PayApp",
|
|
5
|
+
"description": "PayApp Payroll System",
|
|
6
|
+
"version": "1.0.0"
|
|
7
|
+
},
|
|
8
|
+
"host": "api.mytommy.com",
|
|
9
|
+
"schemes": [
|
|
10
|
+
"http",
|
|
11
|
+
"https"
|
|
12
|
+
],
|
|
13
|
+
"basePath": "/api/v1",
|
|
14
|
+
"securityDefinitions": {
|
|
15
|
+
"basicAuth": {
|
|
16
|
+
"type": "basic",
|
|
17
|
+
"description": "HTTP Basic Authentication. Works over `HTTP` and `HTTPS`"
|
|
18
|
+
},
|
|
19
|
+
"api_key": {
|
|
20
|
+
"type": "apiKey",
|
|
21
|
+
"name": "api_key",
|
|
22
|
+
"in": "header"
|
|
23
|
+
},
|
|
24
|
+
"petstore_auth": {
|
|
25
|
+
"type": "oauth2",
|
|
26
|
+
"authorizationUrl": "http://swagger.io/api/oauth/dialog",
|
|
27
|
+
"flow": "implicit",
|
|
28
|
+
"scopes": {
|
|
29
|
+
"write:pets": "modify pets in your account",
|
|
30
|
+
"read:pets": "read your pets"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"produces": [
|
|
35
|
+
"application/json"
|
|
36
|
+
],
|
|
37
|
+
"paths": {
|
|
38
|
+
"/user/accounts": {
|
|
39
|
+
"get": {
|
|
40
|
+
"summary": "List of Accounts including Employer(s)",
|
|
41
|
+
"description": "Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)\n",
|
|
42
|
+
"tags": [
|
|
43
|
+
"User"
|
|
44
|
+
],
|
|
45
|
+
"responses": {
|
|
46
|
+
"200": {
|
|
47
|
+
"description": "An array of accounts",
|
|
48
|
+
"examples": {
|
|
49
|
+
"application/json": {
|
|
50
|
+
"name": "Puma",
|
|
51
|
+
"type": "Dog",
|
|
52
|
+
"color": "Black",
|
|
53
|
+
"gender": "Female",
|
|
54
|
+
"breed": "Mixed"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"headers": {
|
|
58
|
+
"X-Rate-Limit-Limit": {
|
|
59
|
+
"description": "The number of allowed requests in the current period",
|
|
60
|
+
"type": "integer"
|
|
61
|
+
},
|
|
62
|
+
"X-Rate-Limit-Remaining": {
|
|
63
|
+
"description": "The number of remaining requests in the current period",
|
|
64
|
+
"type": "integer"
|
|
65
|
+
},
|
|
66
|
+
"X-Rate-Limit-Reset": {
|
|
67
|
+
"description": "The number of seconds left in the current period",
|
|
68
|
+
"type": "integer"
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"schema": {
|
|
72
|
+
"type": "array",
|
|
73
|
+
"items": {
|
|
74
|
+
"$ref": "#/definitions/Accounts"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"default": {
|
|
79
|
+
"description": "Unexpected error",
|
|
80
|
+
"schema": {
|
|
81
|
+
"$ref": "#/definitions/Error"
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"/employer/{employer_id}": {
|
|
88
|
+
"get": {
|
|
89
|
+
"summary": "Employer Own Profile",
|
|
90
|
+
"description": "Employer profile. \n*Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2\n",
|
|
91
|
+
"parameters": [
|
|
92
|
+
{
|
|
93
|
+
"name": "employer_id",
|
|
94
|
+
"in": "path",
|
|
95
|
+
"required": true,
|
|
96
|
+
"type": "string",
|
|
97
|
+
"description": "Unique employer identifier to be used for fetching specific employer profile data."
|
|
98
|
+
}
|
|
99
|
+
],
|
|
100
|
+
"tags": [
|
|
101
|
+
"Employer"
|
|
102
|
+
],
|
|
103
|
+
"responses": {
|
|
104
|
+
"200": {
|
|
105
|
+
"description": "Profile information for an employer",
|
|
106
|
+
"schema": {
|
|
107
|
+
"$ref": "#/definitions/EmployerOwnProfile"
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"default": {
|
|
111
|
+
"description": "Unexpected error",
|
|
112
|
+
"schema": {
|
|
113
|
+
"$ref": "#/definitions/Error"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"put": {
|
|
119
|
+
"summary": "Update Employer Data",
|
|
120
|
+
"description": "This updates individual or group of employer's records\n*Pages 3_Account_EmployerProfile_*\n",
|
|
121
|
+
"parameters": [
|
|
122
|
+
{
|
|
123
|
+
"name": "employer_id",
|
|
124
|
+
"in": "path",
|
|
125
|
+
"required": true,
|
|
126
|
+
"type": "string",
|
|
127
|
+
"description": "Unique employer identifier to be used for fetching specific employer profile data."
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"in": "body",
|
|
131
|
+
"name": "body",
|
|
132
|
+
"required": false,
|
|
133
|
+
"description": "Unique employer identifier to be used for fetching specific employer profile data.",
|
|
134
|
+
"schema": {
|
|
135
|
+
"$ref": "#/definitions/EmployerOwnProfile"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
],
|
|
139
|
+
"tags": [
|
|
140
|
+
"Employer"
|
|
141
|
+
],
|
|
142
|
+
"responses": {
|
|
143
|
+
"200": {
|
|
144
|
+
"description": "Employer update success"
|
|
145
|
+
},
|
|
146
|
+
"default": {
|
|
147
|
+
"description": "Unexpected error",
|
|
148
|
+
"schema": {
|
|
149
|
+
"$ref": "#/definitions/Error"
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"/employer/employees/listbylocation/{employer_id}/{location_id}": {
|
|
156
|
+
"get": {
|
|
157
|
+
"summary": "Employer Employee List by Location",
|
|
158
|
+
"description": "List all employees under the employer's location\n",
|
|
159
|
+
"parameters": [
|
|
160
|
+
{
|
|
161
|
+
"name": "employer_id",
|
|
162
|
+
"in": "path",
|
|
163
|
+
"required": true,
|
|
164
|
+
"type": "string",
|
|
165
|
+
"description": "Unique employer identifier to be used for fetching specific employer profile data."
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"name": "location_id",
|
|
169
|
+
"in": "path",
|
|
170
|
+
"required": true,
|
|
171
|
+
"type": "string"
|
|
172
|
+
}
|
|
173
|
+
],
|
|
174
|
+
"tags": [
|
|
175
|
+
"Employees",
|
|
176
|
+
"Employer"
|
|
177
|
+
],
|
|
178
|
+
"responses": {
|
|
179
|
+
"200": {
|
|
180
|
+
"description": "List of employees profile",
|
|
181
|
+
"schema": {
|
|
182
|
+
"$ref": "#/definitions/UserProfile"
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
"default": {
|
|
186
|
+
"description": "Unexpected error",
|
|
187
|
+
"schema": {
|
|
188
|
+
"$ref": "#/definitions/Error"
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"/employer/employees": {
|
|
195
|
+
"get": {
|
|
196
|
+
"summary": "Employer Employee List",
|
|
197
|
+
"parameters": [
|
|
198
|
+
{
|
|
199
|
+
"name": "employer_id",
|
|
200
|
+
"in": "query",
|
|
201
|
+
"required": true,
|
|
202
|
+
"type": "string",
|
|
203
|
+
"description": "Unique employer identifier to be used for fetching specific employer profile data."
|
|
204
|
+
}
|
|
205
|
+
],
|
|
206
|
+
"tags": [
|
|
207
|
+
"Employees"
|
|
208
|
+
],
|
|
209
|
+
"responses": {
|
|
210
|
+
"200": {
|
|
211
|
+
"description": "List of employees profile",
|
|
212
|
+
"schema": {
|
|
213
|
+
"$ref": "#/definitions/UserProfile"
|
|
214
|
+
}
|
|
215
|
+
},
|
|
216
|
+
"default": {
|
|
217
|
+
"description": "Unexpected error",
|
|
218
|
+
"schema": {
|
|
219
|
+
"$ref": "#/definitions/Error"
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
},
|
|
225
|
+
"/employee/{employee_id}": {
|
|
226
|
+
"get": {
|
|
227
|
+
"summary": "Employee Profile",
|
|
228
|
+
"description": "E_Employee-Profile (part1)\n",
|
|
229
|
+
"parameters": [
|
|
230
|
+
{
|
|
231
|
+
"name": "employee_id",
|
|
232
|
+
"in": "path",
|
|
233
|
+
"required": true,
|
|
234
|
+
"type": "integer"
|
|
235
|
+
}
|
|
236
|
+
],
|
|
237
|
+
"tags": [
|
|
238
|
+
"Employee"
|
|
239
|
+
],
|
|
240
|
+
"responses": {
|
|
241
|
+
"200": {
|
|
242
|
+
"description": "employee profile",
|
|
243
|
+
"schema": {
|
|
244
|
+
"$ref": "#/definitions/UserProfile"
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"default": {
|
|
248
|
+
"description": "Unexpected error",
|
|
249
|
+
"schema": {
|
|
250
|
+
"$ref": "#/definitions/Error"
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"/employee/unavailability/{employee_id}/{date_start}/{date_end}": {
|
|
257
|
+
"get": {
|
|
258
|
+
"summary": "Employee Profile Availability",
|
|
259
|
+
"description": "E_Employee-Profile_Availability (Calendar View - date clicked)\n",
|
|
260
|
+
"parameters": [
|
|
261
|
+
{
|
|
262
|
+
"name": "employee_id",
|
|
263
|
+
"in": "path",
|
|
264
|
+
"required": true,
|
|
265
|
+
"type": "integer"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "date_start",
|
|
269
|
+
"in": "path",
|
|
270
|
+
"required": true,
|
|
271
|
+
"type": "string"
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"name": "date_end",
|
|
275
|
+
"in": "path",
|
|
276
|
+
"required": true,
|
|
277
|
+
"type": "string"
|
|
278
|
+
}
|
|
279
|
+
],
|
|
280
|
+
"tags": [
|
|
281
|
+
"Employee"
|
|
282
|
+
],
|
|
283
|
+
"responses": {
|
|
284
|
+
"200": {
|
|
285
|
+
"description": "employee unavailability within the current selecte date range",
|
|
286
|
+
"schema": {
|
|
287
|
+
"$ref": "#/definitions/Unavailability"
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"default": {
|
|
291
|
+
"description": "Unexpected error",
|
|
292
|
+
"schema": {
|
|
293
|
+
"$ref": "#/definitions/Error"
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
"/employee/unavailability": {
|
|
300
|
+
"post": {
|
|
301
|
+
"summary": "Add Employee Unavailability",
|
|
302
|
+
"description": "E_Employee-Profile_Availability (Calendar View - date clicked)\n",
|
|
303
|
+
"tags": [
|
|
304
|
+
"Unavailability"
|
|
305
|
+
],
|
|
306
|
+
"parameters": [
|
|
307
|
+
{
|
|
308
|
+
"in": "body",
|
|
309
|
+
"name": "body",
|
|
310
|
+
"required": false,
|
|
311
|
+
"description": "accepts unavailability form data.",
|
|
312
|
+
"schema": {
|
|
313
|
+
"$ref": "#/definitions/Unavailability"
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
"responses": {
|
|
318
|
+
"200": {
|
|
319
|
+
"description": "Unavailability added successfully"
|
|
320
|
+
},
|
|
321
|
+
"default": {
|
|
322
|
+
"description": "Unexpected error",
|
|
323
|
+
"schema": {
|
|
324
|
+
"$ref": "#/definitions/Error"
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
},
|
|
330
|
+
"/employee/unavailability/{employee_unavailability_id}": {
|
|
331
|
+
"delete": {
|
|
332
|
+
"summary": "Delete Employee Unavailability",
|
|
333
|
+
"description": "E_Employee-Profile_Availability_Edit (Delete confirmation)\n",
|
|
334
|
+
"tags": [
|
|
335
|
+
"Unavailability"
|
|
336
|
+
],
|
|
337
|
+
"parameters": [
|
|
338
|
+
{
|
|
339
|
+
"name": "employee_unavailability_id",
|
|
340
|
+
"in": "path",
|
|
341
|
+
"required": true,
|
|
342
|
+
"type": "integer"
|
|
343
|
+
}
|
|
344
|
+
],
|
|
345
|
+
"responses": {
|
|
346
|
+
"200": {
|
|
347
|
+
"description": "Unavailability deleted successfully"
|
|
348
|
+
},
|
|
349
|
+
"default": {
|
|
350
|
+
"description": "Unexpected error",
|
|
351
|
+
"schema": {
|
|
352
|
+
"$ref": "#/definitions/Error"
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
},
|
|
358
|
+
"/employee/shift/{employee_id}/{date_start}/{date_end}": {
|
|
359
|
+
"get": {
|
|
360
|
+
"summary": "Employee Profile Shifts",
|
|
361
|
+
"description": "E_Employee-Profile_Shifts (calendar view – clicked)\nE_Employee-Profile_Shifts (List View)\n",
|
|
362
|
+
"parameters": [
|
|
363
|
+
{
|
|
364
|
+
"name": "employee_id",
|
|
365
|
+
"in": "path",
|
|
366
|
+
"required": true,
|
|
367
|
+
"type": "integer"
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"name": "date_start",
|
|
371
|
+
"in": "path",
|
|
372
|
+
"required": true,
|
|
373
|
+
"type": "string"
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "date_end",
|
|
377
|
+
"in": "path",
|
|
378
|
+
"required": true,
|
|
379
|
+
"type": "string"
|
|
380
|
+
}
|
|
381
|
+
],
|
|
382
|
+
"tags": [
|
|
383
|
+
"Employee"
|
|
384
|
+
],
|
|
385
|
+
"responses": {
|
|
386
|
+
"200": {
|
|
387
|
+
"description": "employee shifts within the current selecte date range",
|
|
388
|
+
"schema": {
|
|
389
|
+
"$ref": "#/definitions/EmployeeShifts"
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"default": {
|
|
393
|
+
"description": "Unexpected error",
|
|
394
|
+
"schema": {
|
|
395
|
+
"$ref": "#/definitions/Error"
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
}
|
|
399
|
+
}
|
|
400
|
+
},
|
|
401
|
+
"/employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end}": {
|
|
402
|
+
"get": {
|
|
403
|
+
"summary": "Employe Shifts",
|
|
404
|
+
"parameters": [
|
|
405
|
+
{
|
|
406
|
+
"name": "employer_id",
|
|
407
|
+
"in": "path",
|
|
408
|
+
"required": true,
|
|
409
|
+
"type": "integer"
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "location_id",
|
|
413
|
+
"in": "path",
|
|
414
|
+
"required": true,
|
|
415
|
+
"type": "integer"
|
|
416
|
+
},
|
|
417
|
+
{
|
|
418
|
+
"name": "date_start",
|
|
419
|
+
"in": "path",
|
|
420
|
+
"required": true,
|
|
421
|
+
"type": "string"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "date_end",
|
|
425
|
+
"in": "path",
|
|
426
|
+
"required": true,
|
|
427
|
+
"type": "string"
|
|
428
|
+
}
|
|
429
|
+
],
|
|
430
|
+
"tags": [
|
|
431
|
+
"Shift"
|
|
432
|
+
],
|
|
433
|
+
"responses": {
|
|
434
|
+
"200": {
|
|
435
|
+
"description": "employer shifts count within the current selecte date range",
|
|
436
|
+
"schema": {
|
|
437
|
+
"$ref": "#/definitions/EmployerShiftsMonth"
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
"default": {
|
|
441
|
+
"description": "Unexpected error",
|
|
442
|
+
"schema": {
|
|
443
|
+
"$ref": "#/definitions/Error"
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
"/employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end}": {
|
|
450
|
+
"get": {
|
|
451
|
+
"summary": "Employe Shifts",
|
|
452
|
+
"parameters": [
|
|
453
|
+
{
|
|
454
|
+
"name": "employer_id",
|
|
455
|
+
"in": "path",
|
|
456
|
+
"required": true,
|
|
457
|
+
"type": "integer"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "location_id",
|
|
461
|
+
"in": "path",
|
|
462
|
+
"required": true,
|
|
463
|
+
"type": "integer"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "date_start",
|
|
467
|
+
"in": "path",
|
|
468
|
+
"required": true,
|
|
469
|
+
"type": "string"
|
|
470
|
+
},
|
|
471
|
+
{
|
|
472
|
+
"name": "date_end",
|
|
473
|
+
"in": "path",
|
|
474
|
+
"required": true,
|
|
475
|
+
"type": "string"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"tags": [
|
|
479
|
+
"Shift"
|
|
480
|
+
],
|
|
481
|
+
"responses": {
|
|
482
|
+
"200": {
|
|
483
|
+
"description": "employer shifts count within the current selecte date range",
|
|
484
|
+
"schema": {
|
|
485
|
+
"$ref": "#/definitions/EmployerShifts"
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"default": {
|
|
489
|
+
"description": "Unexpected error",
|
|
490
|
+
"schema": {
|
|
491
|
+
"$ref": "#/definitions/Error"
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
"/shift/publish": {
|
|
498
|
+
"put": {
|
|
499
|
+
"summary": "Publish Employer Shifts",
|
|
500
|
+
"parameters": [
|
|
501
|
+
{
|
|
502
|
+
"name": "employer_shift_id",
|
|
503
|
+
"in": "query",
|
|
504
|
+
"required": true,
|
|
505
|
+
"type": "integer"
|
|
506
|
+
}
|
|
507
|
+
],
|
|
508
|
+
"tags": [
|
|
509
|
+
"Shift"
|
|
510
|
+
],
|
|
511
|
+
"responses": {
|
|
512
|
+
"200": {
|
|
513
|
+
"description": "shift published"
|
|
514
|
+
},
|
|
515
|
+
"default": {
|
|
516
|
+
"description": "Unexpected error",
|
|
517
|
+
"schema": {
|
|
518
|
+
"$ref": "#/definitions/Error"
|
|
519
|
+
}
|
|
520
|
+
}
|
|
521
|
+
}
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"/shift/{employer_shift_id}": {
|
|
525
|
+
"put": {
|
|
526
|
+
"summary": "Employer Shift Update",
|
|
527
|
+
"parameters": [
|
|
528
|
+
{
|
|
529
|
+
"name": "employer_shift_id",
|
|
530
|
+
"in": "path",
|
|
531
|
+
"required": true,
|
|
532
|
+
"type": "integer"
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"in": "body",
|
|
536
|
+
"name": "body",
|
|
537
|
+
"required": false,
|
|
538
|
+
"description": "accepts shift form data.",
|
|
539
|
+
"schema": {
|
|
540
|
+
"$ref": "#/definitions/EmployerShifts"
|
|
541
|
+
}
|
|
542
|
+
}
|
|
543
|
+
],
|
|
544
|
+
"tags": [
|
|
545
|
+
"Shift"
|
|
546
|
+
],
|
|
547
|
+
"responses": {
|
|
548
|
+
"200": {
|
|
549
|
+
"description": "shift details updated"
|
|
550
|
+
},
|
|
551
|
+
"default": {
|
|
552
|
+
"description": "Unexpected error",
|
|
553
|
+
"schema": {
|
|
554
|
+
"$ref": "#/definitions/Error"
|
|
555
|
+
}
|
|
556
|
+
}
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
},
|
|
560
|
+
"/shift": {
|
|
561
|
+
"post": {
|
|
562
|
+
"summary": "Add Employer Shift",
|
|
563
|
+
"parameters": [
|
|
564
|
+
{
|
|
565
|
+
"in": "body",
|
|
566
|
+
"name": "body",
|
|
567
|
+
"required": false,
|
|
568
|
+
"description": "accepts shift form data.",
|
|
569
|
+
"schema": {
|
|
570
|
+
"$ref": "#/definitions/EmployerShifts"
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
],
|
|
574
|
+
"tags": [
|
|
575
|
+
"Shift"
|
|
576
|
+
],
|
|
577
|
+
"responses": {
|
|
578
|
+
"200": {
|
|
579
|
+
"description": "shift added"
|
|
580
|
+
},
|
|
581
|
+
"default": {
|
|
582
|
+
"description": "Unexpected error",
|
|
583
|
+
"schema": {
|
|
584
|
+
"$ref": "#/definitions/Error"
|
|
585
|
+
}
|
|
586
|
+
}
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
},
|
|
590
|
+
"/employee/shift/{employee_id}": {
|
|
591
|
+
"get": {
|
|
592
|
+
"summary": "Employee Shift",
|
|
593
|
+
"parameters": [
|
|
594
|
+
{
|
|
595
|
+
"name": "employee_id",
|
|
596
|
+
"in": "path",
|
|
597
|
+
"required": true,
|
|
598
|
+
"type": "integer"
|
|
599
|
+
}
|
|
600
|
+
],
|
|
601
|
+
"tags": [
|
|
602
|
+
"Shift"
|
|
603
|
+
],
|
|
604
|
+
"responses": {
|
|
605
|
+
"200": {
|
|
606
|
+
"description": "shift added",
|
|
607
|
+
"schema": {
|
|
608
|
+
"$ref": "#/definitions/EmployeeShift"
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
"default": {
|
|
612
|
+
"description": "Unexpected error",
|
|
613
|
+
"schema": {
|
|
614
|
+
"$ref": "#/definitions/Error"
|
|
615
|
+
}
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
},
|
|
620
|
+
"/shift/scheduled/{employer_shift_id}": {
|
|
621
|
+
"get": {
|
|
622
|
+
"summary": "List Employees Scheduled on this Shift",
|
|
623
|
+
"parameters": [
|
|
624
|
+
{
|
|
625
|
+
"name": "employer_shift_id",
|
|
626
|
+
"in": "path",
|
|
627
|
+
"required": true,
|
|
628
|
+
"type": "integer"
|
|
629
|
+
}
|
|
630
|
+
],
|
|
631
|
+
"tags": [
|
|
632
|
+
"Shift"
|
|
633
|
+
],
|
|
634
|
+
"responses": {
|
|
635
|
+
"200": {
|
|
636
|
+
"description": "list of employees",
|
|
637
|
+
"schema": {
|
|
638
|
+
"$ref": "#/definitions/UserProfile"
|
|
639
|
+
}
|
|
640
|
+
},
|
|
641
|
+
"default": {
|
|
642
|
+
"description": "Unexpected error",
|
|
643
|
+
"schema": {
|
|
644
|
+
"$ref": "#/definitions/Error"
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
},
|
|
650
|
+
"/shift/add/employee/{employer_shift_id}": {
|
|
651
|
+
"post": {
|
|
652
|
+
"summary": "Add employee on shift",
|
|
653
|
+
"parameters": [
|
|
654
|
+
{
|
|
655
|
+
"name": "employer_shift_id",
|
|
656
|
+
"in": "path",
|
|
657
|
+
"required": true,
|
|
658
|
+
"type": "integer"
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
"name": "employee_id",
|
|
662
|
+
"in": "query",
|
|
663
|
+
"required": true,
|
|
664
|
+
"type": "integer"
|
|
665
|
+
}
|
|
666
|
+
],
|
|
667
|
+
"tags": [
|
|
668
|
+
"Shift"
|
|
669
|
+
],
|
|
670
|
+
"responses": {
|
|
671
|
+
"200": {
|
|
672
|
+
"description": "add employee to shift"
|
|
673
|
+
},
|
|
674
|
+
"default": {
|
|
675
|
+
"description": "Unexpected error",
|
|
676
|
+
"schema": {
|
|
677
|
+
"$ref": "#/definitions/Error"
|
|
678
|
+
}
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
},
|
|
683
|
+
"/shift/employee/{employer_shift_assigned_id}/": {
|
|
684
|
+
"delete": {
|
|
685
|
+
"summary": "Remove employee on shift",
|
|
686
|
+
"parameters": [
|
|
687
|
+
{
|
|
688
|
+
"name": "employer_shift_assigned_id",
|
|
689
|
+
"in": "path",
|
|
690
|
+
"required": true,
|
|
691
|
+
"type": "integer"
|
|
692
|
+
}
|
|
693
|
+
],
|
|
694
|
+
"tags": [
|
|
695
|
+
"Shift"
|
|
696
|
+
],
|
|
697
|
+
"responses": {
|
|
698
|
+
"200": {
|
|
699
|
+
"description": "employee removed"
|
|
700
|
+
},
|
|
701
|
+
"default": {
|
|
702
|
+
"description": "Unexpected error",
|
|
703
|
+
"schema": {
|
|
704
|
+
"$ref": "#/definitions/Error"
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
},
|
|
710
|
+
"/user/employer/employee-profile/{location_id}": {
|
|
711
|
+
"get": {
|
|
712
|
+
"summary": "Employer Own Profile",
|
|
713
|
+
"description": "List all employees under the employer's location\n",
|
|
714
|
+
"parameters": [
|
|
715
|
+
{
|
|
716
|
+
"name": "location_id",
|
|
717
|
+
"in": "path",
|
|
718
|
+
"required": true,
|
|
719
|
+
"type": "string"
|
|
720
|
+
}
|
|
721
|
+
],
|
|
722
|
+
"tags": [
|
|
723
|
+
"Employees",
|
|
724
|
+
"Employer"
|
|
725
|
+
],
|
|
726
|
+
"responses": {
|
|
727
|
+
"200": {
|
|
728
|
+
"description": "List of employees profile",
|
|
729
|
+
"schema": {
|
|
730
|
+
"$ref": "#/definitions/UserProfile"
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"default": {
|
|
734
|
+
"description": "Unexpected error",
|
|
735
|
+
"schema": {
|
|
736
|
+
"$ref": "#/definitions/Error"
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
},
|
|
742
|
+
"/user": {
|
|
743
|
+
"put": {
|
|
744
|
+
"security": [
|
|
745
|
+
{
|
|
746
|
+
"api_key": []
|
|
747
|
+
}
|
|
748
|
+
],
|
|
749
|
+
"summary": "Update User Data",
|
|
750
|
+
"description": "This updates individual or group of user's records\n*Pages 3_Account_EmployerProfile_*\n",
|
|
751
|
+
"parameters": [
|
|
752
|
+
{
|
|
753
|
+
"in": "body",
|
|
754
|
+
"name": "body",
|
|
755
|
+
"required": false,
|
|
756
|
+
"description": "accepts any users data to be updated.",
|
|
757
|
+
"schema": {
|
|
758
|
+
"$ref": "#/definitions/UserProfile"
|
|
759
|
+
}
|
|
760
|
+
}
|
|
761
|
+
],
|
|
762
|
+
"tags": [
|
|
763
|
+
"User"
|
|
764
|
+
],
|
|
765
|
+
"responses": {
|
|
766
|
+
"200": {
|
|
767
|
+
"description": "User update success"
|
|
768
|
+
},
|
|
769
|
+
"default": {
|
|
770
|
+
"description": "Unexpected error",
|
|
771
|
+
"schema": {
|
|
772
|
+
"$ref": "#/definitions/Error"
|
|
773
|
+
}
|
|
774
|
+
}
|
|
775
|
+
}
|
|
776
|
+
}
|
|
777
|
+
},
|
|
778
|
+
"/user/password": {
|
|
779
|
+
"put": {
|
|
780
|
+
"summary": "Update User Data",
|
|
781
|
+
"description": "This updates individual or group of user's records\n*Pages 3_Account_EmployerProfile_*\n",
|
|
782
|
+
"parameters": [
|
|
783
|
+
{
|
|
784
|
+
"name": "new_password",
|
|
785
|
+
"in": "query",
|
|
786
|
+
"required": true,
|
|
787
|
+
"type": "string",
|
|
788
|
+
"description": "New password"
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "old_password",
|
|
792
|
+
"in": "query",
|
|
793
|
+
"required": true,
|
|
794
|
+
"type": "string",
|
|
795
|
+
"description": "Old password"
|
|
796
|
+
}
|
|
797
|
+
],
|
|
798
|
+
"tags": [
|
|
799
|
+
"User"
|
|
800
|
+
],
|
|
801
|
+
"responses": {
|
|
802
|
+
"200": {
|
|
803
|
+
"description": "User password updated"
|
|
804
|
+
},
|
|
805
|
+
"default": {
|
|
806
|
+
"description": "Unexpected error",
|
|
807
|
+
"schema": {
|
|
808
|
+
"$ref": "#/definitions/Error"
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
}
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
"/user/login": {
|
|
815
|
+
"get": {
|
|
816
|
+
"security": [
|
|
817
|
+
{
|
|
818
|
+
"basicAuth": []
|
|
819
|
+
}
|
|
820
|
+
],
|
|
821
|
+
"tags": [
|
|
822
|
+
"User"
|
|
823
|
+
],
|
|
824
|
+
"responses": {
|
|
825
|
+
"200": {
|
|
826
|
+
"description": "Will send `Authenticated` if authentication is succesful, otherwise it will send `Unauthorized`"
|
|
827
|
+
},
|
|
828
|
+
"400": {
|
|
829
|
+
"description": "Invalid username/password supplied"
|
|
830
|
+
}
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
},
|
|
834
|
+
"/employee/accept-employer/{employer_id}": {
|
|
835
|
+
"get": {
|
|
836
|
+
"summary": "Accept Employer",
|
|
837
|
+
"description": "4_Messages_ChatWindow_EmploymentOffer_Reject(confirm)\n4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)\n",
|
|
838
|
+
"parameters": [
|
|
839
|
+
{
|
|
840
|
+
"name": "employer_id",
|
|
841
|
+
"in": "path",
|
|
842
|
+
"required": true,
|
|
843
|
+
"type": "string",
|
|
844
|
+
"description": "Employer ID"
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "response",
|
|
848
|
+
"in": "query",
|
|
849
|
+
"required": true,
|
|
850
|
+
"type": "string",
|
|
851
|
+
"description": "Either Accept or Reject"
|
|
852
|
+
}
|
|
853
|
+
],
|
|
854
|
+
"tags": [
|
|
855
|
+
"User"
|
|
856
|
+
],
|
|
857
|
+
"responses": {
|
|
858
|
+
"200": {
|
|
859
|
+
"description": "User's accepted",
|
|
860
|
+
"schema": {
|
|
861
|
+
"$ref": "#/definitions/UserProfile"
|
|
862
|
+
}
|
|
863
|
+
},
|
|
864
|
+
"400": {
|
|
865
|
+
"description": "Invalid email/password supplied"
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
}
|
|
869
|
+
},
|
|
870
|
+
"/user/logout": {
|
|
871
|
+
"get": {
|
|
872
|
+
"summary": "logout user",
|
|
873
|
+
"description": "Logs out current logged in user session\n*Page 3_Account (part3)\n",
|
|
874
|
+
"tags": [
|
|
875
|
+
"User"
|
|
876
|
+
],
|
|
877
|
+
"responses": {
|
|
878
|
+
"default": {
|
|
879
|
+
"description": "successful operation"
|
|
880
|
+
}
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
"/industry": {
|
|
885
|
+
"get": {
|
|
886
|
+
"summary": "List all industries",
|
|
887
|
+
"description": "fetch industries, used in select/list\n*Page 3_Account_EmployerProfile (Industry select)\n",
|
|
888
|
+
"tags": [
|
|
889
|
+
"Industry"
|
|
890
|
+
],
|
|
891
|
+
"responses": {
|
|
892
|
+
"200": {
|
|
893
|
+
"description": "Industry Lists",
|
|
894
|
+
"schema": {
|
|
895
|
+
"$ref": "#/definitions/Industries"
|
|
896
|
+
}
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
"/documents": {
|
|
902
|
+
"post": {
|
|
903
|
+
"summary": "Add new document",
|
|
904
|
+
"tags": [
|
|
905
|
+
"Documents"
|
|
906
|
+
],
|
|
907
|
+
"parameters": [
|
|
908
|
+
{
|
|
909
|
+
"in": "body",
|
|
910
|
+
"name": "body",
|
|
911
|
+
"required": false,
|
|
912
|
+
"description": "accepts document data to be added.",
|
|
913
|
+
"schema": {
|
|
914
|
+
"$ref": "#/definitions/Documents"
|
|
915
|
+
}
|
|
916
|
+
}
|
|
917
|
+
],
|
|
918
|
+
"responses": {
|
|
919
|
+
"200": {
|
|
920
|
+
"description": "Document successfully added"
|
|
921
|
+
},
|
|
922
|
+
"default": {
|
|
923
|
+
"description": "Unexpected error",
|
|
924
|
+
"schema": {
|
|
925
|
+
"$ref": "#/definitions/Error"
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
},
|
|
931
|
+
"/documents/{document_id}": {
|
|
932
|
+
"put": {
|
|
933
|
+
"summary": "Edit document",
|
|
934
|
+
"tags": [
|
|
935
|
+
"Documents"
|
|
936
|
+
],
|
|
937
|
+
"parameters": [
|
|
938
|
+
{
|
|
939
|
+
"name": "document_id",
|
|
940
|
+
"in": "path",
|
|
941
|
+
"required": true,
|
|
942
|
+
"type": "string",
|
|
943
|
+
"description": "Document ID"
|
|
944
|
+
},
|
|
945
|
+
{
|
|
946
|
+
"in": "body",
|
|
947
|
+
"name": "body",
|
|
948
|
+
"required": true,
|
|
949
|
+
"description": "accepts document data to be edited.",
|
|
950
|
+
"schema": {
|
|
951
|
+
"type": "array",
|
|
952
|
+
"$ref": "#/definitions/Documents"
|
|
953
|
+
}
|
|
954
|
+
}
|
|
955
|
+
],
|
|
956
|
+
"responses": {
|
|
957
|
+
"200": {
|
|
958
|
+
"description": "Document successfully updated",
|
|
959
|
+
"schema": {
|
|
960
|
+
"$ref": "#/definitions/Documents"
|
|
961
|
+
}
|
|
962
|
+
},
|
|
963
|
+
"default": {
|
|
964
|
+
"description": "Unexpected error",
|
|
965
|
+
"schema": {
|
|
966
|
+
"$ref": "#/definitions/Error"
|
|
967
|
+
}
|
|
968
|
+
}
|
|
969
|
+
}
|
|
970
|
+
}
|
|
971
|
+
},
|
|
972
|
+
"/document-pages/{document_id}": {
|
|
973
|
+
"get": {
|
|
974
|
+
"summary": "List document page",
|
|
975
|
+
"tags": [
|
|
976
|
+
"Documents"
|
|
977
|
+
],
|
|
978
|
+
"parameters": [
|
|
979
|
+
{
|
|
980
|
+
"name": "document_id",
|
|
981
|
+
"in": "path",
|
|
982
|
+
"required": true,
|
|
983
|
+
"type": "string",
|
|
984
|
+
"description": "Document ID"
|
|
985
|
+
}
|
|
986
|
+
],
|
|
987
|
+
"responses": {
|
|
988
|
+
"default": {
|
|
989
|
+
"description": "Document Page List",
|
|
990
|
+
"schema": {
|
|
991
|
+
"$ref": "#/definitions/DocumentPages"
|
|
992
|
+
}
|
|
993
|
+
}
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
},
|
|
997
|
+
"/document/shared": {
|
|
998
|
+
"get": {
|
|
999
|
+
"summary": "List document shared",
|
|
1000
|
+
"tags": [
|
|
1001
|
+
"Documents"
|
|
1002
|
+
],
|
|
1003
|
+
"responses": {
|
|
1004
|
+
"default": {
|
|
1005
|
+
"description": "Document Page List",
|
|
1006
|
+
"schema": {
|
|
1007
|
+
"$ref": "#/definitions/DocumentShared"
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"/document/share/{document_id}": {
|
|
1014
|
+
"delete": {
|
|
1015
|
+
"summary": "Remove employer to document share",
|
|
1016
|
+
"tags": [
|
|
1017
|
+
"Documents"
|
|
1018
|
+
],
|
|
1019
|
+
"parameters": [
|
|
1020
|
+
{
|
|
1021
|
+
"name": "document_id",
|
|
1022
|
+
"in": "path",
|
|
1023
|
+
"required": true,
|
|
1024
|
+
"type": "string",
|
|
1025
|
+
"description": "Document ID"
|
|
1026
|
+
},
|
|
1027
|
+
{
|
|
1028
|
+
"name": "employer_id",
|
|
1029
|
+
"in": "query",
|
|
1030
|
+
"required": true,
|
|
1031
|
+
"type": "string",
|
|
1032
|
+
"description": "Employer ID"
|
|
1033
|
+
}
|
|
1034
|
+
],
|
|
1035
|
+
"responses": {
|
|
1036
|
+
"200": {
|
|
1037
|
+
"description": "Document unshared successful"
|
|
1038
|
+
},
|
|
1039
|
+
"default": {
|
|
1040
|
+
"description": "Unexpected error",
|
|
1041
|
+
"schema": {
|
|
1042
|
+
"$ref": "#/definitions/Error"
|
|
1043
|
+
}
|
|
1044
|
+
}
|
|
1045
|
+
}
|
|
1046
|
+
}
|
|
1047
|
+
},
|
|
1048
|
+
"/employee/documents/shared/{employee_id}": {
|
|
1049
|
+
"get": {
|
|
1050
|
+
"summary": "List all employee's documents",
|
|
1051
|
+
"tags": [
|
|
1052
|
+
"Documents"
|
|
1053
|
+
],
|
|
1054
|
+
"parameters": [
|
|
1055
|
+
{
|
|
1056
|
+
"name": "employee_id",
|
|
1057
|
+
"in": "path",
|
|
1058
|
+
"required": true,
|
|
1059
|
+
"type": "string",
|
|
1060
|
+
"description": "Employee ID"
|
|
1061
|
+
}
|
|
1062
|
+
],
|
|
1063
|
+
"responses": {
|
|
1064
|
+
"200": {
|
|
1065
|
+
"description": "Employee document lists",
|
|
1066
|
+
"schema": {
|
|
1067
|
+
"$ref": "#/definitions/Documents"
|
|
1068
|
+
}
|
|
1069
|
+
},
|
|
1070
|
+
"default": {
|
|
1071
|
+
"description": "Unexpected error",
|
|
1072
|
+
"schema": {
|
|
1073
|
+
"$ref": "#/definitions/Error"
|
|
1074
|
+
}
|
|
1075
|
+
}
|
|
1076
|
+
}
|
|
1077
|
+
}
|
|
1078
|
+
},
|
|
1079
|
+
"/employee/document/shared/{document_id}": {
|
|
1080
|
+
"get": {
|
|
1081
|
+
"summary": "Employee's document Details",
|
|
1082
|
+
"tags": [
|
|
1083
|
+
"Documents"
|
|
1084
|
+
],
|
|
1085
|
+
"parameters": [
|
|
1086
|
+
{
|
|
1087
|
+
"name": "document_id",
|
|
1088
|
+
"in": "path",
|
|
1089
|
+
"required": true,
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"description": "Employee ID"
|
|
1092
|
+
}
|
|
1093
|
+
],
|
|
1094
|
+
"responses": {
|
|
1095
|
+
"200": {
|
|
1096
|
+
"description": "Employee document details",
|
|
1097
|
+
"schema": {
|
|
1098
|
+
"$ref": "#/definitions/Documents"
|
|
1099
|
+
}
|
|
1100
|
+
},
|
|
1101
|
+
"default": {
|
|
1102
|
+
"description": "Unexpected error",
|
|
1103
|
+
"schema": {
|
|
1104
|
+
"$ref": "#/definitions/Error"
|
|
1105
|
+
}
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
"/employee/locations/{employee_id}": {
|
|
1111
|
+
"post": {
|
|
1112
|
+
"summary": "Employee's list of locations",
|
|
1113
|
+
"tags": [
|
|
1114
|
+
"Locations"
|
|
1115
|
+
],
|
|
1116
|
+
"parameters": [
|
|
1117
|
+
{
|
|
1118
|
+
"name": "employee_id",
|
|
1119
|
+
"in": "path",
|
|
1120
|
+
"required": true,
|
|
1121
|
+
"type": "integer",
|
|
1122
|
+
"description": "Employee ID"
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"in": "body",
|
|
1126
|
+
"name": "body",
|
|
1127
|
+
"required": false,
|
|
1128
|
+
"description": "accepts locations page data to be added.",
|
|
1129
|
+
"schema": {
|
|
1130
|
+
"$ref": "#/definitions/Locations"
|
|
1131
|
+
}
|
|
1132
|
+
}
|
|
1133
|
+
],
|
|
1134
|
+
"responses": {
|
|
1135
|
+
"200": {
|
|
1136
|
+
"description": "Employee location added"
|
|
1137
|
+
},
|
|
1138
|
+
"default": {
|
|
1139
|
+
"description": "Unexpected error",
|
|
1140
|
+
"schema": {
|
|
1141
|
+
"$ref": "#/definitions/Error"
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
}
|
|
1145
|
+
}
|
|
1146
|
+
},
|
|
1147
|
+
"/employee/location/{employee_location_id}": {
|
|
1148
|
+
"delete": {
|
|
1149
|
+
"summary": "remove location from employee",
|
|
1150
|
+
"tags": [
|
|
1151
|
+
"Locations"
|
|
1152
|
+
],
|
|
1153
|
+
"parameters": [
|
|
1154
|
+
{
|
|
1155
|
+
"name": "employee_location_id",
|
|
1156
|
+
"in": "path",
|
|
1157
|
+
"required": true,
|
|
1158
|
+
"type": "integer",
|
|
1159
|
+
"description": "Employee Location ID"
|
|
1160
|
+
}
|
|
1161
|
+
],
|
|
1162
|
+
"responses": {
|
|
1163
|
+
"200": {
|
|
1164
|
+
"description": "Successfully remove employees locations"
|
|
1165
|
+
},
|
|
1166
|
+
"default": {
|
|
1167
|
+
"description": "Unexpected error",
|
|
1168
|
+
"schema": {
|
|
1169
|
+
"$ref": "#/definitions/Error"
|
|
1170
|
+
}
|
|
1171
|
+
}
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
},
|
|
1175
|
+
"/employee/notes/{employee_id}": {
|
|
1176
|
+
"post": {
|
|
1177
|
+
"summary": "Add Employee's notes",
|
|
1178
|
+
"tags": [
|
|
1179
|
+
"Notes"
|
|
1180
|
+
],
|
|
1181
|
+
"parameters": [
|
|
1182
|
+
{
|
|
1183
|
+
"name": "employee_id",
|
|
1184
|
+
"in": "path",
|
|
1185
|
+
"required": true,
|
|
1186
|
+
"type": "integer",
|
|
1187
|
+
"description": "Employee ID"
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"in": "body",
|
|
1191
|
+
"name": "body",
|
|
1192
|
+
"required": false,
|
|
1193
|
+
"description": "accepts noted page data to be added.",
|
|
1194
|
+
"schema": {
|
|
1195
|
+
"$ref": "#/definitions/Note"
|
|
1196
|
+
}
|
|
1197
|
+
}
|
|
1198
|
+
],
|
|
1199
|
+
"responses": {
|
|
1200
|
+
"200": {
|
|
1201
|
+
"description": "Employee notes added"
|
|
1202
|
+
},
|
|
1203
|
+
"default": {
|
|
1204
|
+
"description": "Unexpected error",
|
|
1205
|
+
"schema": {
|
|
1206
|
+
"$ref": "#/definitions/Error"
|
|
1207
|
+
}
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
},
|
|
1212
|
+
"/employee/note/{employee_notes_id}": {
|
|
1213
|
+
"delete": {
|
|
1214
|
+
"summary": "Delte employee's note",
|
|
1215
|
+
"tags": [
|
|
1216
|
+
"Notes"
|
|
1217
|
+
],
|
|
1218
|
+
"parameters": [
|
|
1219
|
+
{
|
|
1220
|
+
"name": "employee_notes_id",
|
|
1221
|
+
"in": "path",
|
|
1222
|
+
"required": true,
|
|
1223
|
+
"type": "integer",
|
|
1224
|
+
"description": "Note ID"
|
|
1225
|
+
}
|
|
1226
|
+
],
|
|
1227
|
+
"responses": {
|
|
1228
|
+
"200": {
|
|
1229
|
+
"description": "Employee note deleted"
|
|
1230
|
+
},
|
|
1231
|
+
"default": {
|
|
1232
|
+
"description": "Unexpected error",
|
|
1233
|
+
"schema": {
|
|
1234
|
+
"$ref": "#/definitions/Error"
|
|
1235
|
+
}
|
|
1236
|
+
}
|
|
1237
|
+
}
|
|
1238
|
+
}
|
|
1239
|
+
},
|
|
1240
|
+
"/employee/roles/{employee_id}": {
|
|
1241
|
+
"get": {
|
|
1242
|
+
"summary": "Employee Role List",
|
|
1243
|
+
"tags": [
|
|
1244
|
+
"Role"
|
|
1245
|
+
],
|
|
1246
|
+
"parameters": [
|
|
1247
|
+
{
|
|
1248
|
+
"name": "employee_id",
|
|
1249
|
+
"in": "path",
|
|
1250
|
+
"required": true,
|
|
1251
|
+
"type": "integer",
|
|
1252
|
+
"description": "Employee ID"
|
|
1253
|
+
}
|
|
1254
|
+
],
|
|
1255
|
+
"responses": {
|
|
1256
|
+
"200": {
|
|
1257
|
+
"description": "Employee role list",
|
|
1258
|
+
"schema": {
|
|
1259
|
+
"$ref": "#/definitions/Role"
|
|
1260
|
+
}
|
|
1261
|
+
},
|
|
1262
|
+
"default": {
|
|
1263
|
+
"description": "Unexpected error",
|
|
1264
|
+
"schema": {
|
|
1265
|
+
"$ref": "#/definitions/Error"
|
|
1266
|
+
}
|
|
1267
|
+
}
|
|
1268
|
+
}
|
|
1269
|
+
}
|
|
1270
|
+
},
|
|
1271
|
+
"/employee/role": {
|
|
1272
|
+
"post": {
|
|
1273
|
+
"summary": "Add Employee Role",
|
|
1274
|
+
"tags": [
|
|
1275
|
+
"Role"
|
|
1276
|
+
],
|
|
1277
|
+
"parameters": [
|
|
1278
|
+
{
|
|
1279
|
+
"name": "employee_id",
|
|
1280
|
+
"in": "query",
|
|
1281
|
+
"required": true,
|
|
1282
|
+
"type": "integer",
|
|
1283
|
+
"description": "Employee ID"
|
|
1284
|
+
},
|
|
1285
|
+
{
|
|
1286
|
+
"in": "body",
|
|
1287
|
+
"name": "body",
|
|
1288
|
+
"required": false,
|
|
1289
|
+
"description": "accepts role page data to be added.",
|
|
1290
|
+
"schema": {
|
|
1291
|
+
"$ref": "#/definitions/Role"
|
|
1292
|
+
}
|
|
1293
|
+
}
|
|
1294
|
+
],
|
|
1295
|
+
"responses": {
|
|
1296
|
+
"200": {
|
|
1297
|
+
"description": "Employee role added"
|
|
1298
|
+
},
|
|
1299
|
+
"default": {
|
|
1300
|
+
"description": "Unexpected error",
|
|
1301
|
+
"schema": {
|
|
1302
|
+
"$ref": "#/definitions/Error"
|
|
1303
|
+
}
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
}
|
|
1307
|
+
},
|
|
1308
|
+
"/employee/role/{employee_role_id}": {
|
|
1309
|
+
"get": {
|
|
1310
|
+
"summary": "Get Employee Role Details",
|
|
1311
|
+
"tags": [
|
|
1312
|
+
"Role"
|
|
1313
|
+
],
|
|
1314
|
+
"parameters": [
|
|
1315
|
+
{
|
|
1316
|
+
"name": "employee_role_id",
|
|
1317
|
+
"in": "path",
|
|
1318
|
+
"required": true,
|
|
1319
|
+
"type": "integer",
|
|
1320
|
+
"description": "Employee Role ID"
|
|
1321
|
+
}
|
|
1322
|
+
],
|
|
1323
|
+
"responses": {
|
|
1324
|
+
"200": {
|
|
1325
|
+
"description": "Employee role details",
|
|
1326
|
+
"schema": {
|
|
1327
|
+
"$ref": "#/definitions/RoleDetails"
|
|
1328
|
+
}
|
|
1329
|
+
},
|
|
1330
|
+
"default": {
|
|
1331
|
+
"description": "Unexpected error",
|
|
1332
|
+
"schema": {
|
|
1333
|
+
"$ref": "#/definitions/Error"
|
|
1334
|
+
}
|
|
1335
|
+
}
|
|
1336
|
+
}
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
"/employee/role/variation/{employee_role_variation_id}": {
|
|
1340
|
+
"get": {
|
|
1341
|
+
"summary": "Get Employee Role Variation Details",
|
|
1342
|
+
"tags": [
|
|
1343
|
+
"Role"
|
|
1344
|
+
],
|
|
1345
|
+
"parameters": [
|
|
1346
|
+
{
|
|
1347
|
+
"name": "employee_role_variation_id",
|
|
1348
|
+
"in": "path",
|
|
1349
|
+
"required": true,
|
|
1350
|
+
"type": "integer",
|
|
1351
|
+
"description": "Employee Role Variation ID"
|
|
1352
|
+
}
|
|
1353
|
+
],
|
|
1354
|
+
"responses": {
|
|
1355
|
+
"200": {
|
|
1356
|
+
"description": "Employee role variation details",
|
|
1357
|
+
"schema": {
|
|
1358
|
+
"$ref": "#/definitions/RoleVariation"
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
"default": {
|
|
1362
|
+
"description": "Unexpected error",
|
|
1363
|
+
"schema": {
|
|
1364
|
+
"$ref": "#/definitions/Error"
|
|
1365
|
+
}
|
|
1366
|
+
}
|
|
1367
|
+
}
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"/employee/role/variation": {
|
|
1371
|
+
"post": {
|
|
1372
|
+
"summary": "Add Employee Role Variation",
|
|
1373
|
+
"tags": [
|
|
1374
|
+
"Role"
|
|
1375
|
+
],
|
|
1376
|
+
"parameters": [
|
|
1377
|
+
{
|
|
1378
|
+
"name": "employee_id",
|
|
1379
|
+
"in": "query",
|
|
1380
|
+
"required": true,
|
|
1381
|
+
"type": "integer",
|
|
1382
|
+
"description": "Employee Role Variation ID"
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"in": "body",
|
|
1386
|
+
"name": "body",
|
|
1387
|
+
"required": false,
|
|
1388
|
+
"description": "accepts variation page data to be added.",
|
|
1389
|
+
"schema": {
|
|
1390
|
+
"$ref": "#/definitions/RoleVariation"
|
|
1391
|
+
}
|
|
1392
|
+
}
|
|
1393
|
+
],
|
|
1394
|
+
"responses": {
|
|
1395
|
+
"200": {
|
|
1396
|
+
"description": "Employee role variation added"
|
|
1397
|
+
},
|
|
1398
|
+
"default": {
|
|
1399
|
+
"description": "Unexpected error",
|
|
1400
|
+
"schema": {
|
|
1401
|
+
"$ref": "#/definitions/Error"
|
|
1402
|
+
}
|
|
1403
|
+
}
|
|
1404
|
+
}
|
|
1405
|
+
}
|
|
1406
|
+
},
|
|
1407
|
+
"/employee/role/variations/{employee_role_id}": {
|
|
1408
|
+
"get": {
|
|
1409
|
+
"summary": "Get Employee Role Variation List",
|
|
1410
|
+
"tags": [
|
|
1411
|
+
"Role"
|
|
1412
|
+
],
|
|
1413
|
+
"parameters": [
|
|
1414
|
+
{
|
|
1415
|
+
"name": "employee_role_id",
|
|
1416
|
+
"in": "path",
|
|
1417
|
+
"required": true,
|
|
1418
|
+
"type": "integer",
|
|
1419
|
+
"description": "Employee Role ID"
|
|
1420
|
+
}
|
|
1421
|
+
],
|
|
1422
|
+
"responses": {
|
|
1423
|
+
"200": {
|
|
1424
|
+
"description": "Employee role details",
|
|
1425
|
+
"schema": {
|
|
1426
|
+
"$ref": "#/definitions/RoleVariation"
|
|
1427
|
+
}
|
|
1428
|
+
},
|
|
1429
|
+
"default": {
|
|
1430
|
+
"description": "Unexpected error",
|
|
1431
|
+
"schema": {
|
|
1432
|
+
"$ref": "#/definitions/Error"
|
|
1433
|
+
}
|
|
1434
|
+
}
|
|
1435
|
+
}
|
|
1436
|
+
}
|
|
1437
|
+
},
|
|
1438
|
+
"/user/bank": {
|
|
1439
|
+
"get": {
|
|
1440
|
+
"summary": "List All User Bank",
|
|
1441
|
+
"tags": [
|
|
1442
|
+
"Bank"
|
|
1443
|
+
],
|
|
1444
|
+
"responses": {
|
|
1445
|
+
"default": {
|
|
1446
|
+
"description": "User Banks List",
|
|
1447
|
+
"schema": {
|
|
1448
|
+
"$ref": "#/definitions/UserBank"
|
|
1449
|
+
}
|
|
1450
|
+
}
|
|
1451
|
+
}
|
|
1452
|
+
}
|
|
1453
|
+
},
|
|
1454
|
+
"/user/bank/{user_bank_id}": {
|
|
1455
|
+
"get": {
|
|
1456
|
+
"summary": "Get User Bank",
|
|
1457
|
+
"tags": [
|
|
1458
|
+
"Bank"
|
|
1459
|
+
],
|
|
1460
|
+
"parameters": [
|
|
1461
|
+
{
|
|
1462
|
+
"name": "user_bank_id",
|
|
1463
|
+
"in": "path",
|
|
1464
|
+
"required": true,
|
|
1465
|
+
"type": "string",
|
|
1466
|
+
"description": "User Bank ID"
|
|
1467
|
+
}
|
|
1468
|
+
],
|
|
1469
|
+
"responses": {
|
|
1470
|
+
"default": {
|
|
1471
|
+
"description": "User Bank Details",
|
|
1472
|
+
"schema": {
|
|
1473
|
+
"$ref": "#/definitions/UserBank"
|
|
1474
|
+
}
|
|
1475
|
+
}
|
|
1476
|
+
}
|
|
1477
|
+
}
|
|
1478
|
+
},
|
|
1479
|
+
"/bank": {
|
|
1480
|
+
"get": {
|
|
1481
|
+
"summary": "List All Bank",
|
|
1482
|
+
"tags": [
|
|
1483
|
+
"Bank"
|
|
1484
|
+
],
|
|
1485
|
+
"responses": {
|
|
1486
|
+
"default": {
|
|
1487
|
+
"description": "Banks List",
|
|
1488
|
+
"schema": {
|
|
1489
|
+
"$ref": "#/definitions/Bank"
|
|
1490
|
+
}
|
|
1491
|
+
}
|
|
1492
|
+
}
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"/user/bank/allotment/{user_bank_id}": {
|
|
1496
|
+
"post": {
|
|
1497
|
+
"summary": "Add User Bank Allotment",
|
|
1498
|
+
"tags": [
|
|
1499
|
+
"Bank"
|
|
1500
|
+
],
|
|
1501
|
+
"parameters": [
|
|
1502
|
+
{
|
|
1503
|
+
"name": "user_bank_id",
|
|
1504
|
+
"in": "path",
|
|
1505
|
+
"required": true,
|
|
1506
|
+
"type": "string",
|
|
1507
|
+
"description": "User Bank ID"
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"in": "body",
|
|
1511
|
+
"name": "body",
|
|
1512
|
+
"required": false,
|
|
1513
|
+
"description": "accepts user bank allotment data to be added.",
|
|
1514
|
+
"schema": {
|
|
1515
|
+
"$ref": "#/definitions/BankAllotment"
|
|
1516
|
+
}
|
|
1517
|
+
}
|
|
1518
|
+
],
|
|
1519
|
+
"responses": {
|
|
1520
|
+
"200": {
|
|
1521
|
+
"description": "User Bank Allotment successfully added"
|
|
1522
|
+
},
|
|
1523
|
+
"default": {
|
|
1524
|
+
"description": "Unexpected error",
|
|
1525
|
+
"schema": {
|
|
1526
|
+
"$ref": "#/definitions/Error"
|
|
1527
|
+
}
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
"/superfund": {
|
|
1533
|
+
"get": {
|
|
1534
|
+
"summary": "List All Superfund",
|
|
1535
|
+
"tags": [
|
|
1536
|
+
"SuperFund"
|
|
1537
|
+
],
|
|
1538
|
+
"responses": {
|
|
1539
|
+
"default": {
|
|
1540
|
+
"description": "SuportFund List",
|
|
1541
|
+
"schema": {
|
|
1542
|
+
"$ref": "#/definitions/SuperFund"
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
}
|
|
1546
|
+
}
|
|
1547
|
+
},
|
|
1548
|
+
"/user/superfund": {
|
|
1549
|
+
"get": {
|
|
1550
|
+
"summary": "List All User SuperFund",
|
|
1551
|
+
"tags": [
|
|
1552
|
+
"SuperFund"
|
|
1553
|
+
],
|
|
1554
|
+
"responses": {
|
|
1555
|
+
"default": {
|
|
1556
|
+
"description": "List User superfund",
|
|
1557
|
+
"schema": {
|
|
1558
|
+
"$ref": "#/definitions/UserSuperFund"
|
|
1559
|
+
}
|
|
1560
|
+
}
|
|
1561
|
+
}
|
|
1562
|
+
}
|
|
1563
|
+
},
|
|
1564
|
+
"/user/superfund/{user_supperfund_id}": {
|
|
1565
|
+
"get": {
|
|
1566
|
+
"summary": "GetUser SuperFund Details",
|
|
1567
|
+
"tags": [
|
|
1568
|
+
"SuperFund"
|
|
1569
|
+
],
|
|
1570
|
+
"parameters": [
|
|
1571
|
+
{
|
|
1572
|
+
"name": "user_supperfund_id",
|
|
1573
|
+
"in": "path",
|
|
1574
|
+
"required": true,
|
|
1575
|
+
"type": "string",
|
|
1576
|
+
"description": "User SuperFund ID"
|
|
1577
|
+
}
|
|
1578
|
+
],
|
|
1579
|
+
"responses": {
|
|
1580
|
+
"default": {
|
|
1581
|
+
"description": "User superfund details",
|
|
1582
|
+
"schema": {
|
|
1583
|
+
"$ref": "#/definitions/UserSuperFund"
|
|
1584
|
+
}
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
}
|
|
1588
|
+
},
|
|
1589
|
+
"/user/superfund/employer/{user_supperfund_id}": {
|
|
1590
|
+
"get": {
|
|
1591
|
+
"summary": "List All Employer with SuperFund",
|
|
1592
|
+
"tags": [
|
|
1593
|
+
"SuperFund"
|
|
1594
|
+
],
|
|
1595
|
+
"parameters": [
|
|
1596
|
+
{
|
|
1597
|
+
"name": "user_supperfund_id",
|
|
1598
|
+
"in": "path",
|
|
1599
|
+
"required": true,
|
|
1600
|
+
"type": "string",
|
|
1601
|
+
"description": "User SuperFund ID"
|
|
1602
|
+
}
|
|
1603
|
+
],
|
|
1604
|
+
"responses": {
|
|
1605
|
+
"default": {
|
|
1606
|
+
"description": "List Employer with superfund",
|
|
1607
|
+
"schema": {
|
|
1608
|
+
"$ref": "#/definitions/UserEmployerSuperFund"
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
},
|
|
1614
|
+
"/user/superfund/employer/remove/{user_supperfund_id}": {
|
|
1615
|
+
"post": {
|
|
1616
|
+
"summary": "Remove User Employer SupportFund",
|
|
1617
|
+
"tags": [
|
|
1618
|
+
"SuperFund"
|
|
1619
|
+
],
|
|
1620
|
+
"parameters": [
|
|
1621
|
+
{
|
|
1622
|
+
"name": "user_supperfund_id",
|
|
1623
|
+
"in": "path",
|
|
1624
|
+
"required": true,
|
|
1625
|
+
"type": "string",
|
|
1626
|
+
"description": "User SuperFund ID"
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"name": "employer_id",
|
|
1630
|
+
"in": "query",
|
|
1631
|
+
"required": true,
|
|
1632
|
+
"type": "integer",
|
|
1633
|
+
"description": "Employer ID"
|
|
1634
|
+
}
|
|
1635
|
+
],
|
|
1636
|
+
"responses": {
|
|
1637
|
+
"200": {
|
|
1638
|
+
"description": "User Employer SuperFund successfully remove"
|
|
1639
|
+
},
|
|
1640
|
+
"default": {
|
|
1641
|
+
"description": "Unexpected error",
|
|
1642
|
+
"schema": {
|
|
1643
|
+
"$ref": "#/definitions/Error"
|
|
1644
|
+
}
|
|
1645
|
+
}
|
|
1646
|
+
}
|
|
1647
|
+
}
|
|
1648
|
+
},
|
|
1649
|
+
"/pay-approval-options": {
|
|
1650
|
+
"get": {
|
|
1651
|
+
"summary": "List all Pay approval options",
|
|
1652
|
+
"description": "used in select/list\n*Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)\n",
|
|
1653
|
+
"tags": [
|
|
1654
|
+
"Payroll"
|
|
1655
|
+
],
|
|
1656
|
+
"responses": {
|
|
1657
|
+
"200": {
|
|
1658
|
+
"description": "Pay Approval Options List",
|
|
1659
|
+
"schema": {
|
|
1660
|
+
"$ref": "#/definitions/PayrollApprovalOptions"
|
|
1661
|
+
}
|
|
1662
|
+
}
|
|
1663
|
+
}
|
|
1664
|
+
}
|
|
1665
|
+
},
|
|
1666
|
+
"/pay-interval-options": {
|
|
1667
|
+
"get": {
|
|
1668
|
+
"summary": "List all Pay interval options",
|
|
1669
|
+
"description": "used in select/list\n*Page 3_Account_EmployerProfile_PayRun (Interval select)\n",
|
|
1670
|
+
"tags": [
|
|
1671
|
+
"Payroll"
|
|
1672
|
+
],
|
|
1673
|
+
"responses": {
|
|
1674
|
+
"200": {
|
|
1675
|
+
"description": "Pay Interval Options List",
|
|
1676
|
+
"schema": {
|
|
1677
|
+
"$ref": "#/definitions/PayrollIntervalOptions"
|
|
1678
|
+
}
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
}
|
|
1682
|
+
},
|
|
1683
|
+
"/pay-release-options": {
|
|
1684
|
+
"get": {
|
|
1685
|
+
"summary": "List all Pay release options",
|
|
1686
|
+
"description": "used in select/list\n*Page 3_Account_EmployerProfile_PayRun (Interval select)\n",
|
|
1687
|
+
"tags": [
|
|
1688
|
+
"Payroll"
|
|
1689
|
+
],
|
|
1690
|
+
"responses": {
|
|
1691
|
+
"200": {
|
|
1692
|
+
"description": "Pay Interval Release List",
|
|
1693
|
+
"schema": {
|
|
1694
|
+
"$ref": "#/definitions/PayrollReleaseOptions"
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
"/tax-entity-type-options": {
|
|
1701
|
+
"get": {
|
|
1702
|
+
"summary": "List all Tax entity Type",
|
|
1703
|
+
"description": "used in select/list\n*Page 3_Account_EmployerProfile_Tax (Entity Type Select)\n",
|
|
1704
|
+
"tags": [
|
|
1705
|
+
"Entity",
|
|
1706
|
+
"Tax"
|
|
1707
|
+
],
|
|
1708
|
+
"responses": {
|
|
1709
|
+
"200": {
|
|
1710
|
+
"description": "Tax Entity Type List",
|
|
1711
|
+
"schema": {
|
|
1712
|
+
"$ref": "#/definitions/TaxEntityTypeOptions"
|
|
1713
|
+
}
|
|
1714
|
+
}
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
"/tax-reporting-options": {
|
|
1719
|
+
"get": {
|
|
1720
|
+
"summary": "List all Tax Reporting Option",
|
|
1721
|
+
"description": "used in select/list\n*Page 3_Account_EmployerProfile_Tax (Reporting Period Select)\n",
|
|
1722
|
+
"tags": [
|
|
1723
|
+
"Reporting",
|
|
1724
|
+
"Tax"
|
|
1725
|
+
],
|
|
1726
|
+
"responses": {
|
|
1727
|
+
"200": {
|
|
1728
|
+
"description": "Tax Reporting Option",
|
|
1729
|
+
"schema": {
|
|
1730
|
+
"$ref": "#/definitions/TaxReportingOptions"
|
|
1731
|
+
}
|
|
1732
|
+
}
|
|
1733
|
+
}
|
|
1734
|
+
}
|
|
1735
|
+
}
|
|
1736
|
+
},
|
|
1737
|
+
"definitions": {
|
|
1738
|
+
"EmployeeShift": {
|
|
1739
|
+
"properties": {
|
|
1740
|
+
"user_id": {
|
|
1741
|
+
"type": "integer",
|
|
1742
|
+
"description": "User ID."
|
|
1743
|
+
},
|
|
1744
|
+
"employer_shift_assigned_id": {
|
|
1745
|
+
"type": "integer",
|
|
1746
|
+
"description": "Shift ID."
|
|
1747
|
+
},
|
|
1748
|
+
"role_name": {
|
|
1749
|
+
"type": "string",
|
|
1750
|
+
"description": "User last name."
|
|
1751
|
+
},
|
|
1752
|
+
"shift_current_time": {
|
|
1753
|
+
"type": "string",
|
|
1754
|
+
"description": "Shift details."
|
|
1755
|
+
},
|
|
1756
|
+
"user_name_last": {
|
|
1757
|
+
"type": "string",
|
|
1758
|
+
"description": "User last name."
|
|
1759
|
+
},
|
|
1760
|
+
"user_name_first": {
|
|
1761
|
+
"type": "string",
|
|
1762
|
+
"description": "User first name."
|
|
1763
|
+
},
|
|
1764
|
+
"user_email": {
|
|
1765
|
+
"type": "string",
|
|
1766
|
+
"description": "User email."
|
|
1767
|
+
},
|
|
1768
|
+
"user_iconurl": {
|
|
1769
|
+
"type": "string",
|
|
1770
|
+
"description": "User Icon URL."
|
|
1771
|
+
},
|
|
1772
|
+
"user_phone": {
|
|
1773
|
+
"type": "string",
|
|
1774
|
+
"description": "User Phone Number."
|
|
1775
|
+
},
|
|
1776
|
+
"shift_status": {
|
|
1777
|
+
"type": "string",
|
|
1778
|
+
"description": "indicated they have started their shift."
|
|
1779
|
+
}
|
|
1780
|
+
}
|
|
1781
|
+
},
|
|
1782
|
+
"UserProfile": {
|
|
1783
|
+
"properties": {
|
|
1784
|
+
"user_id": {
|
|
1785
|
+
"type": "integer",
|
|
1786
|
+
"description": "User ID."
|
|
1787
|
+
},
|
|
1788
|
+
"user_name_last": {
|
|
1789
|
+
"type": "string",
|
|
1790
|
+
"description": "User last name."
|
|
1791
|
+
},
|
|
1792
|
+
"user_name_first": {
|
|
1793
|
+
"type": "string",
|
|
1794
|
+
"description": "User first name."
|
|
1795
|
+
},
|
|
1796
|
+
"user_email": {
|
|
1797
|
+
"type": "string",
|
|
1798
|
+
"description": "User email."
|
|
1799
|
+
},
|
|
1800
|
+
"user_dob": {
|
|
1801
|
+
"type": "string",
|
|
1802
|
+
"description": "User Date of Birth."
|
|
1803
|
+
},
|
|
1804
|
+
"user_iconurl": {
|
|
1805
|
+
"type": "string",
|
|
1806
|
+
"description": "User Icon URL."
|
|
1807
|
+
},
|
|
1808
|
+
"user_status": {
|
|
1809
|
+
"type": "string",
|
|
1810
|
+
"description": "User Status."
|
|
1811
|
+
},
|
|
1812
|
+
"user_phone": {
|
|
1813
|
+
"type": "string",
|
|
1814
|
+
"description": "User Phone Number."
|
|
1815
|
+
},
|
|
1816
|
+
"address": {
|
|
1817
|
+
"type": "array",
|
|
1818
|
+
"description": "Full address of the user.",
|
|
1819
|
+
"items": {
|
|
1820
|
+
"$ref": "#/definitions/UserAddress"
|
|
1821
|
+
}
|
|
1822
|
+
}
|
|
1823
|
+
}
|
|
1824
|
+
},
|
|
1825
|
+
"EmployerOwnProfile": {
|
|
1826
|
+
"properties": {
|
|
1827
|
+
"employer_id": {
|
|
1828
|
+
"type": "integer",
|
|
1829
|
+
"description": "Employer ID."
|
|
1830
|
+
},
|
|
1831
|
+
"employer_business_name": {
|
|
1832
|
+
"type": "string",
|
|
1833
|
+
"description": "Business name of the employer."
|
|
1834
|
+
},
|
|
1835
|
+
"employer_iconurl": {
|
|
1836
|
+
"type": "string",
|
|
1837
|
+
"description": "Icon URL/Thumbnail of the employer."
|
|
1838
|
+
},
|
|
1839
|
+
"user_name_last": {
|
|
1840
|
+
"type": "string",
|
|
1841
|
+
"description": "Employer last name."
|
|
1842
|
+
},
|
|
1843
|
+
"user_name_first": {
|
|
1844
|
+
"type": "string",
|
|
1845
|
+
"description": "Employer first name."
|
|
1846
|
+
},
|
|
1847
|
+
"employer_email": {
|
|
1848
|
+
"type": "string",
|
|
1849
|
+
"description": "Employer email."
|
|
1850
|
+
},
|
|
1851
|
+
"employer_phone": {
|
|
1852
|
+
"type": "string",
|
|
1853
|
+
"description": "Employer phone number."
|
|
1854
|
+
},
|
|
1855
|
+
"industry_id": {
|
|
1856
|
+
"type": "string",
|
|
1857
|
+
"description": "Employer industry."
|
|
1858
|
+
},
|
|
1859
|
+
"employer_abn": {
|
|
1860
|
+
"type": "string",
|
|
1861
|
+
"description": "Employer ABN number."
|
|
1862
|
+
},
|
|
1863
|
+
"employer_acn": {
|
|
1864
|
+
"type": "string",
|
|
1865
|
+
"description": "Employer ACN number."
|
|
1866
|
+
},
|
|
1867
|
+
"employer_contact_email": {
|
|
1868
|
+
"type": "string",
|
|
1869
|
+
"description": "Employer contact email."
|
|
1870
|
+
},
|
|
1871
|
+
"employer_contact_name": {
|
|
1872
|
+
"type": "string",
|
|
1873
|
+
"description": "Employer contact phone."
|
|
1874
|
+
},
|
|
1875
|
+
"payroll_interval_id": {
|
|
1876
|
+
"type": "integer",
|
|
1877
|
+
"description": "Employer payroll interval id."
|
|
1878
|
+
},
|
|
1879
|
+
"payroll_approval_id": {
|
|
1880
|
+
"type": "integer",
|
|
1881
|
+
"description": "Employer payroll approval id."
|
|
1882
|
+
},
|
|
1883
|
+
"payroll_release_id": {
|
|
1884
|
+
"type": "integer",
|
|
1885
|
+
"description": "Employer payroll release id."
|
|
1886
|
+
},
|
|
1887
|
+
"tax_entity_id": {
|
|
1888
|
+
"type": "integer",
|
|
1889
|
+
"description": "Employer tax entity id."
|
|
1890
|
+
},
|
|
1891
|
+
"tax_reporting_id": {
|
|
1892
|
+
"type": "integer",
|
|
1893
|
+
"description": "Employer tax reporting id."
|
|
1894
|
+
},
|
|
1895
|
+
"employer_tax_gst": {
|
|
1896
|
+
"type": "integer",
|
|
1897
|
+
"description": "Employer tax gst."
|
|
1898
|
+
},
|
|
1899
|
+
"employer_tax_payrolltax": {
|
|
1900
|
+
"type": "integer",
|
|
1901
|
+
"description": "Employer tax payroll tax."
|
|
1902
|
+
},
|
|
1903
|
+
"address": {
|
|
1904
|
+
"type": "array",
|
|
1905
|
+
"description": "Full address of the employer.",
|
|
1906
|
+
"items": {
|
|
1907
|
+
"$ref": "#/definitions/EmployerAddress"
|
|
1908
|
+
}
|
|
1909
|
+
}
|
|
1910
|
+
}
|
|
1911
|
+
},
|
|
1912
|
+
"EmployeeShifts": {
|
|
1913
|
+
"properties": {
|
|
1914
|
+
"employer_shift_assigned_id": {
|
|
1915
|
+
"type": "integer"
|
|
1916
|
+
},
|
|
1917
|
+
"employer_id": {
|
|
1918
|
+
"type": "integer"
|
|
1919
|
+
},
|
|
1920
|
+
"employee_id": {
|
|
1921
|
+
"type": "integer"
|
|
1922
|
+
},
|
|
1923
|
+
"location_id": {
|
|
1924
|
+
"type": "integer"
|
|
1925
|
+
},
|
|
1926
|
+
"role_id": {
|
|
1927
|
+
"type": "integer"
|
|
1928
|
+
},
|
|
1929
|
+
"start_date": {
|
|
1930
|
+
"type": "object",
|
|
1931
|
+
"description": "start date and time"
|
|
1932
|
+
},
|
|
1933
|
+
"end_date": {
|
|
1934
|
+
"type": "object",
|
|
1935
|
+
"description": "end date and time"
|
|
1936
|
+
},
|
|
1937
|
+
"note": {
|
|
1938
|
+
"type": "string",
|
|
1939
|
+
"description": "notes for the shift"
|
|
1940
|
+
}
|
|
1941
|
+
}
|
|
1942
|
+
},
|
|
1943
|
+
"EmployerShifts": {
|
|
1944
|
+
"properties": {
|
|
1945
|
+
"employer_shift_id": {
|
|
1946
|
+
"type": "integer"
|
|
1947
|
+
},
|
|
1948
|
+
"employer_id": {
|
|
1949
|
+
"type": "integer"
|
|
1950
|
+
},
|
|
1951
|
+
"location_id": {
|
|
1952
|
+
"type": "integer"
|
|
1953
|
+
},
|
|
1954
|
+
"role_id": {
|
|
1955
|
+
"type": "integer"
|
|
1956
|
+
},
|
|
1957
|
+
"employer_shift_time_start": {
|
|
1958
|
+
"type": "string",
|
|
1959
|
+
"description": "start date and time"
|
|
1960
|
+
},
|
|
1961
|
+
"employer_shift_time_end": {
|
|
1962
|
+
"type": "string",
|
|
1963
|
+
"description": "end date and time"
|
|
1964
|
+
},
|
|
1965
|
+
"employer_shift_repeat": {
|
|
1966
|
+
"type": "boolean"
|
|
1967
|
+
},
|
|
1968
|
+
"notes": {
|
|
1969
|
+
"type": "string"
|
|
1970
|
+
}
|
|
1971
|
+
}
|
|
1972
|
+
},
|
|
1973
|
+
"EmployerShiftsMonth": {
|
|
1974
|
+
"properties": {
|
|
1975
|
+
"employer_shift_id": {
|
|
1976
|
+
"type": "integer"
|
|
1977
|
+
},
|
|
1978
|
+
"date": {
|
|
1979
|
+
"type": "object",
|
|
1980
|
+
"description": "start date and time"
|
|
1981
|
+
},
|
|
1982
|
+
"count": {
|
|
1983
|
+
"type": "integer",
|
|
1984
|
+
"description": "shift counts"
|
|
1985
|
+
},
|
|
1986
|
+
"publish": {
|
|
1987
|
+
"type": "integer"
|
|
1988
|
+
}
|
|
1989
|
+
}
|
|
1990
|
+
},
|
|
1991
|
+
"Unavailability": {
|
|
1992
|
+
"properties": {
|
|
1993
|
+
"employee_unavailability_id": {
|
|
1994
|
+
"type": "integer",
|
|
1995
|
+
"description": "unavailability id"
|
|
1996
|
+
},
|
|
1997
|
+
"employee_unavailability_date_start": {
|
|
1998
|
+
"type": "string",
|
|
1999
|
+
"description": "start date and time"
|
|
2000
|
+
},
|
|
2001
|
+
"employee_unavailability_date_endv": {
|
|
2002
|
+
"type": "string",
|
|
2003
|
+
"description": "end date and time"
|
|
2004
|
+
},
|
|
2005
|
+
"employee_id": {
|
|
2006
|
+
"type": "integer",
|
|
2007
|
+
"description": "employee id"
|
|
2008
|
+
},
|
|
2009
|
+
"notes": {
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"description": "notes"
|
|
2012
|
+
},
|
|
2013
|
+
"employee_unavailability_special_day": {
|
|
2014
|
+
"type": "string",
|
|
2015
|
+
"description": "special day"
|
|
2016
|
+
},
|
|
2017
|
+
"employee_unavailability_fullday": {
|
|
2018
|
+
"type": "boolean",
|
|
2019
|
+
"description": "Fullday or not"
|
|
2020
|
+
}
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2023
|
+
"Documents": {
|
|
2024
|
+
"properties": {
|
|
2025
|
+
"user_document_id": {
|
|
2026
|
+
"type": "integer"
|
|
2027
|
+
},
|
|
2028
|
+
"user_document_name": {
|
|
2029
|
+
"type": "string",
|
|
2030
|
+
"description": "Document name"
|
|
2031
|
+
},
|
|
2032
|
+
"user_document_issuer": {
|
|
2033
|
+
"type": "string",
|
|
2034
|
+
"description": "Document issuer"
|
|
2035
|
+
},
|
|
2036
|
+
"user_document_expiry": {
|
|
2037
|
+
"type": "string",
|
|
2038
|
+
"description": "Document expiry"
|
|
2039
|
+
}
|
|
2040
|
+
}
|
|
2041
|
+
},
|
|
2042
|
+
"DocumentPages": {
|
|
2043
|
+
"properties": {
|
|
2044
|
+
"user_document_page_id": {
|
|
2045
|
+
"type": "integer"
|
|
2046
|
+
},
|
|
2047
|
+
"user_document_page_url": {
|
|
2048
|
+
"type": "string",
|
|
2049
|
+
"description": "Document page url"
|
|
2050
|
+
},
|
|
2051
|
+
"user_document_sort": {
|
|
2052
|
+
"type": "string",
|
|
2053
|
+
"description": "Document page order"
|
|
2054
|
+
},
|
|
2055
|
+
"user_document_id": {
|
|
2056
|
+
"type": "string",
|
|
2057
|
+
"description": "Document id"
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
},
|
|
2061
|
+
"DocumentShared": {
|
|
2062
|
+
"properties": {
|
|
2063
|
+
"user_document_share_id": {
|
|
2064
|
+
"type": "integer"
|
|
2065
|
+
},
|
|
2066
|
+
"user_document_id": {
|
|
2067
|
+
"type": "integer",
|
|
2068
|
+
"description": "Document ID"
|
|
2069
|
+
},
|
|
2070
|
+
"employer_id": {
|
|
2071
|
+
"type": "string",
|
|
2072
|
+
"description": "Employer ID"
|
|
2073
|
+
}
|
|
2074
|
+
}
|
|
2075
|
+
},
|
|
2076
|
+
"Bank": {
|
|
2077
|
+
"properties": {
|
|
2078
|
+
"bank_id": {
|
|
2079
|
+
"type": "integer"
|
|
2080
|
+
},
|
|
2081
|
+
"bank_status": {
|
|
2082
|
+
"type": "string",
|
|
2083
|
+
"description": "Status"
|
|
2084
|
+
},
|
|
2085
|
+
"bank_name": {
|
|
2086
|
+
"type": "string",
|
|
2087
|
+
"description": "Bank Short Name"
|
|
2088
|
+
},
|
|
2089
|
+
"bank_fullname": {
|
|
2090
|
+
"type": "string",
|
|
2091
|
+
"description": "Bank Fullname"
|
|
2092
|
+
},
|
|
2093
|
+
"bank_description": {
|
|
2094
|
+
"type": "string",
|
|
2095
|
+
"description": "Bank Description"
|
|
2096
|
+
},
|
|
2097
|
+
"bank_iconurl": {
|
|
2098
|
+
"type": "string",
|
|
2099
|
+
"description": "Bank Icon"
|
|
2100
|
+
}
|
|
2101
|
+
}
|
|
2102
|
+
},
|
|
2103
|
+
"UserBank": {
|
|
2104
|
+
"properties": {
|
|
2105
|
+
"user_bank_id": {
|
|
2106
|
+
"type": "integer"
|
|
2107
|
+
},
|
|
2108
|
+
"bank_id": {
|
|
2109
|
+
"type": "integer",
|
|
2110
|
+
"description": "Bank ID"
|
|
2111
|
+
},
|
|
2112
|
+
"user_id": {
|
|
2113
|
+
"type": "integer",
|
|
2114
|
+
"description": "User ID"
|
|
2115
|
+
},
|
|
2116
|
+
"user_bank_status": {
|
|
2117
|
+
"type": "string",
|
|
2118
|
+
"description": "Status"
|
|
2119
|
+
},
|
|
2120
|
+
"user_bank_name": {
|
|
2121
|
+
"type": "string",
|
|
2122
|
+
"description": "Bank Label"
|
|
2123
|
+
},
|
|
2124
|
+
"user_bank_bsb": {
|
|
2125
|
+
"type": "string",
|
|
2126
|
+
"description": "Bank BSB"
|
|
2127
|
+
},
|
|
2128
|
+
"user_bank_number": {
|
|
2129
|
+
"type": "string",
|
|
2130
|
+
"description": "Bank Number"
|
|
2131
|
+
},
|
|
2132
|
+
"created_at": {
|
|
2133
|
+
"type": "string",
|
|
2134
|
+
"description": "Create at"
|
|
2135
|
+
}
|
|
2136
|
+
}
|
|
2137
|
+
},
|
|
2138
|
+
"BankAllotment": {
|
|
2139
|
+
"properties": {
|
|
2140
|
+
"user_bank_allotment_id": {
|
|
2141
|
+
"type": "integer"
|
|
2142
|
+
},
|
|
2143
|
+
"user_bank_id": {
|
|
2144
|
+
"type": "integer",
|
|
2145
|
+
"description": "User Bank ID"
|
|
2146
|
+
},
|
|
2147
|
+
"employer_id": {
|
|
2148
|
+
"type": "integer",
|
|
2149
|
+
"description": "Employer ID"
|
|
2150
|
+
},
|
|
2151
|
+
"user_bank_allotment_percent": {
|
|
2152
|
+
"type": "string",
|
|
2153
|
+
"description": "Percent Bank Allotment"
|
|
2154
|
+
},
|
|
2155
|
+
"user_bank_allotment_fixed": {
|
|
2156
|
+
"type": "string",
|
|
2157
|
+
"description": "Fixed Bank Allotment"
|
|
2158
|
+
},
|
|
2159
|
+
"pay_type": {
|
|
2160
|
+
"type": "string",
|
|
2161
|
+
"description": "Pay Type"
|
|
2162
|
+
}
|
|
2163
|
+
}
|
|
2164
|
+
},
|
|
2165
|
+
"SuperFund": {
|
|
2166
|
+
"properties": {
|
|
2167
|
+
"superfund_id": {
|
|
2168
|
+
"type": "integer"
|
|
2169
|
+
},
|
|
2170
|
+
"superfund_name": {
|
|
2171
|
+
"type": "string",
|
|
2172
|
+
"description": "Status"
|
|
2173
|
+
},
|
|
2174
|
+
"superfund_description": {
|
|
2175
|
+
"type": "string",
|
|
2176
|
+
"description": "SuperFund Description"
|
|
2177
|
+
}
|
|
2178
|
+
}
|
|
2179
|
+
},
|
|
2180
|
+
"UserSuperFund": {
|
|
2181
|
+
"properties": {
|
|
2182
|
+
"user_superfund_id": {
|
|
2183
|
+
"type": "integer"
|
|
2184
|
+
},
|
|
2185
|
+
"superfund_id": {
|
|
2186
|
+
"type": "integer"
|
|
2187
|
+
},
|
|
2188
|
+
"user_superfund_number": {
|
|
2189
|
+
"type": "string",
|
|
2190
|
+
"description": "Suprtfund Number"
|
|
2191
|
+
},
|
|
2192
|
+
"user_superfund_status": {
|
|
2193
|
+
"type": "string",
|
|
2194
|
+
"description": "Status"
|
|
2195
|
+
}
|
|
2196
|
+
}
|
|
2197
|
+
},
|
|
2198
|
+
"UserEmployerSuperFund": {
|
|
2199
|
+
"properties": {
|
|
2200
|
+
"user_employer_superfund_id": {
|
|
2201
|
+
"type": "integer"
|
|
2202
|
+
},
|
|
2203
|
+
"user_superfund_id": {
|
|
2204
|
+
"type": "integer"
|
|
2205
|
+
},
|
|
2206
|
+
"employer_id": {
|
|
2207
|
+
"type": "integer"
|
|
2208
|
+
},
|
|
2209
|
+
"employer_name": {
|
|
2210
|
+
"type": "string"
|
|
2211
|
+
},
|
|
2212
|
+
"user_superfund_status": {
|
|
2213
|
+
"type": "string",
|
|
2214
|
+
"description": "Status"
|
|
2215
|
+
}
|
|
2216
|
+
}
|
|
2217
|
+
},
|
|
2218
|
+
"Accounts": {
|
|
2219
|
+
"properties": {
|
|
2220
|
+
"acount_id": {
|
|
2221
|
+
"type": "integer",
|
|
2222
|
+
"description": "ID of the account, either id of the employer of id of the user."
|
|
2223
|
+
},
|
|
2224
|
+
"display_name": {
|
|
2225
|
+
"type": "string",
|
|
2226
|
+
"description": "Display name of the account."
|
|
2227
|
+
},
|
|
2228
|
+
"icon_url": {
|
|
2229
|
+
"type": "string",
|
|
2230
|
+
"description": "thumbnail of the account."
|
|
2231
|
+
},
|
|
2232
|
+
"account_type": {
|
|
2233
|
+
"type": "string",
|
|
2234
|
+
"description": "Account Type(User, Own Employer, Employer)."
|
|
2235
|
+
}
|
|
2236
|
+
}
|
|
2237
|
+
},
|
|
2238
|
+
"EmployerAddress": {
|
|
2239
|
+
"properties": {
|
|
2240
|
+
"employer_address_line1": {
|
|
2241
|
+
"type": "string",
|
|
2242
|
+
"description": "Employer current address line one"
|
|
2243
|
+
},
|
|
2244
|
+
"employer_address_line2": {
|
|
2245
|
+
"type": "string",
|
|
2246
|
+
"description": "Employer current address line two"
|
|
2247
|
+
},
|
|
2248
|
+
"employer_address_city": {
|
|
2249
|
+
"type": "string",
|
|
2250
|
+
"description": "Employer current city"
|
|
2251
|
+
},
|
|
2252
|
+
"employer_postcode": {
|
|
2253
|
+
"type": "string",
|
|
2254
|
+
"description": "Employer current postcode"
|
|
2255
|
+
},
|
|
2256
|
+
"employer_state": {
|
|
2257
|
+
"type": "string",
|
|
2258
|
+
"description": "Employer current state/province"
|
|
2259
|
+
},
|
|
2260
|
+
"country_id": {
|
|
2261
|
+
"type": "string",
|
|
2262
|
+
"description": "Employer current country"
|
|
2263
|
+
}
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
"UserAddress": {
|
|
2267
|
+
"properties": {
|
|
2268
|
+
"user_address_line1": {
|
|
2269
|
+
"type": "string",
|
|
2270
|
+
"description": "User current address line one"
|
|
2271
|
+
},
|
|
2272
|
+
"user_address_line2": {
|
|
2273
|
+
"type": "string",
|
|
2274
|
+
"description": "User current address line two"
|
|
2275
|
+
},
|
|
2276
|
+
"user_address_city": {
|
|
2277
|
+
"type": "string",
|
|
2278
|
+
"description": "User current city"
|
|
2279
|
+
},
|
|
2280
|
+
"user_postcode": {
|
|
2281
|
+
"type": "string",
|
|
2282
|
+
"description": "User current postcode"
|
|
2283
|
+
},
|
|
2284
|
+
"user_state": {
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"description": "User current state/province"
|
|
2287
|
+
},
|
|
2288
|
+
"country_id": {
|
|
2289
|
+
"type": "string",
|
|
2290
|
+
"description": "User current country"
|
|
2291
|
+
}
|
|
2292
|
+
}
|
|
2293
|
+
},
|
|
2294
|
+
"Industries": {
|
|
2295
|
+
"properties": {
|
|
2296
|
+
"industry_id": {
|
|
2297
|
+
"type": "string",
|
|
2298
|
+
"description": "Industry ID"
|
|
2299
|
+
},
|
|
2300
|
+
"industry_name": {
|
|
2301
|
+
"type": "string",
|
|
2302
|
+
"description": "Industry Name"
|
|
2303
|
+
},
|
|
2304
|
+
"industry_code": {
|
|
2305
|
+
"type": "string",
|
|
2306
|
+
"description": "Industry CODE"
|
|
2307
|
+
},
|
|
2308
|
+
"industry_description": {
|
|
2309
|
+
"type": "string",
|
|
2310
|
+
"description": "Industry description"
|
|
2311
|
+
}
|
|
2312
|
+
}
|
|
2313
|
+
},
|
|
2314
|
+
"PayrollApprovalOptions": {
|
|
2315
|
+
"properties": {
|
|
2316
|
+
"payroll_approval_id": {
|
|
2317
|
+
"type": "string"
|
|
2318
|
+
},
|
|
2319
|
+
"payroll_approval_name": {
|
|
2320
|
+
"type": "string",
|
|
2321
|
+
"description": "Short name for the payroll approval timing"
|
|
2322
|
+
}
|
|
2323
|
+
}
|
|
2324
|
+
},
|
|
2325
|
+
"PayrollIntervalOptions": {
|
|
2326
|
+
"properties": {
|
|
2327
|
+
"payroll_interval_id": {
|
|
2328
|
+
"type": "string"
|
|
2329
|
+
},
|
|
2330
|
+
"payroll_interval_name": {
|
|
2331
|
+
"type": "string",
|
|
2332
|
+
"description": "Short name for the payroll interval"
|
|
2333
|
+
}
|
|
2334
|
+
}
|
|
2335
|
+
},
|
|
2336
|
+
"PayrollReleaseOptions": {
|
|
2337
|
+
"properties": {
|
|
2338
|
+
"payroll_release_id": {
|
|
2339
|
+
"type": "string"
|
|
2340
|
+
},
|
|
2341
|
+
"payroll_release_name": {
|
|
2342
|
+
"type": "string",
|
|
2343
|
+
"description": "Short name for the payroll release"
|
|
2344
|
+
}
|
|
2345
|
+
}
|
|
2346
|
+
},
|
|
2347
|
+
"TaxEntityTypeOptions": {
|
|
2348
|
+
"properties": {
|
|
2349
|
+
"tax_entity_id": {
|
|
2350
|
+
"type": "string"
|
|
2351
|
+
},
|
|
2352
|
+
"tax_entity_name": {
|
|
2353
|
+
"type": "string",
|
|
2354
|
+
"description": "Entity Type"
|
|
2355
|
+
}
|
|
2356
|
+
}
|
|
2357
|
+
},
|
|
2358
|
+
"TaxReportingOptions": {
|
|
2359
|
+
"properties": {
|
|
2360
|
+
"entity_type_id": {
|
|
2361
|
+
"type": "string"
|
|
2362
|
+
},
|
|
2363
|
+
"entity_type_name": {
|
|
2364
|
+
"type": "string",
|
|
2365
|
+
"description": "Entity Type"
|
|
2366
|
+
}
|
|
2367
|
+
}
|
|
2368
|
+
},
|
|
2369
|
+
"Locations": {
|
|
2370
|
+
"properties": {
|
|
2371
|
+
"location_id": {
|
|
2372
|
+
"type": "integer"
|
|
2373
|
+
},
|
|
2374
|
+
"employee_location_id": {
|
|
2375
|
+
"type": "integer"
|
|
2376
|
+
},
|
|
2377
|
+
"employee_location_name": {
|
|
2378
|
+
"type": "string",
|
|
2379
|
+
"description": "Location name"
|
|
2380
|
+
}
|
|
2381
|
+
}
|
|
2382
|
+
},
|
|
2383
|
+
"Role": {
|
|
2384
|
+
"properties": {
|
|
2385
|
+
"employee_role_id": {
|
|
2386
|
+
"type": "integer"
|
|
2387
|
+
},
|
|
2388
|
+
"employee_id": {
|
|
2389
|
+
"type": "integer"
|
|
2390
|
+
},
|
|
2391
|
+
"role_id": {
|
|
2392
|
+
"type": "integer"
|
|
2393
|
+
}
|
|
2394
|
+
}
|
|
2395
|
+
},
|
|
2396
|
+
"RoleDetails": {
|
|
2397
|
+
"properties": {
|
|
2398
|
+
"employee_role_id": {
|
|
2399
|
+
"type": "integer"
|
|
2400
|
+
},
|
|
2401
|
+
"employee_id": {
|
|
2402
|
+
"type": "integer"
|
|
2403
|
+
},
|
|
2404
|
+
"last_shift": {
|
|
2405
|
+
"type": "string"
|
|
2406
|
+
},
|
|
2407
|
+
"first_shift": {
|
|
2408
|
+
"type": "string"
|
|
2409
|
+
},
|
|
2410
|
+
"payroll_variations": {
|
|
2411
|
+
"type": "string"
|
|
2412
|
+
}
|
|
2413
|
+
}
|
|
2414
|
+
},
|
|
2415
|
+
"RoleVariation": {
|
|
2416
|
+
"properties": {
|
|
2417
|
+
"employee_role_variations_id": {
|
|
2418
|
+
"type": "integer"
|
|
2419
|
+
},
|
|
2420
|
+
"employee_role_id": {
|
|
2421
|
+
"type": "integer"
|
|
2422
|
+
},
|
|
2423
|
+
"variations_type": {
|
|
2424
|
+
"type": "string"
|
|
2425
|
+
},
|
|
2426
|
+
"variations_value": {
|
|
2427
|
+
"type": "string"
|
|
2428
|
+
}
|
|
2429
|
+
}
|
|
2430
|
+
},
|
|
2431
|
+
"Note": {
|
|
2432
|
+
"properties": {
|
|
2433
|
+
"employee_notes_id": {
|
|
2434
|
+
"type": "integer"
|
|
2435
|
+
},
|
|
2436
|
+
"employee_id": {
|
|
2437
|
+
"type": "integer"
|
|
2438
|
+
},
|
|
2439
|
+
"to_user_id": {
|
|
2440
|
+
"type": "integer"
|
|
2441
|
+
},
|
|
2442
|
+
"location_id": {
|
|
2443
|
+
"type": "integer"
|
|
2444
|
+
},
|
|
2445
|
+
"employer_shift_id": {
|
|
2446
|
+
"type": "integer"
|
|
2447
|
+
},
|
|
2448
|
+
"employee_notes": {
|
|
2449
|
+
"type": "string",
|
|
2450
|
+
"description": "Notes"
|
|
2451
|
+
}
|
|
2452
|
+
}
|
|
2453
|
+
},
|
|
2454
|
+
"Error": {
|
|
2455
|
+
"properties": {
|
|
2456
|
+
"code": {
|
|
2457
|
+
"type": "integer",
|
|
2458
|
+
"format": "int32"
|
|
2459
|
+
},
|
|
2460
|
+
"message": {
|
|
2461
|
+
"type": "string"
|
|
2462
|
+
},
|
|
2463
|
+
"fields": {
|
|
2464
|
+
"type": "string"
|
|
2465
|
+
}
|
|
2466
|
+
}
|
|
2467
|
+
}
|
|
2468
|
+
}
|
|
2469
|
+
}
|