Control Panel User Manual

Sizes :: Create API Module

Create

Description

Allows you to create a new size with the specified properties.

Module URI

Hyperlink /servlet/control/api/sizes/create

Parameters

Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad(None) Must be a String containing no more than 32 characters
outputStringNoxmlxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
nameStringYesJumbo Banner(None) Must be a String containing no more than 80 characters
widthIntegerYes728(None) Must be an Integer between 1 and 9,999
heightIntegerYes90(None) Must be an Integer between 1 and 9,999
notesStringNoN/A(None) Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
default_imageURLYeshttp://example.com/banner.gif(None) Must be a HTTP or HTTPS URL containing no more than 1,024 characters
default_redirectURLYeshttp://example.com/(None) Must be a HTTP or HTTPS URL containing no more than 1,024 characters
default_borderIntegerNo00 Must be an Integer between 0 and 999
default_hspaceIntegerNo00 Must be an Integer between 0 and 999
default_vspaceIntegerNo00 Must be an Integer between 0 and 999
default_alignStringNoright(None) Must be a String equal to one of the following values:
  • top
  • middle
  • bottom
  • left
  • right
May also be left empty for default or inherited alignment
default_targetStringYes_blank_blank Must be a String containing no more than 16 characters
default_altStringNoClick Here!Click Here! Must be a String containing no more than 128 characters
default_textlinkStringNoThis text will appear as a link below the banner.(None) Must be a String containing no more than 128 characters
default_htmlHTMLNoN/A(None) Must be HTML or XHTML code containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
compatibleCSV
Integer
NoN/A(None) This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing size(s)

XML Response

Hyperlink /servlet/control/api/sizes/create?secret=(key)&name=Jumbo+Banner&width=728&height=90&default_image=http://example.com/banner.gif&default_redirect=http://example.com/&default_target=_blank


<id>123</id>

JSON Response

Hyperlink /servlet/control/api/sizes/create?secret=(key)&output=json&name=Jumbo+Banner&width=728&height=90&default_image=http://example.com/banner.gif&default_redirect=http://example.com/&default_target=_blank


{ "id" : 123 }