Gets a list of the characters used in a particular field.
Syntax
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin
Input (getUserCharsParam)
Name | Type | Required | Description |
---|---|---|---|
* charField* |
xsd:string |
Yes | Determines the Trash State to search for. |
* includeInactive* |
xsd:boolean |
Yes | Include or exclude inactive users. Non-IPS Admin users must be an active member of at least one company to be authorized to make any API calls. An authorization fault will be returned if the user has no active company memberships. |
* includInvalid* |
xsd:boolean |
No | Include or exclude invalid users. |
* companyHandleArray* |
types:HandleArray |
No | Filter results based on company. |
* groupHandleArray* |
types:HandleArray |
No | Filters results based on groups. |
* userRoleArray* |
types:StringArray |
No | Filters results based on user role. |
* numChars* |
xsd:int |
No | Enable >1 character. |
Output (getUserCharsReturn)
Name | Type | Required | Description |
---|---|---|---|
* userCharsArray* |
types:StringArray |
Yes | An array of character prefixes. |
This code sample returns:
The User Char Filter Fields string constant determines the type of user characters returned.
Request
<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>
Response
<getUserCharsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<userCharsArray>
<items>b</items>
<items>c</items>
<items>d</items>
</userCharsArray>
</getUserCharsReturn>