Exibir código-fonte para Alocação de equipamento em comodato

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;"><strong>ID</strong></td>
			<td style="width: 4.11634%; height: 18px;"><strong>Campo</strong></td>
			<td style="width: 0.696864%; height: 18px;"><strong>Obrigat&oacute;rio</strong></td>
			<td style="width: 0.696864%; height: 18px;"><strong>Pai</strong></td>
			<td style="width: 3.16901%; height: 18px;"><strong>Tipo</strong></td>
			<td style="width: 27.3043%; 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: 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;">&nbsp;</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&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>C&oacute;digo interno do produto (id).</p>
			</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&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>C&oacute;digo do cliente.</p>
			</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&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>N&uacute;mero do contrato do cliente.</p>
			</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;">
				<p>Data de ativa&ccedil;&atilde;o do equipamento no formato AAAA-MM-DD</p>
			</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;">
				<p>Quantidade do produto que ser&aacute; alocado em comodato. Para itens controlados por serial, este campo dever&aacute; ser informado sempre com o valor igual a "1".</p>
			</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&atilde;o*</td>
			<td style="width: 0.696864%; height: 18px;">A01</td>
			<td style="width: 3.16901%; height: 18px;">N&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>Para itens n&atilde;o controlados por serial: c&oacute;digo da loca&ccedil;&atilde;o de estoque de onde ocorrer&aacute; a sa&iacute;da do produto.</p>
				<p>Para itens controlados por serial: n&atilde;o informar</p>
			</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&atilde;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;">
				<p>Para itens controlados por serial: n&uacute;mero do serial que ser&aacute; alocado ao cliente</p>
				<p>Para itens n&atilde;o controlados por serial: n&atilde;o informar</p>
			</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&atilde;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;">
				<p>Campo do tipo lista contendo um ou mais dados de campos complementares do equipamento. Os campos complementares de equipamento poder&atilde;o estar definidos como obrigat&oacute;rios no sistema.</p>
			</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;">
				<p>Nome do campo complementar, conforme cadastrado no sistema.</p>
			</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;">
				<p>Valor do campo complementar.</p>
			</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&atilde;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;">
				<p>Elemento que conter&aacute; dados para provisionamento do equipamento.</p>
			</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&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>Id do controlador do equipamento.</p>
			</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&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>Id da porta do controlador do equipamento.</p>
			</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&atilde;o</td>
			<td style="width: 0.696864%; height: 18px;">A10</td>
			<td style="width: 3.16901%; height: 18px;">N&uacute;mero</td>
			<td style="width: 27.3043%; height: 18px;">
				<p>ONU ID do equipamento.</p>
			</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;">
				<p>Lista contendo os ids dos scripts e grupos de scripts para provisionamento.</p>
			</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&atilde;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;">
				<p>Id da autentica&ccedil;&atilde;o do cliente.</p>
			</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&atilde;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;">
				<p>Id do IP do cliente</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":
  {
     "equipament_id": 1254,
     "produt_movement_id": 62457
  }
}
</syntaxhighlight>

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

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>