DocumentationDynamic Media Image Production System API

saveImageMap

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

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)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company with the image map you want to save.
assetHandle
xsd:string
Yes
The handle to the image asset to which the image map belongs.
imageMapHandle
xsd:string
No
The handle to the image map. Creates an image map if NULL.
name
xsd:string
Yes
The name of the image map that is created or saved.
shapeType
xsd:string
Yes
Choice of Region Shape.
region
xsd:string
Yes
A comma-delimited list of points that define the region.
action
xsd:string
Yes

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 & .

position
xsd:int
Yes
The order in the list of image maps (the Z axis).
enabled
xsd:boolean
Yes

Output (saveImageMapReturn)

Name
Type
Required
Description
imageMapHandle
xsd:string
Yes
The 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>
4e9b9d8c-5839-4215-aa35-01b652869681