POST | /:id/segments
Función que Realiza
Asocia un segmento a un objetivo con un tipo, valor y unidad específicos.
Funcionamiento
- URL Completa:
{domain}/api/v1/targets/:id/segments - Acción: POST
- Requiere Api-Key?: Si
- Requiere una Sesión?: Si
- Recibe datos mediante: Params & Body
- Cantidad de datos: 5
- Responde con contenido?: No
- Responde únicamente con código de estado?: Si
- Código: 201 | Created
- Códigos de error: Vea la sección Errores
Contenido que se recibe por Parámetros
id = String (targetId)
Contenido que se recibe por Body
Estructura del JSON:
{"parámetro": "tipo de dato"}
{
"segmentId": "String (max 36)",
"type": "Enum('VOLUMEN', 'COBERTURA')",
"value": Int,
"unit": "Enum('ucs', 'cajs', '%')"
}
Códigos de Error
| HTTP Code | Custom Code | Message |
|---|---|---|
| 422 | INVALID_REQUEST_DATA | Los datos enviados son inválidos o insuficientes. |
| 422 | SEGMENT_NOT_FOUND | No se encontró un segmento con esa id |
| 422 | TARGET_NOT_FOUND | No se encontró un objetivo con esa id |
| 422 | SEGMENT_ALREADY_EXISTS | Ya existe un segmento con esa ID asignado a este objetivo. |
| 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. |