Geração de contrato em html

De RBX ISP - Manual do Usuário
Revisão de 08h22min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é gerar um contrato em html, com as palavras mágicas substituídas, conforme os modelos existentes. Cada modelo de contrato gerado será retornado...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é gerar um contrato em html, com as palavras mágicas substituídas, conforme os modelos existentes. Cada modelo de contrato gerado será retornado em base 64. Abaixo, segue exemplo do json de envio:

{
  "contract_generate_html":
  {
    "customer_id": 22563, 
    "contract_id": 65874, 
    "contract_model_id": [15, 16, 18]
  }
}

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

A04 contract_model_id Não A01 Lista

Lista contendo os ids dos modelos de contrato para emissão. Deixando em branco, o sistema irá utilizar os modelos que já estiverem salvos no 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_model_id": 15,
      "contract_model_html": "VGVzdGU=",
    },
    {
      "contract_model_id": 16,
      "contract_model_html": "Q29udHJhdG8gZ2VyYWRvIGVtIGh0bWw=",
    },
    {
      "contract_model_id": 17,
      "contract_model_html": "Q29udHJhdG8gZ2VyYWRvIGVtIGh0bWwgIGJhc2UgNjQ=",
    }
  ]
}

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

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