404

D7net
:/ var / www / html / chatweb02 /
Filename : doc.html
back
<!doctype html>
<html>
  <head>
    <title>Integração API - WebChat</title>
    <style type="text/css">
      body {
	font-family: Trebuchet MS, sans-serif;
	font-size: 15px;
	color: #444;
	margin-right: 24px;
}

h1	{
	font-size: 25px;
}
h2	{
	font-size: 20px;
}
h3	{
	font-size: 16px;
	font-weight: bold;
}
hr	{
	height: 1px;
	border: 0;
	color: #ddd;
	background-color: #ddd;
}

.app-desc {
  clear: both;
  margin-left: 20px;
}
.param-name {
  width: 100%;
}
.license-info {
  margin-left: 20px;
}

.license-url {
  margin-left: 20px;
}

.model {
  margin: 0 0 0px 20px;
}

.method {
  margin-left: 20px;
}

.method-notes	{
	margin: 10px 0 20px 0;
	font-size: 90%;
	color: #555;
}

pre {
  padding: 10px;
  margin-bottom: 2px;
}

.http-method {
 text-transform: uppercase;
}

pre.get {
  background-color: #0f6ab4;
}

pre.post {
  background-color: #10a54a;
}

pre.put {
  background-color: #c5862b;
}

pre.delete {
  background-color: #a41e22;
}

.huge	{
	color: #fff;
}

pre.example {
  background-color: #f3f3f3;
  padding: 10px;
  border: 1px solid #ddd;
}

code {
  white-space: pre;
}

.nickname {
  font-weight: bold;
}

.method-path {
  font-size: 1.5em;
  background-color: #0f6ab4;
}

.up {
  float:right;
}

.parameter {
  width: 500px;
}

.param {
  width: 500px;
  padding: 10px 0 0 20px;
  font-weight: bold;
}

.param-desc {
  width: 700px;
  padding: 0 0 0 20px;
  color: #777;
}

.param-type {
  font-style: italic;
}

.param-enum-header {
width: 700px;
padding: 0 0 0 60px;
color: #777;
font-weight: bold;
}

.param-enum {
width: 700px;
padding: 0 0 0 80px;
color: #777;
font-style: italic;
}

.field-label {
  padding: 0;
  margin: 0;
  clear: both;
}

.field-items	{
	padding: 0 0 15px 0;
	margin-bottom: 15px;
}

.return-type {
  clear: both;
  padding-bottom: 10px;
}

.param-header {
  font-weight: bold;
}

.method-tags {
  text-align: right;
}

