","system":true,"type":"text"},{"name":"user-agent","sortOrder":7,"infoTitle":"We recommend using this header","info":"The User-Agent header is added to help the server identify Postman as the HTTP requesting application or client.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"User-Agent","value":"PostmanRuntime/7.39.1","system":true,"type":"text"},{"name":"accept","sortOrder":8,"infoTitle":"We recommend using this header","info":"The \"Accept: */*\" header is added to tell the server that Postman can understand and process all forms of response content types.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"Accept","value":"*/*","system":true,"type":"text"},{"name":"accept-encoding","sortOrder":9,"infoTitle":"We recommend using this header","info":"The Accept-Encoding header is added to indicate to the server that Postman HTTP client supports a defined list of content-encoding or compression algorithms as response.\n\nYou can remove the header or enter a new one with a different value. Doing that may not accurately render the response within the app.","allowedToToggle":true,"disableEdit":true,"key":"Accept-Encoding","value":"gzip, deflate, br","system":true,"type":"text"},{"name":"connection","sortOrder":10,"infoTitle":"We recommend using this header","info":"Postman added the Connection header to indicate the server to keep the underlying network connection open once the current response is received. This allows Postman to reuse the same connection for faster response times in subsequent requests to the same server.\n\nYou can remove this header or enter a new one with a different value, such as `Connection: Close` to control this behaviour.","allowedToToggle":true,"disableEdit":true,"key":"Connection","value":"keep-alive","system":true,"type":"text"}],"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/gtfs.zip","urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","gtfs.zip"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f12415c7-5ab0-4fc7-9a96-0763b6c64558"},{"name":"Get lines metadatas","id":"57ab17d6-c4a1-41e2-ba6a-ba689579a47e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{publication_api_key}}","type":"text"}],"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/lines.json","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publication_api_namespace}}"}]},"isInherited":true,"source":{"_postman_id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","name":"Publication","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","lines.json"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"57ab17d6-c4a1-41e2-ba6a-ba689579a47e"},{"name":"Get document for a line","id":"85b597e8-8ddc-4d79-b615-cb6c89cceae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{publication_api_key}}","type":"text"}],"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/lines/{{line_id}}/documents/{{document_type}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publication_api_namespace}}"}]},"isInherited":true,"source":{"_postman_id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","name":"Publication","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","lines","{{line_id}}","documents","{{document_type}}"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85b597e8-8ddc-4d79-b615-cb6c89cceae1"},{"name":"Get document for a stop area","id":"c59e9622-41f3-4b9d-86b8-a12731480515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{publication_api_key}}","type":"text"}],"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/stop_areas/{{stop_area_id}}/documents/{{document_type}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publication_api_namespace}}"}]},"isInherited":true,"source":{"_postman_id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","name":"Publication","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","stop_areas","{{stop_area_id}}","documents","{{document_type}}"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c59e9622-41f3-4b9d-86b8-a12731480515"},{"name":"Get document for a company","id":"32da74f8-f3cd-486a-8dbd-aa467b54b5df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{publication_api_key}}","type":"text"}],"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/companies/{{company_id}}/documents/{{document_type}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{publication_api_namespace}}"}]},"isInherited":true,"source":{"_postman_id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","name":"Publication","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","companies","{{company_id}}","documents","{{document_type}}"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"32da74f8-f3cd-486a-8dbd-aa467b54b5df"}],"id":"6d39b553-f5df-4b39-91c2-ee384e55fbbd","description":"This API uses the authentication system for published datas.
\nAPI requests to retrieve the published files return in the headers of the response:
\n\n- ETag: an identifier representing the version of a file accessible at a URL
\n- Last-Modified: Last modification date of the file accessible at a URL
\n
\nAPI requests can use 2 headers:
\n\n- HTTP_IF_NONE_MATCH: to transmit a unique content identifier (etag)
\n- HTTP_IF_MODIFIED_SINCE: to transmit the timestamp of the last modification of the content.
\n
\nIf the browser makes a request with the content identifier (etag) or the last modification since the timestamp corresponding to the version of the server, then the server returns an empty response with an unmodified status with an HTTP code 304.
\nEnvironment variables
\n\n\n\n| Environment variables | \nDescription | \n
\n\n\n\n| CHOUETTE_URL | \nUrl of the Chouette platform https://chouette.enroute.mobi/ | \n
\n\n| publication_api_key | \nAPI key for published data | \n
\n\n| publication_api_namespace | \npublishing API namespace | \n
\n\n
\n
Get the total number of vehicle journeys by date with filter on dates.\nIt is possible to make different kind of search following the arguments of the request:
\n\n- from only : after that date
\n- to only : before that date
\n- from and to : between 2 dates
\n
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","name":"GraphQL","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","graphql"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcd2bbb5-b8c5-4df4-8bb8-da889a405e44"},{"name":"Lines->Routes","id":"ca1b4acb-d7ac-4ca6-be91-62a393e7a330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token token={{publication_api_key}}"}],"body":{"mode":"graphql","graphql":{"query":"{\n lines {\n nodes {\n objectid\n name\n routes {\n nodes {\n name\n objectid\n }\n }\n }\n }\n}","variables":""}},"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/graphql?=","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","name":"GraphQL","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","graphql"],"host":["{{CHOUETTE_URL}}"],"query":[{"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"ca1b4acb-d7ac-4ca6-be91-62a393e7a330"},{"name":"Lines->Routes->StopPoints","id":"2dbff38f-038c-43e5-b9a9-df3e3ee1acfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token token={{publication_api_key}}"}],"body":{"mode":"graphql","graphql":{"query":"{\n # lines and stopAreas can all be paginated. See \"Paginated StopAreas\" request for more details.\n lines {\n nodes {\n objectid\n name\n routes {\n nodes {\n name\n objectid\n publishedName\n wayback\n stopPoints {\n nodes {\n position\n stopArea{\n name\n objectid\n }\n }\n }\n }\n }\n }\n }\n}","variables":""}},"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/graphql","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","name":"GraphQL","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","graphql"],"host":["{{CHOUETTE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2dbff38f-038c-43e5-b9a9-df3e3ee1acfe"},{"name":"Lines -> Documents","id":"7ba8170e-aae5-447d-bad9-7ad607b5a340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token token={{publication_api_key}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"{\n lines {\n nodes {\n name\n number\n publishedName\n codes\n documents { \n uuid\n name\n documentType\n description\n validityPeriod\n createdAt\n updatedAt\n }\n }\n }\n}","variables":""}},"url":"{{CHOUETTE_URL}}/api/v1/datas/{{publication_api_namespace}}/graphql?=","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","name":"GraphQL","type":"folder"}},"urlObject":{"path":["api","v1","datas","{{publication_api_namespace}}","graphql"],"host":["{{CHOUETTE_URL}}"],"query":[{"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"7ba8170e-aae5-447d-bad9-7ad607b5a340"}],"id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da","description":"This API uses the system of authentication for published datas
\nEnvironment variables
\n\n\n\n| Environment variables | \nDescription | \n
\n\n\n\n| CHOUETTE_URL | \nUrl of Chouette platform type https://chouette.enroute.mobi/ | \n
\n\n| publication_api_key | \nAPI key for published datas | \n
\n\n| publication_api_namespace | \nshort name of Publication API | \n
\n\n
\n
Models used in API
\nThe following tables show in details the models used in API and accessible attributs :
\nStopAreas
\n\n\n\n| Attributs | \nComments | \n
\n\n\n\n| name | \n | \n
\n\n| objectid | \nbusiness identifier NeTEx | \n
\n\n| localizedNames | \n | \n
\n\n| areaType | \n | \n
\n\n| registrationNumber | \n | \n
\n\n| longitude | \n | \n
\n\n| latitude | \n | \n
\n\n| country | \n | \n
\n\n| streetName | \n | \n
\n\n| zipCode | \n | \n
\n\n| cityName | \n | \n
\n\n| postalRegion | \n | \n
\n\n| url | \n | \n
\n\n| timeZone | \n | \n
\n\n| waitingTime | \n | \n
\n\n| kind | \n | \n
\n\n| comment | \n | \n
\n\n| status | \n | \n
\n\n| confirmedAt | \n | \n
\n\n| deletedAt | \n | \n
\n\n| isReferent | \n | \n
\n\n| referent | \n | \n
\n\n| parent | \n | \n
\n\n| children | \n | \n
\n\n| lines | \n | \n
\n\n| createdAt | \n | \n
\n\n| updatedAt | \n | \n
\n\n| codes | \n | \n
\n\n| customFields | \n | \n
\n\n| accessibilities | \naccessibility attribute on stop area | \n
\n\n
\n
Lines
\n\n\n\n| Attributs | \nComments | \n
\n\n\n\n| name | \n | \n
\n\n| objectid | \nbusiness identifier NeTEx | \n
\n\n| registrationNumber | \n | \n
\n\n| number | \n | \n
\n\n| publishedName | \n | \n
\n\n| transportMode | \n | \n
\n\n| transportSubmode | \n | \n
\n\n| comment | \n | \n
\n\n| url | \n | \n
\n\n| color | \nline color | \n
\n\n| textColor | \ntext color of line | \n
\n\n| deactivated | \n | \n
\n\n| activeFrom | \n | \n
\n\n| activeUntil | \n | \n
\n\n| seasonal | \n | \n
\n\n| network | \n | \n
\n\n| company | \n | \n
\n\n| secondaryCompanies | \n | \n
\n\n| stopAreas | \n | \n
\n\n| createdAt | \n | \n
\n\n| updatedAt | \n | \n
\n\n
\n
Company
\n\n\n\n| Attributs | \nComments | \n
\n\n\n\n| name | \n | \n
\n\n| objectid | \nbusiness identifier NeTEx | \n
\n\n
\n
Network
\n\n\n\n| Attributs | \nComments | \n
\n\n\n\n| name | \n | \n
\n\n| objectid | \nbusiness identifier NeTEx | \n
\n\n
\n
Route
\n\n\n\n| Attributs | \nComments | \n
\n\n\n\n| name | \n | \n
\n\n| objectid | \nbusiness identifier NeTEx | \n
\n\n| wayback | \n | \n
\n\n| publishedName | \n | \n
\n\n
\n
Data tree
\nActually the datas are searchable on one of the following trees :
\n\n- Lines > Routes > StopAreas
\n- StopAreas > Lines
\n
\nThe call to intermediate models is optional (ex : Routes)
\nNavigation on API datas
\nBy default the number of reassembled elements in different calls is 50 elements
Only the number of Lines and StopAreas reassembled on the first level is fixed on 500 elements
\nTo navigate in the paginated data, it will be necessary to consult the cursors in the response to access the next page.
\nDuring the graphQL request, it is possible to get for the list of elements :
\n\n- first ones with keyword first
\n- last ones with keyword last
\n- after a cursor with the keyword after
\n
\nResearch of datas
\nLine
\nThere's two ways to request lines. One line or multiple lines.
\nWhen requesting one line, the research have 2 attributes:
\n\n- objectid
\n- registrationNumber
\n
\nexample :
\n{\n line(objectid: \"test\", registrationNumber: \"test\"){\n ...\n }\n}\n\n
When requesting multiple lines, the research have 2 attributes:
\n\n- transportMode : search by transport mode
\n- notTransportMode : search by excluding a transport mode
\n- transportModes : search by transport modes
\n- notTransportModes : search by excluding transport modes
\n- company : search by company
\n- notCompany : search by excluding a company
\n- companies : search by companies
\n- notCompanies : search by excluding companies
\n
\ntransportMode values must be used without quotes and uses values :
\n\n- tram
\n- metro
\n- funicular
\n- bus
\n- rail
\n
\nExamples :
\n{\n lines(transportMode: bus){\n ...\n }\n}\n{\n lines(transportModes: [bus, tram]){\n ...\n }\n}\n{\n lines(notTransportMode: bus){\n ...\n }\n}\n{\n lines(notTransportModes: [bus, tram]){\n ...\n }\n}\n\n
Company search uses the company objectid.
\nExamples :
\n{\n lines(company: \"chouette:Company:f9b1d751-6f88-4af6-96cf-a7aa426e1d32:LOC\"){\n ...\n }\n}\n{\n lines(companies: [\"chouette:Company:f9b1d751-6f88-4af6-96cf-a7aa426e1d32:LOC\", \"chouette:Company:f9b2d751-6f18-4af7-96cf-a7aa426e1d32:LOC\"]){\n ...\n }\n}\n{\n lines(notCompany: \"chouette:Company:f9b1d751-6f88-4af6-96cf-a7aa426e1d32:LOC\"){\n ...\n }\n}\n{\n lines(notCompanies: [\"chouette:Company:f9b1d751-6f88-4af6-96cf-a7aa426e1d32:LOC\", \"chouette:Company:f9b2d751-6f18-4af7-96cf-a7aa426e1d32:LOC\"]){\n ...\n }\n}\n\n
StopArea
\nThere's two ways to request stop areas. One stop area or multiple stop areas.
\nWhen requesting one stop area, the research have 2 attributes:
\n\n- objectid
\n- registrationNumber
\n
\nexample :
\n{\n stopArea(objectid: \"chouette:StopArea:5016c324-ca48-4911-aa0b-63d4285ea08b:LOC\", registrationNumber: \"test\"){\n ...\n }\n}\n\n
When requesting multiple stop areas, the research doesn't have any attributes:
\nexample :
\n{\n stopAreas{\n ...\n }\n}\n\n
When requesting accessibilities, the research must include the attribute needed:
\nexample :
\n{\n stopArea {\n nodes {\n accessibilities {\n mobilityImpairedAccessibility\n wheelChairAccessibility\n liftFreeAccessibility\n audibleSignalAvailability\n accessibilityLimitationDescription\n }\n }\n}\n}\n\n
","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a582309c-f0e8-481e-9c47-98a0aa49b90b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"27586e8e-942c-4d03-8951-68191426143d","type":"text/javascript","exec":[""]}}],"_postman_id":"b8713f1e-630c-45bd-a2ad-2c443ae4b8da"}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"063c991f-356b-4f05-95e5-ad8538e7c348","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b466c692-ab5f-420f-95d5-ae4daa2fc2ba","type":"text/javascript","requests":{},"exec":[""]}}]}