zbe

The Low Emissions Zones Publication Service is dedicated to the management of information related to the ZBE by the City Councils.

The objective of this service is to collect alphanumerical and geometric data from the ZBE received from the Town Councils that manage them, and to publish said information in a standardized format.

Both the publication and subscription functionality require different access certificates that must be requested and supplied by DGT 3.0. These certificates, if they have not already been requested, must be requested from soporte@cmobility30.es.

Below are the URLs with which each functionality is accessed:

Mode	urls	Description
Publication	https://pre.cmobility30.es/zbe	Client Integration Environment Endpoint for Publishing

The functionalities are described below.

Publication

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

The general details to make a request:

General Autenticación · (cmobility30.es)

Information related to the attributes of the ZBE

Example of the fictitious area of Pamplona

{

  "type": "Feature",
   "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -1.6586944021737509,
          42.817931931702304
        ],
        [
          -1.6651505010806034,
          42.81523032197569
        ],
        [
          -1.6659737620147723,
          42.814403923662184
        ],
        [
          -1.6639806039635516,
          42.81348215866973
        ],
        [
          -1.6631573430284732,
          42.81427678448003
        ],
        [
          -1.6612075144992389,
          42.813005378282725
        ],
        [
          -1.660340924042174,
          42.813927150381375
        ],
        [
          -1.657567834578714,
          42.814689985867005
        ],
        [
          -1.6547514155924148,
          42.81507140008085
        ],
        [
          -1.6551847108209188,
          42.81672416782487
        ],
        [
          -1.6581744478986309,
          42.81726448615976
        ],
        [
          -1.6586944021737509,
          42.817931931702304
        ]
      ]
    ]
   },
    "properties": {
      "name": "Correct Pamplona's topology example",
      "city_ine": [31201],
      "excluded": false
    } 

}

Attribute	Description
Type	Geometry Type
name	Name of the entity that manages the ZBE. It can be a City Council or entity, such as the Metropolitan Area of XXXXXX
city_ine	Array with the INE codes of the municipalities it manages
excluded	Indicates if the geometry is excluded from the ZBE, since it is within it but the traffic is allowed

Information regarding the information on the restriction

{
   "name": "Madrid",
   "city_ine": [28079,28002],
   "affected_labels": [1,4,2],
   "access_conditions": "Condiciones ejemplo",
   "information_url": "https://www.ayto.es/infoxxxxx",
   "timetable":[[“L”,"08:00:00", "16:00:00"], [“F”,"18:00:00", "20:00:00"]],
   "start_time": "2021-10-17T20:58:38Z"
}

Attribute	Description
name	Name of the entity that manages the ZBE. It can be a City Council or entity, such as the Metropolitan Area of XXXXXX
city_ine	Array with the INE codes of the municipalities it manages
affected_labels	Type of vehicles affected environmental labels
access_conditions	ZBE access conditions
information_url	URL where ZBE information is described
timetable	ZBE application timetable. This may be different for Weekdays “L”, or Holidays “F”
start_time	Expected effective date

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:

Auth

HTTP Status: 401 - Unauthorized

Code Message

1 User not found or valid

Code	Message
1	User not found or valid

Client

HTTP Status: 400 - Bad Request

Code	Message
0	Authenticate
1	Incorrect token received
2	Expired token received
3	There is an error with the token provided. Please request a new one
4	No token received
5	Required request body is missing
6	Missing request header
7	Access denied role

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

{
    "status": 400,
    "code": 0,
    "message": "Authenticate"
}

Server

HTTP Status: 500 - Internal Server Error

Code Message

13 Internal error

Code	Message
13	Internal error

Methods

The access methods to the REST API of the application are the following:

Create or update the attributes of a ZBE

Both for creating and updating the attributes of a ZBE. If the ZBE is new, it will be created, and if it already exists, its values will be updated.