Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 O cronograma e planejamento dos ciclos pode ser consultado na imagem abaixo:

...

Resposta esperada das APIs em caso de requisição antes da disponibilização dos dados

Durante o processo de disponibilização dos dados, caso haja requisições da receptora antes que esse processo seja concluído, as APIs devem retornar uma resposta padrão que informe a indisponibilidade temporária dos dados, seguindo as diretrizes informadas abaixo:

  1. API de Resources:

Caso a receptora consulte a listagem de recursos antes que a disponibilização dos dados tenha sido concluída, a transmissora deverá retornar a listagem dos recursos com o status “TEMPORARY_UNAVAILABLE”. Isso indica que os dados ainda não estão disponíveis para consumo.

Exemplo – GET /resources:​

Code Block
{​
  "data": [​
    {​
      "resourceId": "25cac914-d8ae-6789-b215-650a6215820d",​
      "type": "CAPITALIZATION_TITLES",​
      "status": "TEMPORARILY_UNAVAILABLE"​
    }​
  ],​
  ...​
}
  1. API de Dados:

Caso a receptora consulte a API de Dados antes que os dados tenham sido disponibilizados, a transmissora retornará um erro 404 – Not Found, juntamente com o código de status “STATUS_RESOURCE_TEMPORARY_UNAVAILABLE”. Esse comportamento permite que a receptora saiba que os dados ainda não foram disponibilizados e não estão acessíveis naquele momento.

Exemplo – GET /insurance-capitalization-title/{25cac914-d8ae-6789-b215-650a6215820d}/plan-info:​

Code Block
{
  “errors": [​
    {​
      “code": “STATUS_RESOURCE_TEMPORARY_UNAVAILABLE",​
      “title": “Dado em processo de disponibilização",​
      “detail": “Dado ainda não disponibilizado – Tente novamente mais tarde“,​
      "requestDateTime": "2024-10-02T09:00:00Z"​
    }​
  ],​
  ...​
}​