Link Search Menu Expand Document

4. Create Zone Category

Op name:

scgrids.createZoneCategory

This creates a new Zone category at 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.createZoneCategory (Required) Operation Name
org   (Required) Organisation ID
pid scnoop (Required) Project ID

Body:

{
    "Name": "Labs_2",
    "CategoryID": "LABS_2",
    "PropertyTypeID": "SCHOOL"
}

More example Requests/Responses:

I. Example Request: Create Zone Category

Body:

{
    "Name": "Labs",
    "CategoryID": "LABS",
    "PropertyTypeID": "SCHOOL"
}
I. Example Response: Create Zone Category
{
    "status": 201,
    "message": "Success",
    "data": {
        "Name": "Labs",
        "PropertyTypeID": "SCHOOL",
        "CategoryID": "LABS"
    }
}

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/CategoryID/PropertyTypeID



Table of contents