Lista de campos por produtos
GET /parameterizations/fieldsByProduct/list
HTTP
GET /parameterizations/fieldsByProduct/list HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}
Para listar os campos disponiveis por produtos, utilizamos a seguinte url:
{{url}}/parameterizations/fieldsByProduct/list
URL Params
| Query string | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| fields | Query string | O valor da query é os campos disponiveis separados por virgulas, query usada para montar o retorno do objeto. | ✗ |
| conditions[fieldName] | Query string | O valor da query é o dado do campo informado entre os "[]", query usada como condição para filtrar o retorno de dados. | ✗ |
Campos disponiveis para montar o objeto e / ou filtrar a lista.
| Campo | Query string | Descrição | Obrigatório |
|---|---|---|---|
| id | fields & conditions[fieldName] | Identificador | ✗ |
| alterado_em | fields & conditions[fieldName] | Mostra quando os dados foram alterados | ✗ |
| alterado_por | fields & conditions[fieldName] | Mostra quem alterou os dados | ✗ |
| criado_em | fields & conditions[fieldName] | Mostra quando os dados foram criados | ✗ |
| codigo_produto | fields & conditions[fieldName] | Mostra o código do produto | ✗ |
| nacionalidade | fields & conditions[fieldName] | Mostra a nacionalidade | ✗ |
| genero | fields & conditions[fieldName] | Mostra o gênero | ✗ |
| estado_civil | fields & conditions[fieldName] | Mostra o estado civil | ✗ |
| profissao | fields & conditions[fieldName] | Mostra a profissão | ✗ |
| especie | fields & conditions[fieldName] | Mostra a espécie | ✗ |
| numero | fields & conditions[fieldName] | Mostra o número | ✗ |
| salario | fields & conditions[fieldName] | Mostra o salário | ✗ |
| operacao_bancaria | fields & conditions[fieldName] | Mostra a operação bancária | ✗ |
| flags | fields & conditions[fieldName] | Mostra as flags | ✗ |
| debito | fields & conditions[fieldName] | Mostra o débito | ✗ |
| cartao | fields & conditions[fieldName] | Mostra o cartão | ✗ |
| desconto_em_folha | fields & conditions[fieldName] | Mostra o desconto em folha | ✗ |
| orgao_emissor | fields | Mostra o órgão emissor | ✗ |
| holerite | fields | Mostra o holerite | ✗ |
Requisição
GET
GET {{url}}/parameterizations/fieldsByProduct/list
Resposta
200
{
"status": "success",
"message": "Lista de campos por produtos",
"document": [
{
"id": number,
"alterado_em": date,
"alterado_por": string,
"criado_em": date,
"codigo_produto": number,
"nacionalidade": boolean,
"genero": boolean,
"estado_civil": boolean,
"profissao": boolean,
"especie": boolean,
"numero": boolean,
"salario": boolean,
"operacao_bancaria": boolean,
"flags": boolean,
"debito": boolean,
"cartao": boolean,
"desconto_em_folha": boolean,
"orgao_emissor": boolean,
"holerite": boolean
},
],
}
Errors
| Código | Referência | Explicação |
|---|---|---|
| 400 | BAD REQUEST | O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico. |
| 401 | UNAUTHORIZED | O servidor não autorizou a requisição. Access Token inválido. |
| 403 | FORBIDDEN | O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso. |
| 404 | NOT FOUND | O servidor não encontrou o recurso ou não está disposto a divulgar sua existência. |
| 422 | UNPROCESSABLE ENTITY | O servidor não conseguiu processar as informações contidas na requisição. |