Detalles de la petición
- URL Base: {host}/ASMSAPI/
- URI: api/v9/user/{Id}/usercompanies
- 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/user/{Id}/usercompanies
Parámetros:
Nombre | Tipo de dato | Obligatorio | Descripción |
---|---|---|---|
id | int | si | Identificador del usuario |
Cuerpo de la petición: N/A
Respuesta
{
"totalItems": 2,
"content": [
{
"companytId": 1,
"companyName": "Empresa AT",
"projects": [
{
"projectId": 4,
"projectName": "Soporte"
}
]
},
{
"companytId": 6,
"companyName": "Empresa4",
"projects": [
{
"projectId": 4,
"projectName": "Soporte"
}
]
}
]
}
⚐ Nota: La petición retorna la compañía asociada al usuario consultado y el proyecto al que pertenece.
Parámetros
Nombre | Tipo de dato | Descripción |
---|---|---|
companyId | int | Identificador de la compañía |
companyName | string | Nombre de la compañía |
projects | list | Lista de proyectos relacionados a la compañía |
projects.projectId | int | Identificador del proyecto relacionado a la compañía |
projects.projectName | string | Nombre del proyecto relacionado a la compañía |
Excepciones:
Salida | Descripción |
---|---|
exceptionMessage : “InvalidClientUser”,message : “FailureGetUserCompanies”,operation : “GetUserCompanies”,serviceName : “User” |
El usuario consultado no existe o no está definido como cliente |