Alteração de contrato em degustação

De RBX ISP - Manual do Usuário
Revisão de 08h03min de 4 de junho de 2021 por Felipe (discussão | contribs)
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é possibilitar a alteração de um plano de degustação para o contrato de um cliente. É possível alterar o plano que será utilizado bem como os períodos de início e fim, desde que a degustação não tenha sido iniciada. Abaixo, segue exemplo do json de envio:

{
  "temporary_plan_update":
  {
    "id": 110
    "temporary_plan_id": 16,
    "start_period": "2019-05-01 00:00:00",
    "finish_period": "2019-05-03 23:59:59"
  }
}

Detalhamento dos campos

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

Id do registro retornado pelo serviço temporary_plan_insert.

A03 temporary_plan_id Sim A01 Número

Código do plano de degustação

A04 start_period Sim A01 Data e hora

Período de início. Para começar imediatamente, enviar nulo neste campo.

A05 finish_period Sim A01 Data e hora

Período de fim.

 

Mensagem de retorno

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

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": "Registry successfully updated"
}

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

{
  "status": 0,
  "error_code": 12,
  "error_description": "Document not found!",
  "result": ""
}