Páginas filhas
  • TOTVS Gestão Construção de Imóveis - API Cadastro de Cliente / Propostas

Versões comparadas

Chave

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

...

Deck of Cards
idCADASTROS DAS APIS
Card
labelAPI Genérica para Consultar as Novas Tabelas do PI no RM |

Para consultar os dados das novas Tabelas do Portal Imóveis que foram criadas diretamente no banco do RM, utilize como base a API abaixo, substituindo o termo {nomedatabela} pelo nome da tabela desejada.


http://localhost:8051/api/imb/v1/registrations/{nomedatabela}


Esta API só pode ser utilizada com verbo do tipo get


Exemplos de uso desta API:

Consultando as informações da Tabela XPIMIDIA, na qual estão as informações sobre as Mídias utilizadas para gerar as Propostas no PI (Portal de Imóveis):

http://localhost:8051/api/imb/v1/registrations/XPIMIDIA

Image Added


Outras Tabelas disponíveis até o momento de edição deste documento são:

  • XPIESTADOCIVIL - Que controla o cadastro dos Estados Civis das Pessoas no PI; e 
  • XPIPROFISSAO - Que controla o cadastro das Profissões das Pessoas no PI.
Card
labelPOST - Cadastro de Cliente |

http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData


Image Modified


Neste exempo , via Postman estou cadastrando um Novo Cliente com os seguintes dados:

Nome : CLIENTE NOVO ASTONI

Razão Social : CLIENTE NOVO ASTONI

CPF : 044.266.846-50

Pai: PAI ASTONI

Mãe : MAE ASTONI

Conjuge : ESPOSA ASTONI


Image Modified


Cadastro realizado e é retornado o Código ID do Cliente com seu ID ERP ( CODCFO )

Image Modified

Image Modified

Cadastros realizados na base de dados RM



Informações
titleObservação:

Image Modified


Caso tente adiconar um cliente na qual já exista um com CPF já cadastro no sistema , é feita a validação da API retornando a mensagem que já existe cadastro para o CPF na base de dados.




Card
labelDEL - Deletando registro de Cliente |

http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData/{Número do ID que deseja excluir}

Image Modified


Cliente foi gerado com ID = 35 e neste exemplo , informo o Código 35 do ID que desejo excluir.

Card
labelGET - Consulta Cadastro de Cliente com ou Sem Filtro |

http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData?filter= ["nome like :nome and CPFCNPJ = :cpf", "%ASTONI%", "044.266.846-50"]

Neste exemplo é feita a consulta com Filtro , e esse exemplo é para buscar clientes com CPF acima e nome.

Image Modified


Neste exemplo é informado o Cliente conforme Filtro desejado, somente o CPF informado e que tenha ASTONI em seu nome.



http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData

Neste caso a pesquisa não utiliza filtro.

Image Modified

Neste que não possui Filtros , informa a quantidade de Registros = 2 ( 2 Clientes ) com seus dados.

Image Modified


Card
labelPUT e PATCH - Alterando dados do Cliente |

http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData/34

http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData/34


Ambas APIS alteram dados de Cliente

Image Modified

Não se esquecendo de informar o número do ID que deseja alterar e os campso que serão feitas as alterações.


Alterando neste exemplo os campos:

  • Nome
  • Razão Social
  • Pai
  • Mãe
  • Nome da Esposa ( Conjuge )

Image Modified

Image Modified


Dados alterados no RM


ALTERANDO COM PATCH 

Image Modified

Novamente informar o ID do Cliente que deseja alterar o cadastro e seus dados.

Alterando neste exemplo os campos:

  • Nome
  • Pai
  • Mãe
  • Nome da Esposa ( Conjuge )


Image Modified

Image Modified

Card
labelCampos PVI com RM |

RM                                                              PVI

Column_nameTypeNullableLengthColunatipoNullableLengthTabelaId_erp
CODCOLIGADADCODCOLIGADAno2id_erpvarcharyes255

CODCFOvarcharno25id_erpvarcharyes255

NOMEFANTASIAvarcharyes100razaosocialvarcharyes100

NOMEvarcharyes100nomevarcharyes100

CGCCFOvarcharyes20cpfcnpjvarcharyes14

INSCRESTADUALvarcharyes20inscricaoestadualvarcharyes15

PAGRECsmallintno2





RUAvarcharyes100logradourovarcharyes100

NUMEROvarcharyes8numerovarcharyes10

COMPLEMENTODCOMPLEMENTOyes60complementovarcharyes50

BAIRRODBAIRROyes80bairrovarcharyes50

CIDADEDCIDADEyes32cidadevarcharyes50

CODETDvarcharyes2ufvarcharyes2

CEPDCEPyes9cepvarcharyes8

TELEFONEvarcharyes15telefonevarcharyes15

RUAPGTOvarcharyes100logradourocobrancavarcharyes100

NUMEROPGTOvarcharyes8numerocobrancavarcharyes10

COMPLEMENTOPGTODCOMPLEMENTOyes60complementocobrancavarcharyes50

BAIRROPGTODBAIRROyes80bairrocobrancavarcharyes50

CIDADEPGTODCIDADEyes32cidadecobrancavarcharyes50

CODETDPGTOvarcharyes2ufcobrancavarcharyes2

CEPPGTODCEPyes9cepcobrancavarcharyes8

FAXvarcharyes15faxvarcharyes15

TELEXvarcharyes15celularvarcharyes15

EMAILvarcharyes60emailvarcharyes50

INSCRMUNICIPALvarcharyes20inscricaomunicipalvarcharyes15

ESTADOCIVILvarcharyes1estadocivil_idintyes4estadocivilsim
DTNASCIMENTOdatetimeyes8datanascimentodatetimeyes8

RECCREATEDBYvarcharyes50usuariocriacao_idintyes4usuarionão
RECCREATEDONdatetimeyes8datahoracadastrodatetimeyes8
não
RECMODIFIEDONdatetimeyes8data_ultima_interacaodateyes310
COD_SEXOcharyes1sexosmallintyes2

CODETDMUNICIPIOvarcharyes2naturalidadevarcharyes50

NAT_CFOvarcharyes30nacionalidadevarcharyes50

NOM_PAIvarcharyes45paivarcharyes50

NOM_MAEvarcharyes45maevarcharyes50

EMPR_RENDARMDVALOR4yes15,4rendadecimalyes9

EMPR_NOMEvarcharyes100empresa_nomevarcharyes100

EMPR_ENDERECOvarcharyes30empresa_logradourovarcharyes100

EMPR_NUMEROvarcharyes8empresa_numerovarcharyes10

EMPR_COMPLvarcharyes20empresa_complementovarcharyes30

EMPR_BAIRROvarcharyes30empresa_bairrovarcharyes50

EMPR_CIDADEvarcharyes30empresa_cidadevarcharyes50

EMPR_UFvarcharyes2empresa_ufvarcharyes2

EMPR_CEPvarcharyes9empresa_cepvarcharyes8

EMPR_TEL_COMvarcharyes15empresa_telefonevarcharyes15

EMPR_RAMALvarcharyes8empresa_ramalvarcharyes10

EMPR_FAXvarcharyes15empresa_faxvarcharyes15

EMPR_DATA_ADMdatetimeyes8empresa_dataadmissaodatetimeyes8

EMPR_CARGOvarcharyes25empresa_cargovarcharyes50

CODPROFvarcharno3conjuge_profissao_idintyes4

NOMEvarcharyes250conjuge_nomevarcharyes100





conjuge_emailvarcharyes50

DATNASCdatetimeyes8conjuge_datanascimentodatetimeyes8

CPFvarcharyes20conjuge_cpfvarcharyes11

CIvarcharyes20conjuge_rgnumerovarcharyes50

