Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Já existe:

Consultar Construtora:

Cadastrar Nova Obra:

Listar Obras

  • Filtro CNPJ:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&cnpj=79.550.091/0001-99
  • Filtro Nome:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&company=Catuai Construtora e Incorporadora
  • Filtro Cidade:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&city=São Paulo

O endpoint para lista Obras é:

Code Block
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:

Code Block
{

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:

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&sector=Edificações

Cadastrar Construtora:

Nova negociação:

Update Obras

  • Inserir/Mudar Colaborador (Seller)

  • Inserir/Mudar Coordenador

São inseridos e atualizados pelo menos endpoint:

Code Block
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/{construction}/collaborator

Sendo Construction o id da construção que irá inserir o colaborador. Ex

Code Block
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/6345bd2756a6286f55a89f51/collaborator

O JSON é um array com até 6 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)

Code Block

Get Me - Menu Mobile

Para receber as informações do usuário e preencher o menu lateral

Code Block
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

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions/filters

Precisa fazer ainda / Fazendo:

  • Criar um endpoint para adicionar regionais e business no usuário