Histórico da Página

...

Informações

icon	false

Dica
200 - Operação realizada com sucesso

Campo

Tipo

Descrição

hasNext

Estado


subtle	true
title	boolean

Indica se ainda existem registros a serem retornados

remainingRecords

Estado


subtle	true
title	integer

Quantidade de registros ainda existentes para retorno

items

Estado


subtle	true
title	array

Lista de beneficiários do lote de importação.

Estrutura do objeto items

Campo

Tipo

Descrição

Campo (Protheus)

familyId

Estado

subtle	true
title	string

Código da família no lote

BJ6_CODFAM

cpf

Estado

subtle	true
title	string

CPF do beneficiário

BJ6_CPFBEN

name

Estado

subtle	true
title	string

Nome do beneficiário

BJ6_NOMBEN

kinship

Estado

subtle	true
title	string

Grau de parentesco

BJ6_GRAUPA

status

Estado

subtle	true
title	string

Status da importação

BJ6_STATUS

protocol

Estado

subtle	true
title	string

Número do protocolo gerado na análise

BJ6_PROTOC

protocolStatus

Estado

subtle	true
title	string

Status do protocolo na análise

BBA_STATUS

observation

Estado

subtle	true
title	string

Observações e críticas do beneficiário

BJ6_OBSBEN

Bloco de código

language	c#
theme	Midnight
title	Exemplo
collapse	true

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

icon	false

Bloco de código

language	c#
theme	Midnight
title	Exemplo JSON de Resposta (sem registros)
collapse	true

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

language	c#
theme	Midnight
title	Exemplo JSON de Resposta (sem registros)
collapse	true

{ "hasNext": false, "remainingRecords": 0, "items": [] }

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

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

200 - Operação realizada com sucesso

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

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.

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

200 - Operação realizada com sucesso

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

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.

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

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.