Distribuição de Obras:
Já existe:
Listar Obras
Filtro CNPJ:
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&cnpj=79.550.091/0001-99
Filtro Nome:
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&company=Catuai Construtora e Incorporadora
Filtro Cidade:
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&city=São Paulo
O endpoint para lista Obras é:
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10
Sendo page e limit parametros da paginação.
O objeto de resposta segue com o padrão paginado mostrado no exemplo abaixo:
{
"docs": [
{
"amount": {
"rooms": "60",
"floors": "12",
"area": "847",
"apartments": "0"
},
"address": {
"street": "Rua Vergueiro",
"number": "2573",
"district": "Vila Mariana",
"city": "São Paulo",
"state": "SP",
"region": "Sudeste",
"country": "Brasil",
"zipCode": "4101200"
},
"workPhase": "Execução",
"status": "Obra em Construção",
"investment": {
"total": "0",
"greatness": "MI"
},
"_id": "6345bd2756a6286f55a89f45",
"name": "Exclusive Offices Vergueiro",
"code": "120190",
"type": "Comercial / Institucional",
"sector": "Edificações",
"category": "Prédio Comercial",
"finishPhaseAt": "2022-12-10T00:00:00.000Z",
"finishingDetail": "Médio",
"deliveryAt": "2022-12-10T00:00:00.000Z",
"companies": [
{
"corporateName": "Tiberio Construções e Incorporações S.A",
"cnpj": "47140330000146",
"state": "SP",
"city": "SÃO PAULO",
"types": [
"Construtor"
],
"_id": "6345d0affda8477553e349ec",
"contacts": []
}
],
"internalAreas": [],
"createdAt": "2022-10-11T18:59:51.219Z",
"updatedAt": "2022-10-11T18:59:51.219Z",
"__v": 0
}
],
"totalDocs": 1,
"limit": 10,
"totalPages": 1,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}
Os parametros city, company e cnpj estão reservados como mostrado nas urls na lista de filtros acima. Mas pode ser feito qualquer pesquisa dentro do banco passando a chave do parametro e o valor qual seria pesquisado. Ex:
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10§or=Edificações
Update Obras
Inserir/Mudar Colaborador (Seller)
Inserir/Mudar Coordenador
São inseridos e atualizados pelo menos endpoint:
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/{construction}/collaborator
Sendo Construction o id da construção que irá inserir o colaborador. Ex
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/6345bd2756a6286f55a89f51/collaborator
O JSON é um array com até objetos
_id: id do usuário que será inserido na obra
brand: marca qual o usuario será relacionado
type: tipo do usuário; coordinator (coordenador), seller (vendedor)
[
{
"_id": "634956505d5f0dc2af2ede4e",
"brand": "deca",
"type": "coordinator"
},{
"_id": "634956505d5f0dc2af2ede4e",
"brand": "durafloor",
"type": "coordinator"
},{
"_id": "634956505d5f0dc2af2ede4e",
"brand": "rc",
"type": "coordinator"
},{
"_id": "63494576c0effd329aea260d",
"brand": "durafloor",
"type": "seller"
},{
"_id": "63494576c0effd329aea260d",
"brand": "deca",
"type": "seller"
},{
"_id": "63494576c0effd329aea260d",
"brand": "rc",
"type": "seller"
}
]
Get Me - Menu Mobile
Para receber as informações do usuário e preencher o menu lateral
Get: https://bancodeobras-api.dev.cloud.dex.co/user/me
Filtros para Cidades
Faz o distinct de quais estados / cidades existem no banco de obras para filtro
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions/filters