saveImageFormat

Last update: 2022-03-08
  • Created for:
  • Developer
    Admin

Creates an image format.

NOTE

The urlModifier field value must consist of valid XML. For example, change & to &. Get the urlModfier value from the IPS user interface.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (saveImageFormatParam)

Name Type Required Description
companyHandle xsd:string Yes The handle to the company with the image format you want to work with.
imageFormatHandle xsd:string No Image format handle you want to save.
name xsd:string Yes Image format name.
urlModifier xsd:string Yes This can be any IPS protocol query string. The easiest way to generate a URL modifier is to create one with the IPS user interface and then cut and paste the query string.

Output (saveImageFormatReturn)

Name Type Required Description
imageFormatHandle xsd:string Yes Handle to the image format.

Examples

This code sample creates an image format. In this example, urlModifier was determined by its value in the IPS user interface with a valid HTML format.

Request

<saveImageFormatParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <name>My Image Format Name</name>
   <urlModifier>wid=400&amp;hei=400&amp;fmt=jpeg&amp;qlt=750&amp;op_sharpen=0&amp;
   resMode=bicub&amp;op_usm=0.0,0.0,0,0&amp;iccEmbed=0
   </urlModifier>
</saveImageFormatParam>

Response

<saveImageFormatReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <imageFormatHandle>47|301</imageFormatHandle>
</saveImageFormatReturn>

On this page