Version 5.0
AdvertServe User Manual :: v5.0

Zones :: Retrieve API Module

Retrieve

Description

Allows you to retrieve the properties of an existing zone.

Module URI

Hyperlink /servlet/control/api/zones/retrieve

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
idIntegerYes123 Must be the ID# of an existing zone

XML Response

Hyperlink /servlet/control/api/zones/retrieve?secret=(key)&id=123


<zone id="123" name="Example.com / Forums / 728x90" group="20" type="1" size="19" desktop="true" phone="0" tablet="0" targeting="000010001" viewlimit="0" viewtimeout="1440" viewpixel="123" clickpixel="123" actionpixel="123" defaults="true" refresh="false" refreshinterval="10" refreshlimit="60" status="true" recycle="false">
  <notes/>
  <campaigns>
    <campaign id="10" size="19" default="false" chain="0" priority="1" recycle="false" status="true"/>
    <campaign id="11" size="19" default="false" chain="0" priority="1" recycle="false" status="true"/>
    <campaign id="12" size="19" default="false" chain="0" priority="1" recycle="false" status="true"/>
  </campaigns>
  <publishers>
    <publisher id="7"/>
    <publisher id="8"/>
    <publisher id="9"/>
  </publishers>
</zone>

JSON Response

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


{
  "id": 123,
  "name": "Example.com / Forums / 728x90",
  "group": 20,
  "type": 1,
  "size": 19,
  "desktop": true,
  "phone": 0,
  "tablet": 0,
  "targeting": [
    4,
    8
  ],
  "view_limit": 0,
  "view_timeout": 1440,
  "view_pixel": 123,
  "click_pixel": 123,
  "action_pixel": 123,
  "defaults": true,
  "refresh": false,
  "refresh_interval": 10,
  "refresh_limit": 60,
  "status": true,
  "recycle": false,
  "notes": "",
  "campaigns": [
    {
      "id": 10,
      "size": 19,
      "default": false,
      "chain": 0,
      "priority": 1,
      "recycle": false,
      "status": true
    },
    {
      "id": 11,
      "size": 19,
      "default": false,
      "chain": 0,
      "priority": 1,
      "recycle": false,
      "status": true
    },
    {
      "id": 12,
      "size": 19,
      "default": false,
      "chain": 0,
      "priority": 1,
      "recycle": false,
      "status": true
    }
  ],
  "publishers": [
    7,
    8,
    9
  ]
}