Obtiene un listado de compañías o proveedores que coincidan con criterios de búsqueda.
Detalles de la petición
- Uri:
/api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser} - Tipo: GET
- Encabezados requeridos:
content-type: application/jsonX-Authorization: Bearer {token}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| itemType | Enumerador | Sí | Tipo de búsqueda (Compañia = 38, Proveedor = 58) |
| projectId | Número | No | Identificador del proyecto |
| clientId | Número | No | Identificador del cliente |
| serviceId | Número | No | Identificador del servicio |
| criteria | Texto | No | Texto de búsqueda de usuario |
| filterCaseUser | Texto | No | Determina si se debe hacer filtro previo por cliente |
Cuerpo de la petición
N/A
Ejemplos de uri
api/v9/company/search?itemType=38&projectId=2&criteria=Guiaapi/v9/company/search?itemType=58&projectId=2api/v9/company/search?itemType=38&projectId=2&criteria=
Respuesta
{
"content": [
{
"hasIntegration": false,
"id": 1,
"locationId": 2,
"name": "Guia",
"projectId": 25
}
],
"totalItems": 1
}
Parámetros de Respuesta
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Address1 | Texto | Primer campo de dirección |
| Address2 | Texto | Segundo campo de dirección |
| Address3 | Texto | Tercer campo de dirección |
| CityId | Número | Identificador de la ciudad |
| CityName | Texto | Nombre descriptivo de la ciudad |
| Contact | Texto | Principal contacto de la compañía |
| CountryId | Número | Identificador del país donde está ubicada la compañía |
| CountryName | Texto | Nombre descriptivo del país donde está ubicada la compañía |
| Description | Texto | Acciones correctivas cuando el caso está marcado como problema mayor |
| Texto | Correo electrónico del principal contacto de la compañía | |
| Ext | Texto | Extensión telefónica del principal contacto de la compañía |
| FaxNumber | Texto | Número de fax del principal contacto de la compañía |
| Id | Número | Identificador de la compañía |
| isActive | Booleano | Verdadero si la compañía está activa |
| Location | Texto | Ubicación |
| Mobil | Texto | Número de teléfono móvil del principal contacto de la compañía |
| Name | Texto | Nombre descriptivo de la compañía |
| Nit | Texto | NIT (Número de identificación tributaria) de la compañía |
| Phone1 | Texto | Primer teléfono de la compañía |
| Phone2 | Texto | Segundo teléfono de la compañía |
| Phone3 | Texto | Tercer teléfono de la compañía |
| StatusId | Número | Identificador del estado |
| WebSiteURL | Texto | URL del sitio web de la compañía |
| ProjectId | Número | Identificador del proyecto |
| ConsoleType | Número | Identificador de la consola de origen de la petición |
| RegisterType | Número | Tipo de registro a crear (Compañia = 38, Proveedor = 58) |
Mensajes de Error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | IdNotEmpty |
| 500 | InternalServerError | FailureGetDetail |