Retrieve zone and area information for a Geo PCL definition (GET)


For any given Geo PCL definition, you can view the following information:

  • Zone name, template, and Geo PCL thresholds associated with the definition
  • Name, longitude, and latitude of any areas in the zone
  • Name of Watchpoint and metric (End-to-end time or Page-render time) associated with the Geo PCL definition

Command overview

Method — GET

Resource — geopcl/<geoPCLDefinitionID>/zones where <geoPCLDefinitionID> is the integer that identifies the GeoPCL definition (the GeoPCL definition ID)

Parameters

 1 This parameter is required.

Sample request

https://10.0.0.1/rest/geopclapi/1.0/geopcl/31/zones?usr=jdoe&pwd=pa55w0rd!

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status result="success"></status>
<result>
 <geoPCLDefinition id="31">
  <metric code="e2e">
   <label>End-to-End</label>
  </metric>
  <watchpoint id="2">
  <label>All-Pages</label>
  </watchpoint>
  <zones>
   <zone id="1" tolerating="2000" frustrating="5000">
    <name>Western NA</name>
    <templateName>North America (Western)
    </templateName>
    <areas>
     <area id="1211080859" longitude="-117.122" latitude="38.42">
      <label>Nevada</label>
     </area>
     <area id="1204420371" longitude="-113.677" latitude="52.247">
      <label>Alberta</label>
     </area>
     <area id="1211080891" longitude="-122.127" latitude="44.567">
      <label>Oregon</label>
     </area>
    </areas>
   </zone>
  </zones>
 </geoPCLDefinition>
</result>
</response>

Related topic

Geo-PCL-definition-XML-reference

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*