GET api/cliente?Prefix={Prefix}&Count={Count}&Page={Page}&IdClientes={IdClientes}
Permite realizar la búsqueda de clientes en el sistema. Este método requiere autorización.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Prefix |
Texto a coincidir con el nombre del cliente. (like '%@prefix%'). |
string |
Max length: 255 |
| Count |
Capacidad de registros a obtener (Recomendado 20). |
integer |
Range: inclusive between 0 and 100 |
| Page |
N° de página de registros a obtener (Default 1). |
integer |
None. |
| IdClientes |
Id de clientes entre los cuales buscar separados por coma. (Ej: 1,2,3,4). |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Retorna una colección de [Cliente] con los registros encontrados con su HttpStatusCode correspondiente (OK:200) o retorna un [string] con su HttpStatusCode correspondiente (BadRequest:400).
Collection of Cliente| Name | Description | Type | Additional information |
|---|---|---|---|
| IdCliente |
Identificador interno del cliente. |
integer |
None. |
| Codigo |
Código de identificación del cliente. |
string |
None. |
| Nombre |
Nombre del cliente. |
string |
None. |
| IdEstado |
Identificador de estado del cliente (1: Activo, 2: Inactivo, 3: Bloqueado) |
integer |
None. |
Response Formats
application/json, text/json
[
{
"IdCliente": 1,
"Codigo": "sample string 2",
"Nombre": "sample string 3",
"IdEstado": 4
},
{
"IdCliente": 1,
"Codigo": "sample string 2",
"Nombre": "sample string 3",
"IdEstado": 4
}
]
application/xml, text/xml
<ArrayOfCliente xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tecnolex.Tempus.API.Models">
<Cliente>
<Codigo>sample string 2</Codigo>
<IdCliente>1</IdCliente>
<IdEstado>4</IdEstado>
<Nombre>sample string 3</Nombre>
</Cliente>
<Cliente>
<Codigo>sample string 2</Codigo>
<IdCliente>1</IdCliente>
<IdEstado>4</IdEstado>
<Nombre>sample string 3</Nombre>
</Cliente>
</ArrayOfCliente>