Lotações - GrupoBRA/GovAPI-Doc GitHub Wiki
Obtendo as lotações
GET /v1/lotacao/
Retorno:
{
"success":true,
"data":{
"GovernancaAPI":[
{
"lotacao_id":"{id}",
"lotacao":"Título da lotação",
"uupfid": "{snowflake_id}",
"data_hora": "{%Y-%m-%d}"
}
]
}
}
Obtendo uma lotação
GET /v1/lotacao/{lotacao_id}/
Retorno:
{
"success":true,
"data":{
"GovernancaAPI":{
"lotacao_id":"{id}",
"lotacao":"Título da lotação",
"uupfid": "{snowflake_id}",
"data_hora": "{%Y-%m-%d}"
}
}
}
Pesquisando as lotações por semelhança
GET /v1/lotacao/search/{needle}/
Retorno:
{
"success":true,
"data":{
"GovernancaAPI":[
{
"lotacao_id":"{id}",
"lotacao":"Título da lotação",
"uupfid": "{snowflake_id}",
"data_hora": "{%Y-%m-%d}"
}
]
}
}
Inserindo uma lotação
POST /v1/lotacao/
Insere uma nova lotação para o oid do usuário logado
Payload:
{
"lotacao": "(nome_lotação)",
}
Retorno:
{
"success":true,
"data":{
"GovernancaAPI": {
"lotacao_id":"{id}"
}
}
}
201 | 403 | 406 | 409
Alterando uma lotação
PUT /v1/lotacao/{lotacao_id}/
Altera o nome de uma lotação pela sua id
Payload:
{
"lotacao": "(nome_lotação)",
}
Retorno:
200 | 403 | 406 | 409
Excluindo uma lotação
DEL /v1/lotacao/{lotacao_id}/
Desativa um registro de lotação pela sua id
Retorno:
204 | 403 | 406 | 409