-
Notifications
You must be signed in to change notification settings - Fork 0
Schnittstellen Meetings
Fabian Holtkötter edited this page Oct 21, 2017
·
4 revisions
| Beschreibung | Liefert alle Meetings in reduzierter Darstellung |
| Methode | GET |
| Endpunkt | /meetings/ |
| Sicherheitsregel | keine |
| Antwort | [
{
"id":"FuzzyButteryPhysignathus",
"place":"Arbeitsplatz in Gebäude 5",
"date":"2017-01-05T11:00:00Z",
"closeDate":"2017-01-04T23:59:59Z",
"closed":false
},
{
"id":"SquigglyCuteRoyal",
"place":"Innenhof",
"date":"2017-01-12T15:00:00Z",
"closeDate":"2017-01-12T12:00:00Z",
"closed":false
},
...
]
|
| Antwort Codes |
200 - OK |
| Beschreibung | Liefert die detailierten Daten eines Meetings |
| Methode | GET |
| Endpunkt | /meetings/{meeting-id}/td> |
| Sicherheitsregel | keine |
| Antwort | {
"id": "",
"place": "",
"creator": "",
"buyer": "",
"date": "0001-01-01T00:00:00Z",
"closeDate": "0001-01-01T00:00:00Z",
"closed": false,
"orders": [
{
"customer": "",
"payed": false,
"items": [],
"totalPrice": 0,
"payLink": ""
}
],
"offer": [],
"totalPrice": 0,
"totalItems": null
}
|
| Antwort Codes |
200 - OK |
| Beschreibung | Endpunkt zum erstellen eines neuen Meeting |
| Methode | POST |
| Endpunkt | /meetings/do/createMeeting |
| Sicherheitsregel | Nur registrierte und aktive Nutzer |
| Request Body | "meeting": {
"place": "",
"buyer": "",
"date": "2017-11-25T11:00:00Z",
"closeDate": "2017-11-24T23:59:59Z",
"closed": false,
"offer": [
{"name": "Weisswurst", "price": 1.12},
{"name": "Brezen", "price": 0.65},
...
]
},
|
| Antwort Codes |
201 - CREATED |
| Beschreibung | Schließt ein Meeting, sodass keine Bestellungen mehr hinzugefügt oder geändert werden können. |
| Methode | POST |
| Endpunkt | /meetings/{meetingId}/do/closeMeeting |
| Sicherheitsregel | Nur Creator |
| Antwort Codes |
200 - Meeting wurde geschlossen |
| Beschreibung | Fügt dem Meeting ein Produkt hinzu, welches Bestellt werden kann. |
| Methode | POST |
| Endpunkt | /meetings/{meetingID}/do/putProduct |
| Sicherheitsregel | Creator und Buyer |
| Request Body | {
"product": {
"name": "",
"price": 0
}
}
|
| Antwort Codes |
200 - Produkt hinzugefügt |
| Beschreibung | Entfernt ein Produkt anhand des Namnes |
| Methode | POST |
| Endpunkt | /meetings/{meetingID}/do/removeProduct |
| Sicherheitsregel | Nur Creator und Buyer |
| Request Body | {
"productName": ""
}
|
| Antwort Codes |
200 - Produkt wurde erfolgreich entfernt |
| Beschreibung | Erlaubt es dem Creator einen Buyer zu ernennen |
| Methode | POST |
| Endpunkt | /meetings/{meetingID}/do/setBuyer |
| Sicherheitsregel | Nur Creator |
| Request Body | {
"buyer": "hans@test.de"
}
|
| Antwort Codes |
200 - Buyer wurde gesetzt |
| Beschreibung | Über diesen Endpunkt kann ein Creator oder Buyer den Ort des Meetings setzen. |
| Methode | POST |
| Endpunkt | /meetings/{meetingID}/do/setPlace |
| Sicherheitsregel | Nur Creator und Buyer |
| Request Body | {
"place": "",
}
|
| Antwort Codes |
200 - Ort wurde gespoeichert |
| Beschreibung | Toggled den Bezahlt-Status der Bestellung des Customers, der im Body genannt wird. |
| Methode | POST |
| Endpunkt | /meetings/{meetingId}/do/payOrder |
| Request Body | {
"customer": "..." // Mail-Adresse des Customers, der eine Bestellung in diesem Meeting besitzt.
}
|
| Sicherheitsregel | Meeting-Ersteller und Meeting-Käufer |
| Antwort Codes |
200 - OK 401 - Unauthorized |
| Beschreibung | Über diesen Endpunkt können Kunden eingeladen werden. |
| Methode | POST |
| Endpunkt | /meetings/{meetingId}/do/invite/ |
| Sicherheitsregel | Nur Creator |
| Anfrage | { "userMails": ["asd@asd.de", ...] }
|
| Antwort Codes |
200 - OK 401 - Unauthorized |
| Beschreibung | Erlaubt es dem Ersteller oder Käufer eines Meetings, eine Nachricht an alle Teilnehmer des Meetings zu versenden. Aktuell geschieht dies ausschließlich per Mail. |
| Methode | POST |
| Endpunkt | /meetings/{meetingID}/do/notify |
| Sicherheitsregel | Nur Ersteller und Käufer eines Meetings |
| Request Body | {
"topic": "",
"shortText": "", // Optional
"longText": ""
}
|
| Antwort Codes |
200 - OK 401 - Unauthorized 500 - Fehler beim versenden der Mail |