Woodlist

External API

OpenAPI Description:

Legacy API

Woodlist entity spec

id	int	Primary ID
owner_group	object	Owner group ( ID and name )
number	int	Woodlist number
name	string	Woodlist name
reference_date	time	Reference date ( cut date )
created_by	object	User who created the woodlist ( ID, name and eMail )
base_area	object	Base forest area
includes_areas	object	List of all woodlists from aggregations in woodlist ( ID, name and short name )
includes_wood_types	object	List of aggregation wood types ( ID, name and short name )
includes_usages	object	List of aggregation usages ( ID, name and short name )
includes_qualities	object	List of aggregation qualities ( ID, name and short name )
includes_calamities	object	List of aggregation calamities ( ID, name and short name )

Woodlist listing endpoint

Endpoint	`/inventory/v4/inventory/woodlist/summaries`
Method	GET
Scope	`woodlist`
Query parameter
per_page	Number of results perr page ( max. 100 )	`per_page=50`
page	Current page	`page=1`
business_year	Filter by business year	`business_year=2024`
base_area_id	Filter by base area from woodlist	`base_area_id=5`
search	Search by name or number of woodlist	`search=600` `search=Musterliste`
sort_field	Field to sort by	`sort_field=number` `sort_field=name` `sort_field=reference_date` `sort_field=protocol_volume` `sort_field=updated_at` `sort_field=sale_fm_volume`
sort_order	Sort order	`sort_order=asc` `sort_order=desc`

Example response from /inventory/v4/inventory/woodlist/summaries?per_page=2:

{
    "count": 113,
    "entries": [
        {
            "id": 114,
            "owner_group": {
                "id": 15,
                "name": "Test Forstbetrieb"
            },
            "number": 12324652,
            "name": "",
            "reference_date": "2024-02-29T00:00:00Z",
            "created": "2024-02-29T17:29:23Z",
            "updated": "2024-02-29T17:29:23Z",
            "created_by": {
                "id": 14,
                "name": "Max Mustermann",
                "email": "mustermnann@beispiel.de"
            },
            "note": "",
            "base_area": {
                "id": 22,
                "name": "Testrevier",
                "short_name": "VI"
            },
            "processed_area_size": "",
            "includes_areas": [],
            "includes_wood_types": [],
            "includes_qualities": [],
            "includes_usages": [],
            "includes_calamities": [],
            "volume": 0,
            "sale_fm_volume": 0,
            "selling_unit_count": 0,
            "business_area_id": 5,
            "business_year": 2024
        },
        {
            "id": 112,
            "owner_group": {
                "id": 15,
                "name": "Test Forstbetrieb"
            },
            "number": 410149,
            "name": "",
            "reference_date": "2024-02-14T00:00:00Z",
            "created": "2024-02-14T08:24:47Z",
            "updated": "2024-02-29T14:01:12Z",
            "created_by": {
                "id": 14,
                "name": "Max Mustermann",
                "email": "mustermnann@beispiel.de"
            },
            "note": "TestListe",
            "base_area": {
                "id": 72,
                "name": "Beispiel Revier",
                "short_name": "I"
            },
            "processed_area_size": "",
            "includes_areas": [
                {
                    "id": 142,
                    "full_name": "Beispiel Waldort",
                    "short_name": ""
                }
            ],
            "includes_wood_types": [
                {
                    "id": 34,
                    "full_name": "Lärche",
                    "short_name": "LA"
                },
                {
                    "id": 38,
                    "full_name": "Douglasie",
                    "short_name": "DG"
                },
                {
                    "id": 100,
                    "full_name": "Buche",
                    "short_name": "BU"
                },
                {
                    "id": 2,
                    "full_name": "Birke",
                    "short_name": "BI"
                },
                {
                    "id": 6,
                    "full_name": "Fichte",
                    "short_name": "FI"
                }
            ],
            "includes_qualities": [
                {
                    "id": 26,
                    "full_name": "Normal",
                    "short_name": "N"
                },
                {
                    "id": 14,
                    "full_name": "A",
                    "short_name": "A"
                },
                {
                    "id": 17,
                    "full_name": "B",
                    "short_name": "B"
                },
                {
                    "id": 27,
                    "full_name": "Normal",
                    "short_name": "IN"
                }
            ],
            "includes_usages": [
                {
                    "id": 5,
                    "full_name": "Energieholz kurz",
                    "short_name": "BS"
                },
                {
                    "id": 4,
                    "full_name": "Energieholz lang",
                    "short_name": "BL"
                },
                {
                    "id": 6,
                    "full_name": "Industrieholz kurz",
                    "short_name": "IS"
                },
                {
                    "id": 1,
                    "full_name": "Stammholz lang",
                    "short_name": "ST"
                },
                {
                    "id": 3,
                    "full_name": "Industrieholz lang",
                    "short_name": "IL"
                }
            ],
            "includes_calamities": [],
            "volume": 197.15,
            "sale_fm_volume": 61.575,
            "selling_unit_count": 0,
            "business_area_id": 5,
            "business_year": 2024
        }
    ]
}

Get single woodlist

Endpoint	`/inventory/v4/inventory/woodlist/:ID`
Method	GET
Scope	`woodlist`

Example output for /inventory/v4/inventory/woodlist/112:

{
    "id": 112,
    "owner_group_id": 15,
    "number": 410149,
    "name": "",
    "reference_date": "2024-02-14T00:00:00Z",
    "base_area_id": 72,
    "note": "TestListe",
    "processed_area_size": "",
    "business_area_id": 5,
    "business_area_id_read_only": true,
    "creator_account_id": 26,
    "cut_identifier": "",
    "business_year": 2024
}