Histórico da Página

Expandir

title	API de Usuário Portal de Imóveis

Título	API de Usuário Portal de Imóveis - GET
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData
Verbo	Get.
Parameters	No parameters
Descrição	Utilizando esta API com o verbo Get, o sistema retorna a lista de usuários cadastrados na Tabela XPIUSUARIO do Portal de Imóveis.
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": [
        {
            "id": "1",
            "RESTDS_TEMP_ID": 1,
            "ID_ERP": "1;01455",
            "ID_SUPERIOR": null,
            "GRUPOUSUARIO_ID": 1,
            "NOME": "mestre",
            "SOBRENOME": "totvs",
            "EMAIL": "[email protected]",
            "CELULAR": "3134940000",
            "SALT": "Ay3+rprtuHjBQjA3vAqlJn8SyfqYovB7",
            "HASH": "wsCmCTzMluub+Hls5oNDCc6O2zXevPBm",
            "RESERVAS": 3,
            "ATIVO": 1,
            "DATAHORACADASTRO": "2023-03-13T16:33:06-03:00",
            "DATAHORAULTIMOLOGIN": "2023-03-22T08:31:08.863-03:00",
            "DATAHORAALTERACAO": "2023-03-22T08:31:08.917-03:00",
            "PERGUNTAR_NOTIFICAR_SUPERIOR": 1,
            "LISTAS_DISPOSICAO": 2,
            "LISTAS_VISAO": 3,
            "PERCENTUAL_COMISSAO": 2.0000,
            "CRECI": null,
            "IMOBILIARIA_ID": null,
            "PODE_ATUALIZAR_SISTEMA": 1,
            "TIPOPESSOA": 1,
            "CPFCNPJ": "34360165510",
            "FORCAR_ALTERAR_SENHA": 0,
            "DATA_VIGENCIA_CRECI": null,
            "QTD_MAX_PROSPECTS": 0,
            "RECCREATEDBY": null,
            "RECCREATEDON": null,
            "RECMODIFIEDBY": null,
            "RECMODIFIEDON": null
        }
}

Título	API de Usuário Portal de Imóveis - POST
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData
Verbo	Post
Parameters	No parameters
Descrição	Utilizando esta API com o verbo Post, o sistema irá cadastrar o usuário do Portal de Imóveis alimentando as seguintes tabelas: XPIUSUARIO: Tabelas que armazena os dados dos usuários do PI; FCFO: Tabela (principal) que armazena os dados dos Clientes no financeiro; XPESSOACONJUGE: Tabela que armazena os dados do cônjuge dos clientes no TCGI; e XCLIENTEPESSOAFISICA: Tabela que armazena os dados complementares dos clientes no TCGI;
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
          "ID":-1,
         "NOME": "Itamar",         
         "SOBRENOME": "Morais",    
         "ID_SUPERIOR": 1,
         "GRUPOUSUARIO_ID": 1,
         "CPFCNPJ": "860.672.580-30",
         "celular": "999999999",         
          "EMAIL" : "[email protected]",         
         "TIPOPESSOA": 0
         
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "999999999",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}

Título	API de Usuário Portal de Imóveis - PUT
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Put
Parameters	No parameters
Descrição	Utilizando esta API com o verbo Put, o sistema irá atualizar os dados informados, para o usuário repassado na ID, na tabela XPIUSUARIO, que armazena os dados dos usuários do PI. Ao utilizar este verbo é preciso informar todos os campos/tags do cadastro do usuário porque os campos que não forem informados serão setados como nulos. Para atualizar somente um campo/tag, utilize o verbo Patch descrito mais abaixo.
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
         "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}

Título	API de Usuário Portal de Imóveis - PATCH
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Patch
Parameters	No parameters
Descrição	Utilizando esta API com o verbo Patch, o sistema irá atualizar os dados informados, para o usuário repassado na ID, na tabela XPIUSUARIO, que armazena os dados dos usuários do PI. Este verbo deve ser utilizado para atualizar os campos especificados, sem alterar o valor dos demais campos da tabela.
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
         "id": "37",
        "CELULAR": "31934940000"
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}

Título	API de usuário Portal de Imóveis - DELETE
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Delete
Parameters	No parameters.
Descrição	Utilizando esta API com o verbo Delete, o sistema irá excluir os dados do usuário repassado no ID, na tabela XPIUSUARIO. No exemplo de resposta abaixo, excluímos o usuário de ID 37, criado nos exemplos acima: http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/37
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": "mestre",
        "RECCREATEDON": "2023-03-22T10:02:45-03:00",
        "RECMODIFIEDBY": "mestre",
        "RECMODIFIEDON": "2023-03-22T10:02:45-03:00"
    }
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Parameters

Parameters

Parameters

Parameters

Parameters