Detalles de la Petición
- URL Base: {host}/ASMSAPI/
- Uri:
/api/v9/company/{id} - Tipo: GET
- Encabezados requeridos:
content-type: application/jsonX-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/{id}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| id | Número | Sí | Identificador de la compañía |
Cuerpo de la Petición
N/A
Ejemplos de Uri
/api/v9/company/1
Respuesta
{
"Address1": "",
"Address2": "",
"Address3": "",
"CityId": 4,
"CityName": "Cali",
"Contact": "Servicio al cliente",
"CountryId": 2,
"CountryName": "Colombia",
"Description": "Empresa Guia",
"Email": "correo@empresaguia.com",
"Ext": "",
"FaxNumber": "",
"Id": "",
"isActive": true,
"Location": "",
"Mobil": "3111111111",
"Name": "Guia",
"Nit": "80090000909",
"Phone1": "6022002020",
"Phone2": "6023003030",
"Phone3": "",
"StatusId": "1",
"WebSiteURL": "",
"ProjectId": "25",
"ConsoleType": 3,
"RegisterType": 38
}
Parámetros de Respuesta
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| totalItems | Número | Número total de objetos encontrados |
| content | Lista | Listado de objetos |
| hasIntegration | Texto | Determina si la compañía tiene integraciones |
| id | Número | Identificador del usuario |
| locationId | Número | Identificador de la ubicación de la compañía |
| name | Texto | Nombre de la compañía |
| projectId | Texto | Identificador del proyecto asociado |
Mensajes de Error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 500 | InternalServerError | FailureGetCompanies |