Histórico da Página

CONTEÚDO

Introdução
Endpoint
Parâmetros
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 status do lote será atualizado para Em Processamento durante a execução.
O processamento é assíncrono, iniciando imediatamente a validação e 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

Estado


colour	Green
title	POST

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

03. PARÂMETROS

Nome

Tipo

Localização

Descrição

Content-Type

string

header

multipart/form-data ou application/json (body)

Authorization

string

header

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

Estado

subtle	true
colour	Red
title	Required

importBatchCode

string

body/form

Código do lote que será reprocessado

Estado

subtle	true
colour	Red
title	Required

file

form-data

Arquivo CSV com os beneficiários

Estado

subtle	true
colour	Red
title	Required

fileBase64

string

body

Arquivo CSV em Base64

Estado

subtle	true
colour	Red
title	Required

fileName

string

body

Nome do arquivo CSV

Estado

subtle	true
colour	Red
title	Required

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

Bloco de código

language	c#
theme	Midnight
title	Exemplo de Body
collapse	true

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

04. RESPOSTA

Informações

icon	false

Dica
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.

Informações

icon	false

Aviso
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.

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

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

Aviso
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.

Aviso
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.

Aviso
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.

Campo

Tipo

Descrição

code

Estado


subtle	true
title	INTEGER

Código identificador do erro.

message

Estado

subtle	true
title	string

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

detailedMessage

Estado

subtle	true
title	string

Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo JSON de Erro
collapse	true

{
  "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."
}

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

CONTEÚDO

01. INTRODUÇÃO

02. ENDPOINT

03. PARÂMETROS

04. RESPOSTA

202 - Operação aceita para processamento

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.

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

CONTEÚDO

01. INTRODUÇÃO

02. ENDPOINT

03. PARÂMETROS

04. RESPOSTA

202 - Operação aceita para processamento

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 CSVNã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.

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.