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:
{
"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,
}
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados do equipamento | Sim | Raiz | - | |
A02 | product_id | Sim | A01 | Número |
Código interno do produto (id). |
A03 | customer_id | Sim | A01 | Número |
Código do cliente. |
A04 | contract_id | Sim | A01 | Número |
Número do contrato do cliente. |
A05 | activation_date | Sim | A01 | Data |
Data de ativação do equipamento no formato AAAA-MM-DD |
A06 | quantity | Sim | A01 | Decimal (15.2) |
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". |
A07 | location_id | Não* | A01 | Número |
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 |
A08 | serial_number | Não* | A01 | Texto |
Para itens controlados por serial: número do serial que será alocado ao cliente Para itens não controlados por serial: não informar |
A09 | complementary_fields | Não* | A01 | Lista |
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. |
B01 | name | Sim | A09 | Texto |
Nome do campo complementar, conforme cadastrado no sistema. |
B02 | value | Sim | A09 | Texto |
Valor do campo complementar. |
A10 | provisioning | Não | A01 | Objeto |
Elemento que conterá dados para provisionamento do equipamento. |
C01 | controller_id | Sim | A10 | Número |
Id do controlador do equipamento. |
C02 | controller_port_id | Sim | A10 | Número |
Id da porta do controlador do equipamento. |
C03 | onu_id | Não | A10 | Número |
ONU ID do equipamento. |
C04 | scripts | Sim | A10 | Lista |
Lista contendo os ids dos scripts e grupos de scripts para provisionamento. |
C05 | authentication_id | Não | A10 | Texto |
Id da autenticação do cliente. |
C06 | ip_id | Não | A10 | Booleano |
Id do IP do cliente |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result":
{
"equipament_id": 1254,
"produt_movement_id": 62457
}
}
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:
{
"status": 0,
"error_code": 12,
"error_description": "Internal Server Error!",
"result": ""
}