Skip to content

Commit 0c9251b

Browse files
TjoostenTjoosten
authored andcommitted
Extend docs
1 parent 406d65e commit 0c9251b

File tree

3 files changed

+408
-7
lines changed

3 files changed

+408
-7
lines changed

apiary.apib

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
AUTHOR: Tim Joosten
21
FORMAT: 1A
32
HOST: http://www.st-joris-turnhout.be
43

54
# SIJOT-3 API
65

76
Deze referentie hoort bij de API die Scouts en Gidsen Sint-Joris, Turnhout. Heeft ontwikkeld voor intern gebruik.
87

9-
## Authorisatie
10-
8+
# Group algemeen
119
#### Authorization request headers
1210

1311
Bij elke(*) request moet een *Authorization-header* worden meegegeven:
@@ -20,9 +18,34 @@ paneel van de website.
2018
(*) Enkele endpoints zijn publiek. Hierbij is geen *Authorization-header* noodzakelijk. Het resultaat kan wel afhangen
2119
van de *Authorization-header*
2220

23-
## Verhuringen [/api/lease]
21+
## Errors
22+
23+
#### Status codes
24+
25+
Code | Reason Phrase
26+
-------- | -----------------------------
27+
`200` | Request OK
28+
`201` | Resource created
29+
`304` | Not Modified
30+
`400` | Bad request
31+
`401` | Unauthorized request
32+
`404` | Resource not found
33+
`50x` | Internal server error.
34+
35+
#### Formaat
36+
37+
```javascript
38+
{
39+
"error": {
40+
"code": "{HTTP Status code}",
41+
"http_code": "{Uitleg van de HTTP code}",
42+
"message": "{Titel van de fout.}"
43+
}
44+
}
45+
```
46+
# Group Overzicht
2447

25-
### Oplijsting van alle verhuringen [GET]
48+
### Oplijsting van alle verhuringen [GET /api/lease]
2649

2750
+ Response 200 (application/json)
2851

@@ -37,7 +60,39 @@ van de *Authorization-header*
3760

3861
### Bekijk een specifieke verhuring [GET /{verhuring_id}]
3962
+ Parameters
40-
+ verhuring_id (integer) - De id van de verhuring in the systeem.
63+
+ verhuring_id (integer) - De id van de verhuring in het systeem.
4164

65+
+ Response 401
66+
67+
68+
### Maak een verhuring aan [POST /api/lease]
69+
70+
+ Request (application/json)
71+
+ Attributes
72+
+ choices: Swift, `Objective-C` (array, required) - test
73+
74+
+ Response 401
75+
76+
### Verwijder een verhuring [DELETE /{verhuring_id}]
77+
78+
+ Parameters
79+
80+
+ verhuring_id (integer) - De id van de verhuring in het systeem.
81+
82+
+ Response 200 (application/json)
83+
84+
+ Response 401 (application/json)
85+
86+
+ Body
87+
88+
```javascript
89+
{
90+
"error": {
91+
"code": "401",
92+
"http_code": "GEN-UNAUTHORIZED",
93+
"message":"Unauthorized."
94+
}
95+
}
96+
```
4297

43-
### Maak een verhuring aan [POST]
98+
+ Response 404 (application/json)

0 commit comments

Comments
 (0)