Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Chouette-Valid API
Introduction
Messages
POST
Create a validation
GET
Get a validation

Chouette-Valid API

General principle

Chouette-Valid API allows to validate GTFS and NeTEx files. A validation job is created and once it is done, you are able to read the validation error messages if any.

To create a validation, you need:

  • a file

  • a set of rules

You then need to wait until the validation is proceed. It has one of the following statuses:

  • new: the validation was just created

  • enqueued: the validation is waiting to be processed

  • running: the validation is being processed

  • done: the validation is finished

Once the validation is done, it has one the following user statuses:

  • pending: the validation is still running

  • successful: the file is valid

  • warning: the file is valid, but there are some warnings

  • failed: the file is invalid

If the validation has failed or have some warning, you can get the list of messages.

Typical scenario

First, you need to create a validation to check a GTFS or NeTEx file. If the request is successful, you will receive a id that will identify your validation for the rest of the process. Next, you will need to make another request to periodically check the status of the validation until that validation is done. Now, you can check if it is successful or not. If it is not succesfull, you may retrieve warning or error messages via a final request.

API Access

This API is reserved for users of Chouette Valid SaaS platform and requires an account token. To request an account, contact our team on https://enroute.mobi.

The Chouette Valid API is available on https://chouette-valid.enroute.mobi. API calls are made only in HTTPS.

All API endpoints must be invoked by using our account token with an Authentication: Token header (see examples below).

Response codes

All requests return:

  • an HTTP 200 code (OK): if successful

  • an HTTP 400 code (Bad Request): when parameters are unknown.

  • an HTTP 500 code (Internal Server Error): in the event of an undetermined error

Support

Any question ? Contact our support team on https://support.enroute.mobi

AUTHORIZATIONInherit auth from parent