Lista de Registros

1 Método "listaRegistros”
- 1.1 Endpoint
- 1.2 Parâmetros de entrada
- 1.3 Exemplo request
- 1.4 Descrição dos objetos e atributos de retorno - Sucesso
- 1.5 Exemplo de retorno com "sucesso”
- 1.6 Retorno da API - Falha

Só são suportadas integrações no padrão REST.

Método "listaRegistros”

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Este método irá retornar a lista de declarações disponíveis relacionadas ao beneficiário.

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com listaRegistros Atenção O endpoint obrigatoriamente deve terminar com “/listaRegistros”.	POST	application/json	Endpoint para listar registros relacionadas ao localizador (chaveUnica)

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
integracao	M	Objeto
chaveUnica	M	String

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/listaRegistros

Body:
{
  "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
      },
  "chaveUnica": "string"
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
tipoRegistros	M	Array de objetos ”tipoRegistros”	Retorna um array de objetos “tipoRegistros”	Deve retornar um array de objetos

{
  "tipoRegistros": [Array-objetos]
}

Objeto tipoRegistros

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
nome	M	String	Tipo das declarações	Texto livre
registros	M	Array de objetos “registro”	Retorna um array de objetos “registro”	Deve retornar um array de objetos

{
  "tipoRegistros": [
    {
      "nome": "string",
      "registros": [Array-objetos]
}

Objeto registro

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	titulo do item	Formato: Texto livre.
subTitulo	M	String	subtitulo do item	Formato: Texto livre.
idRegistro	M	String	identificar do item	Formato: Texto livre.

{
  "tipoRegistros": [
    {
      "nome": "string",
      "registros": [
        {
          "titulo": "string",
          "subTitulo": "string",
          "idRegistro": "string"
        }
      ]
    }

Exemplo de retorno com "sucesso”

{
  "tipoRegistros": [
    {
      "nome": "Imposto de Renda",
      "registros": [
        {
          "titulo": "2020",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:IRPF:3020170703122640"
        },
        {
          "titulo": "2019",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:IRPF:3020170703122641"
        }
      ]
    },
    {
      "nome": "INSS",
      "registros": [
        {
          "titulo": "2020",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:INSS:3020170703122640"
        },
        {
          "titulo": "2019",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:INSS:3020170703122641"
        },
        {
          "titulo": "2018",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:INSS:3020170703122642"
        },
        {
          "titulo": "2017",
          "subTitulo": "Contrato - 020221",
          "idRegistro": "2020:INSS:3020170703122643"
        }
      ]
    }
  ]
}

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;

Mosia Omnichannel