Begin to introduce status

This commit is contained in:
Nico Schottelius 2018-10-26 19:50:56 +02:00
parent 05decb388e
commit c64b2120b0

View file

@ -42,6 +42,12 @@ OR
``` ```
## Usage: REST
- Use an existing token to connect to the service
- All REST based messages: JSON
### POST: /verify ### POST: /verify
Not sure if this one will be publicly available. Not sure if this one will be publicly available.
@ -75,11 +81,6 @@ OR
} }
``` ```
## Usage: REST
- Use an existing token to connect to the service
- All REST based messages: JSON
### POST /app/register ### POST /app/register
Register a new app. Returns an app ID. Register a new app. Returns an app ID.
@ -96,10 +97,21 @@ Request JSON object:
Response JSON object: Response JSON object:
```
{ {
status: "OK",
appid: "UUID of your app", appid: "UUID of your app",
} }
```
OR
```
{
status: "FAIL",
error: "Reason for failure"
}
```
### GET /app ### GET /app
@ -115,7 +127,9 @@ Request JSON object:
Response JSON object: Response JSON object:
[ {
status: "OK",
apps: [
{ {
name: "name of your web app" name: "name of your web app"
appid: "UUID of your app", appid: "UUID of your app",
@ -124,8 +138,8 @@ Response JSON object:
name: "name of your second web app" name: "name of your second web app"
appid: "UUID of your second app", appid: "UUID of your second app",
} }
] ]
}
### GET /app/UUID ### GET /app/UUID