blob: d1972f3c98ed444830fcac660e6d581ea93a4e58 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Physical Location &mdash; Traffic Control 1.8.0 documentation </title>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
<link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Profiles" href="profile.html"/>
<link rel="prev" title="Parameter" href="parameter.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="/" class="icon icon-home"> Traffic Control
<img src="../../../_static/tc_logo.png" class="logo" />
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator&#8217;s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer&#8217;s Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Traffic Control</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Traffic Control 1.8.0</a> &raquo;</li>
<li><a href="../../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../../traffic_ops.html">Traffic Ops</a> &raquo;</li>
<li>Physical Location</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v11/phys_location.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="physical-location">
<span id="to-api-v11-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline"></a></h1>
<div class="section" id="api-1-1-phys-locations">
<span id="to-api-v11-phys-loc-route"></span><h2>/api/1.1/phys_locations<a class="headerlink" href="#api-1-1-phys-locations" title="Permalink to this headline"></a></h2>
<p><strong>GET /api/1.1/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="10%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;Mile High&quot;</span><span class="p">,</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;4&quot;</span><span class="p">,</span>
<span class="s">&quot;poc&quot;</span><span class="p">:</span> <span class="s">&quot;Jane Doe&quot;</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-10-02 08:22:43&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;phone&quot;</span><span class="p">:</span> <span class="s">&quot;(123) 555-1111&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;NM&quot;</span><span class="p">,</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;jane.doe@email.com&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;87107&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span><span class="p">:</span> <span class="s">&quot;123 East 3rd St&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;Mile High&quot;</span><span class="p">,</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;4&quot;</span><span class="p">,</span>
<span class="s">&quot;poc&quot;</span><span class="p">:</span> <span class="s">&quot;Jane Doe&quot;</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-10-02 08:22:43&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;phone&quot;</span><span class="p">:</span> <span class="s">&quot;(123) 555-1111&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;NM&quot;</span><span class="p">,</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;jane.doe@email.com&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;87107&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span><span class="p">:</span> <span class="s">&quot;123 East 3rd St&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>GET /api/1.1/phys_locations/trimmed.json</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="11%" />
<col width="61%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Ashburn&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>GET /api/1.1/phys_locations/:id</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="15%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>yes</td>
<td>Physical location ID.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="10%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;Mile High&quot;</span><span class="p">,</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;4&quot;</span><span class="p">,</span>
<span class="s">&quot;poc&quot;</span><span class="p">:</span> <span class="s">&quot;Jane Doe&quot;</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-10-02 08:22:43&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;phone&quot;</span><span class="p">:</span> <span class="s">&quot;(123) 555-1111&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;NM&quot;</span><span class="p">,</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;jane.doe@email.com&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;87107&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span><span class="p">:</span> <span class="s">&quot;123 East 3rd St&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<dl class="docutils">
<dt><strong>PUT /api/1.1/phys_locations/:id</strong></dt>
<dd><p class="first">Update a physical location</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: admin or oper</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="13%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>int</td>
<td>Physical location id.</td>
</tr>
</tbody>
</table>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="13%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>yes</td>
<td>Physical location address.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>yes</td>
<td>Physical location city.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>no</td>
<td>Physical location comments.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>no</td>
<td>Physical location email.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>yes</td>
<td>Physical location name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>no</td>
<td>Physical location phone.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>no</td>
<td>Physical location point of contact.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>no</td>
<td>Physical location region ID.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>yes</td>
<td>Physical location short name.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>yes</td>
<td>Physical location state.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>yes</td>
<td>Physical location zip.</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;regionId&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</span><span class="p">,</span>
<span class="s">&quot;poc&quot;</span><span class="p">:</span> <span class="s">&quot;Jane Doesssss&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;phone&quot;</span><span class="p">:</span> <span class="s">&quot;(123) 555-1111&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;NM&quot;</span><span class="p">,</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;jane.doe@email.com&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;87107&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span><span class="p">:</span> <span class="s">&quot;123 East 9rd St&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</dd>
</dl>
<div class="line-block">
<div class="line"><br /></div>
</div>
<blockquote>
<div><p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="10%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;alerts&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;level&quot;</span><span class="p">:</span> <span class="s">&quot;success&quot;</span><span class="p">,</span>
<span class="s">&quot;text&quot;</span><span class="p">:</span> <span class="s">&quot;Physical location update was successful.&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;Mile High&quot;</span><span class="p">,</span>
<span class="s">&quot;region&quot;</span><span class="p">:</span> <span class="s">&quot;4&quot;</span><span class="p">,</span>
<span class="s">&quot;poc&quot;</span><span class="p">:</span> <span class="s">&quot;Jane Doe&quot;</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-10-02 08:22:43&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;phone&quot;</span><span class="p">:</span> <span class="s">&quot;(123) 555-1111&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;NM&quot;</span><span class="p">,</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;jane.doe@email.com&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;87107&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span><span class="p">:</span> <span class="s">&quot;123 East 3rd St&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span><span class="p">:</span> <span class="s">&quot;Albuquerque&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<dl class="docutils">
<dt><strong>POST /api/1.1/regions/:region_name/phys_locations</strong></dt>
<dd><p class="first">Create physical location.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: admin or oper</p>
<p>region_name: the name of the region to create physical location into.</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="16%" />
<col width="56%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">region_name</span></code></td>
<td>yes</td>
<td>The name of the physical location</td>
</tr>
</tbody>
</table>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="13%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>yes</td>
<td>The name of the location</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>yes</td>
<td>The short name of the location</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>yes</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>no</td>
<td>Point of contact</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>no</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>no</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;my physical location1&quot;</span><span class="p">,</span>
<span class="s">&quot;shortName&quot;</span> <span class="p">:</span> <span class="s">&quot;myphylocation1&quot;</span><span class="p">,</span>
<span class="s">&quot;address&quot;</span> <span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span> <span class="p">:</span> <span class="s">&quot;Shanghai&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;SH&quot;</span><span class="p">,</span>
<span class="s">&quot;zip&quot;</span><span class="p">:</span> <span class="s">&quot;200000&quot;</span><span class="p">,</span>
<span class="s">&quot;comments&quot;</span><span class="p">:</span> <span class="s">&quot;this is physical location1&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</dd>
</dl>
<div class="line-block">
<div class="line"><br /></div>
</div>
<blockquote>
<div><p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="11%" />
<col width="67%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The id of the physical location created.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the location</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>The short name of the location</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionName</span></code></td>
<td>string</td>
<td>The region name the physical location belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>string</td>
<td>Point of contact</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre> {
&quot;response&quot;: {
&#39;shortName&#39;: &#39;myphylocati&#39;,
&#39;regionName&#39;: &#39;myregion1&#39;,
&#39;name&#39;: &#39;my physical location1&#39;,
&#39;poc&#39;: &#39;&#39;,
&#39;phone&#39;: &#39;&#39;,
&#39;comments&#39;: &#39;this is physical location1&#39;,
&#39;state&#39;: &#39;SH&#39;,
&#39;email&#39;: &#39;&#39;,
&#39;zip&#39;: &#39;20000&#39;,
&#39;region_id&#39;: &#39;20&#39;,
&#39;city&#39;: &#39;Shanghai&#39;,
&#39;address&#39;: &#39;&#39;,
&#39;id&#39;: &#39;200&#39;
}
}
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>