DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

getUserChars getuserchars

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

Creado para:

  • Desarrollador
  • Administrador

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

Sintaxis

Tipos de usuarios autorizados section-7023871be4d2442daf51ff060ca06d9a

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parámetros section-93107d87f1b24fc8ad276dfee5e30b63

Entrada (getUserCharsParam)

Nombre
Tipo
Obligatorio
Descripción
charField
xsd:string
Sí
Determina el estado de la papelera que se va a buscar.
includeInactive
xsd:boolean
Sí
Incluir o excluir usuarios inactivos. Los usuarios que no son administradores de IPS deben ser miembros activos de al menos una compañía para poder realizar llamadas de API. Se devuelve un error de autorización si el usuario no tiene ninguna pertenencia activa a la compañía.
includeInvalid
xsd:boolean
No
Incluya o excluya usuarios no válidos.
companyHandleArray
types:HandleArray
No
Filtrar 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
Habilite >1 carácter.

Salida (getUserCharsReturn)

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

Ejemplos section-3702f165e8b041139a6144f4a76ca25f

Este ejemplo de código devuelve:

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

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

Solicitud

<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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681