Mudanças entre as edições de "Cadastro de locações de estoque"

De RBX ISP - Manual do Usuário
(Limpou toda a página)
Etiqueta: anulando
 
Linha 1: Linha 1:
 +
O objetivo deste serviço é realizar a inclusão de uma locação de estoque. Abaixo, segue exemplo do json de envio:
  
 +
<syntaxhighlight lang="json" line="1">
 +
{
 +
  "inventory_location_insert":
 +
  {
 +
    "id": 2,
 +
    "description": "Prédio Azul",
 +
    "linked_person":
 +
    {
 +
      "type": "customer",
 +
      "id": 1
 +
    },
 +
    "status": "A",
 +
    "linked_user": "anderson"
 +
  }
 +
}
 +
</syntaxhighlight>
 +
 +
'''Detalhamento dos campos'''
 +
<table style="border-collapse: collapse; width: 100%;" border="1">
 +
<tr style="height: 18px;">
 +
<td style="width: 2.56232%; height: 18px;"><strong>ID</strong></td>
 +
<td style="width: 6.5821%; height: 18px;"><strong>Campo</strong></td>
 +
<td style="width: 3.62012%; height: 18px;"><strong>Obrigat&oacute;rio</strong></td>
 +
<td style="width: 1.04384%; height: 18px;"><strong>Pai</strong></td>
 +
<td style="width: 5.67084%; height: 18px;"><strong>Tipo</strong></td>
 +
<td style="width: 34.0876%; height: 18px;"><strong>Observa&ccedil;&otilde;es</strong></td>
 +
</tr>
 +
<tr style="height: 18px;">
 +
<td style="width: 2.56232%; height: 18px;">A01</td>
 +
<td style="width: 6.5821%; height: 18px;">inventory_location_insert</td>
 +
<td style="width: 3.62012%; height: 18px;">Sim</td>
 +
<td style="width: 1.04384%; height: 18px;">Raiz</td>
 +
<td style="width: 5.67084%; height: 18px;">-</td>
 +
<td style="width: 34.0876%; height: 18px;">&nbsp;</td>
 +
</tr>
 +
<tr style="height: 18px;">
 +
<td style="width: 2.56232%; height: 10px;">A02</td>
 +
<td style="width: 6.5821%; height: 10px;">id</td>
 +
<td style="width: 3.62012%; height: 10px;">N&atilde;o</td>
 +
<td style="width: 1.04384%; height: 10px;">A01</td>
 +
<td style="width: 5.67084%; height: 10px;">Inteiro (3)</td>
 +
<td style="width: 34.0876%; height: 10px;">
 +
<p>C&oacute;digo da loca&ccedil;&atilde;o. Se n&atilde;o for informado, ser&aacute; gerado automaticamente pelo sistema.&nbsp;</p>
 +
<p>N&atilde;o pode ser enviado o id 1 neste campo.</p>
 +
<p>Campo chave prim&aacute;ria da loca&ccedil;&atilde;o, ou seja, n&atilde;o pode se repetir.</p>
 +
</td>
 +
</tr>
 +
<tr style="height: 18px;">
 +
<td style="width: 2.56232%; height: 10px;">A03</td>
 +
<td style="width: 6.5821%; height: 10px;">description</td>
 +
<td style="width: 3.62012%; height: 10px;">Sim</td>
 +
<td style="width: 1.04384%; height: 10px;">A01</td>
 +
<td style="width: 5.67084%; height: 10px;">Texto (30)</td>
 +
<td style="width: 34.0876%; height: 10px;">
 +
<p>Descri&ccedil;&atilde;o da loca&ccedil;&atilde;o.</p>
 +
</td>
 +
</tr>
 +
<tr style="height: 18px;">
 +
<td style="width: 2.56232%; height: 10px;">A04</td>
 +
<td style="width: 6.5821%; height: 10px;">linked_person</td>
 +
<td style="width: 3.62012%; height: 10px;">N&atilde;o</td>
 +
<td style="width: 1.04384%; height: 10px;">A01</td>
 +
<td style="width: 5.67084%; height: 10px;">-</td>
 +
<td style="width: 34.0876%; height: 10px;">
 +
<p>Grupo de informa&ccedil;&otilde;es de cliente/fornecedor vinculado &agrave; loca&ccedil;&atilde;o.</p>
 +
</td>
 +
</tr>
 +
<tr style="height: 94px;">
 +
<td style="width: 2.56232%; height: 10px;">B01</td>
 +
<td style="width: 6.5821%; height: 10px;">type</td>
 +
