Link Search Menu Expand Document

2. Create Property Type

Op name:

scgrids.createPropertyType

This creates a type of Property at the system level

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

Body:

{
    "Name": "Commercial Buildings",
    "TypeID": "COMMERCIAL_BUILDINGS"
}

More example Requests/Responses:

I. Example Request: Create PropertyType

Body:

{
    "Name": "Commercial Buildings",
    "TypeID": "COMMERCIAL_BUILDINGS"
}
I. Example Response: Create PropertyType
{
    "status": 201,
    "message": "Success",
    "data": {
        "Name": "Commercial Buildings",
        "TypeID": "COMMERCIAL_BUILDINGS"
    }
}

Status Code: 201

Error codes:

400
Possible reasons:
1. Missing op/org/pid
2. Invalid characters/improper input body
3. Missing access_token in the header
4. Missing Name/TypeId in input body



Table of contents