diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 34bfc66..0000000 --- a/.gitattributes +++ /dev/null @@ -1,3 +0,0 @@ -/.gitattributes export-ignore -/.gitignore export-ingore -/LICENSE export-ignore \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 757fee3..0000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/.idea \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e446a35..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2016 Tim Joosten - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/contribution.md b/contribution.md deleted file mode 100644 index e2ac7fa..0000000 --- a/contribution.md +++ /dev/null @@ -1,5 +0,0 @@ -Contribution Guidelines - -If you are submitting documentation for the current stable release, submit it to the corresponding branch. -For example, documentation for SIJOT-2.x would be submitted to the 2.* branch. -Documentation intended for the next release of Sijot-2.x should be submitted to the master branch. diff --git a/documentation/activities.md b/documentation/activities.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/authorization.md b/documentation/authorization.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/groups.md b/documentation/groups.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/rental.md b/documentation/rental.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/status-codes.md b/documentation/status-codes.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/users.md b/documentation/users.md deleted file mode 100644 index e69de29..0000000 diff --git a/output.html b/output.html index 470f530..787f3f2 100644 --- a/output.html +++ b/output.html @@ -1,5 +1,5 @@ -SIJOT-3 API Back to top

SIJOT-3 API

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

-

algemeen

Authorization request headers

+SIJOT-3 API Back to top

SIJOT-3 API

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

+

Algemeen

Authorization request headers

Bij elke(*) request moet een Authorization-header worden meegegeven:

X-Authorization: {Uw API sleutel}

{Uw API sleutel} is een random gegenereerde JSON token. Die kan verkregen worden als admin in het controle @@ -54,32 +54,35 @@

Formaat

Oplijsting van alle verhuringen

Oplijsting van alle verhuringen
GET/api/lease

Example URI

GET http://www.st-joris-turnhout.be/api/lease
Response  200
HideShow
Headers
Content-Type: application/json
X-Authorization: '<Uw API sleutel>'
Body
{}

Bekijk een specifieke verhuring

Bekijk een specifieke verhuring
GET/{verhuring_id}

Example URI

GET http://www.st-joris-turnhout.be/verhuring_id
URI Parameters
HideShow
verhuring_id
integer (required) 

De id van de verhuring in het systeem.

-
Response  401

Maak een verhuring aan

Maak een verhuring aan
POST/api/lease

Example URI

POST http://www.st-joris-turnhout.be/api/lease
Request
HideShow
Headers
Content-Type: application/json
Body
{
-  "choices": [
-    "Swift",
-    "Objective-C"
-  ]
+

Verhuringen

Oplijsting van alle Verhuringen

Oplijsting van alle Verhuringen
GET/api/lease

Example URI

GET http://www.st-joris-turnhout.be/api/lease

Informatie optrent verhuring

Informatie optrent verhuring
GET/api/lease/1

Example URI

GET http://www.st-joris-turnhout.be/api/lease/1

Verhuring invoegen

Verhuring invoegen
POST/api/lease/store

Example URI

POST http://www.st-joris-turnhout.be/api/lease/store

Verhuring aanpassen

Verhuring aanpassen
PUT/api/lease/1

Example URI

PUT http://www.st-joris-turnhout.be/api/lease/1

Verhuring verwijderen

Verhuring verwijderen
DELETE/api/lease/1

Example URI

DELETE http://www.st-joris-turnhout.be/api/lease/1
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
+  "error": {
+    "code": 401,
+    "http_code": "GEN-AUTHORIZED",
+    "message": "Unauthorized"
+  }
 }
Schema
{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "choices": {
-      "type": "array",
-      "description": "test"
+    "error": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "number"
+        },
+        "http_code": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
     }
-  },
-  "required": [
-    "choices"
-  ]
-}
Response  401

Verwijder een verhuring

Verwijder een verhuring
DELETE/{verhuring_id}

Example URI

DELETE http://www.st-joris-turnhout.be/verhuring_id
URI Parameters
HideShow
verhuring_id
integer (required) 

De id van de verhuring in het systeem.

-
Response  200
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
-  "error": {
-    "code": "401",
-    "http_code": "GEN-UNAUTHORIZED",
-    "message": "Unauthorized."
   }
-}
Response  404
HideShow
Headers
Content-Type: application/json

Generated by aglio on 27 Aug 2017