GET /api/external/v2/structure/{level}

Back to search

Get all items in structure matching requested level.

Request Information

Permissions

The user must be authorized.

Embeded Resource Parameters

None

URI Parameters

Name	Description	Type	Additional information
level	The level in the structure to get items for. Valid values are "R" for divisions, "E" for estates, "B" for buildings and "A" for tenants. "E" and "B" are mandatory in Momentum Energi, but "R" and "A" are optional and therefor may need to be configured.	string	Required

Body Parameters

None.

Response Information

Resource Description

A list with all items if any, otherwise empty list.

DataResultOfUGItemDto

Name	Type	Additional information
Data	Collection of UGItemDto	None.
Total	integer	None.
Take	integer	None.
Skip	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "key": "sample string 1",
      "parentKey": "sample string 2",
      "name": "sample string 3",
      "number": "sample string 4",
      "level": "sample string 5",
      "levelName": "sample string 6",
      "longitude": 1.1,
      "latitude": 1.1
    },
    {
      "key": "sample string 1",
      "parentKey": "sample string 2",
      "name": "sample string 3",
      "number": "sample string 4",
      "level": "sample string 5",
      "levelName": "sample string 6",
      "longitude": 1.1,
      "latitude": 1.1
    }
  ],
  "total": 1,
  "take": 2,
  "skip": 3
}