Sizes :: Retrieve API Module

Retrieve

Description

Allows you to retrieve the properties of an existing size.

Module URI

/servlet/control/api/sizes/retrieve

Parameters

Parameter Name	Parameter Type	Required?	Example Value	Validation Rules (If Applicable)
secret	String	Yes	a78bf24c5a23581aceba1c5f51ac4cad	Must be a String containing no more than 32 characters
output	String	No	xml	Must be a String equal to either json or xml

Parameter Name	Parameter Type	Required?	Example Value	Validation Rules (If Applicable)
id	Integer	Yes	123	Must be the ID# of an existing size

XML Response

/servlet/control/api/sizes/retrieve?secret=(key)&id=19


<size id="19" name="Jumbo Banner" width="728" height="90">
  <notes>IAB Standard Size</notes>
  <default image="http://adserver.example.com/servlet/files/16" redirect="http://www.example.com/" border="0" hspace="0" vspace="0" align="" target="_top" alt="Click Here!" textlink="">
    <html/>
  </default>
  <compatible>
    <id>15</id>
    <id>21</id>
  </compatible>
</size>

JSON Response

/servlet/control/api/sizes/retrieve?secret=(key)&output=json&id=123


{
  "id": 19,
  "name": "Jumbo Banner",
  "width": 728,
  "height": 90,
  "notes": "IAB Standard Size",
  "default": {
    "image": "http://adserver.example.com/servlet/files/16",
    "redirect": "http://www.example.com/",
    "border": 0,
    "hspace": 0,
    "vspace": 0,
    "align": "",
    "target": "_top",
    "alt": "Click Here!",
    "textlink": "",
    "html": ""
  },
  "compatible": [
    15,
    21
  ]
}

< Previous Page

Sizes API Module

Index

Next Page >

XXX