Link Search Menu Expand Document

8. List Property Types

Op name:

scgrids.listPropertyTypes

This lists all the system level Property types

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.listPropertyTypes (Required) Operation Name
org   (Required) Organisation ID
pid scnoop (Required) Project ID is scnoop when it’s not known

More example Requests/Responses:

I. Example Response: List PropertyTypes
{
    "status": 200,
    "message": "Success",
    "data": [
        {
            "Name": "Bank",
            "TypeID": "BANK"
        },
        {
            "Name": "Commercial Buildings",
            "TypeID": "COMMERCIAL_BUILDINGS"
        },
        {
            "Name": "Corporate Buildings",
            "TypeID": "CORPORATE_BUILDINGS"
        },
        {
            "Name": "Restaurants",
            "TypeID": "RESTAURANTS"
        },
        {
            "Name": "School",
            "TypeID": "SCHOOL"
        }
    ]
}

Status Code: 200

Error codes:

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



Table of contents