Link Search Menu Expand Document

5. List Levels By Building

OP name:

scgrids.listLevelsByBuilding

This lists the levels for a given Building

Endpoint:

Method: POST
Type: FORMDATA
URL: /v1/actions

Headers:

Key Value Description
Authorization   (Required) The Acccess Token or HMAC Signature
x-sc-identity external (Required)

Query params:

Key Value Description
op scgrids.listLevelsByBuilding (Required) Operation Name
org   (Required) Organisation ID
pid   (Required) Project ID

More example Requests/Responses:

I. Example Response: List Levels By Building
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "Name": "Level 3",
            "Level": "L3",
            "LID": ""
        },
        {
            "Name": "Level 4",
            "Level": "L4",
            "LID": ""
        },
        {
            "Name": "Level 2",
            "Level": "L2",
            "LID": ""
        },
        {
            "Name": "Level 8",
            "Level": "L8",
            "LID": ""
        },
        {
            "Name": "New Name",
            "Level": "L1",
            "Area": 5000,
            "LID": ""
        },
        {
            "Name": "Level 9",
            "Level": "L9",
            "LID": ""
        },
        {
            "Name": "Level 6",
            "Level": "L6",
            "LID": ""
        },
        {
            "Name": "Level 7",
            "Level": "L7",
            "LID": ""
        },
        {
            "Name": "Level 5",
            "Level": "L5",
            "LID": ""
        },
        {
            "Name": "Level 0",
            "Level": "L0",
            "LID": ""
        }
    ]
}

Status Code: 200

Error codes:

400
Possible reasons:
1. Missing op/org/pid



Table of contents