Histórico da Página

CONTEÚDO

Visão Geral
1. Rota
2. Parâmetros de Entrada
3. Retorno
Regras de Negócio Aplicadas
Exemplo de Utilização

01. VISÃO GERAL

O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração com o APP da Unimed Brasil.

A API Extrato Competências (Medico/ExtratoCompetencias) tem por objetivo retornar as últimas seis (6) competências referente ao extrato de contas do médico.

A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil:

a. Rota

/Medico/v1/ExtratoCompetencias

b. Parâmetros de Entrada

Esta API não exige parâmetros de entrada.

c. Retorno

O objeto Json de retorno da API possui a seguinte estrutura:

Bloco de código

{
  "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok",
  "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)",
  "Data": [
    {
      "nome": "Nome da competência que será exibido em tela",
      "valor": "Valor da competência é o filtro utilizado na consulta do serviço Extrato"
    }
  ],
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista contendo as últimas seis (6) competências referente ao extrato de contas do médico.

04. EXEMPLO DE UTILIZAÇÃO

Se a requisição ocorrer no dia 04/08/2021, por exemplo, então a API irá retornar:

Bloco de código

{
    "Result": 1,
    "Data": [
        {
            "valor": "08/2021",
            "nome": "08/2021"
        },
        {
            "valor": "07/2021",
            "nome": "07/2021"
        },
        {
            "valor": "06/2021",
            "nome": "06/2021"
        },
        {
            "valor": "05/2021",
            "nome": "05/2021"
        },
        {
            "valor": "04/2021",
            "nome": "04/2021"
        },
        {
            "valor": "03/2021",
            "nome": "03/2021"
        }
    ],
    "DebugMessage": "",
    "Message": ""
}

HTML

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave