Obtiene un listado de compañías que coincidan con un nombre o parte de un nombre de compañía.
Detalles de la petición
- URL Base: {host}/ASMSAPI/
- Uri: /api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}
- Tipo: GET
-
Encabezados requeridos:
- content-type: application/json
- X-Authorization: Bearer {token}
Descripción de la URL
- {host}: Representa el dominio del ambiente en el que se encuentra la API.
- ASMSAPI/: Prefijo fijo de la API.
- Uri: Endpoint específico para la petición.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| companyName | Texto | Sí | Nombre completo o parcial de las compañías que se desean encontrar |
| projectId | Número | No | Identificador de proyecto |
| matchName | Booleano | No | Determina si la búsqueda debe ser exacta |
Cuerpo de la petición
N/A
Ejemplos de uri
api/v9/company/getbyname?companyName=Guia&projectId=25&matchName=true
Respuesta
Respuesta de ejemplo
{
"description": "Aranda software",
"Id": 2,
"isActive": true,
"location": "",
"name": "Aranda Software",
"nit": "1",
"stateId": 1
}
Parámetros de respuesta
| Título | Tipo de dato | Descripción |
|---|---|---|
| description | Texto | Descripción de la compañía |
| Id | Número | Id de la compañía |
| isActive | Booleano | Determina si la compañía está activa |
| location | Texto | Ubicación de la compañía |
| name | Texto | Nombre de la compañía |
| nit | Texto | NIT de la compañía |
| stateId | Número | Identificador del estado |
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BacRequest | IdNotEmpty |
| 500 | InternalServerError | FailureGetCompanyByName |