Show Menu
TOPICS×

getVignettePublishFormats

Syntax

Authorizied User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (getVignettePublishFormatsParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company.
Output (getVignettePublishFormatsReturn)
Name
Type
Required
Description
* vignetteFormatArray *
types:VignettePublishFormatArray
Yes
Array of vignette publish formats.

Examples

This code sample returns two vignette publish formats associated with a specific company. Information is returned in an array, which is truncated for brevity.
Request
<getVignettePublishFormatsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
</getVignettePublishFormatsParam>

Response
<getVignettePublishFormatsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <vignetteFormatArray>
      <items>
         <companyHandle>c|21</companyHandle>
         <vignetteFormatHandle>v|21|281</vignetteFormatHandle>
         <name>APIcreateVignettePublishFormat</name>
         ...
      </items>
   </vignetteFormatArray>
</getVignettePublishFormatsReturn>