Übersicht der Sitzungsfunktionen
Login und gleichzeitigem Starten einer neuen Sitzung
Method Details
HTTP Method: POST
Method URI: API/Login
Response Format: JSON
Erforderlich: WAHR
Example POST URL:
http://localhost/CustomXApp/Api/Login
Example POST body:
{
"username": "Max",
"password": "geheim"
}
Example response:
c009f9dc
Error response:
null
Erforderliche Parameter
Parameter | Beschreibung |
username | customX Benutzername. Dieser Benutzer mus in der Konto-Verwaltung von customX bekannt sein. In Abhängigkeit des Regelwerks reicht es aus, ein Konto für den Aufruf anzulegen. Abfragen, Aussehen, usw. werden in der Regel durch Rollenparameter gesteuert. |
password | Passwort des customX Benutzerkontos. |
Antwortdetails
Die Antwort enthält entweder die ID der neu angelegten Sitzung oder null im Falle eines Fehlschlags.
Logout mit Beenden der Session
Method Details
HTTP Method: POST
Method URI: API/Logout
Response Format: JSON
Erforderlich: WAHR
Example POST URL:
http://localhost/CustomXApp/Api/Logout
Example POST body:
{
"sessionid": "c009f9dc"
}
Example response:
true
Erforderliche Parameter
Parameter | Beschreibung |
sessionid | ID einer aktiven Session |
Antwortdetails
Die Antwort lautet true für ein einfolgreiches Abmelden und false für einen Fehlschlag.