getUserChars

特定のフィールドで使用されている文字のリストを取得します。

構文

認証済みユーザータイプ

IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin

パラメータ

入力 (getUserCharsParam)

名前	種類	必須	説明
charField	`xsd:string`	はい	検索するごみ箱の状態を決定します。
includeInactive	`xsd:boolean`	はい	非アクティブなユーザーを含めるか除外します。 IPS 管理者以外のユーザーは、API 呼び出しをおこなう権限を持つ 1 つ以上の会社のアクティブなメンバーである必要があります。ユーザーがアクティブな会社メンバーシップを持っていない場合、認証エラーが返されます。
includInvalid	`xsd:boolean`	いいえ	無効なユーザーを含めるか除外します。
companyHandleArray	`types:HandleArray`	いいえ	会社に基づいて結果をフィルタリングします。
groupHandleArray	`types:HandleArray`	いいえ	グループに基づいて結果をフィルタリングします。
userRoleArray	`types:StringArray`	いいえ	ユーザーの役割に基づいて結果をフィルタリングします。
numChars	`xsd:int`	いいえ	1 文字以上を有効にします。

出力 (getUserCharsReturn)

名前	種類	必須	説明
userCharsArray	`types:StringArray`	はい	文字プレフィックスの配列。

例

このコードサンプルは、次の値を返します。

特定の会社のユーザーの姓の名の最初の文字。
グループのセット。
一連のユーザーの役割。

User Char Filter Fields 文字列定数は、返されるユーザー文字の種類を決定します。

リクエスト

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