Link Search Menu Expand Document

1. Batch Get Buildings

Op name:

scgrids.readBuildings

This gets a Building’s details given a list of PIDs

Endpoint:

Method: POST
Type: application/json
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.readBuildings (Required) Operation Name
org   (Required) Organization Name
pid scnoop (Required) Project Name

Body:

{
    "PIDs": [
        ""
    ]
}

More example Requests/Responses:

I. Example Request: Batch Get Buildings

Body:

{
    "PIDs": [
        ""
    ]
}
I. Example Response: Batch Get Buildings
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "PropId": "",
            "PID": "",
            "Config": {
                "Email": {
                    "Default": ""
                }
            },
            "OperatingHours": {
                "0": [
                    {
                        "End": "2222",
                        "Start": "0001"
                    }
                ],
                "1": [
                    {
                        "End": "2333",
                        "Start": "0002"
                    }
                ],
                "2": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "3": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "4": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "5": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ],
                "6": [
                    {
                        "End": "2359",
                        "Start": "0000"
                    }
                ]
            },
            "Name": "Test Building",
            "IsPropertyAddress": true,
            "LevelsCount": 1,
            "Status": "Active",
            "IsBeaconEnabled": true,
            "CreatedBy": "sc_kiran",
            "CreatedOn": 1611908128,
            "UpdatedBy": "sc_kiran",
            "UpdatedOn": 1611908128
        }
    ]
}

Status Code: 200

Error codes:

400
Possible reasons:
1. Missing op, org or pid
2. Invalid characters/improper input body



Table of contents