Histórico da Página

06. EXEMPLOS DE JSONS DE RESPOSTA

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tela XXX
   1. Outras Ações / Ações relacionadas
      
4. Configurações INI
5. Verbos
6. Uso da API - POST
7. Atributos de Resposta
8. Exemplos de JSON de RespostaTela XXXPrincipais Campos e Parâmetros
9. Tabelas utilizadas

01. VISÃO GERAL

...

• 01. Configuração
• Exemplo de configuração do REST

03. VERBOS

Seguem os verbos disponíveis na API:

04. USO DA API - POST

A API não tem QueryParams específicos, ela recebe um JSON no body com o seguintes conteúdo:

{
    "batchNumber": "123456",
    "authType": "2",
    "idOnHealthInsurer":[
        "000120221100000032",
        "000120221100000033"
    ]
}

Lote 00000850 criado no sistema de gestão. As guias selecionadas foram movidas para este novo lote com um Local de Digitação válido para ser faturado:

Image Added

Na tabela da PEG criada, há a marcação que é um lote processado por este processo (BCI_LOTHAT):

Image Added

05

...

. ATRIBUTOS DE RESPOSTA

O JSON de resposta retorna o número do lote gerado no sistema de gestão SIGAPLS, valor do lote e quantidade de guias:

06. EXEMPLOS DE JSON DE RESPOSTA

{
    "batchNumber": "00000850",
    "value": 4.48,
    "formQuantity": 2
}

{
    "code": 400,
    "message": "Bad Request",
    "detailedMessage": "Nao foram encontradas no SIGAPLS todas as guias informadas para processamento",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

06. TABELAS UTILIZADAS

• Criação de campo na tabela BCI: