TABLE DES MATIÈRES
- Propriétés d'un objet d'enregistrement
- Valeur
- Liste
- Répétable
- Numérique
- Texte
- Bool
- Date
- menu déroulant
- Fichier
- Obtenir des inscriptions
Une inscription correspond aux données qu'un rapporteur a soumises compte tenu de la structure d'une mesure. Compte tenu des propriétés personnalisables d'une mesure, l'enregistrement contient un graphique des réponses pour les valeurs correspondant aux questions d'une mesure.
Interface utilisateur Swagger
Vous trouverez ci-dessous les détails de la documentation relative aux inscriptions. Pour tester le point de terminaison, rendez-vous sur notre page Swagger UI.
Propriétés d'un objet d'enregistrement
| Propriété | Type de données | Description |
| id | Guide | Identifiant de l'enregistrement. |
unité organisationnelle | chaîne | L'unité organisationnelle à laquelle appartiennent les données. |
| nomDeMesure | chaîne | Nom de la mesure |
utilisateur responsable | chaîne | Le journaliste chargé de rapporter les données |
confirméÀ | Date et heure ? | Si l'enregistrement est confirmé, il contient l'horodatage. |
| période | chaîne | Le type de période |
| début de période | chaîne | Date de début de la période |
| fin de période | chaîne | Date de fin de la période |
| données | objet | La représentation des données. Structure des données. |
La propriété d'époque contient un code et un numéro. Par exemple « M4 » : M pour mois et 4 pour avril. C'est un moyen d'identifier la périodicité si nécessaire. Si la mesure est configurée pour être calculée depuis le début de l'année, la date de début correspond toujours à la date de début de l'année.
Les données d'enregistrement sont un objet graphique contenant les valeurs. La structure du graphique est définie par la manière dont la mesure est configurée. Il appartient au contrôleur de configurer la mesure que le déclarant doit remplir.
L'objet racine dans la propriété de données est toujours une ListValue, une collection de valeurs.
Valeur
Base de tous les types de valeurs, contient des informations générales disponibles dans tous les types de valeurs.
| Propriété | Description |
| id | Identifiant des données. Ceci est unique pour chaque inscription. |
| nom | Nom du système ; il peut être défini dans le générateur de mesures afin d'identifier le contrôle. |
| étiquette | Le nom d'affichage montré au journaliste. |
type | Le type de la valeur. Utilisé comme discriminateur. |
balises | Une liste de balises. Ils peuvent être définis dans Measure Builder et est la méthode recommandée pour identifier un contrôle. |
Pour identifier un sous-type de Valeur, on utilise le type de propriété. Toutes les propriétés communes sont omises dans les descriptions de chaque valeur ci-dessous.
Liste
Une collection de valeurs. L'objet racine dans les données est toujours une liste. Il peut contenir d'autres listes. L'identifiant et le nom d'une liste sont toujours nuls.
| Propriété | Description |
| Valeur | Tableau de valeurs |
Exemple
Exemple d'une liste comportant deux valeurs.
{
"value": [
{
"type": "numeric",
"value": 4,
"unit": "Trips",
"id": "measure_1",
"name": "measure_1",
"label": « Nombre de vols »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 2000,
« unit » : « km »,
« id » : « measure_2 »,
« name » : « measure_2 »,
« label » : « Distance par avion 2 »,
« tags » : []
}
],
« type » : « list »
}Répétable
Un contrôle reproductible dans une mesure permet au rapporteur d'ajouter et de supprimer des lignes dans Position Green lors de la communication des données. Chaque ligne dans la répétition est représentée sous forme de liste dans la structure de données.
Propriété | Description |
| Valeur | Tableau de lignes |
Exemple
Exemple d'enregistrement où la mesure contient une répétition qui permet au déclarant d'ajouter une ou plusieurs lignes et d'indiquer une source et l'énergie utilisée.
Chaque ligne du bloc répétable se voit attribuer un identifiant unique, mais le nom de chaque contrôle reste le même.
La réponse ressemble à ceci.
{
"value": [
{
"type": "repeatable",
"value": [
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Wind"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 65000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solaire"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 250000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nucléaire"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 3000000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"label": « Énergie consommée »,
« tags » : []
}
],
« type » : « list »
}
],
« id » : « repeatable_q3gn »,
« name » : « repeatable_q3gn »
}
],
« type » : « list »
}Numérique
Contient une valeur numérique et une unité.
| Propriété | Description |
valeur | Valeur décimale |
| unité | L'unité de la valeur |
Exemple
La valeur est 9000 et l'unité est le kilomètre.
{
"type": "numeric",
"value": 9000,
"unit": "km",
"id": "measure_2_copy1",
"name": "measure_2_copy1",
"label": "Distance par train",
"tags": []
}Texte
Valeur textuelle où le rapporteur saisit une réponse qualitative.
| Propriété | Description |
| valeur | Valeur du texte |
{
"type": "text",
"id": "info",
"name": "info",
"label": "Informations supplémentaires",
"tags": [],
"value": "Réponse textuelle qualitative"
}Bool
Une valeur booléenne où le rapporteur a choisi entre Oui et Non lors du remplissage des réponses.
| Propriété | Description |
| valeur | Valeur booléenne |
Exemple
{
"type": "bool",
"id": "renewable",
"name": "renewable",
"label": "La source est-elle renouvelable ?",
"tags": [],
"value": true
}Date
Une valeur qui contient une date au format ISO 8601, aaaa-mm-jj.
| Propriété | Description |
| valeur | Date au format ISO 8601 aaaa-mm-jj |
Exemple
{
"type": "date",
"value": "2020-01-24",
"id": "registration_date",
"name": "registration_date",
"label": "Date",
"tags": []
}menu déroulant
Une valeur déroulante qui contient une ou plusieurs options sélectionnées par un journaliste.
| Propriété | Description |
| Valeur | Un tableau de SelectedOption |
Le menu déroulant comporte un paramètre de configuration qui indique si le rapporteur est autorisé à sélectionner plusieurs valeurs. La valeur du menu déroulant est toujours un tableau dans la structure de données.
La SelectedOption contient un nom et une valeur facultative.
Exemple
Voici un exemple de trois valeurs différentes issues de menus déroulants.
- La valeur contient une chaîne codée en JSON.
- La valeur contient une valeur simple.
- Aucune valeur n'est associée à l'option sélectionnée.
{
"type": "repeatable",
"value": [
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Wind",
"value": "{\"renewable\":true}"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 65000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solaire",
"value": "100"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 250000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nucléaire"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 3000000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"label": « Énergie consommée »,
« tags » : []
}
],
« type » : « list »
}
],
« id » : « repeatable_q3gn »,
« name » : « repeatable_q3gn »
}Fichier
Valeur représentant les fichiers téléchargés par le rapporteur. Le journaliste peut télécharger un ou plusieurs fichiers. Ils contiennent un nom et un lien. Le nom correspond au nom du fichier et le lien est une URL permettant de télécharger la pièce jointe.
Propriété | Description |
| Valeur | Un tableau de fichiers (nom et lien) |
Exemple
{
"type": "file",
"value": [
{
"name": "Invoice ACME.pdf",
"link": "/attachment/get/3ef994e5-81ee-4958-bb99-3812be0d305a"
},
{
"name": "Invoice FOO.xlsx",
"link": "/attachment/get/ba602707-0055-48b2-b6ed-879eabfa217b"
}
],
"id": "measure_gtby",
"name": "measure_gtby",
"label": "Télécharger les documents sources",
"tags": []
}Obtenir des inscriptions
GET https://api.positiongreen.com/v1/registrations
Retours d'inscriptions
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| annéeId* | chaîne | Identifiant de l'année (Guid) |
| mesureIds | tableau | Identifiants de mesure (Guid) |
| orgUnitIds | tableau | Identifiants d'unité organisationnelle (Guid) |
| orgUnitIds | tableau | Identifiants d'unité organisationnelle (Guid) |
| inclure les enfants | bool | Indique s'il faut inclure les enfants des unités organisationnelles fournies dans la réponse. (Valeur par défaut = faux) |
| mesurerPrettyIds | tableau | Identifiants esthétiques des mesures (chaîne) |
| date de début | chaîne | Date de début pour obtenir les inscriptions (aaaa-mm-jj) |
date de fin | chaîne | Date limite pour les inscriptions (aaaa-mm-jj) |
| premier | numéro | Nombre d'inscriptions à renvoyer. Valeur par défaut = 10. Minimum 1 et maximum 100. |
| après | chaîne | Curseur pour indiquer où continuer à obtenir les inscriptions |
| trier par | chaîne | « Période » |
| sortDirection | chaîne | « Ascendant », « Descendant » |
{
"totalCount": 178,
"pageInfo": {
"hasNextPage": true,
"startCursor": "cGFnZTsw",
"endCursor": "cGFnZTs5"
},
"items": [
{
"cursor": « cGFnZTs0MTQ= »,
« node » : {
« id » : « 715117fd-a8c5-4cf7-9a4b-8cc7aafee0f4 »,
« organizationUnit » : « Björn Johansson »,
« measureName » : « Rapport sur la consommation d'énergie »,
« responsibleUser » : « Björn Johansson »,
« data » : {
« value » : [
{
« type » : « repeatable »,
« value » : [
{
« value » : [
{
"type": "dropdown",
"value": [
{
"name": "Wind",
"value": "{\"renewable\":true}"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 65000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solaire",
"value": "100"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 250000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nucléaire"
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"label": « Source »,
« tags » : []
},
{
« type » : « numeric »,
« value » : 3000000,
« unit » : « kWh »,
« id » : « measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"label": "Énergie consommée",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
},
{
"type": "file",
"value": [
{
"name": "ReportTest.pdf",
"link": "/attachment/get/3ef294e5-81ee-4958-bb99-3812be0d305a"
},
{
"name": "Information.pdf",
"link": "/attachment/get/bb602707-0055-48b2-b6ed-879eabfa217b"
}
],
"id": "measure_gtby",
"name": "measure_gtby",
"label": « Filuppladdning »,
« tags » : []
}
],
« type » : « list »
},
« period » : « Y0 »
}
}
]
}Une requête utilisant startDate et endDate renverra les inscriptions dont periodEndDate se situe dans la plage. Cela signifie que si vous filtrez sur startDate « 2019-12-01 », vous obtiendrez toutes les inscriptions dont la date periodEndDate est postérieure au 01/12/2019. Cela peut s'expliquer par le fait que la mesure est configurée pour être déclarée chaque année, la date de début de l'enregistrement étant alors le 01/01/2019 et la date de fin le 31/12/2019 (si l'année correspond à l'année civile).
Cet article a-t-il été utile ?
C'est super !
Merci pour votre commentaire
Désolé ! Nous n'avons pas pu vous être utile
Merci pour votre commentaire
Commentaires envoyés
Nous apprécions vos efforts et nous allons corriger l'article