getUserChars

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

Syntax

Autorisierte Benutzertypen

IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin

Parameter

Eingabe (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 basierend auf Gruppen.
userRoleArray	`types:StringArray`	Nein	Filtert Ergebnisse basierend auf der Benutzerrolle.
numChars	`xsd:int`	Nein	Aktivieren Sie >1 Zeichen.

Ausgabe (getUserCharsReturn)

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

Beispiele

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.

Anforderung

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