Árvore de páginas

Versões comparadas

Chave

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

...

Informações
iconfalse
Dica

200 - Operação realizada com sucesso

CampoTipoDescrição
hasNext

Estado
subtletrue
titleboolean

Indica se ainda existem registros a serem retornados
remainingRecords

Estado
subtletrue
titleinteger

Quantidade de registros ainda existentes para retorno
items

Estado
subtletrue
titlearray

Lista de beneficiários do lote de importação.
Estrutura do objeto items
CampoTipoDescriçãoCampo (Protheus)
familyId 

Estado
subtletrue
titlestring

Código da família no lote

BJ6_CODFAM

cpf 

Estado
subtletrue
titlestring

CPF do beneficiárioBJ6_CPFBEN
name 

Estado
subtletrue
titlestring

Nome do beneficiárioBJ6_NOMBEN
kinship 

Estado
subtletrue
titlestring

Grau de parentescoBJ6_GRAUPA
status 

Estado
subtletrue
titlestring

Status da importaçãoBJ6_STATUS
protocol 

Estado
subtletrue
titlestring

Número do protocolo gerado na análiseBJ6_PROTOC
protocolStatus 

Estado
subtletrue
titlestring

Status do protocolo na análiseBBA_STATUS
observation 

Estado
subtletrue
titlestring

Observações e críticas do beneficiárioBJ6_OBSBEN
Bloco de código
languagec#
themeMidnight
titleExemplo
collapsetrue
{
    "items": [
        {
            "familyId": "000001",
            "cpf": "30870587501",
            "name": "RYAN LORENZO CAMPOS",
            "kinship": "TITULAR",
            "status": "3",
            "protocol": "88888820250806102191",
            "protocolStatus": "7",
            "observation": ""
        },
        {
            "familyId": "000001",
            "cpf": "77561672950",
            "name": "CAUÊ ERICK ASSUNÇÃO",
            "kinship": "SOGRO",
            "status": "3",
            "protocol": "88888820250806102191",
            "protocolStatus": "7",
            "observation": ""
        }
    ],
    "hasNext": false,
    "remainingRecords": 0,
    "total": 2
}
Informações
iconfalse
Bloco de código
languagec#
themeMidnight
titleExemplo JSON de Resposta (sem registros)
collapsetrue
{
  "hasNext": false,
  "remainingRecords": 0,
  "items": []
}
Aviso

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

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.

Bloco de código
languagec#
themeMidnight
titleExemplo JSON de Resposta (sem registros)
collapsetrue
{ "hasNext": false, "remainingRecords": 0, "items": [] }

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": 404,
  "message": "O lote informado não foi encontrado. Verifique o código e tente novamente.",
  "detailedMessage": "Lote de beneficiários com o código informado não localizado na tabela BJ5 (campo BJ5_CODLOT) durante o processo de importação."
}

...