DocumentationDynamic Media Image Production System API

getImageSetMembers

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Gets an array of members that are in an image set.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Requires read access to the image and member set asset.

Parameters

Input (getImageSetMembersParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company that contains the image set.
assetHandle
xsd:string
Yes
The image set asset handle.

Output (getImageSetMembersReturn)

Name
Type
Required
Description
memberArray
types:ImageSetMemberArray
No
Array of image set members.

Examples

This code sample returns specific image set members. The response returns an empty array.

Request

<ns1:getImageSetMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:assetHandle>34195|22|927</ns1:assetHandle>
</ns1:getImageSetMembersParam>

Response

<getImageSetMembersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <memberArray></memberArray>
</getImageSetMembersReturn>
4e9b9d8c-5839-4215-aa35-01b652869681