GET | /
Función que Realiza
Obtiene un listado de todos los objetivos registrados, opcionalmente filtrados por vendedor.
Funcionamiento
- URL Completa:
{domain}/api/v1/targets/ - Acción: GET
- Requiere Api-Key?: Si
- Requiere una Sesión?: Si
- Recibe datos mediante: Query
- Cantidad de datos: 1
- Responde con contenido?: Si
- Responde únicamente con código de estado?: No
- Código: 200 | Ok
- Códigos de error: Vea la sección Errores
Contenido que se recibe por Query
sellerId? = Int
Contenido que devuelve
{
"targets": [
{
"id": "String",
"sellerId": "Number",
"description": "String",
"fromDate": "Number",
"toDate": "Number",
"segments": [
{
"id": "String",
"name": "String",
"completed": "Boolean",
"type": "VOLUMEN" | "COBERTURA",
"value": "Number",
"unit": "String"
}
],
"clients": [
{
"id": "Number",
"socialReason": "String"
}
]
}
]
}
Códigos de Error
| HTTP Code | Custom Code | Message |
|---|---|---|
| 422 | INVALID_REQUEST_DATA | Los datos enviados son inválidos o insuficientes. |
| 401 | INVALID_API_KEY | La API Key proporcionada no es válida. |
| 401 | INVALID_SESSION | La sesión no es válida o ha expirado. |
| 401 | INSUFFICIENT_PERMISSIONS | No tienes los permisos suficientes para acceder. |