Corvus Hilfe > Api > Yuna > Aktion

Aktion

Neben den Key wird weiterhin zwingend eine Aktion benötigt. Ohne die Aktion wüsste die Api auch nicht genau was zu tun wäre.

Fehlt die Aktion, oder ist die Aktion nicht vorhanden, z.B. ein Tippfehler, dann bekommt man eine freundliche Fehlermeldung, dass es diese Aktion nicht gibt.

Action

Die Action ist, im Gegensatz zu den anderen Daten, kein Block, sondern ein einfacher String.

Das sieht in etwa so aus:

{
    "action": "Die Action kommt hier rein"
}

Datenfelder

Name	Typ	Default	Beschreibung
`.action`	String	-	Die Aktion die ausgeführt werden soll

Eigenarten

Jede Aktion kann verschiedene Parameter besitzen. Die hier alle aufzuzählen ist relativ nutzlos. Daher sind alle möglichen Aktionen im Menü aufgelistet, und dort wird genau beschrieben, welche Parameter es geben könnte und wie man sie verwendet.

Beispiele

Fehlende Aktion

Gesendet:

{
    "auth": {
        "key": "123...xyz"
    }
}

Empfangen:

{
    "requestStatus": {
        "isError": true,
        "errorMessage": "Unknown action"
    }
}

Unbekannte Aktion

Gesendet:

{
	"auth": {
		"key": "123...xyz"
	},
	"action": "Irgendwas"
}

Empfangen:

{
	"action": "Irgendwas",
	"requestStatus": {
		"isError": true,
		"errorMessage": "Unknown action"
	}
}

Erfolgreiche Test Aktion

Wobei unklar ist, ob diese Aktion später noch existieren wird …

Gesendet:

{
	"auth": {
		"key": "123...xyz"
	},
	"action": "test"
}

Empfangen:

{
	"action": "test"
}