文档Dynamic Media Image Production System API

getUserChars

最近更新： 2024年7月20日
  • 主题：

创建对象：

  • 开发人员
  • 管理员

获取特定字段中使用的字符列表。

语法

授权用户类型

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

参数

输入(getUserCharsParam)

名称
类型
必需
说明
charField
xsd:string
是
确定要搜索的垃圾桶状态。
includeInactive
xsd:boolean
是
包含或排除不活动的用户。 非IPS管理员用户必须是至少一个公司的活跃成员，才能获得发出任何API调用的授权。 如果用户没有活动的公司成员资格，则会返回授权错误。
includInvalid
xsd:boolean
否
包含或排除无效用户。
companyHandleArray
types:HandleArray
否
根据公司筛选结果。
groupHandleArray
types:HandleArray
否
根据组筛选结果。
userRoleArray
types:StringArray
否
根据用户角色筛选结果。
numChars
xsd:int
否
启用>1个字符。

输出(getUserCharsReturn)

名称
类型
必需
说明
userCharsArray
types:StringArray
是
字符前缀的数组。

示例

此代码示例返回：

  • 特定公司用户的姓氏的第一个字符。
  • 一组组。
  • 一组用户角色。

“用户字符过滤字段”字符串常量确定返回的用户字符类型。

请求

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

响应

<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