You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/11/01 21:44:55 UTC
[31/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html b/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
index 4765744..bd4f778 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-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-2-phys-locations">
<span id="to-api-v12-phys-loc-route"></span><h2>/api/1.2/phys_locations<a class="headerlink" href="#api-1-2-phys-locations" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/phys_locations.json</strong></p>
+<p><strong>GET /api/1.2/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,47 +208,47 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -256,40 +256,52 @@
<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </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">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(321) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"60636"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 4th Street"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"chicago"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -322,13 +334,348 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</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.2/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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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.2/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-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -421,14 +768,14 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span>
- <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
- <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -507,23 +854,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": {
- 'shortName': 'myphylocati',
- 'regionName': 'myregion1',
- 'name': 'my physical location1',
- 'poc': '',
- 'phone': '',
- 'comments': 'this is physical location1',
- 'state': 'SH',
- 'email': '',
- 'zip': '20000',
- 'region_id': '20',
- 'city': 'Shanghai',
- 'address': '',
- 'id': '200'
- }
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/profile.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/profile.html b/docs/1.7.0/development/traffic_ops_api/v12/profile.html
index c85ecaf..9e7db37 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/profile.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/profile.html
@@ -35,7 +35,7 @@
<link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="InfluxDB" href="influxdb.html"/>
+ <link rel="next" title="Profile parameters" href="profile_parameter.html"/>
<link rel="prev" title="Physical Location" href="phys_location.html"/>
@@ -177,7 +177,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -190,11 +190,31 @@
<span id="to-api-v12-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-profiles">
<span id="to-api-v12-profiles-route"></span><h2>/api/1.2/profiles<a class="headerlink" href="#api-1-2-profiles" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/profiles.json</strong></p>
+<p><strong>GET /api/1.2/profiles</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<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">param</span></code></td>
+<td>no</td>
+<td>Used to filter profiles by parameter.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -229,13 +249,13 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -245,7 +265,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/profiles/trimmed.json</strong></p>
+<p><strong>GET /api/1.2/profiles/trimmed</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -272,10 +292,85 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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.2/profiles/:id</strong></p>
+<blockquote>
+<div><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="22%" />
+<col width="16%" />
+<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">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</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">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -319,9 +414,9 @@
</div></blockquote>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -362,12 +457,12 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -447,14 +542,14 @@
</div></blockquote>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"profileCopyFrom"</span><span class="p">:</span> <span class="s">"CCR1"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
- <span class="s">"idCopyFrom"</span><span class="p">:</span> <span class="s">"3"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -465,6 +560,182 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>PUT /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Allows user to edit a profile.</p>
+<blockquote>
+<div><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="22%" />
+<col width="13%" />
+<col width="65%" />
+</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>profile id.</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 new name for the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>yes</td>
+<td>The new description for the profile.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>{
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+}
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE description"</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was updated: 219"</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>DELETE /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a profile.</p>
+<blockquote>
+<div><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="31%" />
+<col width="18%" />
+<col width="51%" />
+</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>profile id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<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">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was deleted."</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>
</div>
</div>
@@ -474,7 +745,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>