CONTEÚDO

  1. Visão Geral
    1. Rota
    2. Parâmetros de Entrada
    3. Retorno
  2. Regras de Negócio Aplicadas
  3. 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 de Coparticipação do Beneficiario/PeriodosDemonstrativoCoparticipacao tem por objetivo retornar os períodos/competências do extrato de coparticipação do beneficiário retroativos à data de requisição (12 meses).

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

a. Rota

/Beneficiario/v1/PeriodosDemonstrativoCoparticipacao

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:

{
  "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": [
    {
      "id": "Campo de identificação da competência",
      "nome": "Descrição da competência que será exibida no aplicativo"
    }
  ],
  "DebugMessage": "string"
}

03. REGRAS DE NEGÓCIO APLICADAS

A API retorna uma lista com de períodos os últimos 12 (doze) meses, à partir da data  em que se está realizando a requisição, para a posterior consulta do extrato de coparticipação.

04. EXEMPLO DE UTILIZAÇÃO

Se a requisição ocorrer no dia 11/03/2020, por exemplo, então a API irá retornar:

{
  "Result": 1,
  "Data": [
	{
      "id": "03/2020",
      "nome": "02/2020"
    },
	{
      "id": "02/2020",
      "nome": "02/2020"
    },
	{
      "id": "01/2020",
      "nome": "01/2020"
    },
	{
      "id": "12/2019",
      "nome": "12/2019"
    },
	{
      "id": "11/2019",
      "nome": "11/2019"
    },
	{
      "id": "10/2019",
      "nome": "10/2019"
    },
	{
      "id": "09/2019",
      "nome": "09/2019"
    },
    {
      "id": "08/2019",
      "nome": "08/2019"
    },
    {
      "id": "07/2019",
      "nome": "07/2019"
    },
    {
      "id": "06/2019",
      "nome": "06/2019"
    },
	{
      "id": "05/2019",
      "nome": "05/2019"
    }
	{
      "id": "04/2019",
      "nome": "04/2019"
    }
  ],
  "DebugMessage": "",
  "Message": ""
}



<!-- 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>