Desativação de equipamento em comodato

De RBX ISP - Manual do Usuário
Revisão de 08h53min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é desativar um equipamento que está alocado em comodato em um cliente. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é desativar um equipamento que está alocado em comodato em um cliente. Abaixo, segue exemplo do json de envio:

{
  "equipment_lending_disable":
  {
    "equipment_id": 1254, 
    "customer_id": 658, 
    "contract_id": 1548,
    "disabled_date": "2019-10-10",
    "reason": "cancellation",
    "location_id": 5,
    "open_ticket_to_remove_from_network": false
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 Dados do equipamento Sim Raiz -  
A02 equipment_id Sim A01 Número

Código interno do equipamento alocado em comodato (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 disabled_date Sim A01 Data

Data de desativação do equipamento no formato AAAA-MM-DD

A06 reason Sim A01 Texto

Motivo da desativação do equipamento. Valores permitidos:

  • cancellation: cancelamento
  • change: troca
  • defect: defeito
A07 location_id Sim A01 Número

Código da locação de estoque para onde o produto irá retornar.

A08 open_ticket_to_remove_from_network Não A01 Booleano

Define se deverá ser aberto um atendimento para retirada do equipamento da rede, quando o equipamento estiver cadastrado na rede. Valores permitidos:

  • true: abre o atendimento
  • false: não abre o atendimento

 

Mensagem de retorno

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

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": "Equipment successfully disabled!"
}

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

{
  "status": 0,
  "error_code": 12,
  "error_description": "Internal Server Error!",
  "result": ""
}