Documents - ENG

Description

In Chouette, you can create documents linked to your offer. These documents can be timetables for your lines, images, etc.

Creation of a document type

Each document created in Chouette must have a type. Document types are managed at Workgroup level in the ‘Document types’ block:

For every document type: name, short name, description, document count, are displayed.

For each Document Type, a gearwheel is used to launch the available actions:

• Show this document type

• Edit this document type

• Delete this document type

To create a new document type, click on ‘Create a Document Type’ at the top right of the page:

You then define the name, short name and description of the type of document created:

Once validated, the document type is created and can be viewed and edited:

Creation of a document

Users of a Workbench are responsible for creating documents relating to their offer.

You can check the list of documents created in your Workbench:

For each document you create, a gearwheel allows you to view, edit or delete the document:

To add a document, click on ‘Create a Document’ at the top right of the page.

In the edit form, fill in the information relating to your document.

In the ‘Identification’ block :

You must enter the name of the document being created and assign it a document type.

Il est possible de définir une période de validité pour votre document :

Dans le bloc “Contenu”, vous devez sélectionner le document à partir de votre répertoire et y ajouter une description :

Vous pouvez définir le fournisseur de document et ajouter un code :

Après validation, votre document est créé. Une fiche récapitulative du document apparait avec un aperçu s'il s’agit d'une image. Vous pouvez éditer ou supprimer votre document.

Association d’un document à une ligne

Une fois vos documents créés, vous pouvez les associer aux lignes correspondantes.

Pour associer un document à une ligne, il faut aller sur la fiche d’une ligne dans le référentiel et cliquer sur “Associer d’autres documents” :

Vous êtes redirigé sur la page de sélection des documents. La partie supérieure de la page correspond aux documents déjà associés à la ligne. Une roue dentée vous permet de dissocier le document en question :

La partie inférieure de la page correspond aux documents non-associés à la ligne et disponible dans votre Espace de Travail. Pour chaque document de la liste, une roue dentée vous permet l’association à ligne :

Une fois le document associé, celui-ci passe dans la section supérieure de la page avec une notification de confirmation :

Association d’un document à un arrêt

Une fois vos documents créés, vous pouvez les associer aux arrêts correspondants.

Pour associer un document à un arrêt, il faut aller sur la fiche d’un arrêt dans le référentiel et cliquer sur le bouton “Associer d’autres documents” :

Vous êtes redirigé sur la page d’association de documents :

Avec la roue dentée vous pouvez associer un ou plusieurs documents voulus à votre arrêt :

Après l’association, la fiche d’arrêt se met à jour, affichant les documents associés :

Pour ouvrir la page du document associé, il faut cliquer sur son nom. Ici vous pouvez éditer, télécharger ou supprimer ce document :

Pour dissocier un document, il faut revenir sur la page d’association à l’aide du bouton “Associer autres documents”, cliquer sur la roue dentée d’un document associé, puis sur “Dissocier” :

Association d’un document à un transporteur

Une fois vos documents créés, vous pouvez les associer aux transporteurs correspondants.

Pour associer un document à un transporteur, il faut aller sur la fiche d’un transporteur dans le référentiel de ligne et cliquer sur le bouton “Associer d’autres documents” :

Vous êtes redirigé sur la page d’association de documents :

Avec la roue dentée vous pouvez associer un ou plusieurs documents voulus à votre transporteur :

Après l’association, la fiche de transporteur se met à jour, affichant les documents associés :

Pour ouvrir la page du document associé, il faut cliquer sur son nom. Ici vous pouvez éditer, télécharger ou supprimer ce document :

Pour dissocier un document, il faut revenir sur la page d’association à l’aide du bouton “Associer autres documents”, cliquer sur la roue dentée d’un document associé, puis sur “Dissocier” :

Fournisseurs de documents

Chaque document doit obligatoirement appartenir à un fournisseur. C’est à l’utilisateur d’un Espace de Travail de créer les fournisseurs de documents en relation avec son offre.

Vous pouvez consulter la liste des fournisseurs de documents créés dans votre Espace de travail :

Pour chaque fournisseur, nom, nom court, le nombre de documents et espace de travail, sont affichés.

Une roue dentée vous permet d’afficher, éditer ou supprimer le fournisseur de documents:

Pour ajouter un fournisseur, il faut cliquer sur le bouton “Créer un Fournisseur de Document” en haut à droite de la page.

Dans la fiche d'édition, il faut donner un nom et un nom court à votre fournisseur.

Après la validation du formulaire, votre fournisseur est créé, apparait dans la liste des fournisseurs de documents et peut être utilisé lors de la création de documents.

Publication des documents via API

Les documents associés aux lignes peuvent être récupérés via une API de Publication paramétrée dans votre Groupe de Travail.

La description et l’utilisation de cette API (parmi d’autres) est disponible dans de nombreux langages via notre documentation Postman.

Récupération des documents

Pour récupérer vos documents publiés via API, il suffit d’utiliser le endpoint suivant :

# Ligne
/api/v1/datas/<publication api>/lines/<registration number>/documents/<document_type>
# Arret
/api/v1/datas/<publication api>/stop_areas/<registration number>/documents/<document_type>
# Transporteur
/api/v1/datas/<publication api>/companies/<registration number>/documents/<document_type>
# A une date définie 
/api/v1/datas/<publication api>/companies/<registration number>/documents/<document_type>?valid_on=<date>

• <publication api> doit être remplacé par le nom court de votre API de publication

• <registration number> doit être remplacé par le numéro d’enregistrement de votre ligne. En référence au GTFS, cela correspond au route_id.

• <document_type> doit être remplacé par le nom court du type de document du document souhaité.

• <date> doit être remplacé par la date de validité du document souhaité. Cette date doit être au format AAAA-MM-JJ

Par exemple, en utilisant le endpoint :

/api/v1/datas/GTFS/lines/230/documents/fiche_horaire?valid_on=2024-05-22

⇒ Vous récupérez sur l’API de Publication “GTFS” le document type ‘fiche_horaire” associé à la ligne “302” valide le 22 mai 2024.

Si une ligne est associée à plusieurs documents, seul le dernier document mis à jour avec le bon type et la bonne date de validité sera récupéré.