{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"adapps-lango-switcher-macro","parameters":{"macroParams":{"hideTitle":{"value":"true"}},"macroMetadata":{"macroId":{"value":"563749eee59d8da7c7d2756534f0837ffdbb6c1fad7cd547fb794aff6330669b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://langoapp.adapps.it/assets/images/lango_logo.png"}}],"title":"Lango Switcher"}},"localId":"807b52a5-4c3e-4f00-8faa-9e9cbee8a374"}},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"96f7a838519d8aaeeedb7f8fd7275efb"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"53ff666b-c367-48e5-afe6-bf9b4c75eaae"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"In Chouette, you can create documents linked to your offer. These documents can be timetables for your lines, images, etc. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creation of a document type ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Each document created in Chouette must have a type. Document types are managed at Workgroup level in the ‘Document types’ block: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":269,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":269,"id":"6db33a45-5693-485b-a6c1-861973ca02f4","collection":"contentId-2786328577","type":"file","height":358}}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This section is available only to administrators of the Workgroup.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"For every document type: name, short name, description, document count, are displayed.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1018,"id":"db0f73fe-c271-441b-a2bf-b0a0530f64dc","collection":"contentId-2786328577","type":"file","height":457}}]},{"type":"paragraph","content":[{"text":"For each Document Type, a gearwheel is used to launch the available actions: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Show this document type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit this document type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delete this document type","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To create a new document type, click on ‘Create a Document Type’ at the top right of the page: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1015,"id":"6f24f348-57e8-4065-896c-ba8b9f76ac9d","collection":"contentId-2786328577","type":"file","height":160}}]},{"type":"paragraph","content":[{"text":"You then define the name, short name and description of the type of document created: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1134,"id":"db8ec03a-f382-4f10-b3d7-a6b470bd60e8","collection":"contentId-2786328577","type":"file","height":431}}]},{"type":"paragraph","content":[{"text":"Once validated, the document type is created and can be viewed and edited: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1137,"id":"ba5ba6d5-72d9-4d40-8a6e-738945916cf1","collection":"contentId-2786328577","type":"file","height":365}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creation of a document ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Users of a Workbench are responsible for creating documents relating to their offer. ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can check the list of documents created in your Workbench: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":269,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":269,"id":"11d35868-ef61-4a30-887e-b76a5208c154","collection":"contentId-2786328577","type":"file","height":459}}]},{"type":"paragraph","content":[{"text":"For each document you create, a gearwheel allows you to view, edit or delete the document: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1210,"id":"ea01f66b-c05a-4eb5-ba3b-a467c0123a73","collection":"contentId-2786328577","type":"file","height":566}}]},{"type":"paragraph","content":[{"text":"To add a document, click on ‘Create a Document’ at the top right of the page. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In the edit form, fill in the information relating to your document. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ‘Identification’ block : ","type":"text"}]},{"type":"paragraph","content":[{"text":"You must enter the name of the document being created and assign it a document type.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":718,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":758,"id":"75a4bf2b-a565-4061-a16d-643e1090071d","collection":"contentId-2786328577","type":"file","height":363}}]},{"type":"paragraph","content":[{"text":"You can define a validity period for your document: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":718,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":758,"alt":"01e04abd-8a77-467f-8bc5-86c9ba594fab.png","id":"7ceb6644-719f-4797-b96e-b4d1c89fb516","collection":"contentId-2786328577","type":"file","height":363}}]},{"type":"paragraph","content":[{"text":"In the ‘Content’ block, select the document from your directory and add a description: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":596,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":596,"id":"b8d1b0df-0ea5-4eb8-a43a-083cf8c581d1","collection":"contentId-2786328577","type":"file","height":178}}]},{"type":"paragraph","content":[{"text":"You can define the ","type":"text"},{"text":"document provider","type":"text","marks":[{"type":"link","attrs":{"href":"https://enroute.atlassian.net/wiki/spaces/PUBLIC/pages/2786328577/The+documents#Document-Providers"}}]},{"text":" and add a code : ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":650,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":650,"id":"1e642d31-6cc6-45c4-80fb-1cb87db8f0fb","collection":"contentId-2786328577","type":"file","height":253}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"After validation, your document is created. A summary of the document appears with a preview if it is an image. You can edit or delete your document. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":766,"id":"eb5e81c3-e953-4762-a7c7-68ca1ac7b47e","collection":"contentId-2786328577","type":"file","height":742}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Associate a document to a line ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Once you have created your documents, you can associate them with the corresponding lines. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To associate a document with a line, go to the line record in the repository and click on ‘Associate other documents’: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1468,"id":"3720d4c7-7e7c-4701-a478-afcae114e629","collection":"contentId-2786328577","type":"file","height":730}}]},{"type":"paragraph","content":[{"text":"You are redirected to the document selection page. The upper part of the page shows the documents already associated with the line. A cogwheel allows you to dissociate the document in question: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1210,"id":"d9c2d044-c034-488e-9e62-e0da3f5b5269","collection":"contentId-2786328577","type":"file","height":601}}]},{"type":"paragraph","content":[{"text":"The lower part of the page corresponds to the documents not associated with the line and available in your Workbench. For each document in the list, a cogwheel allows you to associate it with a line: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1192,"id":"4cacc58b-b428-415e-8685-3c7c526ae5ee","collection":"contentId-2786328577","type":"file","height":339}}]},{"type":"paragraph","content":[{"text":"Once the document has been linked, it moves to the top section of the page with a confirmation message: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1210,"id":"67486fea-1cd1-443e-8704-0126bf45f02b","collection":"contentId-2786328577","type":"file","height":647}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Associate a document to a stop","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Once you have created your documents, you can associate them with the corresponding stops. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To associate a document with a stop, go to the stop record in the referential and click on the ‘Associate other documents’ button: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":722,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":722,"id":"b5ee775b-1b92-47cd-9942-97c9b8f2a4af","collection":"contentId-2786328577","type":"file","height":168}}]},{"type":"paragraph","content":[{"text":"You will be redirected to the document association page: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1224,"id":"0e524949-2cb7-4760-9d88-4bf7bd8fdc2b","collection":"contentId-2786328577","type":"file","height":558}}]},{"type":"paragraph","content":[{"text":"Use the cogwheel to associate one or more documents with your stop: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1230,"id":"70aa79fa-2f9d-45af-ad03-27c621756154","collection":"contentId-2786328577","type":"file","height":638}}]},{"type":"paragraph","content":[{"text":"After association, the stop record is updated, displaying the associated documents: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":719,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":719,"id":"da99b76b-49e0-45a5-83d2-508e8571b87f","collection":"contentId-2786328577","type":"file","height":219}}]},{"type":"paragraph","content":[{"text":"To open the associated document record, click on its name. Here you can edit, download or delete the document: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":939,"id":"4769dee9-089b-41c6-84ad-0a93d863e667","collection":"contentId-2786328577","type":"file","height":742}}]},{"type":"paragraph","content":[{"text":"To dissociate a document, return to the ‘Associate Documents’ page using the ‘Link other documents’ button, click on the cogwheel of a linked document, then on ‘Dissociate’: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1145,"id":"11783098-5845-4ff6-af3e-da3f3593c2fa","collection":"contentId-2786328577","type":"file","height":602}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Associating a document with a company","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Once you have created your documents, you can associate them with the corresponding companies.","type":"text"}]},{"type":"paragraph","content":[{"text":"To associate a document with a company, go to the company record in the line referential and click on the ‘Associate other documents’ button:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1331,"id":"2f62a772-216c-41d3-ad3d-6cbf84f727b4","collection":"contentId-2786328577","type":"file","height":741}}]},{"type":"paragraph","content":[{"text":"You will be redirected to the document association page:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1235,"id":"dc2540ef-13a9-4e8d-854d-40ce0fcdf9e3","collection":"contentId-2786328577","type":"file","height":474}}]},{"type":"paragraph","content":[{"text":"Use the cogwheel to link one or more documents to your carrier: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1232,"id":"ebb63cb3-f73e-4351-bee5-ad43aacdc16c","collection":"contentId-2786328577","type":"file","height":538}}]},{"type":"paragraph","content":[{"text":"After association, the carrier record is updated, displaying the associated documents:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":611,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":611,"id":"38cab49f-0712-477d-ba92-871fb45ebddc","collection":"contentId-2786328577","type":"file","height":172}}]},{"type":"paragraph","content":[{"text":"To open the associated document page, click on its name. Here you can edit, download or delete the document:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1233,"id":"f71ed9e1-adb2-4633-a494-a11581d877db","collection":"contentId-2786328577","type":"file","height":702}}]},{"type":"paragraph","content":[{"text":"To dissociate a document, return to the ‘Associate Documents’ page using the ‘Associate other documents’ button, click on the cogwheel of a linked document, then on ‘Unlink’: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1234,"id":"e1bc9df0-3cb3-4b03-b12e-626b699cbfa9","collection":"contentId-2786328577","type":"file","height":536}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Document Providers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Each document must belong to a provider. It is up to the user of a Workbench to create document providers in relation to their offer. ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can check the list of document providers created in your Workbench: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":269,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":269,"id":"1f680807-4986-4985-a8be-95157e79f9e0","collection":"contentId-2786328577","type":"file","height":570}}]},{"type":"paragraph","content":[{"text":"For each provider: the name, short name, number of documents and workbench are displayed. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1234,"id":"a988717e-be4c-48bd-a1e4-4a5ef5014392","collection":"contentId-2786328577","type":"file","height":373}}]},{"type":"paragraph","content":[{"text":"A cogwheel lets you display, edit or delete the document provider: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":402,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":402,"id":"18358ded-a74d-4607-ac83-561dbee94916","collection":"contentId-2786328577","type":"file","height":369}}]},{"type":"paragraph","content":[{"text":"To add a provider, click on the ‘Create a Document Provider’ button at the top right of the page.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the edit form, you need to give your provider a name and a short name.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1224,"id":"838cf64d-2138-4a0c-ac92-cfa6e85f2b28","collection":"contentId-2786328577","type":"file","height":384}}]},{"type":"paragraph","content":[{"text":"Once the form has been validated, your provider is created, it appears in the list of document providers and can be used to create documents. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1222,"id":"9179afac-1de4-4843-a267-380d685a5693","collection":"contentId-2786328577","type":"file","height":499}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Publication of documents via API ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The documents associated with the lines can be retrieved via a Publication API set up in your Workgroup. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The description and use of this API (among others) is available in many languages via our ","type":"text"},{"text":"Postman documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/9950294/Szf3aqMh"}}]},{"text":".","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1470,"id":"1bf19f1e-f5cf-4cdb-8cec-c8b9f53dbb06","collection":"contentId-2786328577","type":"file","height":733}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Retrieving documents","type":"text","marks":[{"type":"textColor","attrs":{"color":"#403294"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To retrieve your documents published via API, simply use the following endpoint: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"# Line\n/api/v1/datas//lines//documents/\n# Stop Area\n/api/v1/datas//stop_areas//documents/\n# Company\n/api/v1/datas//companies//documents/\n# On a specific date \n/api/v1/datas//companies//documents/?valid_on=","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" must be replaced by the ","type":"text"},{"text":"short name","type":"text","marks":[{"type":"strong"}]},{"text":" of your publication API","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" must be replaced by the ","type":"text"},{"text":"registration number","type":"text","marks":[{"type":"strong"}]},{"text":" of your line. In reference to GTFS, this corresponds to route_id.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" must be replaced by the ","type":"text"},{"text":"short name","type":"text","marks":[{"type":"strong"}]},{"text":" of the document type of the desired document.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" must be replaced by the ","type":"text"},{"text":"validity date","type":"text","marks":[{"type":"strong"}]},{"text":" of the desired document. This date must be in YYYY-MM-DD format. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For example, using the endpoint :","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"/api/v1/datas/GTFS/lines/230/documents/fiche_horaire?valid_on=2024-05-22","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"⇒ The ‘GTFS’ Publication API is used to retrieve the ‘timetable’ document type associated with the ‘302’ line, which is valid on 22 May 2024.","type":"text"}]},{"type":"paragraph","content":[{"text":"If a line is associated with several documents, only the last document updated with the correct type and validity date will be retrieved. ","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported