CONTEÚDO

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


01. INTRODUÇÃO

Esta API inicia o processamento de validação e geração dos beneficiários de um lote na rotina de análise de beneficiários (PLSA977AB). O processo é executado de forma assíncrona, permitindo que o cliente acompanhe o status posteriormente.

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

02. ENDPOINT

/totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/start

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

batchCodestring

body

Código do lote para iniciar o processamento. 

{
  "batchCode": "00000155"
}

04. RESPOSTA

202 - Operação aceita para processamento

Retorna no cabeçalho da resposta o campo Location, apontando para:

/totvsHealthPlans/familyContract/v1/beneficiaries/importBatches/{batchCode}

Esse endpoint pode ser utilizado para acompanhar o status do processamento.

O status do lote será atualizado para Em Processamento durante a execução.

400 - O lote não está disponível para processamento. Verifique o status atual.
Não é permitido processar o lote. O status atual deve ser 'Recebido' ou 'Erro'.

404 - O lote informado não foi encontrado. Verifique o código e tente novamente.
Lote de beneficiários com o código informado não localizado na tabela BJ5 (campo BJ5_CODLOT) durante o processo de importação.

406 - Os campos do json no body estão inválidos.
Verifique a lista de erros no campo details para mais detalhes.

406 - JSON inválido
"Mensagem de erro ao converter string para objeto JSON"

CampoTipoDescrição
code

Código identificador do erro.
message

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

Mensagem técnica e mais detalhada do 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."
}