Parameters for all requests

• companyid - The companyid is a unique code that is given as part of your subscription to access the API. This code must be supplied as part of the header for each API request.

Refer to the Documentation page for each specific request and the supported Parameters

Template Compounds

Description

Compounds is generated by using the "Compound" option. The Compound option is added after the action. Compound parameters are added after a ? character which is appended to Compound.

For example: /api/Compound/Render?Elements[0]=Templates/LayoutTemplate.PXF%3fPersonalizations[0].Name=Placeholder%26Personalizations[0].Design=TEMPLATE-INSERT&Elements[1]=Templates/TemplateToInsert.PXF%3fPersonalizations[0].Name=DESIGN%26Personalizations[0].Design=Mascot.PXF%26Personalizations[1].Name=Line+1%26Personalizations[1].Text=LINE+ONE

Parameters

• Elements[] - Array of template components. Values are URL encoded Templates components
  • The first Element is assumed to be the layout or insert template.
  • The second Element in the array being the second Template will be inserted into this first Template.
  • The first Elements Personalization value for Design should be a value of TEMPLATE-INSERT or INSERT-TEMPLATE. Either value is supported and will signal the compound that this will be used for inserting.
• For all available Template parameters see the Parameters section under Templates.

Compounds can have their Start/Stop points specified. See start/stop parameters.

Compounds can be transformed. See transformation parameters.

Example

 

/api/Compound/Render?Elements[0]=Templates/4CIRCLEa.PXF%3fPersonalizations[0].Name=Placement%26Personalizations[0].Design=TEMPLATE-INSERT&Elements[1]=Templates/Template_INSERT.PXF%3fPersonalizations[0].Name=DESIGN%26Personalizations[0].Design=134150.PXF%26Personalizations[1].Name=Line+1%26Personalizations[1].Text=150%26Personalizations[1].TextColour=TEAM+BLUE%26Personalizations[2].Name=Line+2%26Personalizations[2].Text=STATE+ALL%26Personalizations[2].TextColour=LIPSTICK%26Personalizations[3].Name=Line+3%26Personalizations[3].Text=DIVISION+V%26Personalizations[3].TextColour=ORANGE+SUNRISE%26Personalizations[4].Name=Line+4%26Personalizations[4].Text=2017%26Personalizations[4].TextColour=LIME+GREEN

This produces a template within a template:

• api/Templates/Render?Path=4CIRCLEa.PXF%3fPersonalizations[0].Name=Placement%26Personalizations[0].Design=TEMPLATE-INSERT
• api/Templates/Render?Path=Template_INSERT.PXF%3fPersonalizations[0].Name=DESIGN%26Personalizations[0].Design=134150.PXF%26Personalizations[1].Name=Line+1%26Personalizations[1].Text=150%26Personalizations[1].TextColour=TEAM+BLUE%26Personalizations[2].Name=Line+2%26Personalizations[2].Text=STATE+ALL%26Personalizations[2].TextColour=LIPSTICK%26Personalizations[3].Name=Line+3%26Personalizations[3].Text=DIVISION+V%26Personalizations[3].TextColour=ORANGE+SUNRISE%26Personalizations[4].Name=Line+4%26Personalizations[4].Text=2017%26Personalizations[4].TextColour=LIME+GREEN

---