UserContent REST API : Status Updates

Mon. 8. June 2020 13:36 Uhr

Authentifizierung/Request Headers

Die Authentifizierung erfolgt mit einem vorgängig kommunizierten API Key, der im Request Header wie folgt mitzuliefern ist:

X-Api-Key: {client_api_key_here}

Zusätzlich muss der Content-Type auf Application/json gesetzt werden:

 Content-Type: Application/json

URL/Request

Mit einem PUT Request auf folgende URL kann der Status eines Objekts geändert werden:

https://www.mopage.ch/api/v1/usercontent/updatestate/{id}

{id} stellt dabei die ID des Objekts auf dem moPage Server dar.

PUT Data (JSON)

Im Body des Requests werden die entsprechenden Werte geliefert (JSON):

{
 "status": 8,
 "comment": "Meldung scheint in falscher Rubrik",
 "statustext": "Die Meldung wurde erfolgreich bearbeitet - besten Dank..."
}

Feld	Beschreibung/Werte
status	2 = aufgenommen 3 = weitergeleitet DS Anfrage wurde an zuständige Fachstelle weitergeleitet (initialer Status) 4 = DS in Bearbeitung Fachstelle nimmt Anfrage zur Bearbeitung auf 5 = DS abgelehnt Fachstelle lehnt Anfrage ab 6 = DS erledigt Fachstelle hat Anfrage erledigt 8 = DS zurückgewiesen Fachstelle weist Anfrage zurück
comment	optionaler Kommentar bei Rückweisung (für internen Gebrauch)
statustext	optionaler Text, der, wenn gesetzt, an die Abonnenten der Meldung geschickt wird (Mail/Push) UND auf der Meldung selbst sichtbar ist

Ist der neu gelieferte Status <> alter Status im System, wird, sofern für den neuen Status eine Benachrichtigung vorgesehen ist (Modulkonfiguration), eine Benachrichtigung an alle Abonnenten der Meldung ausgelöst (Push/Mail)

Response

Status	Text	Beschreibung
200	OK	- Status change has been applied. - No status change applied (object already had that status).
400	Bad Request	Statuscode is not in expected range
401	Unauthorized	No permission with provided key.