Home

Série 1

Páginas filhas
  • Department - Version 1.0

Versões comparadas

Chave

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

Esta entidade exibe informações sobre departamentos e suporta as seguintes operações: GET, POST, PUT e DELETE.

 

Campos do retorno

NomeDescriçãoTamanho do campoTipoMais detalhes
codeCódigo do departamento9Numérico-
descriptionNome do departamento100Caracter-
parentdepartmentCódigo do departamento superior9Numérico-

 

Exemplo de obtenção de informações específicas sobre o departamento:

/first/api/v1/Department/0102

{

"pk": "0102",
"id": "0102",
"description": "FLORES",
"parentdepartment": "01"

}


Exemplo de consulta e retorno com parâmetro

Retornando um departamento por parte da descrição do nome

/first/api/v1/Department?description=TULIPAS

{

"total": 1,
"hasNext": false,
"syncing": false,
"lines": [
{
"pk": "010202",
"id": "010202",
"description": "TULIPAS",
"parentdepartment": "0102"
}
]
}

 

Exemplo de inclusão e exclusão de registros

Para adicionar um novo departamento deve-se usar o método de POST, e no campo de requisição informar os campos necessários para inclusão. Observação: Para a alteração basta mudar o método para PUT e então realizar o mesmo procedimento abaixo.

/first/api/v1/Department

 

 

{

"pk": "010208 ",
"description": "DÁLIAS",
"parentdepartment": "0102" 
}

Retorno:

"url": "/first/api/v1/department/010208",
"id": "010208"
}

 

Para excluir um departamento deve-se usar o método de DELETE, e informar o registro que deve ser excluído, via URL

 

/first/api/v1/Department/010208

 

Retorno:

"url": "/first/api/v1/department/010208",
"id": "010208"
}