DokumentationDynamic Media Image Production System-API

getUserChars getuserchars

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Ruft eine Liste der in einem bestimmten Feld verwendeten Zeichen ab.

Syntax

Autorisierte Benutzertypen section-7023871be4d2442daf51ff060ca06d9a

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameter section-93107d87f1b24fc8ad276dfee5e30b63

Input (getUserCharsParam)

Name
Typ
Erforderlich
Beschreibung
charField
xsd:string
Ja
Bestimmt den Papierkorbsstatus, nach dem gesucht werden soll.
includeInactive
xsd:boolean
Ja
Inaktive Benutzer ein- oder ausschließen. Benutzer, die keine IPS-Administratoren sind, müssen aktives Mitglied von mindestens einem Unternehmen sein, damit sie API-Aufrufe durchführen können. Ein Autorisierungsfehler wird zurückgegeben, wenn der Benutzer keine aktiven Unternehmensmitgliedschaften hat.
includeInvalid
xsd:boolean
Nein
Ungültige Benutzer ein- oder ausschließen.
companyHandleArray
types:HandleArray
Nein
Filtern Sie die Ergebnisse nach Unternehmen.
groupHandleArray
types:HandleArray
Nein
Filtert Ergebnisse anhand von Gruppen.
userRoleArray
types:StringArray
Nein
Filtert Ergebnisse basierend auf der Benutzerrolle.
numChars
xsd:int
Nein
Aktivieren Sie >1 Zeichen.

Output (getUserCharsReturn)

Name
Typ
Erforderlich
Beschreibung
userCharsArray
types:StringArray
Ja
Ein Array von Zeichenpräfixen.

Beispiele section-3702f165e8b041139a6144f4a76ca25f

Dieses Codebeispiel gibt zurück:

  • Die ersten Zeichen der Nachnamen der Benutzer eines bestimmten Unternehmens.
  • Eine Gruppe von Gruppen.
  • Eine Reihe von Benutzerrollen.

Die String-Konstante Benutzerzeichenfilter Felder bestimmt den Typ der zurückgegebenen Benutzerzeichen.

Anfrage

<ns1:getUserCharsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:charField>LastName</ns1:charField>
   <ns1:includeInvalid>false</ns1:includeInvalid>
   <ns1:companyHandleArray>
      <ns1:items>47</ns1:items>
   </ns1:companyHandleArray>
</ns1:getUserCharsParam>

Antwort

<getUserCharsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <userCharsArray>
      <items>b</items>
      <items>c</items>
      <items>d</items>
   </userCharsArray>
</getUserCharsReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681