Controllr/API/REST-HTTP/Área Administrativa/Cadastro Clientes

De BrByte Wiki
< Controllr‎ | API‎ | REST-HTTP‎ | Área Administrativa
Revisão de 15h27min de 27 de junho de 2019 por Miguel (discussão | contribs)

Listar os Clientes

POST /controllrctl/client/list 


  curl -i -X POST \
        -H "Content-Type:application/x-www-form-urlencoded" \
        -H "Accept:application/json" \  
        -d "where: [{"field":"client_status","oper":5,"value":0}]" \
        -d "start: 0" \
        -d "limit: 15" \
        -d "sort: client_complete_name" \
        -d "dir: ASC" \
        'http://192.168.144.10:8080/controllrctl/client/list'

Resposta JSON 

 
{
    "success": true,
    "total": 493,
    "results": [
        {
            "client_pk": 430,
            "client_status": 3,
            "client_type": 0,
            "client_username": "",
            "client_password": "",
            "client_name": "teste",
            "client_lastname": "brbyte",
            "client_mail": "",
            "client_doc1": "",
            "client_doc2": "",
            "client_date_cad": "2016-09-20 00:00:00",
            "client_date_deactivation": null,
            "client_date_birth": "2016-09-20 00:00:00",
            "client_observations": "",
            "offices_pk": 1,
            "offices_identification": "Matriz",
            "client_complete_name": "teste brbyte",
            "client_phones": null,
            "cli_addr_address": "Rua Oscar Ferreira Bugre",
            "cli_addr_number": "88",
            "cli_addr_neighborhood": "Vila Nasser",
            "cli_addr_zipcode": "79.117-101",
            "cli_addr_province": "Campo Grande",
            "cli_addr_state": "MS",
            "cli_addr_completation": ""
        }
    ]
}


Para listagem dos clientes usando algum filtro especifico deve montar a requisição com os parâmetros corretos. Utilizando o F12 do seu navegador, irá visualizar os parâmetros que são utilizáveis para montagem da sua URL. Caminho da opção do desenvolvedor: Aba Network > XHR > Headers


Controllrctl-client-list.png


FORM DATA

Start
Parâmetro da posição que deseja que seja listado os clientes. Sendo 0 (zero) a primeira posição


Limit
Parâmetro para setar o valor da quantidade de clientes que devem ser listados na requisição URL


Sort
Parâmetro de ordenação da coluna de sua listagem. Por padrão é ordenado pela coluna client_complete_name, mas pode escolher qualquer outra de sua escolha


Dir
Parâmetro de ordenação do maior para o menor ou vice-versa. Sendo ASC - para ordenar do menor para o maior e DESC - para ordenar do maior para o menor


Where
Parâmetro de montagem de filtro para listagem de clientes específicos.
Field
Marque a coluna que deseja usar esse filtro e também pode usar com a opção AND, para usar mais de uma coluna no filtro
Oper
É código do filtro que irá usar para a coluna marcada.
"oper":1 Menor que <
"oper":2 Maior que >
"oper":3 Menor ou igual à <=
"oper":4 Maior ou igual à >=
"oper":5 Igual à =
"oper":6 Diferente de != ou <>
"oper":7 É IS
"oper":8 Não é IS NOT
"oper":9 LIKE
"oper":10 ILIKE
Value
Valor da coluna que deseja utilizar no filtro


Cadastrar Clientes

POST /controllrctl/client/create 


  curl -i -X POST \
        -H "Content-Type:application/x-www-form-urlencoded" \
        -H "Accept:application/json" \  
        -d "client_doc1:19117390001" \
        -d "offices_pk: 1" \
        -d "client_type:0" \
        -d "client_status:0" \
        -d "client_name:Maria" \
        -d "client_lastname:Aparecida"\
        -d "client_date_birth:1945-03-20"\
        -d "client_doc2:45.810.184-9"\
        -d "client_mail:maria@aparecida.com.br"\
        -d "client_date_cad:2019-06-27"\
        -d "client_username:maria"\
        -d "client_password:maria"\
        -d "client_password1:maria"\
        -d "client_observations:cadastro completo"\
        'http://192.168.144.10:8080/controllrctl/client/create'

Resposta JSON 

 
{
    "success": true,
    "total": 1,
    "results": [
        {
            "client_pk": 5,
            "client_name": "Maria",
            "client_lastname": "Aparecida"
        }
    ]
}


Colunas de preenchimento do cadastro dos clientes

Coluna Descrição Obrigatório Exemplo
client_doc1 Preenchimento do CPF/CNPJ do cliente, inserção sem . (pontos) nem - (traço) Não 19117390001
office_pk ID do escritório cadastrado Matriz ou Filiais Sim 1 (Matriz)
client_type Tipo da pessoa que será cadastrada, sendo 0 = Física e 1 = Jurídica Sim 0
client_status Status que se encontra esse cliente, sendo 0 = Ativo, 1 = Desativado, 2 = Interessado e 3 = Removido Sim 0
client_name Primeiro nome do cliente a ser cadastrado Sim Maria
client_lastname Sobrenome do cliente a ser cadastrado Sim Aparecida
client_date_birth Data de nascimento do cliente, preenchimento no formato AAAA-MM-DD, default é a data do sistema Não 1945-03-20
client_doc2 Preenchimento do RG/IE do cliente Não 45.810.184-9
client_mail Cadastro do e-mail do seu cliente Não maria@aparecida.com.br
client_date_cad Data que o cliente está sendo cadastrado, preenchimento no formato AAAA-MM-DD, default é a data do sistema Não 2019-06-27
client_username Criar um nome de usuário para ter acesso à área do cliente Não maria
client_password Criar uma senha de login à área do cliente. Sim/Não maria
client_password1 Confirmação da senha de login à área do cliente Sim/Não maria
client_observations Preencher algum informação extra do cliente Não cadastro completo

Atualizar Clientes

POST /controllrctl/client/update 


  curl -i -X POST \
        -H "Content-Type:application/x-www-form-urlencoded" \
        -H "Accept:application/json" \
        -d "client_pk:5" \
        -d "client_doc1:19117390001" \
        -d "offices_pk: 1" \
        -d "client_type:0" \
        -d "client_status:0" \
        -d "client_name:Maria" \
        -d "client_lastname:Aparecida"\
        -d "client_date_birth:1945-03-20"\
        -d "client_doc2:45.810.184-9"\
        -d "client_mail:maria@aparecida.com"\
        -d "client_date_cad:2019-06-27"\
        -d "client_username:maria"\
        -d "client_password:maria"\
        -d "client_password1:maria"\
        -d "client_observations:cadastro completo"\
        'http://192.168.144.10:8080/controllrctl/client/update'

Resposta JSON 

 
{
    "success": true,
    "total": 1,
    "results": [
        {
            "client_pk": 5,
            "client_name": "Maria",
            "client_lastname": "Aparecida"
        }
    ]
}


Basicamente é quase a mesma coisa que o create, porém agora é necessário ter o ID do cliente client_pk.

Remover Clientes

POST /controllrctl/client/delete 


  curl -i -X POST \
        -H "Content-Type:application/x-www-form-urlencoded" \
        -H "Accept:application/json" \
        -d "client_pk:6" \
        -d "cur_client_status:0" \
        'http://192.168.144.10:8080/controllrctl/client/delete'

Resposta JSON 

 
{
    "success": true,
    "total": 1,
    "results": [
        {
            "client_pk": 6,
            "client_name": "teste",
            "client_lastname": "completo"
        }
    ]
}
Coluna Descrição Obrigatório Exemplo
client_pk ID do cadastro do cliente Sim 6
cur_client_status Status que irá mudar o cliente, sendo 0 = Removido e 1 = Ativo Sim 0


Exemplos

  • Buscar cliente pelo Nome

Form Data:

where : [{"field":"client_complete_name","oper":10,"value":"%conexão%"},{"field":"AND"},{"field":"client_status","oper":5,"value":0}]

  • Buscar cliente pelo CPF/CNPJ

Form Data:

where: [{"field":"client_doc1","oper":5,"value":"19117390001"},{"field":"AND"},{"field":"client_status","oper":5,"value":0}]

  • Listar clientes ativos ordenado pelo nome em ordem alfabética

Form Data:

where: [{"field":"client_status","oper":5,"value":0}]

sort: client_complet_name

dir: ASC


Disponível em “https://wiki.brbyte.com/index.php?title=Controllr/API/REST-HTTP/Área_Administrativa/Cadastro_Clientes&oldid=4647”
Powered by MediaWiki