getUserChars

Obtiene una lista de los caracteres utilizados en un campo concreto.

Sintaxis

Tipos de usuarios autorizados

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parámetros

Entrada (getUserCharsParam)

Nombre Tipo Obligatorio Descripción
charField xsd:string Determina el estado de la Papelera que se va a buscar.
includeInactive xsd:boolean Incluir o excluir usuarios inactivos. Los usuarios administradores que no sean de IPS deben ser miembros activos de al menos una empresa para poder realizar llamadas de API. Se devuelve un error de autorización si el usuario no tiene membresías activas de la empresa.
includeInvalid xsd:boolean No Incluir o excluir usuarios no válidos.
companyHandleArray types:HandleArray No Filtre los resultados según la empresa.
groupHandleArray types:HandleArray No Filtra los resultados según los grupos.
userRoleArray types:StringArray No Filtra los resultados según la función del usuario.
numChars xsd:int No Activar >1 carácter.

Salida (getUserCharsReturn)

Nombre Tipo Obligatorio Descripción
userCharsArray types:StringArray Matriz de prefijos de caracteres.

Ejemplos

Este ejemplo de código devuelve:

  • Primeros caracteres de los apellidos de los usuarios de una empresa específica.
  • Conjunto de grupos.
  • Conjunto de funciones de usuario.

La constante de cadena Campos de filtro de caracteres del usuario determina el tipo de caracteres de usuario devueltos.

Solicitar

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

Respuesta

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

En esta página