12 Funktionen für den Webuser
aoRestServer/ODATA für ABES/Objects - Hinweise für Frontend-Entwickler
Für die Anmeldung als Webuser steht der aus der ABES/Objects-COM-Server Dokumentation bekannte Satz an Funktionen bereit.
Diese werden hier im Einzelnen für ihre Verwendung in der OData-Schnittstelle erläutert.
Für das Ausführen aller Webuser-Funktionen muß ein gültiges Authentifizierungs-Token des Servers im Request mitgegeben werden.
- Funktion WebuserLogin
- Funktion WebuserLogout
- Funktion WebuserRegister
- Funktion WebuserSetPassword
- Funktion WebuserReset
- Funktion Webuser
Diese Funktion dient der Anmeldung eines Webusers.
|
Parametername
|
Parametertyp
|
|
Username
|
string
|
|
Password
|
string
|
Aufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/WebuserLogin(
Username=’abc’,
Password=’def’)
|
Erfolg:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Edm.String”,
“value”: “success”
}
|
Diese Funktion dient dem expliziten Abmelden eines Webusers.
|
Parametername
|
Parametertyp
|
|
—
|
—
|
Aufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/WebuserLogout()
|
Erfolg:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”,
“value”: true
}
|
Diese Funktion dient dem erstmaligen Registrieren eines Webusers.
Es ist darauf zu achten, dass der Registrierungskey korrekt URL-enkodiert wird.
|
Parametername
|
Parametertyp
|
|
RegKey
|
string
|
|
Username
|
string
|
|
Password
|
string
|
Aufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/WebuserRegister(
RegKey=’12abcd’,
Username=’abc’
Password=’def’)
|
Erfolg:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Edm.String”,
“value”: “success”
}
|
Diese Funktion dient dem Ändern des Passwortes eines Webusers.
|
Parametername
|
Parametertyp
|
|
Password
|
string
|
Aufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/WebuserRegister(Password=’def’)
|
Erfolg:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”,
“value”: true
}
|
Diese Funktion dient dem Rücksetzen des Registrations-Schlüssels für einen Webuser.
|
Parametername
|
Parametertyp
|
|
—
|
—
|
Aufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/WebuserReset()
|
Erfolg:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Edm.Boolean”,
“value”: true
}
|
Die Funktion Webuser liefert den Zugriff auf das aktuelle Personen-Objekt. Es kann in einer URL syntaktisch wie ein Personen-Objekt-Zugriff benutzt werden.
|
Parametername
|
Parametertyp
|
|
—
|
—
|
Beispielaufruf:
|
Request
|
|
GET
|
http://test.server.de/odata/Webuser()?$select=Name,Ort
|
Rückgabe:
|
Response (Status=200)
|
|
{
“@odata.context”: “http://test.server.de/odata/$metadata#Person/$entity”,
“_OID”: “477167524F722B793545453746634932716D50793446”,
“Name”: “Bottke”,
“Ort”: null
}
|
Die Bildschirmfotos können in aktuellen Programmversionen visuell abweichen.
Sie haben Fragen oder Anregungen? Schreiben Sie uns gerne an support@rackow-software.de
