IoT Coffee Machine Core API documentation version v1.0
https://tobias-blaufuss.de:65291
/public
Am System anmelden.
post /public/auth/login
Am System anmelden.
Body
Media type: application/json
Type: object
Properties- username: required(string)
Username des Nutzeraccounts
- password: required(string)
Passwort des Nutzeraccounts
HTTP status code 200
Ok. Login erfolgreich.
Body
Media type: application/json
Type: object
Properties- token: required(string)
JWT-Token für zukünftige API-Requests
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Im System registrieren.
post /public/users
Im System registrieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Neuer Username des Nutzeraccounts
Example:
John - password: required(string)
Neues Password des Nutzeraccounts
Example:
somepassword - email: required(string)
Neue E-Mail-Adresse des Nutzeraccounts
Example:
John.Doe@domain.tld
HTTP status code 201
Created. Nutzeraccount erstellt.
Headers
- Location: required(string)
URL zum neu angelegten Nutzeraccount.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
/auth/refresh
Liefert einen neuen JWT-Token.
post /auth/refresh
Liefert einen neuen JWT-Token.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok. JWT-Token erneuert.
Body
Media type: application/json
Type: object
Properties- token: required(string)
JWT-Token für zukünftige API-Requests
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
/users
Liefert eine Liste an Nutzeraccounts.
Erstellt einen neuen Nutzeraccount.
get /users
Liefert eine Liste an Nutzeraccounts.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: user
- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /users
Erstellt einen neuen Nutzeraccount.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Neuer Username des Nutzeraccounts
Example:
John - password: required(string)
Neues Password des Nutzeraccounts
Example:
somepassword - email: required(string)
Neue E-Mail-Adresse des Nutzeraccounts
Example:
John.Doe@domain.tld - roles: required(array of integer)
IDs der zugewiesenen Nutzerrollen des Nutzeraccounts
Example:
[ 1, 2 ]
HTTP status code 201
Created. Nutzeraccount erstellt.
Headers
- Location: required(string)
URL zum neu angelegten Nutzeraccount.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert den Nutzeraccount mit der angegebenen öffentlichen ID.
Bearbeitet den Nutzeraccount mit der angegebenen öffentlichen ID.
Löscht den Nutzeraccount mit der angegebenen öffentlichen ID.
get /users/{public_id}
Liefert den Nutzeraccount mit der angegebenen öffentlichen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
put /users/{public_id}
Bearbeitet den Nutzeraccount mit der angegebenen öffentlichen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Neuer Username des Nutzeraccounts
Example:
John - password: required(string)
Neues Password des Nutzeraccounts
Example:
somepassword - email: required(string)
Neue E-Mail-Adresse des Nutzeraccounts
Example:
John.Doe@domain.tld - roles: required(array of integer)
IDs der zugewiesenen Nutzerrollen des Nutzeraccounts
Example:
[ 1, 2 ]
HTTP status code 200
Ok. Nutzeraccount bearbeitet.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
delete /users/{public_id}
Löscht den Nutzeraccount mit der angegebenen öffentlichen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
HTTP status code 204
No Content. Nutzeraccount gelöscht.
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste aller Nutzerrollen des Nutzeraccounts mit der angegebenen öffentlichen ID.
get /users/{public_id}/roles
Liefert eine Liste aller Nutzerrollen des Nutzeraccounts mit der angegebenen öffentlichen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: userrole
- id: required(integer)
ID der Nutzerrolle.
Example:
42 - name: required(string)
Name der Nutzerrolle.
Example:
Admin
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste aller Kaffee-Profile.
Erstellt ein Kaffee-Profil.
get /users/{public_id}/profiles
Liefert eine Liste aller Kaffee-Profile.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-profile
- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /users/{public_id}/profiles
Erstellt ein Kaffee-Profil.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 1 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
HTTP status code 201
Created. Kaffee-Profil erstellt.
Headers
- Location: required(string)
URL zum neu angelegten Kaffee-Profil.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert das Kaffee-Profil mit der angegebenen ID.
Bearbeitet das Kaffee-Profil mit der angegebenen ID.
Löscht das Kaffee-Profil mit der angegebenen ID.
get /users/{public_id}/profiles/{id}
Liefert das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b - id: required(integer)
ID des Kaffee-Profils.
Example:
42
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
put /users/{public_id}/profiles/{id}
Bearbeitet das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b - id: required(integer)
ID des Kaffee-Profils.
Example:
42
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 1 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
HTTP status code 200
Ok. Kaffee-Profil bearbeitet.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
delete /users/{public_id}/profiles/{id}
Löscht das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- public_id: required(string)
Öffentliche ID des Nutzeraccounts.
Example:
f9940ce9-5adf-4247-810c-b2f7e771143b - id: required(integer)
ID des Kaffee-Profils.
Example:
42
HTTP status code 204
No Content. Kaffee-Profil gelöscht.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert den Nutzeraccount des eingeloggten Nutzers.
Bearbeitet den Nutzeraccount des eingeloggten Nutzers.
get /users/current
Liefert den Nutzeraccount des eingeloggten Nutzers.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
put /users/current
Bearbeitet den Nutzeraccount des eingeloggten Nutzers.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: (string)
Neuer Username des Nutzeraccounts
Example:
JohnDoe - old_password: (string)
Altes Password des Nutzeraccounts
Example:
oldpassword123 - new_password: (string)
Neues Password des Nutzeraccounts
Example:
newpassword312 - email: (string)
Neue E-Mail-Adresse des Nutzeraccounts
Example:
John.Doe@domain.tld
HTTP status code 200
Ok. Nutzeraccount bearbeitet.
Body
Media type: application/json
Type: object
Properties- public_id: required(string)
Öffentliche ID des Nutzeraccounts
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg - name: required(string)
Username des Nutzeraccounts
Example:
Tom4421 - email: required(string)
E-Mail-Adresse des Nutzeraccounts
Example:
some.email@gmx.de
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste aller Kaffee-Profile.
Erstellt ein Kaffee-Profil.
get /users/current/profiles
Liefert eine Liste aller Kaffee-Profile.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-profile
- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /users/current/profiles
Erstellt ein Kaffee-Profil.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 1 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
HTTP status code 201
Created. Kaffee-Profil erstellt.
Headers
- Location: required(string)
URL zum neu angelegten Kaffee-Profil.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert das Kaffee-Profil mit der angegebenen ID.
Bearbeitet das Kaffee-Profil mit der angegebenen ID.
Löscht das Kaffee-Profil mit der angegebenen ID.
get /users/current/profiles/{id}
Liefert das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(integer)
ID des Kaffee-Profils.
Example:
42
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
put /users/current/profiles/{id}
Bearbeitet das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(integer)
ID des Kaffee-Profils.
Example:
42
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 1 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
HTTP status code 200
Ok. Kaffee-Profil bearbeitet.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
delete /users/current/profiles/{id}
Löscht das Kaffee-Profil mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(integer)
ID des Kaffee-Profils.
Example:
42
HTTP status code 204
No Content. Kaffee-Profil gelöscht.
Body
Media type: application/json
Type: object
Properties- id: (integer)
ID des Kaffee-Profils
Example:
42 - name: required(string)
Name des Kaffee-Profils
Example:
Stark - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 1 - maximum: 100000)
water_in_percent
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert einen eine Liste aller Aufträge.
Speichert einen neuen ausgeführten Auftrag einer Kaffeemaschine.
get /users/current/jobs
Liefert einen eine Liste aller Aufträge.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Query Parameters
- coffee_machine_name: (string)
Filtert die Liste der Aufträge nach dem Namen einer Kaffeemaschinen.
Example:
Winston - square: (boolean)
Filter die Liste nach beglichenen (square=true) oder offenen (square=false) Aufträgen.
Example:
false
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: job
- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /users/current/jobs
Speichert einen neuen ausgeführten Auftrag einer Kaffeemaschine.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
HTTP status code 201
Created. Neuer Auftrag wurde gespeichert.
Headers
- Location: required(string)
URL zum neu angelegten Auftrag.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
/roles
Liefert eine Liste aller verfügbarer Nutzerrollen.
get /roles
Liefert eine Liste aller verfügbarer Nutzerrollen.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: userrole
- id: required(integer)
ID der Nutzerrolle.
Example:
42 - name: required(string)
Name der Nutzerrolle.
Example:
Admin
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
/jobs
Liefert einen eine Liste aller Aufträge.
Speichert einen neuen ausgeführten Auftrag einer Kaffeemaschine.
get /jobs
Liefert einen eine Liste aller Aufträge.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Query Parameters
- coffee_machine_name: (string)
Filtert die Liste der Aufträge nach dem Namen einer Kaffeemaschinen.
Example:
Winston - square: (boolean)
Filter die Liste nach beglichenen (square=true) oder offenen (square=false) Aufträgen.
Example:
false
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: job
- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /jobs
Speichert einen neuen ausgeführten Auftrag einer Kaffeemaschine.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
- user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 201
Created. Neuer Auftrag wurde gespeichert.
Headers
- Location: required(string)
URL zum neu angelegten Auftrag.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert einen einzelnen Auftrag mit der angegebenen ID.
Bearbeitet einen existierenden Job einer Kaffeemaschine.
Löscht den Auftrag mit der angegebenen ID.
get /jobs/{id}
Liefert einen einzelnen Auftrag mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
put /jobs/{id}
Bearbeitet einen existierenden Job einer Kaffeemaschine.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 200
Ok. Auftrag bearbeitet.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
delete /jobs/{id}
Löscht den Auftrag mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 204
No Content. Auftrag gelöscht.
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
/coffee
Liefert eine Liste an verfügbaren Kaffeeprodukten.
Erstellt ein neues Kaffeeprodukt.
get /coffee/products
Liefert eine Liste an verfügbaren Kaffeeprodukten.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-product
- id: required(integer)
ID des Kaffeeproduktes.
Example:
42 - name: required(string)
Name des Kaffeeproduktes.
Example:
Dallmayr Prodomo - coffee_brand_id: required(integer)
ID der Kaffeemarke.
Example:
42 - coffee_type_id: required(integer)
ID des Kaffeetyps.
Example:
42
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /coffee/products
Erstellt ein neues Kaffeeprodukt.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffeeproduktes.
Example:
Dallmayr Prodomo - coffee_brand_id: required(integer)
ID der Kaffeemarke.
Example:
42 - coffee_type_id: required(integer)
ID des Kaffeetyps.
Example:
42
HTTP status code 201
Created. Neues Kaffeeprodukt erstellt.
Headers
- Location: required(string)
URL des neu erstellten Kaffeeprodukts.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Kaffeeproduktes.
Example:
42 - name: required(string)
Name des Kaffeeproduktes.
Example:
Dallmayr Prodomo - coffee_brand_id: required(integer)
ID der Kaffeemarke.
Example:
42 - coffee_type_id: required(integer)
ID des Kaffeetyps.
Example:
42
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert das Kaffeeprodukt mit der angegebenen ID.
get /coffee/products/{id}
Liefert das Kaffeeprodukt mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Kaffeeproduktes.
Example:
42 - name: required(string)
Name des Kaffeeproduktes.
Example:
Dallmayr Prodomo - coffee_brand_id: required(integer)
ID der Kaffeemarke.
Example:
42 - coffee_type_id: required(integer)
ID des Kaffeetyps.
Example:
42
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste an verfügbaren Kaffeetypen.
Erstellt einen neue Kaffeetyp.
get /coffee/types
Liefert eine Liste an verfügbaren Kaffeetypen.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-type
- id: required(integer)
ID des Kaffeetyps
Example:
42 - name: required(string)
Name des Kaffeetyps
Example:
Arabica
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /coffee/types
Erstellt einen neue Kaffeetyp.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name des Kaffeetyps
Example:
Arabica
HTTP status code 201
Created. Neuer Kaffeetype erstellt.
Headers
- Location: required(string)
URL zum neu angelegten Kaffeetyp.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Kaffeetyps
Example:
42 - name: required(string)
Name des Kaffeetyps
Example:
Arabica
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert den Kaffeetyp mit der angegebenen ID.
get /coffee/types/{id}
Liefert den Kaffeetyp mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID des Kaffeetyps
Example:
42 - name: required(string)
Name des Kaffeetyps
Example:
Arabica
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste an verfügbaren Kaffeemarken.
Erstellt eine neue Kaffeemarke.
get /coffee/brands
Liefert eine Liste an verfügbaren Kaffeemarken.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-brand
- id: required(integer)
ID der Kaffeemarke
Example:
42 - name: required(string)
Name der Kaffeemarke
Example:
Dallmayr
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /coffee/brands
Erstellt eine neue Kaffeemarke.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name der Kaffeemarke
Example:
Dallmayr
HTTP status code 201
Created. Neue Kaffeemarke erstellt.
Headers
- Location: required(string)
URL zur neu angelegten Kaffeemarke.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID der Kaffeemarke
Example:
42 - name: required(string)
Name der Kaffeemarke
Example:
Dallmayr
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert die Kaffeemarke mit der angegebenen ID.
get /coffee/brands/{id}
Liefert die Kaffeemarke mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID der Kaffeemarke
Example:
42 - name: required(string)
Name der Kaffeemarke
Example:
Dallmayr
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert eine Liste an verfügbaren Kaffeemaschinen.
Erstellt eine neue Kaffeemaschine.
get /coffee/machines
Liefert eine Liste an verfügbaren Kaffeemaschinen.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: coffee-machine
- id: required(integer)
ID der Kaffeemaschine
Example:
42 - name: required(string)
Name der Kaffeemaschine
Example:
Winston
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
post /coffee/machines
Erstellt eine neue Kaffeemaschine.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
Body
Media type: application/json
Type: object
Properties- name: required(string)
Name der Kaffeemaschine
Example:
Winston
HTTP status code 201
Created. Neue Kaffeemachine erstellt.
Headers
- Location: required(string)
URL zur neu angelegten Kaffeemaschine.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID der Kaffeemaschine
Example:
42 - name: required(string)
Name der Kaffeemaschine
Example:
Winston
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert die Kaffeemaschine mit der angegebenen ID.
get /coffee/machines/{id}
Liefert die Kaffeemaschine mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- id: required(integer)
ID der Kaffeemaschine
Example:
42 - name: required(string)
Name der Kaffeemaschine
Example:
Winston
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert einen eine Liste aller Aufträge einer Kaffeemaschine mit der angegebenen ID.
get /coffee/machines/{id}/jobs
Liefert einen eine Liste aller Aufträge einer Kaffeemaschine mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: array of object
Items: job
- id: required(integer)
ID des Auftrags.
Example:
42 - create_date: required(integer)
Erstellungsdatum des Auftrags.
- square_date: (integer)
Datum, an dem der Auftrag beglichen wurde.
- coffee_machine_id: required(integer)
Die ID der Kaffeemaschine, welche den Auftrag ausgeführt hat.
Example:
42 - coffee_strength_in_percent: required(integer - minimum: 0 - maximum: 100)
Kaffeestärke in Prozent
Example:
66 - water_in_percent: required(integer - minimum: 0 - maximum: 100)
Wasseranteil in Prozent
Example:
66 - price: required(integer - minimum: 0)
Der Preis pro Kaffee in Cents
Example:
10 - doses: required(integer - minimum: 1 - maximum: 2)
Die Anzahl der hergestellten Kaffee in diesem Auftrag
Example:
1 - coffee_product_id: required(integer)
ID des Kaffeeproduktes, welches sich zum Zeitpunkt des Auftrags in der Kaffeemaschine befand.
Example:
42 - user_id: required(string)
Public ID des Nutzeraccounts, für den der Job erstellt werden soll.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.
Liefert die Anzahl aller Aufträge einer Kaffeemaschine mit der angegebenen ID.
get /coffee/machines/{id}/jobs/count
Liefert die Anzahl aller Aufträge einer Kaffeemaschine mit der angegebenen ID.
Anhand dieses Sicherheitsmechanismus werden Endpunkte gegen ungewollten Zugriff abgesichert. Ein JWT-Token wird hierbei bei jedem Request benötigt, um den Nutzer zu identifizieren.
URI Parameters
- id: required(string)
HTTP status code 200
Ok.
Body
Media type: application/json
Type: object
Properties- size: required(integer)
Länge der Liste
Example:
42
Secured by jwt
Headers
- x-access-token: required(string)
Ein JWT-Token wird im Header platziert, um den Nutzer der Anfrage zu identifizieren.
Example:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwdWJsaWNfaWQiOiJkMzg5MjRmYi05NDE3LTRhNTAtYjcxNS0wMWY4MDVjMjgwNjMiLCJleHAiOjE1NDI1NDE3NDV9.jbWsgjOFn6jEx0IGVoUaiqwt530_Fko8qgoMhGvl4mg
HTTP status code 401
Token fehlt.
HTTP status code 401
Token ist invalide.
HTTP status code 403
Ausführung der Methode verboten.