DocumentaçãoAPI do sistema de produção de imagens Dynamic Media

getUserChars getuserchars

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

Criado para:

  • Desenvolvedor
  • Administrador

Obtém uma lista dos caracteres usados em um determinado campo.

Sintaxe

Tipos de usuário autorizados section-7023871be4d2442daf51ff060ca06d9a

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parâmetros section-93107d87f1b24fc8ad276dfee5e30b63

Entrada (getUserCharsParam)

Nome
Tipo
Obrigatório
Descrição
charField
xsd:string
Sim
Determina o estado da lixeira a ser pesquisado.
includeInative
xsd:boolean
Sim
Incluir ou excluir usuários inativos. Os usuários não administradores de IPS devem ser membros ativos de pelo menos uma empresa para serem autorizados a fazer chamadas de API. Uma falha de autorização é retornada se o usuário não tiver associações ativas da empresa.
includeInvalid
xsd:boolean
Não
Incluir ou excluir usuários inválidos.
companyHandleArray
types:HandleArray
Não
Filtrar resultados com base na empresa.
groupHandleArray
types:HandleArray
Não
Filtra resultados com base em grupos.
userRoleArray
types:StringArray
Não
Filtra resultados com base na função do usuário.
numChars
xsd:int
Não
Habilite mais de 1 caractere.

Saída (getUserCharsReturn)

Nome
Tipo
Obrigatório
Descrição
userCharsArray
types:StringArray
Sim
Uma matriz de prefixos de caracteres.

Exemplos section-3702f165e8b041139a6144f4a76ca25f

Esta amostra de código retorna:

  • Primeiro caractere dos sobrenomes dos usuários de uma empresa específica.
  • Um conjunto de grupos.
  • Um conjunto de funções de usuário.

A constante da string de Campos de filtro de caractere do usuário determina o tipo de caracteres do usuário retornados.

Solicitação

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

Resposta

<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