DocumentationDynamic Media Image Production System API

saveImageMap

Last update: March 8, 2022
  • Topics:
  • Dynamic Media Classic,SDK/API

CREATED FOR:

  • Developer
  • Admin

Create a new image map or edit an existing map.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read and write access to the asset.

Parameters

Input (saveImageMapParam)

NameTypeRequiredDescription
companyHandlexsd:stringYesThe handle to the company with the image map you want to save.
assetHandlexsd:stringYesThe handle to the image asset to which the image map belongs.
imageMapHandlexsd:stringNoThe handle to the image map. Creates an image map if NULL.
namexsd:stringYesThe name of the image map that is created or saved.
shapeTypexsd:stringYesChoice of Region Shape.
regionxsd:stringYesA comma-delimited list of points that define the region.
actionxsd:stringYes

The href value associated with the image map as specified in the IPS interface.

To obtain the href value, click the image in the IPS interface, copy and paste the URL into this element, and then format the IPS URL as a proper URL. For example, & becomes & .

positionxsd:intYesThe order in the list of image maps (the Z axis).
enabledxsd:booleanYes

Output (saveImageMapReturn)

NameTypeRequiredDescription
imageMapHandlexsd:stringYesThe handle to the new or edited image map.

Examples

This code sample creates a new image map for an asset. It uses a shape type determined by a region shape string constant and returns a handle to the new image map.

Request

<saveImageMapParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <assetHandle>24266|1|17062</assetHandle>
   <name>My Image Map</name>
   <shapeType>Rectangle</shapeType>
   <region>0,10,0,10</region>
   <action>http://s7oslo.macromedia.com/scene7/browse/MoreInfo.jsp?assetID=24266&amp;
   iRow=1&iRows=1&amp;strSearchType=image</action>
   <position>0</position>
</saveImageMapParam>

Response

<saveImageMapReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <imageMapHandle>34191|8|554</imageMapHandle>
</saveImageMapReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681