DocumentationDynamic Media Image Production System API

setImageMaps

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

CREATED FOR:

  • Developer
  • Admin

Sets the image map for an asset.

You must have already created the image maps. Image maps are applied in order of retrieval from the array. This means the second image map overlays the first, the third overlays the second, and so on.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (setImageMapsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Company handle.
assetHandle
xsd:string
Yes
Asset handle.
imageMapArray
types:ImageMapDefinitionArray
Yes
Array of predefined image maps.

Output (setImageMapsReturn)

Name
Type
Required
Description
imageMapHandleArray
types:HandleArray
Yes
An array with image map handles applied to the asset.

Examples

This code sample sets 2 image maps for an image asset. The code specifies shape type, region, and action taken when the image maps are invoked. The response contains an array with handles to the image maps.

Request

<setImageMapsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <assetHandle>a|739|1|537</assetHandle>
   <imageMapArray>
      <items>
         <name>ImageMap2</name>
         <shapeType>Rectangle</shapeType>
         <region>40</region>
         <action>400</action>
         <enabled>true</enabled>
      </items>
      <items>
         <name>ImageMap3</name>
         <shapeType>Rectangle</shapeType>
         <region>40</region>
         <action>400</action>
         <enabled>false</enabled>
      </items>
   </imageMapArray>
</setImageMapsParam>
4e9b9d8c-5839-4215-aa35-01b652869681