U

Use Case 17

Use case 17 is dedicated to information related to receiving and publishing in real time the position of workers on the road when they present a risk to themselves or to drivers. This service includes the information generated by the Connected Vest.

This information can be sent to the DGT 3.0 platform either by IoT devices or by Apps that can be used to position these elements on the road. The platform has the functionality for the publication (sending) of information through a REST API. Both the publication and subscription functionality require different access certificates that must be requested and supplied by DGT 3.0. If these certificates have not already been requested, they should be requested from soporte@cmobility30.es.

Below are the URLs with which each functionality is accessed:

Mode URL Description
Publication https://pre.cmobility30.es/use-case-17 Client integration environment endpoint for publishing

The functionality is described below.

Publication

This use case has a REST API for the publication (sending) of the data by the companies that request it. Details of this can be found in the following sections:

  • General details for making a request:

General · (cmobility30.es)

  • The details of the master tables and data that can compose the event:

Master Tables

  • The structure of the event can be seen here:

Event

Errors

As stated above, all HTTP responses other than 200 – OK, can be considered invalid. The format of the error response is like the following example:

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

These errors will have three main categories:

Authentication Error

  • HTTP Status: 401 - Unauthorized
    Code Message
    1 User not found or valid

Client Error

  • 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 Permission denied. Role assigned to user missing
    13 There is an error in one or more elements of the list
    14 The actionId must be unique. This one has been already used
    15 The event type is 3. However, event has not been started
    16 The event has already been marked as finished
    17 The event has already been marked as started
    19 The event had been marked as finished automatically
    20 The event type must be between 2 and 3

In the case of getting an error 3 - Missing required property, the response obtained will have a value in the message that will indicate the missing fields to send:

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

Server Error

  • HTTP Status: 500 - Internal Server Error
    Code Message
    17 Internal error