Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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


01. INTRODUÇÃO

Inicia Esta API inicia o processamento de validação e geração dos beneficiários do de um lote (BJ6) 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.

...

NomeTipoLocalizaçãoDescrição

Content-Type

string

headermultipart/form-data ou application/json (body)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>.

Estado
subtletrue
colourRed
titleRequired

batchCodestring

body

Código do lote para iniciar o processamento.

Estado
subtletrue
colourRed
titleRequired

...

Informações
iconfalse
Dica

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.

Nota
iconfalse

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

Informações
iconfalse
Aviso

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

Aviso

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.

Aviso

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

Aviso

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

CampoTipoDescrição
code

Estado
subtletrue
titleINTEGER

Código identificador do erro.
message

Estado
subtletrue
titlestring

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

Estado
subtletrue
titlestring

Mensagem técnica e mais detalhada do erro.
Bloco de código
languagec#
themeMidnight
titleExemplo JSON de Erro
collapsetrue
{
  "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."
}

...