TAuthentication
Dieser Web Service führt die Authentifizierung durch. Das Ändern oder setzen der Adresse sowie die Abo-Funktionen werden von den Services GP.asmx und Abo.asmx übernommen. --- This webservice is for authentification. The functions for changing address-data or subscribtion-data are implemented in the services GP.asmx and Abo.asmx.
Folgende Vorgänge werden unterstützt. Eine ausführliche Definition finden Sie in der Dienstbeschreibung.
-
AnswerQuestion
Diese Funktion dient zum beantworten der Sicherheitsfrage für vergessliche Nutzer. Sie löst das generieren eines neuen Passworts aus, und versendet es an die in der Datenbank gepseicherte E-Mail-Adresse. Als Rückgabewert wird lediglich über Erfolg oder Mißerfolg Auskunft gegeben. Eingeloggt ist der Nutzer nicht. --- This function is for replying to the security question. It generates a new password which will send to the stored email-address. -
ChangeEmail
Diese Funktion dient zum ändern der Email-Adresse für den Userlogin. Es ist vorgesehen, dass auf der Web-Seite der Nutzer auch seine alte Maildadresse nochmal eingeben muss und dieser Wert dann hier als Oldemail übergeben wird. Als Rückgabewert wird ein Enumerationswert zurückgegeben, der Auskunft über Erfolg oder Mißerfolg gibt. --- This method is for changing the email-adress. -
ChangeLanguage
Diese Funktion ändert die Sprache des Benutzers. Die Sprache ist im 2-stelligen ISO-Format anzugeben. --- This function changes the language of the user. The language is to be indicated in the ISO format with two digits. -
ChangeNickName
Diese Funktion dient zum Ändern des Nickname. --- This function is for changing the nickname. -
ChangePassword
Diese Funktion dient zum ändern des Passworts. Es ist vorgesehen, dass auf der Web-Seite der Nutzer auch sein altes Passwort nochmal eingeben muss und dieser Wert dann hier als OldPw übergeben wird. Als Rückgabewert wird ein Enumerationswert zurückgegeben, der Auskunft über Erfolg oder Mißerfolg gibt. --- This method is for changing a password. -
ChangeUsername
Diese Funktion dient zum ändern des Usernamens. Die Funktion ist notwendig, wenn die auf dem Service aufsetzenden Webanwendungen die Email-Adresse als Usernamen verwenden und diese sich ändert. Als Rückgabewert wird ein Enumerationswert zurückgegeben, der Auskunft über Erfolg oder Mißerfolg gibt. --- This method is for changing the username. -
CheckEmail
Diese Funktion überprüft, ob eine E-Mail-Adresse bereits vergeben wurde oder nicht. Der Username ist nur notwendig um den Status der EMail-Adresse genauer zurückgeben zu können. Bei vergebener EMail und passenden Username wird beispielsweise rcUsedWithUser zurückgegeben. Ansonsten wird rcUsed zurückgegeben. --- This function examines whether a E-Mail address was already assigned or not. The username only necessary to return the status of the user more exactly. -
CheckRefNoPair
Diese Funktion dient dazu 2 Referenznummern gegeneinander zu prüfen. Die Imlpementierung dieser Funktion ist für die Mandanten unterschiedlich und geschieht nach dessen Vorgaben. --- This function validates 2 reference numbers. It works different for each client depending on the requirements. -
CheckReferencePair
Diese Funktion wird nicht mehr unterstützt. --- This function is no longer supported. -
CheckSubscriptionUsername
Diese Funktion dient dazu 2 Referenznummern gegeneinander zu prüfen. Die Imlpementierung dieser Funktion ist für die Mandanten unterschiedlich und geschieht nach dessen Vorgaben. --- This function validates 2 reference numbers. It works different for each client depending on the requirements. -
CheckUsername
Diese Funktion dient zur Erstanmeldung. Sie überprüft, ob ein Username bereits vergeben wurde oder nicht. Das Passwort ist nur notwendig um den Status des Users genauer zurückgeben zu können. Bei vergebenen Usernamen passendem Passwort wird beispielsweise rcAlreadyDone zurückgegeben. Ansonsten wird rcUsed zurückgegeben. --- This method is necessary for the registration of new users. It is to be used to check if a user name is already used. -
FmChangePersonalData
Diese Funktion dient zum Ändern der persönlichen Daten eines bestehenden VollNutzers. --- This is a special function for 'www.fachmedien.net'. -
GenerateAndSendPassword
Beim Aufruf dieser Funktion bekommt der Nutzer ein neues, automatisch generiertes Passwort zugeschickt. --- Calling this funcion, the user gets a new automaticly generated password via mail. -
GetAuthentDetails
Diese Funktion liefert die für die Authentifizierung nötigen Daten eines eingeloggten Nutzers, um ein Authentifizierungsticket erstellen zu können. --- This function can be used to test the login status. -
GetEmailAddress
Hiermit kann eine E-Mail-Adresse erfragt werden. Der Wert wird in der Klasse StringWebDetails gekapselt, um im Fehlerfall über den Returncode den Grund angeben zu können. --- Hereby a E-Mail address can be inquired. The value is enclosed in the class 'stringWebdetails'. -
GetNickname
Diese Funktion dient zum Holen des Nickname. --- This function retrieves the nickname. -
GetQuestion
Diese Funktion dient zum Holen der Sicherheitsfrage für vergessliche Nutzer. --- This function serves the safety question for forgetful users. -
GetRoles
Diese Funktion gibt die Rollen des Nutzers in Form eines String-Arrays zurück. --- This method returns the roles (the rigths) of a user as an array of string -
GetRolesByReference
Diese Funktion gibt die Rollen des Nutzers in Form eines String-Arrays zurück. --- This method returns the roles (the rigths) of a user as an array of string -
GetVerificationCode
Diese Methode dient zur Erstanmeldung und versendet einen Freischaltkode an die angegebene E-Mail-Adresse mit der der User registriert werden kann. Die Sprache hat das 2-stellige ISO-Code-Format und ist die Sprache mit der der User zukünftig angesprochen wird. Sie kann später mit ChangeSprache geändert werden. Der Username, Passwort und EMail sind zwingend. Frage und Antwort definieren dem vergesslichen User die Frage und die passende Antwort, falls er das Passwort nicht weiss. Die IP-Adresse im IP4-Format dient zum erkennen von DoS-Attacken. Die Referenznummer muss nur angegeben werden, wenn der Nutzer bereits in der Datenbank bekannt sein muss. Der Rückgabewert ist eine Enumeration, die den Erfolg oder Mißerfolg mitteilt. --- This method serves for the registration of new users and sends a registration code to the indicated email address. The language has the ISO code format with two digits and is the language with that the user is addressed in the future. The reference number must be only indicated, if the user already known in the data base. The return value is an enumeration, which communicates success or failure. -
HasRole
Diese Funktion gibt true zurück, wenn der User die angefragte Rolle hat. --- When the user-roles contains the requested role this function returns true. -
Login
Dies ist die einfache Login-Funktion. Außer User und Passwort muss auch die Sprache, der Mandant und die IP-Adresse im IP4-Format zur Erkennung von DoS-Attacken mitegeben werden. Als weiterer Parameter wurde der appcode hinzugefügt. Hier kann optional ein bis zu acht stelliger Kode übergeben werdend er zu statistischen Zwecken mit geloggt wird. Der Rückgabewert ist eine Klasse, die zwei Ids: Wid und WidHash enthält. Diese zwei Ids müssen bei jedem Aufruf der Web-Services mitgegeben werden, die eine Authentifizierung voraussezten. Außerdem enthält die Klasse die Sprache im ISO-Code-Format wie sie in der Datenbank steht, eine eindeutige Referenznummer, über die der Kunde identifiziert wird und einen Enumerationswert, der über Erfolg oder Misserfolg Auskunft gibt. --- This is the simple login function. Except user and password also the language, the client and the IP address in the IP4-Format must be given. The parameter appcode was added as an optional parameter. It must have max. 8 characters and will be logged for statistical purposes.The return value is a class which contains two Ids: Wid and WidHash. These two Ids must be given with each call of the Web services, which presuppose a authentification. In addition the class contains the language in the ISO code format like it is in the data base, a clear reference number, over those the customer is identified and a enumeration value, which gives information about success or failure. -
Logout
Da für jeden User eine Session bereit gehalten wird, wäre ein Logout ganz nett. --- It would be nice if every session is closed with an logout. -
RegisterNewUser
Diese Funktion dient zum Registrieren des Nutzers bei der Erstanmeldung. Wenn der Freischaltkode über getFreischaltkode bezogen wurde, kann auf die Angaben von Frage und Antwort verzichtet werden. --- This function is to be used for the registration of new users. -
RegisterUser
Diese Funktion dient zum abschließenden Registrieren des Nutzers bei der Erstanmeldung. Wenn der Freischaltkode über getFreischaltkode bezogen wurde, kann auf die Angaben von Frage und Antwort verzichtet werden. --- This function is to be used for the registration of new users. -
ResendVerificationCode
Diese Funktion dient zum erneuten Senden der Bestaetigungsemail, falls der Nutzer bei der urprünglichen Registrierung die falsche E-Mail-Adresse angegeben hat. Diese Funktion ist nur auf teilregistrierte User anwendbar. --- This function serves for renewed sending of the confirmation email, if the user indicated the wrong E-Mail address for the first registration. This function is applicable only to part-registered user. -
SendMessage
Diese Funktion hat nichts direkt mit der Authentifizierung zu tun. Da aber zum versenden der Nachricht der Nutzer nicht authentifiziert sein muss, ist die Funktion in diesem Web-Service lokalisiert. Die Felder sind bis auf BetreffTyp und BetreffValue frei editierbar. Der Betrefftyp sollte 'Betreff' enthalten, wenn der BetreffValue etwas anderes als eine Referenznummer sein soll. Der boolsche Rückgabewert zeigt den Emppfang der Meldung an. --- This function does not have to do anything directly with the authentification. It should be used for sending messages to the customer service. -
SetViewAsSubscriberRole
Dies ist eine Spezialfunktion, die lediglich für das Handling mit Abonennten und Beziehen benötigt wird. --- This is a special function, which is only needed for the handling with subscribers and purchasors. -
ValidateSession
Diese Funktion dient zum Abfragen, ob Session noch in Liste ist. --- This method is to validate a session. -
ValidateVerificationCode
Diese Funktion dient zum Verifizieren über den Freischaltkode. --- This function is to be used for validating the registration code.