{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"88561634-aafb-4f8e-bfa9-b99fd9f066b3","name":"GRC360 - Documentation Publique","description":"Cette documentation a pour but de vous présenter les principaux concepts utilisés par GRC360 pour mettre à disposition des données.\n\nPour commencer a utiliser l'API GRC360 vous avez besoin de :\n- Un compte 'Staff' sur la plateforme (Demander a votre administrateur de vous inviter à rejoindre sa collectivité).\n- L'identifiant de votre collectivité : le `tenantId`.\n\nSi vous ne posséder pas ces éléments vous pouvez contacter votre administrateur ou le [support GRC360](https://citopia.atlassian.net/servicedesk/customer/portals).\n\n\n## Spécification de la commune sur laquelle vous souhaitez travailler\n\nGRC360 permet à un seul utilisateur de traiter les données de plusieurs collectivités.\n\nPour simplifier l'utilisation de l'API et la répartition des données, l'utilisateur spécifie la collectivité sur laquelle il souhaite travailler dans le [Header HTTP](https://developer.mozilla.org/fr/docs/Web/HTTP/Headers) `X-Tenant`. \n\n```\nX-Tenant: <tenantId>\n```\n\nCe header doit être fourni dans toutes les requêtes envoyées à GRC360.\n\n**Un compte utilisateur étant utilisé pour travailler sur plusieurs collectivités, il n'est pas nécessaire de fournir ce header lors de l'authentification par exemple.**\n\nS'il n'est pas fourni, GRC360 renvoie l'erreur suivante :\n\n```json\n{\n    \"message\": \"tenant header is needed\",\n    \"success\": false,\n    \"code\": 400\n}\n```\n\n## Enveloppe de retour\n\nTous les messages de retour de l'API respectent le format suivant:\n\n| Key | type | obligatoire | description |\n|--|--|--|--|\n| code | number | oui | le code de retour |\n| data | any / any[] | non | les données renvoyées par le endpoint |\n| success | boolean | oui |est ce que l'action est un succès ?|\n| message | string | non | message complémentaire |\n\n## Pagination\n\nPour limiter le nombre d'éléments renvoyés pour chaque requête, la quasi totalité des endpoint de GRC360 renvoyant des données vont implémenter un mécanisme de pagination basé sur les paramètres suivants :\n\n| Paramètre      | Type     | Description                                                   | Valeur par defaut |\n|----------------|----------|---------------------------------------------------------------|-------------------|\n| start          | number | 1er Element à renvoyer (commence à 0)                         | 0                 |\n| size           | number | Nombre d'éléments à renvoyer                                  | 10                |\n| order[{field}] | DESC/ASC | Trie les résultats suivant le champs et la direction spécifée | -                 |\n\n\nCes paramètres doivent être passés en tant que [Query String](https://en.wikipedia.org/wiki/Query_string).\n\n**Si aucun paramètre n'est spécifié, GRC360 renvoie par défaut les 10 premiers éléments.**","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11624583","team":448543,"collectionId":"88561634-aafb-4f8e-bfa9-b99fd9f066b3","publishedId":"TzCV24D9","public":true,"publicUrl":"https://doc-api.grc360.fr","privateUrl":"https://go.postman.co/documentation/11624583-88561634-aafb-4f8e-bfa9-b99fd9f066b3","customColor":{"top-bar":"FFFFFF","right-sidebar":"212439","highlight":"2592f0"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-04-12T12:23:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0efa421509f67794a4fbe676177138aec049b1c023ec17170628f8ba2eba3e29","favicon":"https://grc360.fr/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://doc-api.grc360.fr/view/metadata/TzCV24D9"}