getUserChars

Ottiene un elenco dei caratteri utilizzati in un campo specifico.

Sintassi

Tipi di utenti autorizzati

IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin

Parametri

Input (getUserCharsParam)

Nome	Tipo	Obbligatorio	Descrizione
charField	`xsd:string`	Sì	Determina lo stato del cestino da cercare.
includeInactive	`xsd:boolean`	Sì	Includi o escludi gli utenti inattivi. Gli utenti amministratori non IPS devono essere membri attivi di almeno una società per essere autorizzati a effettuare chiamate API. Viene restituito un errore di autorizzazione se l’utente non dispone di appartenenze attive alla società.
includInvalid	`xsd:boolean`	No	Includere o escludere utenti non validi.
companyHandleArray	`types:HandleArray`	No	Filtrare i risultati in base all’azienda.
groupHandleArray	`types:HandleArray`	No	Filtra i risultati in base ai gruppi.
userRoleArray	`types:StringArray`	No	Filtra i risultati in base al ruolo dell’utente.
numChars	`xsd:int`	No	Abilita >1 carattere.

Output (getUserCharsReturn)

Nome	Tipo	Obbligatorio	Descrizione
userCharsArray	`types:StringArray`	Sì	Matrice di prefissi di caratteri.

Esempi

Questo esempio di codice restituisce:

Primi caratteri dei cognomi degli utenti di una specifica azienda.
Un insieme di gruppi.
Un insieme di ruoli utente.

La costante della stringa Campi filtro caratteri utente determina il tipo di caratteri utente restituiti.

Request Contents (Richiesta contenuto)

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

Risposta

<getUserCharsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <userCharsArray>
      <items>b</items>
      <items>c</items>
      <items>d</items>
   </userCharsArray>
</getUserCharsReturn>