<td style="width: 3.62012%; height: 10px;">Sim</td>
 +
<td style="width: 1.04384%; height: 10px;">A04</td>
 +
<td style="width: 5.67084%; height: 10px;">Texto (30)</td>
 +
<td style="width: 34.0876%; height: 10px;">
 +
<p>Valores permitidos:</p>
 +
<ul>
 +
<li><strong>customer</strong>: cliente</li>
 +
<li><strong>supplier</strong>: fornecedor</li>
 +
</ul>
 +
</td>
 +
</tr>
 +
<tr style="height: 62px;">
 +
<td style="width: 2.56232%; height: 46px;">B02</td>
 +
<td style="width: 6.5821%; height: 46px;">id</td>
 +
<td style="width: 3.62012%; height: 46px;">Sim</td>
 +
<td style="width: 1.04384%; height: 46px;">A04</td>
 +
<td style="width: 5.67084%; height: 46px;">Inteiro (15)</td>
 +
<td style="width: 34.0876%; height: 46px;">
 +
<p>C&oacute;digo do cliente/fornecedor (conforme informado no campo anterior).</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td style="width: 2.56232%;">A05</td>
 +
<td style="width: 6.5821%;">status</td>
 +
<td style="width: 3.62012%;">Sim</td>
 +
<td style="width: 1.04384%;">A01</td>
 +
<td style="width: 5.67084%;">Texto</td>
 +
<td style="width: 34.0876%;">
 +
<p>Situa&ccedil;&atilde;o da loca&ccedil;&atilde;o. Valores permitidos:</p>
 +
<ul>
 +
<li><strong>A</strong>: ativa</li>
 +
<li><strong>I</strong>: inativa</li>
 +
</ul>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td style="width: 2.56232%;">A06</td>
 +
<td style="width: 6.5821%;">linked_user</td>
 +
<td style="width: 3.62012%;">N&atilde;o</td>
 +
<td style="width: 1.04384%;">A01</td>
 +
<td style="width: 5.67084%;">Texto (20)</td>
 +
<td style="width: 34.0876%;">
 +
<p>Usu&aacute;rio vinculado &agrave; loca&ccedil;&atilde;o. N&atilde;o &eacute; permitido vincular um mesmo usu&aacute;rio a mais de uma loca&ccedil;&atilde;o.</p>
 +
</td>
 +
</tr>
 +
</table>
 +
<p>&nbsp;</p>
 +
'''Mensagem de retorno'''
 +
 +
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
 +
 +
<syntaxhighlight lang="json" line="1">
 +
{
 +
  "status": 1,
 +
  "error_code": 0,
 +
  "error_description": "",
 +
  "result":
 +
  {
 +
    "id": 15
 +
  }
 +
}
 +
</syntaxhighlight>
 +
 +
Em caso de falha, será retornado um json conforme o exemplo abaixo:
 +
 +
<syntaxhighlight lang="json" line="1">
 +
{
 +
  "status": 0,
 +
  "error_code": 19,
 +
  "error_description": "Unknown error!",
 +
  "result": ""
 +
}
 +
</syntaxhighlight>

Edição atual tal como às 08h48min de 4 de junho de 2021

O objetivo deste serviço é realizar a inclusão de uma locação de estoque. Abaixo, segue exemplo do json de envio:

{
  "inventory_location_insert":
  {
    "id": 2,
    "description": "Prédio Azul",
    "linked_person":
    {
      "type": "customer",
      "id": 1
    },
    "status": "A", 
    "linked_user": "anderson"
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 inventory_location_insert Sim Raiz -  
A02 id Não A01 Inteiro (3)

Código da locação. Se não for informado, será gerado automaticamente pelo sistema. 

Não pode ser enviado o id 1 neste campo.

Campo chave primária da locação, ou seja, não pode se repetir.

A03 description Sim A01 Texto (30)

Descrição da locação.

A04 linked_person Não A01 -

Grupo de informações de cliente/fornecedor vinculado à locação.

B01 type Sim A04 Texto (30)

Valores permitidos:

  • customer: cliente
  • supplier: fornecedor
B02 id Sim A04 Inteiro (15)

Código do cliente/fornecedor (conforme informado no campo anterior).

A05 status Sim A01 Texto

Situação da locação. Valores permitidos:

  • A: ativa
  • I: inativa
A06 linked_user Não A01 Texto (20)

Usuário vinculado à locação. Não é permitido vincular um mesmo usuário a mais de uma locação.

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": 
  {
    "id": 15
  }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 19,
  "error_description": "Unknown error!",
  "result": ""
}