Show Menu
TOPICS×

getCompanyMembership

Gets a user’s memberships in a company array.
Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (getCompanyMembershipParam)
Name
Type
Required
Description
* userHandle *
xsd:string
No
The handle to the user whose memberships you want to obtain.
Output (getCompanyMembershipReturn)
Name
Type
Required
Description
* membershipArray *
types:CompanyMembershipArray
Yes
Array of company memberships.

Examples

This code sample takes a user handle and gets all the user’s company memberships in an array. The response has been truncated for brevity.
Request
<ns1:getCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>70|kmagnusson@adobe.com</ns1:userHandle>
</ns1:getCompanyMembershipParam>

Response
<getCompanyMembershipReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <membershipArray>
      <items>
         <companyHandle>48</companyHandle>
         <name>AIR</name>
         <rootPath>AIR/</rootPath>
         <expires>2101-01-31T23:00:00.485-08:00</expires>
      </items>
      ...
    </membershipArray>
</getCompanyMembershipReturn>