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

De BrByte Wiki
Linha 74: Linha 74:
 
! Start
 
! Start
 
|-
 
|-
|É a posição que deseja que seja listado os clientes. Sendo 0 (zero) o primeiro da posição
+
|Parâmetro da posição que deseja que seja listado os clientes. Sendo '''0 (zero)''' a primeira posição
 
|-
 
|-
 
|}
 
|}
  
 +
 +
{| class="wikitable table-striped" style="margin: auto;"
 +
! Limit
 +
|-
 +
| Parâmetro para setar o valor da quantidade de clientes que devem ser listados na requisição URL
 +
|-
 +
|}
 +
 +
 +
{| class="wikitable table-striped" style="margin: auto;"
 +
! 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
 +
|-
 +
|}
 +
 +
 +
{| class="wikitable table-striped" style="margin: auto;"
 +
! 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'''
 +
|-
 +
|}
 +
 +
 +
{| class="wikitable table-striped" style="margin: auto;"
 +
! Where
 +
|-
 +
|
 +
  
  

Edição das 07h34min de 27 de junho de 2019

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