.method-tag {
  background: none repeat scroll 0% 0% #24A600;
  border-radius: 3px;
  padding: 2px 10px;
  margin: 2px;
  color: #FFF;
  display: inline-block;
  text-decoration: none;
}

    </style>
  </head>
  <body>
  <h1>Integração API - WebChat</h1>
    <div class="app-desc">Api de integração com Webchat</div>
    <div class="app-desc">Contato para informações: <a href="you@your-company.com">you@your-company.com</a></div>
    <div class="app-desc">Versão: 1.0.0</div>
    <div class="app-desc">BasePath:/chatweb02/api/v1</div>
    <div class="license-info">Apache 2.0</div>
    <div class="license-url">http://www.apache.org/licenses/LICENSE-2.0.html</div>
  <h2>Access</h2>

  <h2><a name="__Methods">Methods</a></h2>
  [ Jump to <a href="#__Models">Models</a> ]

  <h3>Table of Contents </h3>
  <div class="method-summary"></div>
  <h4><a href="#Users">Users</a></h4>
  <ul>
  <li><a href="#post"><code><span class="http-method">post</span> /users</code></a></li>
  <li><a href="#delete"><code><span class="http-method">delete</span> /users</code></a></li>
  <li><a href="#get"><code><span class="http-method">get</span> /users</code></a></li>
  <li><a href="#put"><code><span class="http-method">put</span> /users</code></a></li>
  </ul>

  <h1><a name="Users">Users</a></h1>
  <div class="method"><a name="post"/>
    <div class="method-path">
    <a class="up" href="#__Methods">Up</a>
    <pre class="post"><code class="huge"><span class="http-method">post</span> /users</code></pre></div>
    <div class="method-summary"> (<span class="nickname">post</span>)</div>
    <div class="method-notes">Passando os dados para via post, é possivel realizar o cadastro de novos usuarios dentro do chat.</div>


    <h3 class="field-label">Consumes</h3>
    This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
    <ul>
      <li><code>application/json</code></li>
    </ul>

    <h3 class="field-label">Request body</h3>
    <div class="field-items">
      <div class="param">post <a href="#post">post</a> (optional)</div>

      <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Adicionar usuário </div>

    </div>  <!-- field-items -->





    <!--Todo: process Response Object and its headers, schema, examples -->


    <h3 class="field-label">Produces</h3>
    This API call produces the following media types according to the <span class="header">Accept</span> request header;
    the media type will be conveyed by the <span class="header">Content-Type</span> response header.
    <ul>
      <li><code>application/json</code></li>
    </ul>

    <h3 class="field-label">Responses</h3>
    <h4 class="field-label">201</h4>
    usuário criado
        <a href="#"></a>
    <h4 class="field-label">400</h4>
    invalid input, object invalid
        <a href="#"></a>
    <h4 class="field-label">409</h4>
    an existing item already exists
        <a href="#"></a>
  </div> <!-- method -->
  <hr/>
  <div class="method"><a name="delete"/>
    <div class="method-path">
    <a class="up" href="#__Methods">Up</a>
    <pre class="delete"><code class="huge"><span class="http-method">delete</span> /users</code></pre></div>
    <div class="method-summary"> (<span class="nickname">delete</span>)</div>
    <div class="method-notes">Esse metodo deleta o usuário selecionado</div>





    <h3 class="field-label">Query parameters</h3>
    <div class="field-items">
      <div class="param">id (required)</div>

      <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; basta enviar via get ID do usuário </div>
    </div>  <!-- field-items -->



    <!--Todo: process Response Object and its headers, schema, examples -->


    <h3 class="field-label">Produces</h3>
    This API call produces the following media types according to the <span class="header">Accept</span> request header;
    the media type will be conveyed by the <span class="header">Content-Type</span> response header.
    <ul>
      <li><code>application/json</code></li>
    </ul>

    <h3 class="field-label">Responses</h3>
    <h4 class="field-label">201</h4>
    deletado com sucesso
        <a href="#"></a>
    <h4 class="field-label">400</h4>
    bad input parameter
        <a href="#"></a>
  </div> <!-- method -->
  <hr/>
  <div class="method"><a name="get"/>
    <div class="method-path">
    <a class="up" href="#__Methods">Up</a>
    <pre class="get"><code class="huge"><span class="http-method">get</span> /users</code></pre></div>
    <div class="method-summary"> (<span class="nickname">get</span>)</div>
    <div class="method-notes">Esse metodo tras a lista de todos os usuários que tem cadastrados no chat. Isso possibilita a integração com outros sistemas.</div>





    <h3 class="field-label">Query parameters</h3>
    <div class="field-items">
      <div class="param">id (optional)</div>

      <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; basta enviar via get ID do usuário </div>
    </div>  <!-- field-items -->


    <h3 class="field-label">Return type</h3>
    <div class="return-type">
      array[<a href="#get">get</a>]

    </div>

    <!--Todo: process Response Object and its headers, schema, examples -->

    <h3 class="field-label">Example data</h3>
    <div class="example-data-content-type">Content-Type: application/json</div>
    <pre class="example"><code>[ {
  "nome" : "nome",
  "id" : 0,
  "login" : "login",
  "email" : "email",
  "status" : "status",
  "perfil" : "perfil"
}, {
  "nome" : "nome",
  "id" : 0,
  "login" : "login",
  "email" : "email",
  "status" : "status",
  "perfil" : "perfil"
} ]</code></pre>

    <h3 class="field-label">Produces</h3>
    This API call produces the following media types according to the <span class="header">Accept</span> request header;
    the media type will be conveyed by the <span class="header">Content-Type</span> response header.
    <ul>
      <li><code>application/json</code></li>
    </ul>

    <h3 class="field-label">Responses</h3>
    <h4 class="field-label">200</h4>
    Apresenta a listagem de usuários existentes

    <h4 class="field-label">400</h4>
    bad input parameter
        <a href="#"></a>
  </div> <!-- method -->
  <hr/>
  <div class="method"><a name="put"/>
    <div class="method-path">
    <a class="up" href="#__Methods">Up</a>
    <pre class="put"><code class="huge"><span class="http-method">put</span> /users</code></pre></div>
    <div class="method-summary"> (<span class="nickname">put</span>)</div>
    <div class="method-notes">Realiza a atualização do usuário selecionado</div>



    <h3 class="field-label">Request body</h3>
    <div class="field-items">
      <div class="param">post <a href="#put">put</a> (optional)</div>

      <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; Atualizar usuário </div>

    </div>  <!-- field-items -->





    <!--Todo: process Response Object and its headers, schema, examples -->


    <h3 class="field-label">Produces</h3>
    This API call produces the following media types according to the <span class="header">Accept</span> request header;
    the media type will be conveyed by the <span class="header">Content-Type</span> response header.
    <ul>
      <li><code>application/json</code></li>
    </ul>

    <h3 class="field-label">Responses</h3>
    <h4 class="field-label">201</h4>
    usuário atualizado
        <a href="#"></a>
    <h4 class="field-label">400</h4>
    invalid input, object invalid
        <a href="#"></a>
    <h4 class="field-label">409</h4>
    usuário não cadastrado
        <a href="#"></a>
  </div> <!-- method -->
  <hr/>

  <h2><a name="__Models">Models</a></h2>
  [ Jump to <a href="#__Methods">Methods</a> ]

  <h3>Table of Contents</h3>
  <ol>
    <li><a href="#get"><code>get</code> - </a></li>
    <li><a href="#post"><code>post</code> - </a></li>
    <li><a href="#put"><code>put</code> - </a></li>
  </ol>

  <div class="model">
    <h3><a name="get"><code>get</code> - </a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'></div>
    <div class="field-items">
      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span>  format: int64</div>
<div class="param">nome (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">login (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">perfil (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
    </div>  <!-- field-items -->
  </div>
  <div class="model">
    <h3><a name="post"><code>post</code> - </a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'></div>
    <div class="field-items">
      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span>  format: int64</div>
<div class="param">nome (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">login (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">perfil (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
    </div>  <!-- field-items -->
  </div>
  <div class="model">
    <h3><a name="put"><code>put</code> - </a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'></div>
    <div class="field-items">
      <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span>  format: int64</div>
<div class="param">nome (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">login (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
<div class="param">perfil (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  format: string</div>
    </div>  <!-- field-items -->
  </div>
  </body>
</html>