INHALTSVERZEICHNIS
- Eigenschaften eines Registrierungsobjekts
- Wert
- Liste
- Wiederholungsmodul
- Zahl
- Text
- Bool
- Datum
- Auswahlliste
- Datei
- Registrierungen abrufen
Bei einer Registrierung handelt es sich um die Daten, die ein Berichterstatter aufgrund der Struktur einer Metrik übermittelt hat. Angesichts der individuell anpassbaren Eigenschaften einer Metrik enthält die Registrierung ein Diagramm der Antworten für die Werte, die den Fragen in einer Metrik entsprechen.
Swagger UI
Nachfolgend finden Sie die Dokumentation zu den Registrierungen. Um den Endpunkt zu testen, besuchen Sie bitte unsere Swagger-UI-Seite.
Eigenschaften eines Registrierungsobjekts
| Eigenschaft | Datenart | Beschreibung |
| id | Guid | ID der Registrierung |
organizationUnit | String | Organisationseinheit, zu der die Daten gehören |
| measureName | String | Bezeichnung der Metrik |
responsibleUser | String | Für die Datenerfassung zuständiger Berichterstatter |
confirmedAt | DateTime? | Wenn die Registrierung bestätigt wurde, hat sie einen Zeitstempel |
| period | String | Art des Zeitraums |
| periodStart | String | Startdatum des Zeitraums |
| periodEnd | String | Enddatum des Zeitraums |
| data | Objekt | Die Darstellung der Daten. Datenstruktur |
Die Eigenschaft "Zeitraum" enthält einen Code und eine Zahl, zum Beispiel "M4": M für Monat und 4 für April. Auf diese Weise lässt sich bei Bedarf das Intervall ermitteln. Wenn für die Metrik "Seit Jahresbeginn" eingestellt ist, dann ist das Startdatum immer das Datum des Jahresbeginns.
Die Registrierungsdaten sind ein Diagrammobjekt, das die Werte enthält. Die Diagrammstruktur richtet sich nach dem Setup der Metrik. Der Controller konfiguriert die Metrik, in der der Berichterstatter die Daten erfasst.
Das Stammobjekt in der Dateneigenschaft ist immer ein ListValue, eine Sammlung von Werten.
Wert
Die Grundlage aller Wertarten; enthält allgemeine Informationen, die in allen Wertarten verfügbar sind.
| Eigenschaft | Beschreibung |
| id | ID der Daten. Diese ist bei jeder Registrierung anders. |
| name | Systemname; er kann im Metrikengenerator festgelegt werden, um das Steuerelement näher zu bestimmen. |
| label | Anzeigename, den der Berichterstatter sieht |
type | Art des Wertes. Wird als Unterscheidungsmerkmal verwendet |
tags | Eine Liste von Tags. Sie können im Metrikengenerator festgelegt werden und werden als Möglichkeit zur Identifizierung eines Steuerelements empfohlen. |
Zur Ermittlung einer Unterart eines Wertes wird die Eigenschaftsart verwendet. In den nachfolgenden Beschreibungen der einzelnen Werte wurden alle gemeinsamen Eigenschaften weggelassen.
Liste
Eine Sammlung von Werten. Das Stammobjekt bei "data" ist immer eine Liste. Sie kann andere Listen enthalten. ID und Bezeichnung einer Liste sind immer Null.
| Eigenschaft | Beschreibung |
| Value | Auflistung von Werten |
Beispiel
Beispiel für eine Liste mit zwei Werten.
{
"value": [
{
"type": "numeric",
"value": 4,
"unit": "Trips",
"id": "measure_1",
"name": "measure_1",
"label": "Number of flights",
"tags": []
},
{
"type": "numeric",
"value": 2000,
"unit": "km",
"id": "measure_2",
"name": "measure_2",
"label": "Distance by airplane 2",
"tags": []
}
],
"type": "list"
}Wiederholungsmodul
Mit einem wiederholbaren Steuerelement kann ein Berichterstatter bei der Datenerfassung in Position Green in einer Metrik Zeilen hinzufügen und entfernen. Jede Zeile des Wiederholungsmoduls wird in der Datenstruktur als Liste dargestellt.
Eigenschaft | Beschreibung |
| Value | Auflistung von Zeilen |
Beispiel
Das nachfolgende Beispiel zeigt eine Registrierung in einer Metrik. Sie enthält ein Wiederholungsmodul, bei dem der Berichterstatter eine oder mehrere Zeilen hinzufügen und jeweils eine Energiequelle sowie den Energieverbrauch angeben kann.
Jeder Zeile im Wiederholungsmodul wird eine eindeutige ID zugewiesen, die Bezeichnung bleibt jedoch für jedes Steuerelement gleich.
Die Antwort sieht folgendermaßen aus:
{
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solar"
}
],
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nuclear"
}
],
"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": "Energy used",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
}
],
"type": "list"
}Zahl
Enthält einen numerischen Wert und eine Einheit.
| Eigenschaft | Beschreibung |
value | Dezimalwert |
| unit | Einheit des Wertes |
Beispiel
Der Wert ist 9000 und die Einheit ist Kilometer.
{
"type": "numeric",
"value": 9000,
"unit": "km",
"id": "measure_2_copy1",
"name": "measure_2_copy1",
"label": "Distance by train",
"tags": []
}Text
Textwert, bei dem der Berichterstatter eine qualitative Antwort einträgt.
| Eigenschaft | Beschreibung |
| value | Textwert |
{
"type": "text",
"id": "info",
"name": "info",
"label": "Additional info",
"tags": [],
"value": "Qualitative text response"
}Bool
Ein boolescher Wert, bei dem der Berichterstatter bei der Beantwortung zwischen Ja und Nein gewählt hat.
| Eigenschaft | Beschreibung |
| value | Boolescher Wert |
Beispiel
{
"type": "bool",
"id": "renewable",
"name": "renewable",
"label": "Is the source renewable?",
"tags": [],
"value": true
}Datum
Ein Wert, der ein Datum im Format JJJJ-MM-TT gemäß ISO 8601 enthält.
| Eigenschaft | Beschreibung |
| value | Datum im Format JJJJ-MM-TT gemäß ISO 8601 |
Beispiel
{
"type": "date",
"value": "2020-01-24",
"id": "registration_date",
"name": "registration_date",
"label": "Date",
"tags": []
}Dropdown-Listen
Ein Dropdown-Wert, der eine oder mehrere von einem Berichterstatter ausgewählte Optionen enthält.
| Eigenschaft | Beschreibung |
| Value | Mehrere SelectedOption-Werte |
In den Einstellungen der Dropdown-Liste wurde festgelegt, ob der Berichterstatter mehrere Werte auswählen darf. Der Dropdown-Wert ist immer eine Liste in der Datenstruktur.
Die SelectedOption enthält eine Bezeichnung und einen optionalen Wert.
Beispiel
Dieses Beispiel zeigt drei verschiedene Werte aus Dropdown-Listen.
- Der Wert enthält einen JSON-kodierten String.
- Der Wert enthält einen einfachen Wert.
- Es gibt keinen Wert für die ausgewählte Option.
{
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solar",
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nuclear"
}
],
"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": "Energy used",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
}Datei
Ein Wert, der die vom Berichterstatter hochgeladenen Dateien darstellt. Der Berichterstatter kann eine oder mehrere Dateien hochladen. Sie enthalten eine Bezeichnung und einen Link. Die Bezeichnung entspricht dem Dateinamen und der Link ist ein URL-Pfad zum Herunterladen des Anhangs.
Eigenschaft | Beschreibung |
| Value | Eine Liste von Dateien (Bezeichnung und Link) |
Beispiel
{
"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": "Upload source materials",
"tags": []
}Registrierungen abrufen
GET https://api.positiongreen.com/v1/registrations
Es werden Registrierungen ausgegeben
Abfrageparameter
| Bezeichnung | Art | Beschreibung |
|---|---|---|
| yearId* | String | ID des Jahres (Guid) |
| measureIds | Auflistung | IDs der Metrik (Guid) |
| orgUnitIds | Auflistung | IDs der Organisationseinheit (Guid) |
| orgUnitIds | Auflistung | IDs der Organisationseinheit (Guid) |
| includeChildren | bool | Gibt an, ob untergeordnete Einheiten der angegebenen Organisationseinheiten in die Antwort einbezogen werden sollen. (Standardeinstellung = falsch) |
| measurePrettyIds | Auflistung | PrettyIDs von Metriken (String) |
| startDate | String | Startdatum für den Abruf der Registrierungen (JJJJ-MM-TT) |
endDate | String | Enddatum für den Abruf der Registrierungen (JJJJ-MM-TT) |
| first | Zahl | Anzahl der auszugebenden Registrierungen. Standardeinstellung = 10. Mindestens 1 und höchstens 100. |
| after | String | Cursor für die Stelle, an der der Abruf von Registrierungen fortgesetzt werden soll. |
| sortBy | String | "Zeitraum" |
| sortDirection | String | "Aufsteigend", "Absteigend" |
{
"totalCount": 178,
"pageInfo": {
"hasNextPage": true,
"startCursor": "cGFnZTsw",
"endCursor": "cGFnZTs5"
},
"items": [
{
"cursor": "cGFnZTs0MTQ=",
"node": {
"id": "715117fd-a8c5-4cf7-9a4b-8cc7aafee0f4",
"organizationUnit": "Björn Johansson",
"measureName": "Report energy usage",
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Solar",
"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": "Energy used",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"value": [
{
"name": "Nuclear"
}
],
"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": "Energy used",
"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"
}
}
]
}Bei Abfragen mittels "startDate" und "endDate" werden Registrierungen ausgegeben, deren "periodEndDate" innerhalb des Bereichs liegt. Wenn Sie beispielsweise bei "startDate" nach "2019-12-01" filtern, erhalten Sie alle Registrierungen, bei denen das "periodEndDate" nach dem 1. Dezember 2019 liegt. Für eine Metrik könnte zum Beispiel als Intervall eine jährliche Datenerfassung eingestellt sein. Dann ist das Startdatum der Registrierung der 01.01.2019 und das Enddatum der 31.12.2019 (wenn das Jahr dem Kalenderjahr entspricht).
War dieser Artikel hilfreich?
Das ist großartig!
Vielen Dank für das Feedback
Leider konnten wir nicht helfen
Vielen Dank für das Feedback
Feedback gesendet
Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren