Mudanças entre as edições de "Controllr/API/REST-HTTP/Área Administrativa/Cadastro Clientes"

Edição das 09h36min de 27 de junho de 2019

Índice

1 Listar os Clientes
2 FORM DATA
3 Exemplos
- 3.1 Cadastrar Clientes

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

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

Exemplos

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"
        }
    ]
}

@@ Linha 69: / Linha 69: @@
-'''FORM DATA'''
+==='''FORM DATA'''===
 {| class="wikitable table-striped" style="margin: auto;"
@@ Linha 143: / Linha 143: @@
+=='''Exemplos'''==
+==='''Cadastrar Clientes'''===
+<div>
+<span class="label label-info">POST</span> <span class="label label-concrete">/controllrctl/client/create</span>
+</div>
+<blockquote><pre>
+  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"\
+        <nowiki>'http://192.168.144.10:8080/controllrctl/client/create'</nowiki>
+</pre></blockquote>
+<div>
+<span class="label label-success">Resposta</span> <span class="label label-concrete">JSON</span>
+</div>
+<blockquote class="blockquote-neutral"><pre>
+{
+    "success": true,
+    "total": 1,
+    "results": [
+        {
+            "client_pk": 5,
+            "client_name": "Maria",
+            "client_lastname": "Aparecida"
+        }
+    ]
+}
+</pre></blockquote>