Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Current »

Já existe:

Consultar Construtora:

Pode ser feito por 2 metodos

  • Listar um: 

    Get: https://bancodeobras-api.dev.cloud.dex.co/construction-company/633491d48f6c5d97e7d423dd

  • Listar todos: 

    Get: https://bancodeobras-api.dev.cloud.dex.co/construction-company

Sendo que o metodo de listar um precisaria do _id da construtora que está sendo pesquisada

Cadastrar nova Construtora:

Cadastrar Nova Obra Manualmente:

Post: https://bancodeobras-api.dev.cloud.dex.co/construction

Para cadastrar uma obra manualmente enviar um body JSON para o endpoint como o ex:

{
  "name": "teste",
  "category": "Prédio Residencial",
  "type": "Residencial",
  "finishingDetail": "Desconhecido",
  "sector": "Edificações",
  "amount": {
      "area": "teste",
      "salesPontential": "teste",
      "unitSalesPontential": "teste"
  },
  "address": {
      "zipCode": "teste",
      "region": "teste",
      "street": "teste",
      "number": "teste",
      "state": "teste",
      "city": "teste"
  },
  "workPhase": "teste",
  "status": {
      "name": "Obra não Iniciada"
  },
  "startPhaseAt": "Wed Oct 19 2022 10:47:51 GMT-0300 (Horário Padrão de Brasília)",
  "finishPhaseAt": "Wed Oct 19 2022 10:47:51 GMT-0300 (Horário Padrão de Brasília)",
  "DeliveryAt": "Wed Oct 19 2022 10:47:51 GMT-0300 (Horário Padrão de Brasília)",
  "constructionCompany": {
      "_id": "633491d48f6c5d97e7d423dd",
      "name": "teste",
      "cnpj": "teste",
      "city": "teste",
      "state": "teste",
      "phone": "teste"
  }
}

Onde o id da construtora irá criar um documento novo na collection de constructionCompanies

E o documento final será criado na collection de constructions

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:

{

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&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:

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é 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)

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

Precisa fazer ainda / Fazendo:

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

  • Paginação para listar todas construtoras

  • Criar método para popular construtoras a partir das construtoras cadastradas via excel ou por obras-online

  • No labels