DocumentationDynamic Media Image Production System API

batchSetFontFields

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets font metadata fields.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (batchSetFontFieldsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company that contains the fonts.
updateArray
types:FontFieldUpdateArray
Yes
Array of font field updates.

Output (batchSetFontFieldsParam)

Name
Type
Required
Description
successCount
xsd:int
Yes
The number of successfully set font fields.
warningCount
xsd:int
Yes
Number of warnings generated when the operation attempted to set font fields.
errorCount
xsd:int
Yes
Number of errors generated when the operation attempted to set font fields.
warningDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated warnings when the operation attempted to apply the updates.
errorDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated errors when the operation attempted to apply the updates.

Examples

Request

<batchSetFontFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <companyHandle>c|1</companyHandle>
   <updateArray>
      <items>
          <assetHandle>a|450|14|19</assetHandle>
          <fontName>Bookman Old Style Font Name</fontName>
          <postscriptName>Bookman Old Style PostScript</postscriptName>
          <rtfName>Bookman Old Style RTF</rtfName>
          <fontFamily>Bookman Old Style Family</fontFamily>
          <style>BoldItalic</style>
          <typeName>Open Type</typeName><type>OTF</type>
      </items>
   </updateArray>
</batchSetFontFieldsParam>

Response

<batchSetFontFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <successCount>1</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</batchSetFontFieldsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681