/rest/service_date

The rest API service_date endpoint allow to know at which dates, and which type of data are available for the concerned agency.

A session_id cookie is required to request CITiO APIs. To learn more about Authentification, use the documentation here.

Request

Base URL

https://{agency_name}.api.cit.io

Method
  • GET /rest/service_date
Request syntax

GET https://{agency_name}.api.cit.io/rest/service_date

Response

A JSON-formatted object containing a list of service dates.

Response code

Response content

200

Json object

400

bad query message

failed query message

500

Back-end error response

Fields

Name

Description

service_date

YYYY-MM-DD formatted date

num_validations

number of cleaned validations used to compute the kpis

num_courses

number of cleaned courses used to compute the kpis

num_courses_with_counting_cells

number of cleaned courses with counting cells boarding or alighting values greater than 0 used to compute the kpis

num_controls

number of cleaned controls used to compute the kpis

num_bookings_tad

number of cleaned TAD bookings used to compute the kpis

num_scheduled_courses

number of cleaned theoretical courses used to compute the kpis

JSON object

[
    {
        "num_controls": int,
        "num_courses": int,
        "num_courses_with_counting_cells": int,
        "num_validations": int,
        "service_date": int,
    },
    ...
]

Sample

Demonstrator

https://irigo_demonstrateur.api.cit.io/rest/service_date

Sample request
https://test_network.api.cit.io/rest/service_date
Sample response content
[
    {
        "num_controls": 0,
        "num_courses": 185,
        "num_courses_with_counting_cells": 103,
        "num_validations": 4613,
        "service_date": "2021-01-04",
    },
    {
        "num_controls": 0,
        "num_courses": 184,
        "num_courses_with_counting_cells": 100,
        "num_validations": 4588,
        "service_date": "2021-01-05",
    },
    {
        "num_controls": 0,
        "num_courses": 185,
        "num_courses_with_counting_cells": 102,
        "num_validations": 3231,
        "service_date": "2021-01-06",
    },
    {
        "num_controls": 0,
        "num_courses": 183,
        "num_courses_with_counting_cells": 100,
        "num_validations": 4601,
        "service_date": "2021-01-07",
    },
    {
        "num_controls": 0,
        "num_courses": 184,
        "num_courses_with_counting_cells": 103,
        "num_validations": 4365,
        "service_date": "2021-01-08",
    },
    {
        "num_controls": 0,
        "num_courses": 130,
        "num_courses_with_counting_cells": 89,
        "num_validations": 0,
        "service_date": "2021-01-09",
    },
    {
        "num_controls": 0,
        "num_courses": 128,
        "num_courses_with_counting_cells": 87,
        "num_validations": 0,
        "service_date": "2021-01-10",
    },
]

Avez-vous trouvé ce que vous cherchiez ?

/rest/lines

How to create a graph of Validations per line

Contact