Error messages – Planning | Maplink Developers

Errores de validación

Los siguientes mensajes de error pueden aparecer debido a parámetros omitidos o introducidos incorrectamente. El código de error devuelto por la API será 400 (Bad Request) y el JSON devuelto tendrá la siguiente estructura:

{
    "logId": "5e8f64f0-0ece-4e26-84c3-7ff889eff092",
    "message": "Validation failed",
    "errors": [
        "sites may not be empty",
        "operations[0].customerSite reference not found",
        "operations[1].customerSite reference not found"
    ]
}

La siguiente tabla muestra las validaciones aplicadas a cada entidad y el mensaje de error devuelto:

Parámetro	Validaciones	Mensajes de error
sites	notEmpty	may not be empty
depots	notEmpty	may not be empty
operations	notEmpty	may not be empty
vehicleTypes	notEmpty	may not be empty
vehicles	notEmpty	may not be empty
products	notEmpty	may not be empty
legislationProfiles	notEmpty	may not be empty
logisticConstraints	notEmpty	may not be empty
optimizationProfile	notBlank	is mandatory
optimizationProfile	invalid profile	optimizationProfile {name} not found
tripsProfile	notBlank	is mandatory
startDate	notNull	is mandatory

Tabla de reglas de validación para entidades principales

Las siguientes tablas muestran las validaciones aplicadas para cada entidad específica:

operations
Parámetro	Validaciones	Mensajes de error
id	notBlank, unique	is mandatory, already exists
weight	notNull, notNegative	is mandatory, may not be negative
volume	notNull, notNegative	is mandatory, may not be negative
product	notBlank, validReference	is mandatory, reference not found
type	notBlank, isContainedIn	is mandatory, does not have a valid value. Allowed values: [COLLECTION, DELIVERY]
priority	notNegative	may not be negative
depotSite	notBlank, validReference	is mandatory, reference not found
customerSite	notBlank, validReference	is mandatory, reference not found
customerTimeWindows	notEmpty	may not be empty

Tabla de reglas de validación para el parámetro operations

vehicles
Parámetro	Validaciones	Mensajes de error
name	notBlank, unique	is mandatory, already exists
vehicleType	notBlank, validReference	is mandatory, reference not found
legislationProfile	notBlank, validReference	is mandatory, reference not found
availablePeriods	notEmpty	may not be empty
priority	notNegative	may not be negative

Tabla de reglas de validación para el parámetro vehicle

vehicleTypes
Parámetro	Validaciones	Mensajes de error
name	notNull, unique	is mandatory, already exists
maxWeight	notNull, notNegative	is mandatory, may not be negative
maxVolume	notNull, notNegative	is mandatory, may not be negative
size	notNegative	may not be negative
maxSitesNumber	notNegative	may not be negative
compartmentsAccessMode	notNull, isContainedIn	is mandatory, does not have a valid value. Allowed values: [ALL_COMPARTMENTS, REAR_ACCESS]
trip.calculationMode	notNull	is mandatory
trip.toll.vehicleType	notNull	is mandatory

Tabla de reglas de validación para el parámetro vehicleTypes

sites y depots
Parámetro	Validaciones	Mensajes de error
name	notBlank, unique	is mandatory, already exists
coordinates	notNull	is mandatory
coordinates.latitude	notNull, range(-90, 90)	is mandatory, must be between -90 and 90
coordinates.longitude	notNull, range(-180, 180)	is mandatory, must be between -180 and 180
logisticConstraints	notBlank, validReference	is mandatory, reference not found

Tabla de reglas de validación para el parámetros sites y depots

legislationProfile
Parámetro	Validaciones	Mensajes de error
name	notBlank, unique	is mandatory, already exists
maxContinuousDrivingTime	greaterThanZero	must be greater than zero
drivingPauseDuration	greaterThanZero	must be greater than zero
maxContinuousWorkingTime	greaterThanZero	must be greater than zero
workingPauseDuration	greaterThanZero	must be greater than zero

Tabla de reglas de validación para el parámetro legislationProfile

callback
Parámetro	Validaciones	Mensajes de error
url	notNull	is mandatory
url	Invalid url	does not have a valid value. Example of allowed values: http://www.foo.br, https://www.foo.br, http://www.foo.br/bar

Tabla de reglas de validación para el parámetro callback

Las validaciones a continuación se aplican a las ventanas de tiempo descritas en los parámetros vehicles[n].availablePeriods, operations[n].customerTimeWindows y operations[n].depotTimeWindows:

timeWindow
Parámetro	Validaciones	Mensajes de error
start	notNull	is mandatory
end	notNull	is mandatory
start, end	start < end	must have the start less than to the end
start, end	start != end	must not start the same as the end
end	end < startDate	must have at least one timeWindow with end after problem’s startDate

Tabla de reglas de validación para parámetros relacionados con la ventana de tiempo.

Errores de procesamiento

Los siguientes mensajes de error pueden aparecer al consultar el estado del procesamiento de la solicitud a través de los endpints https://api.maplink.global/planning/v1/events?jobId={{planningId}} y https://api.maplink.global/planning/v1/jobs/{{planningId}}.

El mensaje de error sigue la siguiente estructura:

{
        "id": "688d267a74be5d22a1ac9002",
        "jobId": "688d26787766ef668397ff50",
        "type": "ERROR",
        "description": "{'logId':'db496388-c45a-4902-af42-0971578cbb38','errors':[{'code':'TECHNICAL_ERROR','description':'global.maplink.matrixinprocessor.exception.ProcessException: [ProcessError(code=INVALID_SITE_POSITION, description=Some sites have not been positionned, detail=[Cliente1])]'}]}",
        "createdAt": 1754080890262
    }

El evento retorna con el type igual a ERROR y se pueden devolver los siguientes mensajes en la description:

Mensaje de error	Causa
{‘logId’:’{{logId}}‘,’errors’: [{‘code’:’TECHNICAL_ERROR’,’description’:’Not possible to create route between sites {{siteId}} and {{siteId}}‘}]}	No se pudo encontrar una ruta entre los dos puntos. El punto podría estar mal ubicado o no existir ninguna ruta, como un punto en una calle sin salida de un solo sentido.
Error in process MRS: Cannot find point {{latitude}},{{longitude}}	No se pudo encontrar la ubicación de las coordenadas proporcionadas. Algunas coordenadas podrían no ser válidas, por ejemplo, al caer al océano.

Tabla de mensajes de error de procesamiento

Ejemplo de una ruta con un mensaje de error:

[
    {
        "id": "688d29735e59ee6e88b67adb",
        "jobId": "688d29737766ef668397ff52",
        "type": "STATUS_CHANGE",
        "description": "ENQUEUED",
        "createdAt": 1754081651310
    },
    {
        "id": "688d297374be5d22a1ac900b",
        "jobId": "688d29737766ef668397ff52",
        "type": "STATUS_CHANGE",
        "description": "CONVERT_TO_MATRIX",
        "createdAt": 1754081651314
    },
    {
        "id": "688d29735e59ee6e88b67adc",
        "jobId": "688d29737766ef668397ff52",
        "type": "PERCENT_CHANGE",
        "description": "1",
        "createdAt": 1754081651317
    },
    {
        "id": "688d297308fc0e441d9e9d23",
        "jobId": "688d29737766ef668397ff52",
        "type": "STATUS_CHANGE",
        "description": "PROCESSING",
        "createdAt": 1754081651339
    },
    {
        "id": "688d29745e59ee6e88b67add",
        "jobId": "688d29737766ef668397ff52",
        "type": "ERROR",
        "description": "{'logId':'e687f91b-e4ce-4cbf-b6c5-8e304e281617','errors':[{'code':'TECHNICAL_ERROR','description':Not possible to create route between sites OP-1 and OP-2'}]},
        "createdAt": 1754081652037
    }
]

Artículo anterior Planning

Status Codes – Planning

Próximo artículo Trip