checkLogin

Prüft, ob sich ein Benutzer mit einem bestimmten Unternehmen (identifiziert durch Handle), einer E-Mail-Adresse und einem Kennwort anmelden kann.

HINWEIS

Wenn das Handle des Unternehmens weggelassen wird, überprüft diese Methode die Anmeldung des Standardbenutzers.

Autorisierte Benutzertypen

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameter

Eingabe (checkLoginParam)

Name Typ Erforderlich Beschreibung
companyHandle xsd:string Nein Der Handle für das Unternehmen, das den Benutzer enthält.
E-Mail xsd:string Ja Die E-Mail-Adresse des Benutzers.
Passwort xsd:string Ja Das Kennwort des Benutzers.

Ausgabe (checkLoginParam)

Name Typ Erforderlich Beschreibung
status xsd:string Ja Anmeldestatus des Benutzers.

Beispiele

Dieser Beispielcode verwendet einen Unternehmens-Handle-Parameter, eine E-Mail-Adresse und ein Kennwort, um zu bestimmen, ob sich ein Benutzer bei IPS anmelden kann. Wenn der Benutzer can anmelden, gibt diese Methode die Zeichenfolge zurück, ValidLogin. Wenn der Benutzer cannot anmelden, gibt diese Methode die Zeichenfolge zurück, InvalidLogin.

Anforderung

<ns1:checkLoginParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>137</ns1:companyHandle>
   <ns1:email>juser3@scene7.com</ns1:email>
   <ns1:password>welcome</ns1:password>
</ns1:checkLoginParam>

Antwort

<ns1:checkLoginReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:status>InvalidLogin</ns1:status>
</ns1:checkLoginReturn>

Auf dieser Seite