getUserChars

특정 필드에 사용되는 문자 목록을 가져옵니다.

구문

인증된 사용자 유형

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

매개 변수

입력(getUserCharsParam)

이름 유형 필수 설명
*charField* xsd:string 검색할 휴지통 상태를 결정합니다.
*inactive* 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>

이 페이지에서는