„api-v1-ecoaccount-get_de“ hinzufügen

Michel Peltriaux 2022-01-28 14:30:54 +01:00
parent 40a4a4d1c6
commit 31fe75d03f

376
api-v1-ecoaccount-get_de.md Normal file

@ -0,0 +1,376 @@
## Spezifikation
### Ökokonten
#### GET alle
`/api/v1/ecoaccount`
##### Beispiel Response
```json
{
"3e7acd84-bb67-408d-886e-91004c319f38": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
7.764930725097654,
50.530801443594385
],
[
7.763471603393552,
50.52709125717179
],
[
7.761154174804686,
50.524581259743805
],
[
7.762441635131831,
50.52141629007823
],
[
7.766475677490232,
50.51950629189859
],
[
7.770338058471677,
50.51868769758818
],
[
7.778749465942381,
50.51928800147066
],
[
7.780122756958003,
50.52763689111973
],
[
7.775144577026365,
50.533965783820754
],
[
7.768535614013667,
50.533965783820754
],
[
7.764930725097654,
50.530801443594385
]
]
]
],
"properties": {
"id": "3e7acd84-bb67-408d-886e-91004c319f38",
"identifier": "OEK-12022-TW4ECJ",
"title": "Tolles Ökokonto",
"created_on": "2022-01-12T11:41:14.328Z",
"modified_on": "2022-01-12T11:47:45.303Z",
"deductable_surface": 10000.0,
"deductable_surface_available": 9000.0,
"responsible": {
"conservation_office": {
"atom_id": 710123,
"long_name": "LK Ahrweiler",
"short_name": "10"
},
"conservation_file_number": "123-TEST",
"handler": "Landkreis Ahrweiler"
},
"legal": {
"agreement_date": "2022-01-11"
},
"before_states": [
{
"biotope": {
"atom_id": 136155,
"long_name": "Eichen-Buchenmischwald",
"short_name": "AA1"
},
"surface": 10000.0
}
],
"after_states": [
{
"biotope": {
"atom_id": 136156,
"long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
"short_name": "AA2"
},
"surface": 10000.0
}
],
"actions": [
{
"action": {
"atom_id": 709234,
"long_name": "Sonstiges (s. Erläuterungen)",
"short_name": null
},
"amount": 1.0,
"unit": "cm",
"comment": ""
}
],
"deadlines": [],
"deductions": [
{
"id": "f784e131-afb7-4e15-ad57-0b2469f5e967",
"eco_account": {
"id": "3e7acd84-bb67-408d-886e-91004c319f38",
"identifier": "OEK-12022-TW4ECJ",
"title": "Tolles Ökokonto"
},
"surface": 1000.0,
"intervention": {
"id": "97d7cce8-83e9-4043-bc76-317caf983a41",
"identifier": "EIV-12022-B6XGM9",
"title": "Tolles Baugebiet GEÄNDERT1"
}
}
]
}
},
"978ea565-83fd-4ad6-890f-babd16a1aa6a": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
7.764930725097654,
50.530801443594385
],
[
7.763471603393552,
50.52709125717179
],
[
7.761154174804686,
50.524581259743805
],
[
7.762441635131831,
50.52141629007823
],
[
7.766475677490232,
50.51950629189859
],
[
7.770338058471677,
50.51868769758818
],
[
7.778749465942381,
50.51928800147066
],
[
7.780122756958003,
50.52763689111973
],
[
7.775144577026365,
50.533965783820754
],
[
7.768535614013667,
50.533965783820754
],
[
7.764930725097654,
50.530801443594385
]
]
]
],
"properties": {
"id": "978ea565-83fd-4ad6-890f-babd16a1aa6a",
"identifier": "OEK-012022-NNMBVE",
"title": "Tolles Ökokonto",
"created_on": "2022-01-24T15:53:58.062Z",
"modified_on": "2022-01-24T15:55:33.602Z",
"deductable_surface": 100.0,
"deductable_surface_available": 100.0,
"responsible": {
"conservation_office": {
"atom_id": 710123,
"long_name": "LK Ahrweiler",
"short_name": "10"
},
"conservation_file_number": "123-TEST",
"handler": "Landkreis Ahrweiler"
},
"legal": {
"agreement_date": "2022-01-11"
},
"before_states": [
{
"biotope": {
"atom_id": 136155,
"long_name": "Eichen-Buchenmischwald",
"short_name": "AA1"
},
"surface": 10000.0
}
],
"after_states": [
{
"biotope": {
"atom_id": 136156,
"long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
"short_name": "AA2"
},
"surface": 10000.0
}
],
"actions": [
{
"action": {
"atom_id": 709234,
"long_name": "Sonstiges (s. Erläuterungen)",
"short_name": null
},
"amount": 1.0,
"unit": "cm",
"comment": ""
}
],
"deadlines": [],
"deductions": []
}
},
...
}
```
#### GET einzeln
`/api/v1/ecoaccount/<uuid>`
##### Beispiel Response
```json
{
"3e7acd84-bb67-408d-886e-91004c319f38": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
7.764930725097654,
50.530801443594385
],
[
7.763471603393552,
50.52709125717179
],
[
7.761154174804686,
50.524581259743805
],
[
7.762441635131831,
50.52141629007823
],
[
7.766475677490232,
50.51950629189859
],
[
7.770338058471677,
50.51868769758818
],
[
7.778749465942381,
50.51928800147066
],
[
7.780122756958003,
50.52763689111973
],
[
7.775144577026365,
50.533965783820754
],
[
7.768535614013667,
50.533965783820754
],
[
7.764930725097654,
50.530801443594385
]
]
]
],
"properties": {
"id": "3e7acd84-bb67-408d-886e-91004c319f38",
"identifier": "OEK-12022-TW4ECJ",
"title": "Tolles Ökokonto",
"created_on": "2022-01-12T11:41:14.328Z",
"modified_on": "2022-01-12T11:47:45.303Z",
"deductable_surface": 10000.0,
"deductable_surface_available": 9000.0,
"responsible": {
"conservation_office": {
"atom_id": 710123,
"long_name": "LK Ahrweiler",
"short_name": "10"
},
"conservation_file_number": "123-TEST",
"handler": "Landkreis Ahrweiler"
},
"legal": {
"agreement_date": "2022-01-11"
},
"before_states": [
{
"biotope": {
"atom_id": 136155,
"long_name": "Eichen-Buchenmischwald",
"short_name": "AA1"
},
"surface": 10000.0
}
],
"after_states": [
{
"biotope": {
"atom_id": 136156,
"long_name": "Buchenmischwald mit einheimischen Laubbaumarten",
"short_name": "AA2"
},
"surface": 10000.0
}
],
"actions": [
{
"action": {
"atom_id": 709234,
"long_name": "Sonstiges (s. Erläuterungen)",
"short_name": null
},
"amount": 1.0,
"unit": "cm",
"comment": ""
}
],
"deadlines": [],
"deductions": [
{
"id": "f784e131-afb7-4e15-ad57-0b2469f5e967",
"eco_account": {
"id": "3e7acd84-bb67-408d-886e-91004c319f38",
"identifier": "OEK-12022-TW4ECJ",
"title": "Tolles Ökokonto"
},
"surface": 1000.0,
"intervention": {
"id": "97d7cce8-83e9-4043-bc76-317caf983a41",
"identifier": "EIV-12022-B6XGM9",
"title": "Tolles Baugebiet GEÄNDERT1"
}
}
]
}
}
}
```