Bloqueio de contrato

De RBX ISP - Manual do Usuário
Revisão de 08h09min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é realizar o bloqueio de um contrato que esteja Ativo. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "contract...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é realizar o bloqueio de um contrato que esteja Ativo. Abaixo, segue exemplo do json de envio:

{
  "contract_block":
  {
    "customer_id": 22563, 
    "contract_id": 65874
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 Dados da autenticação Sim Raiz -  
A02 customer_id Sim A01 Número

Código do cliente

A03 contract_id Sim A01 Número

Número do contrato

 

Mensagem de retorno

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

{

  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": "Contract blocked successfully"
}

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

{
  "status": 0,
  "error_code": 12,
  "error_description": "The field contract_id is invalid!",
  "result": ""
}