DokumentationDynamic Media Image Production System API

checkLogin checklogin

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Kontrollerar om en användare med ett visst företag (identifieras av referens), e-postadress och lösenord kan logga in.

NOTE
Om företagsreferensen utelämnas kontrollerar den här metoden standardanvändarens inloggning.

Auktoriserade användartyper section-df8b26b550854f899948276adaca083a

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

Parametrar section-1ad4c0b4803b4388aedd655030676cb3

Indata (checkLoginParam)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:string
Nej
Referensen till företaget som innehåller användaren.
e-post
xsd:string
Ja
Användarens e-postadress.
lösenord
xsd:string
Ja
Användarens lösenord.

Utdata (checkLoginParam)

Namn
Typ
Obligatoriskt
Beskrivning
status
xsd:string
Ja
Användarens inloggningsstatus.

Exempel section-23f90100a9d94bc7b4045634cccd1b98

I den här exempelkoden används en företagshanteringsparameter, e-postadress och ett lösenord för att avgöra om en användare kan logga in på IPS. Om användaren kan logga in returnerar metoden strängen ValidLogin. Om användaren inte kan logga in returnerar metoden strängen InvalidLogin.

Begäran

<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>

Svar

<ns1:checkLoginReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:status>InvalidLogin</ns1:status>
</ns1:checkLoginReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681