Skip to main content

​
Vehiculos Admisibles Campana API

Manage the relationship between vehicles and advertising campaigns. This table tracks which vehicles are eligible/admitted for specific campaigns.

​
Vehicle-Campaign Relationship Object

​
id
integer
required
Unique identifier for the relationship (auto-generated primary key)
​
id_vehiculo
integer
required
Foreign key reference to Vehiculo (the eligible vehicle)
​
id_campana
integer
required
Foreign key reference to CampanaPublicitaria (the advertising campaign)

​
GET /api/vehiculosadmisiblescampana

Retrieve all vehicle-campaign eligibility relationships.

​
Query Parameters

​
id_vehiculo
integer
Filter by vehicle ID to see all campaigns a vehicle is eligible for
​
id_campana
integer
Filter by campaign ID to see all vehicles eligible for a campaign

​
Response

[
  {
    "id": 1,
    "id_vehiculo": 5,
    "id_campana": 12
  },
  {
    "id": 2,
    "id_vehiculo": 8,
    "id_campana": 12
  },
  {
    "id": 3,
    "id_vehiculo": 5,
    "id_campana": 15
  }
]

​
GET /api/vehiculosadmisiblescampana/campana/

Retrieve all vehicles eligible for a specific campaign with full vehicle details.

​
Path Parameters

​
id_campana
integer
required
The ID of the advertising campaign

​
Response

[
  {
    "id": 1,
    "id_vehiculo": 5,
    "id_campana": 12,
    "vehiculo": {
      "id_vehiculo": 5,
      "placa": "ABC1234",
      "id_marca": 1,
      "id_modelo": 3,
      "anio": 2022,
      "categoria_vehiculo": "sedan",
      "color_vehiculo": "Negro",
      "estado": 1
    }
  },
  {
    "id": 2,
    "id_vehiculo": 8,
    "id_campana": 12,
    "vehiculo": {
      "id_vehiculo": 8,
      "placa": "XYZ5678",
      "id_marca": 2,
      "id_modelo": 7,
      "anio": 2021,
      "categoria_vehiculo": "suv",
      "color_vehiculo": "Blanco",
      "estado": 1
    }
  }
]

​
GET /api/vehiculosadmisiblescampana/vehiculo/

Retrieve all campaigns that a specific vehicle is eligible for.

​
Path Parameters

​
id_vehiculo
integer
required
The ID of the vehicle

​
Response

[
  {
    "id": 1,
    "id_vehiculo": 5,
    "id_campana": 12,
    "campana": {
      "id_campana": 12,
      "nombre_campana": "Summer 2024",
      "fecha_inicio": "2024-06-01",
      "fecha_fin": "2024-08-31",
      "presupuesto": 50000.00,
      "sedan_admisible": true,
      "suv_admisible": true,
      "camion_admisible": false,
      "camioneta_admisible": false,
      "bus_admisible": false
    }
  },
  {
    "id": 3,
    "id_vehiculo": 5,
    "id_campana": 15,
    "campana": {
      "id_campana": 15,
      "nombre_campana": "Winter Sale",
      "fecha_inicio": "2024-12-01",
      "fecha_fin": "2025-02-28",
      "presupuesto": 75000.00,
      "sedan_admisible": true,
      "suv_admisible": false,
      "camion_admisible": false,
      "camioneta_admisible": false,
      "bus_admisible": false
    }
  }
]

​
POST /api/vehiculosadmisiblescampana

Add a vehicle to a campaign’s eligible vehicles list.

​
Request Body

​
id_vehiculo
integer
required
ID of the vehicle to make eligible
​
id_campana
integer
required
ID of the campaign

​
Request Example

{
  "id_vehiculo": 5,
  "id_campana": 12
}

​
Response

{
  "id": 1,
  "id_vehiculo": 5,
  "id_campana": 12,
  "message": "Vehicle successfully added to campaign"
}

​
DELETE /api/vehiculosadmisiblescampana/

Remove a vehicle from a campaign’s eligible vehicles list.

​
Path Parameters

​
id
integer
required
The ID of the vehicle-campaign relationship to delete

​
Response

{
  "message": "Vehicle removed from campaign eligibility"
}

​
Campaign Vehicle Eligibility Rules

Campaigns define which vehicle categories are eligible through boolean flags:
​
sedan_admisible
boolean
Whether sedans are eligible for the campaign
​
suv_admisible
boolean
Whether SUVs are eligible for the campaign
​
camion_admisible
boolean
Whether trucks (camion) are eligible for the campaign
​
camioneta_admisible
boolean
Whether pickup trucks are eligible for the campaign
​
bus_admisible
boolean
Whether buses are eligible for the campaign

​
Eligibility Check Example

Before adding a vehicle to a campaign, verify that the vehicle’s category matches the campaign’s admissible types: 
{
  "vehiculo": {
    "categoria_vehiculo": "sedan"
  },
  "campana": {
    "sedan_admisible": true,
    "suv_admisible": false,
    "camion_admisible": false,
    "camioneta_admisible": false,
    "bus_admisible": false
  },
  "eligible": true
}

​
Use Cases

​
1. Register Vehicle for Campaign

When a driver wants to participate in a campaign, create a relationship between their vehicle and the campaign: 
POST /api/vehiculosadmisiblescampana
{
  "id_vehiculo": 5,
  "id_campana": 12
}

​
2. List All Available Vehicles for Campaign

Get all vehicles that can participate in a specific campaign: 
GET /api/vehiculosadmisiblescampana/campana/12

​
3. Check Driver’s Active Campaigns

Find all campaigns a driver’s vehicle is enrolled in: 
GET /api/vehiculosadmisiblescampana/vehiculo/5

Build docs developers (and LLMs) love

Get started for freeTalk to us