ORGEMISCIvarcharyes8conjuge_rgorgaovarcharyes20

ORGEMISCIvarcharyes8conjuge_rgufvarcharyes2





conjuge_sexovarcharyes1

NOMPAIvarcharyes45conjuge_paivarcharyes100

NOMEMAEvarcharyes45conjuge_maevarcharyes100

TELEFONEvarcharyes15conjuge_telefonevarcharyes15

CELULARvarcharyes15conjuge_celularvarcharyes15





conjuge_naturalidadevarcharyes50

NAT_PESSvarcharyes30conjuge_nacionalidadevarcharyes50





conjuge_cartoriofirmavarcharyes50





conjuge_rendadecimalyes9

LOCALTRABvarcharyes40conjuge_empresa_nomevarcharyes100





conjuge_empresa_cargovarcharyes50





conjuge_empresa_dataadmissaodatetimeyes8

TELCOMERvarcharyes15conjuge_empresa_telefonevarcharyes15

LOGRADOUROvarcharyes45conjuge_empresa_logradourovarcharyes100

NUMEROENDvarcharyes6conjuge_empresa_numerovarcharyes10

COMPLEMENTOENDvarcharyes15conjuge_empresa_complementovarcharyes50

BAIRROvarcharyes25conjuge_empresa_bairrovarcharyes50

CIDADEvarcharyes30conjuge_empresa_cidadevarcharyes50

UFvarcharyes2conjuge_empresa_ufvarcharyes2

CEPvarcharyes8conjuge_empresa_cepvarcharyes8

DATACASAMENTOdatetimeyes8datacasamentodatetime2yes8

Card
labelIncluir Proposta |

API para inclusão de Proposta : http://localhost:8051/api/imb/v1/sales/proposals

Exemplo da API para inclusão de Proposta:


{
    "codcoligada"1,            
    "statuspvi"1,
    "codempreendimento"100,       
    "codunidade""01",    
    "codsubunidade""000502",            
    "idcorretorpvi"1,    
    "idclienteprincipalpvi"17,
    "idclientespvi": [
                17,
                18
                 ]



}


Image Added

Idclientepvi : ( 17 e 18 ) estão cadastrados.


Image Added

Image Added

IDclientePrincipal = 17 ( ADRIANO ASTONI FERREIRA 01 )


Image Added

Image Added


Image Added

Proposta 61 incluída na Base de Dados RM.

Image Added

Proposta com os Dois compradores inserida e a SubUnidade .

Card
labelConsultar Propostas |

API para consultar Propostas : http://localhost:8051/api/imb/v1/sales/proposals


Image Added

Image Added

Card
labelAlterando dados API Proposta |

API Alterando Proposta PUThttp://localhost:8051/api/imb/v1/sales/proposals/1_61    ( 1_61  = Coligada e número da Proposta que deseja alterar os dados )

Image Added

Neste exemplo estou alterando o Comprador principal 17 para 18.

Image Added

Foi alterado para o Adriano Astoni Ferreira 02 o Comprador Principal.





API Alterando Proposta PATCH :  http://localhost:8051/api/imb/v1/sales/proposals/1_61

Mesmo critério de PUT - Inserindo a coligada e numero da Proposta.


{
    "codcoligada"1,        
    "idpropostavenda"61,    
    "statuspvi"1,
   "codempreendimento"100,       
    "codunidade""01",    
    "codsubunidade""000502",            
    "idcorretorpvi"1,    
    "idclienteprincipalpvi"18,
    "idclientespvi": [
                18
                
                 ]



}



Image Added


Excluíndo o ID 17 da Proposta.


Image Added


Comprador ID 17 Excluído.

Card
labelAPI para Deletar Proposta |

API para Deletar Proposta : http://localhost:8051/api/imb/v1/sales/proposals/1_61


Inserir o número da Proposta que deseja excluir via API .


Image Added


Proposta excluída da Base de Dados RM.