Response
Bei einem Aufruf mit fehlerhaftem ApiKey oder dem Aufruf von einer IP, die nicht über die IP Filter freigegeben ist, erhalten Sie einen HTTP 401 (unauthorized) zurück.
Im Falle von falschen Parametern, z.B. einem ungültigen command erhalten sie einen HTTP 200 mit entsprechender Fehlermeldung zurück:
{
"error": true,
"message": {
"command": [
"The selected command is invalid."
]
}
}
Im Erfolgsfall wird Response als JSON übergeben und hat folgendes Format:
{
"error": false,
"meta": {
"changesUntil": <im POST Reqeust übergebener Parameter für changesUntil>,
"available": <Gesamtzahl der Gäste, die zur Verfügung stehen - berücksichtig changesUntil>,
"limit": <Das aktuelle Limit - entweder aus dem POST Requeest oder der default Wert>,
"offset": <Der aktuelle Offset - entweder aus dem POST Reqeust oder 0>
},
"event": {
.... Definierte Felder der Veranstaltung, z.B. Name, Datum, ....
},
"guests": [
{
.... Definierte Werte eines Gastes, z.B. E-Mail Adresse, Firma, Vorname, ....
"id": <Immer vorhanden: GATEWatch interne ID des Gastes>,
"created": <Immer vorhanden: Datum der Erstellung des Gast-Datensatzes>,
"updated": <Immer vorhanden: Datum der letzten Änderung>,
"deleted": <Immer vorhanden: true/false als Info, ob der Gast geschlöscht wurde>
},
....
]
}