Obtendo um cliente ou uma lista de clientes¶
O serviço para obter o cliente está presente em:
GET /api/Partners
{
//Número da Página (geralmente usado somente depois da primeira consutla) padrão sempre 1
"pageNumber":1,
//Tamanho da página, quantidade de registro por consulta padrão 30
"pageSize":30,
//Texto do Filtro, pode ser qualquer informação que deseja, por exemplo: "José Silva"
"queryForAnyField":"String",
//Campo de Ordenação, por exemplo: Código do Cliente
"sortBy":"cardCode",
//Ordem da ordenação, asc ou desc
"sortOrder":"asc",
}
o resultado será algo parecido com:
{
//Quantidade de Página
"totalPages":0,
//Total de Registros
"totalRows":0,
//Número da Página Consultada
"pageNumber":0,
//Tamanho de Cada Página
"pageSize":0,
//Valor que foi consultado
"queryForAnyField": "String",
//Campo que foi ordenado
"sortBy":"String",
//Tipo de Ordenação que foi realizado
"sortOrder":"String"
//Resultado da Consulta, pode ter 1 ou mais registros
[
{
//Não há necessidade de repetir detalhadamente todos os campos do cliente, haja vista que os mesmos estão representados nas seções acima
//.... Campos do Cliente ....
},
],
}
E para obter um determinado cliente pelo seu código basta realizar um chamada ao WebService:
GET /api/Partners/{"Código_do_Cliente-CardCode"}
E o resultado será um NotFound (Status 404) ou os dados do clientes (Status 200) com os valores do cliente apresentada nas seções anteriores.