Pular para o conteúdo principal

Lista de especies

GET /parameterizations/species

HTTP
GET /parameterizations/species HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Para listar as especies, utilizamos a seguinte url: {{url}}/parameterizations/species

URL Params

Query stringTipoDescriçãoObrigatório
fieldsQuery stringO valor da query é os campos disponiveis separados por virgulas, query usada para montar o retorno do objeto.
conditions[fieldName]Query stringO 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.

CampoQuery stringDescriçãoObrigatório
idfields & conditions[fieldName]Identificador
alterado_emfields & conditions[fieldName]Mostra quando os dados foram alterados
alterado_porfields & conditions[fieldName]Mostra quem alterou os dados
criado_emfields & conditions[fieldName]Mostra quando os dados foram criados
codigo_inssfields & conditions[fieldName]Mostra o codigo inss
descricaofields & conditions[fieldName]Mostra a descrição
statusfields & conditions[fieldName]Mostra o status

Requisição

GET
GET {{url}}/parameterizations/species

Resposta

200
{
"status": "success",
"message": "Lista de especies",
"document": [
{
"id": number,
"alterado_em": string,
"alterado_por": string,
"criado_em": string,
"codigo_inss": number,
"descricao": string,
"status": string
},
],
}

Errors

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401UNAUTHORIZEDO servidor não autorizou a requisição. Access Token inválido.
403FORBIDDENO servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404NOT FOUNDO servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição.