C

Caso de Uso 14

Carga y descarga

El caso de uso 14 está dedicado a la información relativa a zonas de carga y descarga.

Este caso de uso pretende la recopilación y publicación de forma centralizada y homogénea la información relativa a las zonas de carga y descarga de las distintas ciudades/ayuntamientos del territorio nacional. Permite en tiempo real por parte de los suministradores el envío de la información a la plataforma DGT 3.0 sobre las características que las limitan las zonas de carga y descarga. Los consumidores podrán publicar la información en sus sistemas de información accesibles por el usuario final permitiendo a este preveer con antelación las zonas de carga y descarga en el desarrollo de su trayectoria.

La plataforma cuenta con una funcionalidad para la publicación (envío) y una funcionalidad de suscripción (consumo) de información a través de una API REST.

La funcionalidad de publicación requiere de un certificado de acceso que debe ser solicitado y suministrado por DGT 3.0. Este certificado, de no haber sido solicitado ya, se deberá solicitar a soporte@cmobility30.es.

A continuación se muestra la URL con las que se accede a la funcionalidad de publicación:

Modo URL Descripción
Publicación https://pre.cmobility30.es/use-case-14 Endpoint del entorno de integración de clientes para la publicación (ciertos métodos de publicación serán accesibles para el consumo)
Suscripción (Consumidor) https://pre.cmobility30.es/use-case-14 Endpoint del entorno de integración para la suscripción

A continuación se describen las funcionalidades:

Publicación

Este caso de uso dispone de una API REST para la publicación (envío) de los datos por parte de las empresas que así lo deseen. En los siguientes apartados se pueden encontrar los detalles de esta:

  • Los detalles generales para realizar una petición:

General · (cmobility30.es)

  • Información relativa a los métodos específicos del caso de uso:

Métodos de Publicación

Nota: Algunos métodos de publicación para la obtención de información también podrán ser utilizados por los consumidores.

Suscripción (consumidor)

Este caso de uso dispone de una API REST para el consumo de los datos por parte de las empresas que así lo deseen. En los siguientes apartados se pueden encontrar los detalles de esta:

  • Información relativa a los métodos específicos del caso de uso:

Métodos de Suscripción

Errores

Como se ha indicado anteriormente, todas las respuestas HTTP que no sean 200 – OK, se pueden considerar inválidas. El formato de la respuesta de error es como el siguiente ejemplo:

{
    "status": 401,
    "code": 1,
    "message": "User not found or valid"
}

Estos errores tendrán tres categorías principales:

Error de Autentificación

  • HTTP Status: 401 - Unauthorized

    Code Message
    1 User not found or valid

Error de Cliente

  • HTTP Status: 400 - Bad Request

    Code Message
    0 Authenticate
    2 Entity ID not found
    3 Missing required property
    4 The entity received cannot be proccessed
    5 Incorrect token received
    6 Expired token received
    7 There is an error with the token provided. Please request a new one
    8 No token received
    9 Required request body is missing
    10 Event is marked as expired by timestamp
    11 Missing request header
    12 Access denied role
    13 Unique key violated
    14 There is an error in one or more elements
    15 Invalid GeoJson
    16 GeoJson does not belong to municipality

En el caso de obtener un error 3 - Missing required property la respuesta obtenida tendrá un valor en el message que nos indicará los campos que faltan por enviar:

{
    "status": 400,
    "code": 3,
    "message": "[municipalityIneCode: must not be null, capacity: must not be null]"
}

Error de Servidor

  • HTTP Status: 500 - Internal Server Error

    Code Message
    18 Internal error