Linha Microsiga Protheus

Árvore de páginas


CONTEÚDO

  1. Introdução
  2. Endpoint
  3. Parâmetros
  4. Resposta


01. INTRODUÇÃO

Esta API permite reprocessar um lote de beneficiários enviando um novo arquivo CSV com os registros a serem corrigidos. O processamento é assíncrono, iniciando imediatamente a validação e a geração dos beneficiários contidos no arquivo enviado.

Clique aqui para detalhes sobre como habilitar o serviço de APIs no Protheus.

02. ENDPOINT

POST /totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/reprocess

03. PARÂMETROS

NomeTipoLocalizaçãoDescrição

Content-Type

string

headermultipart/form-data ou application/json (dependendo do formato do corpo da requisição).
Authorizationstring

header

Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. REQUIRED

importBatchCodestring

body/form

Código do lote que será reprocessado REQUIRED

filefile

form-data

Arquivo CSV com os beneficiários REQUIRED

fileBase64string

body

Arquivo CSV em Base64 REQUIRED

fileNamestring

body

Nome do arquivo CSV REQUIRED

Pode-se enviar o arquivo CSV dos beneficiários via file (form-data) ou fileBase64 (body) com o fileName.

Exemplo de Body 
{
  "importBatchCode": "00000155",
  "fileBase64": "QjJOX0NPRFNFUTtCMk5fQ1BGVVNSO0IyTl9OT01VU1I7QjJOX0RBVE5BUztCMk5...",
  "fileName": "modelo-importacao-beneficiarios.csv"
}

04. RESPOSTA

202 - Operação aceita para processamento

O lote iniciou o reprocessamento de forma assíncrona. Durante o processamento, o status do lote será atualizado para Em Processamento, além de anexar o arquivo CSV de correção ao banco de conhecimento do lote.

400 - Formato de JSON inválido.
O corpo da requisição não está em um formato JSON válido. Verifique a estrutura e tente novamente.

400 - O parâmetro não foi informado.
O parâmetro obrigatório deve ser enviado na requisição.

400 - O parâmetro não foi informado.
O parâmetro obrigatório deve ser enviado na requisição.

400 - Este lote não pode ser ajustado, pois não está com erro de importação.
O reprocessamento foi recusado. O lote informado não possui status (BJ5_STATUS) de erro de importação.

400 - Erro ao processar o arquivo CSV
Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido.

406 - Formato de dados inválido.
Os dados enviados não estão no formato form-data. Verifique se o Content-Type da requisição está definido como multipart/form-data e se os campos foram corretamente estruturados.

CampoTipoDescrição
code

INTEGER

Código identificador do erro.
message

STRING

Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage

STRING

Mensagem técnica e mais detalhada do erro.
Exemplo JSON de Erro 
{
  "status": 400,
  "message": "Erro ao processar o arquivo CSV",
  "detailedMessage": "Não foi possível obter o arquivo CSV. Verifique se o arquivo está disponível e se está em um formato válido."
}