Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXXExtrato de Autorizações
    1. Outras Ações / Ações relacionadas
  4. Tela XXXExtrato de Autorizações
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não existem itens a serem visualizados"
}

Estrutura de Retorno

AtributoTipoDescrição
statusBoolean

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
itensArrayLista de objetos de “itens“
itemIdCaracterChave única do item da guia de autorização (Operadora + Ano + Mês + Numero + Sequencial)
procedimentoCaracterCódigo do procedimento
procedimentoDescricaoCaracterDescrição do procedimento
statusIdNumericCódigo do status, conforme retorno do método guiaStatus. (Status da TISS)
quantidadeSolicitadaNumericQuantidade solicitada
quantidadeAutorizadaNumericQuantidade autorizada pela operadora
dataAutorizacaoCaracterData da autorização do procedimento (Formato: YYYY-MM-DD)

Método guiaPdf

Este método irá retornar uma URL ou uma string BASE64 do arquivo PDF da guia completa.

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno

AtributoTipoDescrição
statusBoolean

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
binarioCaracter em base64Conteúdo binário do tipo base64, do arquivo PDF da guia a ser impressa
urlCaracterURL do arquivo PDF informado no cadastro da Operadora

Método guiaStatus

Retorna a tabela de domínio dos status da autorização, para que possamos montar as legendas da listagem.

...

Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "autorizacaoStatus": [
        {
            "chaveStatus": "1",
            "descricao": "Autorizado"
        },
        {
            "chaveStatus": "2",
            "descricao": "Em análise"
        },
        {
            "chaveStatus": "3",
            "descricao": "Negado"
        },
        {
            "chaveStatus": "4",
            "descricao": "Aguardando justificativa técnica do solicitante"
        },
        {
            "chaveStatus": "5",
            "descricao": "Aguardando documentação do prestador"
        },
        {
            "chaveStatus": "6",
            "descricao": "Solicitação cancelada"
        },
        {
            "chaveStatus": "7",
            "descricao": "Autorizado parcialmente"
        }
    ]
}

Estrutura de Retorno

AtributoTipoDescrição
statusBoolean

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
autorizacaoStatusArrayLista de objetos de “autorizacaoStatus“
chaveStatusCaracterCódigo de identificação do status da autorização
descricaoCaracterDescrição do status


Veja um exemplo de como a comunicação com a API é feita na prática: 

...