Felipe: Criou página com 'O objetivo deste serviço é alocar um equipamento em comodato em um cliente. Abaixo, segue exemplo do json de envio: { "equipment_le...'

2021-06-04T11:31:29Z

Criou página com 'O objetivo deste serviço é alocar um equipamento em comodato em um cliente. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "equipment_le...'

Página nova

O objetivo deste serviço é alocar um equipamento em comodato em um cliente. Abaixo, segue exemplo do json de envio:

<syntaxhighlight lang="json" line="1">
{
"equipment_lending":
{
"product_id": 122,
"customer_id": 658,
"contract_id": 1548,
"activation_date": "2019-10-01",
"quantity": 1,
"location_id": 5,
"serial_number": "XTS5487",
"complementary_fields":
[
{
"name": "modelo",
"value": "21"
},
{
"name": "cor",
"value": "preto"
}
],
"provisioning":
{
"controller_id": 17,
"controller_port_id": 18,
"onu_id": 8,
"scripts": [12, 15, 17],
"authentication_id": 2,
"ip_id": 7,
}
}
}
</syntaxhighlight>

'''Detalhamento dos campos'''
<table style="border-collapse: collapse; width: 100%;" border="1">
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">ID</td>
<td style="width: 4.11634%; height: 18px;">Campo</td>
<td style="width: 0.696864%; height: 18px;">Obrigatório</td>
<td style="width: 0.696864%; height: 18px;">Pai</td>
<td style="width: 3.16901%; height: 18px;">Tipo</td>
<td style="width: 27.3043%; height: 18px;">Observações</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 4.11634%; height: 18px;">Dados do equipamento</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">Raiz</td>
<td style="width: 3.16901%; height: 18px;">-</td>
<td style="width: 27.3043%; height: 18px;"> </td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 4.11634%; height: 18px;">product_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Código interno do produto (id).
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 4.11634%; height: 18px;">customer_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Código do cliente.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 4.11634%; height: 18px;">contract_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Número do contrato do cliente.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A05</td>
<td style="width: 4.11634%; height: 18px;">activation_date</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Data</td>
<td style="width: 27.3043%; height: 18px;">
Data de ativação do equipamento no formato AAAA-MM-DD
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A06</td>
<td style="width: 4.11634%; height: 18px;">quantity</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Decimal (15.2)</td>
<td style="width: 27.3043%; height: 18px;">
Quantidade do produto que será alocado em comodato. Para itens controlados por serial, este campo deverá ser informado sempre com o valor igual a "1".
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A07</td>
<td style="width: 4.11634%; height: 18px;">location_id</td>
<td style="width: 0.696864%; height: 18px;">Não*</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Para itens não controlados por serial: código da locação de estoque de onde ocorrerá a saída do produto.
Para itens controlados por serial: não informar
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A08</td>
<td style="width: 4.11634%; height: 18px;">serial_number</td>
<td style="width: 0.696864%; height: 18px;">Não*</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Para itens controlados por serial: número do serial que será alocado ao cliente
Para itens não controlados por serial: não informar
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A09</td>
<td style="width: 4.11634%; height: 18px;">complementary_fields</td>
<td style="width: 0.696864%; height: 18px;">Não*</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
Campo do tipo lista contendo um ou mais dados de campos complementares do equipamento. Os campos complementares de equipamento poderão estar definidos como obrigatórios no sistema.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">B01</td>
<td style="width: 4.11634%; height: 18px;">name</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A09</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Nome do campo complementar, conforme cadastrado no sistema.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">B02</td>
<td style="width: 4.11634%; height: 18px;">value</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A09</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Valor do campo complementar.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A10</td>
<td style="width: 4.11634%; height: 18px;">provisioning</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Objeto</td>
<td style="width: 27.3043%; height: 18px;">
Elemento que conterá dados para provisionamento do equipamento.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C01</td>
<td style="width: 4.11634%; height: 18px;">controller_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Id do controlador do equipamento.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C02</td>
<td style="width: 4.11634%; height: 18px;">controller_port_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
Id da porta do controlador do equipamento.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C03</td>
<td style="width: 4.11634%; height: 18px;">onu_id</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
ONU ID do equipamento.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C04</td>
<td style="width: 4.11634%; height: 18px;">scripts</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
Lista contendo os ids dos scripts e grupos de scripts para provisionamento.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C05</td>
<td style="width: 4.11634%; height: 18px;">authentication_id</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
Id da autenticação do cliente.
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">C06</td>
<td style="width: 4.11634%; height: 18px;">ip_id</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A10</td>
<td style="width: 3.16901%; height: 18px;">Booleano</td>
<td style="width: 27.3043%; height: 18px;">
Id do IP do cliente
</td>
</tr>
</table>
 
'''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":
{
"equipament_id": 1254,
"produt_movement_id": 62457
}
}
</syntaxhighlight>

Os campos retornados no elemento result são: 
- '''equipment_id''': id do equipamento incluído (será necessário informar na desativação). 
- '''product_movement_id''': id da movimentação de estoque gerada. 

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

<syntaxhighlight lang="json" line="1">
{
"status": 0,
"error_code": 12,
"error_description": "Internal Server Error!",
"result": ""
}
</syntaxhighlight>

Alocação de equipamento em comodato - Histórico de revisão

Felipe: Criou página com 'O objetivo deste serviço é alocar um equipamento em comodato em um cliente. Abaixo, segue exemplo do json de envio: { "equipment_le...'