INNEHÅLLSFÖRTECKNING
- Egenskaper för ett objekt för registrering
- Värde
- Lista
- Upprepbar
- Numerisk
- Textfält
- Bool
- Datum
- Dropdown
- Fil
- Hämta registreringar
En registrering är de uppgifter som en Rapportör har skickat in med tanke på en mätnings struktur. Med tanke på de anpassningsbara egenskaperna hos en mätning innehåller registreringen en graf med svar för de värden som motsvarar frågorna i en mätning.
Swagger användargränssnitt
Nedan hittar du dokumentationsdetaljer för registreringar. För att testa slutpunkten, vänligen gå till vår Swagger UI-sida.
Egenskaper för ett objekt för registrering
| Egendom | Typ av data | Beskrivning |
| id | Vägledning | Id för registreringen. |
organisationUnit | sträng | Den organisationsenhet som uppgifterna tillhör. |
| mätNamn | sträng | Mätningens namn |
Ansvarig användare | sträng | Rapportören som ansvarar för rapporteringen av uppgifterna |
bekräftadAt | DateTime? | Om registreringen bekräftas innehåller den tidsstämpeln |
| mätperiod | sträng | Typ av period |
| periodStart | sträng | Startdatum för perioden |
| periodSlut | sträng | Slutdatum för perioden |
| data | objekt | Datarepresentationen. Datastruktur. |
Period-egenskapen innehåller en kod och ett nummer. Till exempel "M4": M för månad och 4 för april. Det är ett sätt att identifiera periodiciteten om det behövs. Om mätningen är konfigurerad för att vara Året hittills är startdatumet alltid årets startdatum.
Data för registreringen är ett grafobjekt som innehåller värdena. Grafens struktur definieras av hur mätningen är set-up. Det är upp till controllern att konfigurera mätningen så att Rapportören kan fylla i den.
Rotobjektet i dataegenskapen är alltid ett ListValue, en samling värden.
Värde
Basen för alla värdetyper, innehåller allmän information som finns i alla värdetyper.
| Egendom | Beskrivning |
| id | Id för uppgifterna. Detta är unikt för varje registrering. |
| namn | Systemnamn; det kan ställas in i mätbyggaren för att identifiera kontrollen. |
| label | Det namn som visades för Rapportören. |
ämne | Typ av värde. Används som en diskriminator. |
etiketter | En lista med taggar. De kan ställas in i Measure Builder och är det rekommenderade sättet att identifiera en kontroll. |
För att identifiera en subtyp av Value används egenskapstypen. Alla gemensamma egenskaper är utelämnade i beskrivningarna av varje värde nedan.
Lista
En samling av värden. Rotobjektet i data är alltid en lista. Den kan innehålla andra listor. En listas id och namn är alltid null.
| Egendom | Beskrivning |
| Värde | Array med värden |
Exempel
Exempel på en lista med två värden.
{
"värde": [
{
"typ": "numeric",
"value": 4,
"unit": "Trips",
"id": "measure_1",
"name": "measure_1",
"märkning": "Antal flygningar",
"tags": []
},
{
"type": "numeric",
"value": 2000,
"unit": "km",
"id": "measure_2",
"name": "measure_2",
"märkning": "Avstånd med flygplan 2",
"tags": []
}
],
"type": "list"
}Upprepbar
En upprepningsbar kontroll i en mätning gör det möjligt för Rapportören att lägga till och ta bort rader i Position Green vid Datarapportering. Varje rad i den upprepningsbara modulen representeras som en lista i datastrukturen.
Egendom | Beskrivning |
| Värde | Array av rader |
Exempel
Ett exempel på en registrering där mätningen innehåller en upprepningsbar modul som gör det möjligt för Rapportören att lägga till en eller flera rader och ange en källa och använd energi.
Varje rad i den upprepningsbara modulen tilldelas ett unikt id, men namnet på varje kontroll kommer fortfarande att vara detsamma.
Svaret ser ut så här.
{
"värde": [
{
"typ": "upprepningsbar modul",
"värde": [
{
"värde": [
{
"typ": "dropdown",
"värde": [
{
"namn": "Wind"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 65000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Solar"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 250000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Nuclear"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 3000000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
}
],
"typ": "list"
}Numerisk
Innehåller ett numeriskt värde och en enhet.
| Egendom | Beskrivning |
värde | Decimalvärde |
| enhet | Enheten för värdet |
Exempel
Värdet är 9000 och enheten är i kilometer.
{
"typ": "numeric",
"value": 9000,
"unit": "km",
"id": "measure_2_copy1",
"name": "measure_2_copy1",
"märkning": "Avstånd med tåg",
"tags": []
}Textfält
Textvärde där Rapportören fyller i ett kvalitativt svar.
| Egendom | Beskrivning |
| värde | Textvärde |
{
"typ": "text",
"id": "info",
"name": "info",
"märkning": "Ytterligare information",
"tags": [],
"value": "Kvalitativt textsvar"
}Bool
Ett bool-värde där Rapportören har valt mellan Ja och Nej när han fyllt i svaren.
| Egendom | Beskrivning |
| värde | Booleskt värde |
Exempel
{
"type": "bool",
"id": "renewable",
"name": "renewable",
"märkning": "Är källan förnybar?",
"tags": [],
"value": true
}Datum
Ett värde som innehåller ett datum i ISO 8601, format ååååå-mm-dd.
| Egendom | Beskrivning |
| värde | Datum i ISO 8601-format ååååå-mm-dd |
Exempel
{
"typ": "date",
"value": "2020-01-24",
"id": "registration_date",
"name": "registration_date",
"märkning": "Date",
"tags": []
}Dropdown
Ett rullgardinsvärde som innehåller ett eller flera alternativ som valts av en Rapportör.
| Egendom | Beskrivning |
| Värde | En array av SelectedOption |
Rullgardinsmenyn har en konfigurationsinställning som anger om Rapportören får välja många värden. Rullgardinsmenyns värde är alltid en array i datastrukturen.
SelectedOption innehåller ett namn och ett valfritt värde.
Exempel
Här är ett exempel på tre olika värden från rullgardinsmenyer.
- Värdet innehåller en JSON-kodad sträng
- Värdet innehåller ett enkelt värde
- Det finns inget värde kopplat till det valda alternativet
{
"typ": "upprepningsbar modul",
"värde": [
{
"värde": [
{
"typ": "dropdown",
"värde": [
{
"namn": "Vind",
"värde": "{\"renewable\":true}"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 65000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Solar",
"värde": "100"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 250000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Nuclear"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 3000000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
}Fil
Ett värde som representerar uppladdade filer av Rapportören. Rapportören kan uppladda en eller flera filer. De innehåller ett namn och en länk. Namnet är filnamnet och länken är en URL-sökväg för att ladda ner bilagan.
Egendom | Beskrivning |
| Värde | En array av filer (namn och länk) |
Exempel
{
"typ": "file",
"value": [
{
"name": "Faktura ACME.pdf",
"länk": "/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": "Uppladdning av källmaterial",
"tags": []
}Hämta registreringar
GET https://api.positiongreen.com/v1/registrations
Returnerar registreringar
Parametrar för förfrågan
| År | Ämne | Beskrivning |
|---|---|---|
| årId* | sträng | Årets id (Guid) |
| måttIds | uppställning | Mätning av id (Guid) |
| orgUnitIds | uppställning | Organisationsenhetens id (Guid) |
| orgUnitIds | uppställning | Organisationsenhetens id (Guid) |
| includeChildren | bool | Anger om barn till de inkluderade organisationsenheterna ska ingå i svaret. (Förvalt = false) |
| mätaPrettyIds | uppställning | Ganska id för mätningar (sträng) |
| startDatum | sträng | Startdatum för registreringar (åååå-mm-dd) |
slutDatum | sträng | Slutdatum för registreringar (åååå-mm-dd) |
| först | [empty string] | Antal registreringar för att återvända. Förvalt = 10. Minst 1 och högst 100. |
| efter | sträng | Markör till var vi ska fortsätta att få registreringar från |
| sortera efter | sträng | "Period |
| sortDirection | sträng | "Stigande", "Fallande |
{
"totalCount": 178,
"pageInfo": {
"hasNextPage": true,
"startCursor": "cGFnZTsw",
"endCursor": "cGFnZTs5"
},
"items": [
{
"cursor": "cGFnZTs0MTQ=",
"node": {
"id": "715117fd-a8c5-4cf7-9a4b-8cc7aafee0f4",
"organizationUnit": "Björn Johansson",
"measureName": "Rapportering av energianvändning",
"responsibleUser": "Björn Johansson",
"data": {
"value": [
{
"type": "upprepningsbar modul",
"värde": [
{
"värde": [
{
"typ": "dropdown",
"värde": [
{
"namn": "Vind",
"värde": "{\"renewable\":true}"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862358690400",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 65000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862358690400",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Solar",
"värde": "100"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359182380",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 250000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359182380",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
},
{
"value": [
{
"type": "dropdown",
"värde": [
{
"namn": "Nuclear"
}
],
"id": "measure_fc2t!!repeatable_q3gn!!15862359243871",
"name": "measure_fc2t",
"märkning": "Source",
"tags": []
},
{
"type": "numeric",
"value": 3000000,
"unit": "kWh",
"id": "measure_dnkl!!repeatable_q3gn!!15862359243871",
"name": "measure_dnkl",
"märkning": "Användning av energi",
"tags": []
}
],
"type": "list"
}
],
"id": "repeatable_q3gn",
"name": "repeatable_q3gn"
},
{
"type": "file",
"value": [
{
"name": "ReportTest.pdf",
"länk": "/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"
}
}
]
}Vid användning av startDate och endDate returneras registreringar där periodEndDate ligger inom intervallet. Det innebär att om du filtrerar på startDate '2019-12-01' kommer du att få alla registreringar där periodEndDate är senare än 2019-12-01. Det kan vara så att mätningen är konfigurerad för att rapporteras årligen och då är startdatum för registreringen 2019-01-01 och slutdatum 2019-12-31 (om året följer ett kalenderår).
Var artikeln till hjälp?
Toppen!
Tack för din feedback
Vi beklagar att det inte var till hjälp
Tack för din feedback
Feddback skickat
Vi uppskattar din feedback och uppdaterar artikeln vid behov