Skip to content

Room

It represents an enclosed space within a floor 

Attributes

id (long)
Unique identifier to identify the room

id (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

name (string)
Name to identify the room [max-length: 250]

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

description (string)
Description of the room

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

space_code (string)
Unique name to identify the room [max-length: 250]

space_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

display_image (string)
Contains the image attachment id used as a default room image

display_image (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

total_capacity (long)
Indicates the total capacity of the room

total_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the room

occupied_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

type (sp_type)

Indicates the type of the room

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the room

space_attributes (space_attributes)

site (site)

Indicates the site of the room

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the room

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the room

criticalities (sp_criticality)

room_layouts (room_layout_mapping)

Contains the collection of room layouts available in the space with capacity

room_layouts (room_layout_mapping)

status (sp_status)

Indicates the status of the room

status (sp_status)

attachments (attachment)

Contains the attachments of the room

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the room

supervisors (technician)

area (JSONObject)

Indicates the area of the room along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the room

created_by (user)

created_time (datetime)read only

Indicates the time when the room is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

last_updated_by (user)read only

Indicates the user who recently edited the room

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the room was recently edited

last_updated_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

available_capacity (long)read only

Indicates the available capacity of the room

available_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

space_campus (space)

Indicates the campus in which the room is present

space_campus (space)
Indicates the campus in which the room is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

space_building (space)

Indicates the building in which the room is present

space_building (space)
Indicates the building in which the room is present

Example

{
  "space_building": {
    "id": "99999000000043501",
    "name": "Signture Tower",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036768"
    }
  }
}

space_floor (space)

Indicates the floor in which the room is present

space_floor (space)
Indicates the floor in which the room is present

Example

{
  "space_floor": {
    "id": "99999000000043511",
    "name": "First Floor",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036772"
    }
  }
}

department (department)

Indicates the department of the room

department (department)
Indicates the department of the room

Example

{
  "department": {
    "id": "99999000000038431",
    "name": "Facility Services",
    "site": {
      "id": "99999000000006750"
    }
  }
}

is_room_partitionable (boolean)

Indicates whether the room contains partitions

is_room_partitionable (boolean)
Indicates whether the room contains partitions

Example

false

is_floating_capacity (boolean)

Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

is_floating_capacity (boolean)
Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

Example

false

Add Room

This operation helps to create a room

Mandatory Fields :- name

Url

<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}

Attributes

id (long)
Unique identifier to identify the room

id (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

name (string)
Name to identify the room [max-length: 250]

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

description (string)
Description of the room

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

space_code (string)
Unique name to identify the room [max-length: 250]

space_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

display_image (string)
Contains the image attachment id used as a default room image

display_image (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

total_capacity (long)
Indicates the total capacity of the room

total_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the room

occupied_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

type (sp_type)

Indicates the type of the room

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the room

space_attributes (space_attributes)

site (site)

Indicates the site of the room

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the room

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the room

criticalities (sp_criticality)

room_layouts (room_layout_mapping)

Contains the collection of room layouts available in the space with capacity

room_layouts (room_layout_mapping)

status (sp_status)

Indicates the status of the room

status (sp_status)

attachments (attachment)

Contains the attachments of the room

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the room

supervisors (technician)

area (JSONObject)

Indicates the area of the room along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the room

created_by (user)

created_time (datetime)read only

Indicates the time when the room is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

last_updated_by (user)read only

Indicates the user who recently edited the room

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the room was recently edited

last_updated_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

available_capacity (long)read only

Indicates the available capacity of the room

available_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

space_campus (space)

Indicates the campus in which the room is present

space_campus (space)
Indicates the campus in which the room is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

space_building (space)

Indicates the building in which the room is present

space_building (space)
Indicates the building in which the room is present

Example

{
  "space_building": {
    "id": "99999000000043501",
    "name": "Signture Tower",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036768"
    }
  }
}

space_floor (space)

Indicates the floor in which the room is present

space_floor (space)
Indicates the floor in which the room is present

Example

{
  "space_floor": {
    "id": "99999000000043511",
    "name": "First Floor",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036772"
    }
  }
}

department (department)

Indicates the department of the room

department (department)
Indicates the department of the room

Example

{
  "department": {
    "id": "99999000000038431",
    "name": "Facility Services",
    "site": {
      "id": "99999000000006750"
    }
  }
}

is_room_partitionable (boolean)

Indicates whether the room contains partitions

is_room_partitionable (boolean)
Indicates whether the room contains partitions

Example

false

is_floating_capacity (boolean)

Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

is_floating_capacity (boolean)
Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

Example

false

$ curl <service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "space_defaultroom": {
    "name": "Conference hall",
    "description": "meetings will be held here",
    "space_campus": {
      "id": "100000000000043080"
    },
    "space_building": {
      "id": "100000000000043152"
    },
    "space_floor": {
      "id": "100000000000043222"
    },
    "is_room_partitionable": false,
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "500",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "total_capacity": "20",
    "occupied_capacity": "0",
    "supervisors": [
      {
        "id": "100000000000041924"
      }
    ],
    "space_code": "Conf",
    "is_floating_capacity": false,
    "department": {
      "id": "100000000000038648"
    },
    "amenities": [
      {
        "id": "100000000000040482"
      },
      {
        "id": "100000000000040512"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "room_layouts": [
      {
        "layout": {
          "id": "100000000000040521"
        },
        "capacity": "10"
      },
      {
        "layout": {
          "id": "100000000000040524"
        },
        "capacity": "10"
      }
    ],
    "attachments": [
      {
        "file_id": "55"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_room": null,
    "display_image": "55"
  }
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "space_defaultroom": {
    "name": "Conference hall",
    "description": "meetings will be held here",
    "space_campus": {
      "id": "100000000000043080"
    },
    "space_building": {
      "id": "100000000000043152"
    },
    "space_floor": {
      "id": "100000000000043222"
    },
    "is_room_partitionable": false,
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "500",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "total_capacity": "20",
    "occupied_capacity": "0",
    "supervisors": [
      {
        "id": "100000000000041924"
      }
    ],
    "space_code": "Conf",
    "is_floating_capacity": false,
    "department": {
      "id": "100000000000038648"
    },
    "amenities": [
      {
        "id": "100000000000040482"
      },
      {
        "id": "100000000000040512"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "room_layouts": [
      {
        "layout": {
          "id": "100000000000040521"
        },
        "capacity": "10"
      },
      {
        "layout": {
          "id": "100000000000040524"
        },
        "capacity": "10"
      }
    ],
    "attachments": [
      {
        "file_id": "55"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_room": null,
    "display_image": "55"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "space_defaultroom": {
    "name": "Conference hall",
    "description": "meetings will be held here",
    "space_campus": {
      "id": "100000000000043080"
    },
    "space_building": {
      "id": "100000000000043152"
    },
    "space_floor": {
      "id": "100000000000043222"
    },
    "is_room_partitionable": false,
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "500",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "total_capacity": "20",
    "occupied_capacity": "0",
    "supervisors": [
      {
        "id": "100000000000041924"
      }
    ],
    "space_code": "Conf",
    "is_floating_capacity": false,
    "department": {
      "id": "100000000000038648"
    },
    "amenities": [
      {
        "id": "100000000000040482"
      },
      {
        "id": "100000000000040512"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "room_layouts": [
      {
        "layout": {
          "id": "100000000000040521"
        },
        "capacity": "10"
      },
      {
        "layout": {
          "id": "100000000000040524"
        },
        "capacity": "10"
      }
    ],
    "attachments": [
      {
        "file_id": "55"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_room": null,
    "display_image": "55"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "space_defaultroom": {
    "name": "Conference hall",
    "description": "meetings will be held here",
    "space_campus": {
      "id": "100000000000043080"
    },
    "space_building": {
      "id": "100000000000043152"
    },
    "space_floor": {
      "id": "100000000000043222"
    },
    "is_room_partitionable": false,
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "500",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "total_capacity": "20",
    "occupied_capacity": "0",
    "supervisors": [
      {
        "id": "100000000000041924"
      }
    ],
    "space_code": "Conf",
    "is_floating_capacity": false,
    "department": {
      "id": "100000000000038648"
    },
    "amenities": [
      {
        "id": "100000000000040482"
      },
      {
        "id": "100000000000040512"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "room_layouts": [
      {
        "layout": {
          "id": "100000000000040521"
        },
        "capacity": "10"
      },
      {
        "layout": {
          "id": "100000000000040524"
        },
        "capacity": "10"
      }
    ],
    "attachments": [
      {
        "file_id": "55"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_room": null,
    "display_image": "55"
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "space_defaultroom": {
        "occupied_capacity": "0",
        "common_module": "space_room",
        "amenities": [
            {
                "name": "Wifi Access",
                "description": null,
                "id": "100000000000040482",
                "icon_name": "wifi_access"
            },
            {
                "name": "Uninterrupted Power",
                "description": null,
                "id": "100000000000040512",
                "icon_name": "uninterrupted_power"
            }
        ],
        "attachments": [
            {
                "size": "486641",
                "content_type": "image/png",
                "file_id": "55",
                "name": "Screenshot 2025-01-24 at 11.06.42\u202fAM.png",
                "content_url": "/space_defaultrooms/100000000000043254/_uploads/55",
                "id": "100000000000043260"
            }
        ],
        "space_building": {
            "name": "Signature Tower",
            "id": "100000000000043152",
            "type": {
                "id": "100000000000037122"
            }
        },
        "description": "meetings will be held here",
        "space_code": "Conf",
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultrooms",
            "name": "space_defaultroom",
            "display_name_plural": "Default Room",
            "id": "100000000000037128",
            "display_name": "Default Room",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043254",
        "department": {
            "site": {
                "id": "100000000000006824"
            },
            "name": "Space",
            "id": "100000000000038648"
        },
        "display_image": "55",
        "total_capacity": "20",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "500"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:37 PM",
            "value": "1738224452757"
        },
        "is_room_partitionable": false,
        "space_room": null,
        "is_floating_capacity": false,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 20,
        "room_layouts": [
            {
                "layout": {
                    "name": "Boardroom",
                    "description": "Centrally located table.",
                    "id": "100000000000040521",
                    "icon_name": "boardroom"
                },
                "id": "100000000000043256",
                "capacity": 10
            },
            {
                "layout": {
                    "name": "Theatre",
                    "description": "Row wise seating towards one side.",
                    "id": "100000000000040524",
                    "icon_name": "theatre"
                },
                "id": "100000000000043258",
                "capacity": 10
            }
        ],
        "space_floor": {
            "name": "Ground floor",
            "id": "100000000000043222",
            "type": {
                "id": "100000000000037126"
            }
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "available_partition_capacity": "0",
        "name": "Conference hall",
        "partition_capacity": 0,
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "jeniffer.doe@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Doe",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1005",
                "name": "Jeniffer Doe",
                "id": "100000000000041924",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Jeniffer",
                "job_title": null
            }
        ]
    }
}

Edit Room

This operation helps to edit a Room

Url

<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}

Attributes

id (long)
Unique identifier to identify the room

id (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

name (string)
Name to identify the room [max-length: 250]

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

description (string)
Description of the room

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

space_code (string)
Unique name to identify the room [max-length: 250]

space_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

display_image (string)
Contains the image attachment id used as a default room image

display_image (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

total_capacity (long)
Indicates the total capacity of the room

total_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the room

occupied_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

type (sp_type)

Indicates the type of the room

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the room

space_attributes (space_attributes)

site (site)

Indicates the site of the room

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the room

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the room

criticalities (sp_criticality)

room_layouts (room_layout_mapping)

Contains the collection of room layouts available in the space with capacity

room_layouts (room_layout_mapping)

status (sp_status)

Indicates the status of the room

status (sp_status)

attachments (attachment)

Contains the attachments of the room

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the room

supervisors (technician)

area (JSONObject)

Indicates the area of the room along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the room

created_by (user)

created_time (datetime)read only

Indicates the time when the room is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

last_updated_by (user)read only

Indicates the user who recently edited the room

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the room was recently edited

last_updated_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

available_capacity (long)read only

Indicates the available capacity of the room

available_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

space_campus (space)

Indicates the campus in which the room is present

space_campus (space)
Indicates the campus in which the room is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

space_building (space)

Indicates the building in which the room is present

space_building (space)
Indicates the building in which the room is present

Example

{
  "space_building": {
    "id": "99999000000043501",
    "name": "Signture Tower",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036768"
    }
  }
}

space_floor (space)

Indicates the floor in which the room is present

space_floor (space)
Indicates the floor in which the room is present

Example

{
  "space_floor": {
    "id": "99999000000043511",
    "name": "First Floor",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036772"
    }
  }
}

department (department)

Indicates the department of the room

department (department)
Indicates the department of the room

Example

{
  "department": {
    "id": "99999000000038431",
    "name": "Facility Services",
    "site": {
      "id": "99999000000006750"
    }
  }
}

is_room_partitionable (boolean)

Indicates whether the room contains partitions

is_room_partitionable (boolean)
Indicates whether the room contains partitions

Example

false

is_floating_capacity (boolean)

Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

is_floating_capacity (boolean)
Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

Example

false

$ curl <service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "space_defaultroom": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "space_defaultroom": {
    "description": "Situated in GST Road, Guduvancherry"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "space_defaultroom": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "space_defaultroom": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "space_defaultroom": {
        "occupied_capacity": "0",
        "common_module": "space_room",
        "amenities": [
            {
                "name": "Wifi Access",
                "description": null,
                "id": "100000000000040482",
                "icon_name": "wifi_access"
            },
            {
                "name": "Uninterrupted Power",
                "description": null,
                "id": "100000000000040512",
                "icon_name": "uninterrupted_power"
            }
        ],
        "attachments": [
            {
                "size": "486641",
                "content_type": "image/png",
                "file_id": "55",
                "name": "Screenshot 2025-01-24 at 11.06.42\u202fAM.png",
                "content_url": "/space_defaultrooms/100000000000043254/_uploads/55",
                "id": "100000000000043260"
            }
        ],
        "space_building": {
            "name": "Signature Tower",
            "id": "100000000000043152",
            "type": {
                "id": "100000000000037122"
            }
        },
        "description": "Situated in GST Road, Guduvancherry",
        "space_code": "Conf",
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultrooms",
            "name": "space_defaultroom",
            "display_name_plural": "Default Room",
            "id": "100000000000037128",
            "display_name": "Default Room",
            "icon_name": null
        },
        "last_updated_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "id": "100000000000043254",
        "department": {
            "site": {
                "id": "100000000000006824"
            },
            "name": "Space",
            "id": "100000000000038648"
        },
        "display_image": "55",
        "total_capacity": "20",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "500"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:37 PM",
            "value": "1738224452757"
        },
        "is_room_partitionable": false,
        "space_room": null,
        "is_floating_capacity": false,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 20,
        "room_layouts": [
            {
                "layout": {
                    "name": "Boardroom",
                    "description": "Centrally located table.",
                    "id": "100000000000040521",
                    "icon_name": "boardroom"
                },
                "id": "100000000000043256",
                "capacity": 10
            },
            {
                "layout": {
                    "name": "Theatre",
                    "description": "Row wise seating towards one side.",
                    "id": "100000000000040524",
                    "icon_name": "theatre"
                },
                "id": "100000000000043258",
                "capacity": 10
            }
        ],
        "space_floor": {
            "name": "Ground floor",
            "id": "100000000000043222",
            "type": {
                "id": "100000000000037126"
            }
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": {
            "display_value": "Jan 30, 2025 01:39 PM",
            "value": "1738224582367"
        },
        "available_partition_capacity": "0",
        "name": "Conference hall",
        "partition_capacity": 0,
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "jeniffer.doe@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Doe",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1005",
                "name": "Jeniffer Doe",
                "id": "100000000000041924",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Jeniffer",
                "job_title": null
            }
        ]
    }
}

Get Room

This operation helps to get a single room

Url

<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}

Attributes

id (long)
Unique identifier to identify the room

id (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

name (string)
Name to identify the room [max-length: 250]

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

description (string)
Description of the room

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

space_code (string)
Unique name to identify the room [max-length: 250]

space_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

display_image (string)
Contains the image attachment id used as a default room image

display_image (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

total_capacity (long)
Indicates the total capacity of the room

total_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the room

occupied_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

type (sp_type)

Indicates the type of the room

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the room

space_attributes (space_attributes)

site (site)

Indicates the site of the room

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the room

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the room

criticalities (sp_criticality)

room_layouts (room_layout_mapping)

Contains the collection of room layouts available in the space with capacity

room_layouts (room_layout_mapping)

status (sp_status)

Indicates the status of the room

status (sp_status)

attachments (attachment)

Contains the attachments of the room

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the room

supervisors (technician)

area (JSONObject)

Indicates the area of the room along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the room

created_by (user)

created_time (datetime)read only

Indicates the time when the room is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

last_updated_by (user)read only

Indicates the user who recently edited the room

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the room was recently edited

last_updated_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

available_capacity (long)read only

Indicates the available capacity of the room

available_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

space_campus (space)

Indicates the campus in which the room is present

space_campus (space)
Indicates the campus in which the room is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

space_building (space)

Indicates the building in which the room is present

space_building (space)
Indicates the building in which the room is present

Example

{
  "space_building": {
    "id": "99999000000043501",
    "name": "Signture Tower",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036768"
    }
  }
}

space_floor (space)

Indicates the floor in which the room is present

space_floor (space)
Indicates the floor in which the room is present

Example

{
  "space_floor": {
    "id": "99999000000043511",
    "name": "First Floor",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036772"
    }
  }
}

department (department)

Indicates the department of the room

department (department)
Indicates the department of the room

Example

{
  "department": {
    "id": "99999000000038431",
    "name": "Facility Services",
    "site": {
      "id": "99999000000006750"
    }
  }
}

is_room_partitionable (boolean)

Indicates whether the room contains partitions

is_room_partitionable (boolean)
Indicates whether the room contains partitions

Example

false

is_floating_capacity (boolean)

Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

is_floating_capacity (boolean)
Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

Example

false

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "space_defaultroom": {
        "occupied_capacity": "0",
        "common_module": "space_room",
        "amenities": [
            {
                "name": "Wifi Access",
                "description": null,
                "id": "100000000000040482",
                "icon_name": "wifi_access"
            },
            {
                "name": "Uninterrupted Power",
                "description": null,
                "id": "100000000000040512",
                "icon_name": "uninterrupted_power"
            }
        ],
        "attachments": [
            {
                "size": "486641",
                "content_type": "image/png",
                "file_id": "55",
                "name": "Screenshot 2025-01-24 at 11.06.42\u202fAM.png",
                "content_url": "/space_defaultrooms/100000000000043254/_uploads/55",
                "id": "100000000000043260"
            }
        ],
        "space_building": {
            "name": "Signature Tower",
            "id": "100000000000043152",
            "type": {
                "id": "100000000000037122"
            }
        },
        "description": "meetings will be held here",
        "space_code": "Conf",
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultrooms",
            "name": "space_defaultroom",
            "display_name_plural": "Default Room",
            "id": "100000000000037128",
            "display_name": "Default Room",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043254",
        "department": {
            "site": {
                "id": "100000000000006824"
            },
            "name": "Space",
            "id": "100000000000038648"
        },
        "display_image": "55",
        "total_capacity": "20",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "500"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:37 PM",
            "value": "1738224452757"
        },
        "is_room_partitionable": false,
        "space_room": null,
        "is_floating_capacity": false,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 20,
        "room_layouts": [
            {
                "layout": {
                    "name": "Boardroom",
                    "description": "Centrally located table.",
                    "id": "100000000000040521",
                    "icon_name": "boardroom"
                },
                "id": "100000000000043256",
                "capacity": 10
            },
            {
                "layout": {
                    "name": "Theatre",
                    "description": "Row wise seating towards one side.",
                    "id": "100000000000040524",
                    "icon_name": "theatre"
                },
                "id": "100000000000043258",
                "capacity": 10
            }
        ],
        "space_floor": {
            "name": "Ground floor",
            "id": "100000000000043222",
            "type": {
                "id": "100000000000037126"
            }
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "available_partition_capacity": "0",
        "name": "Conference hall",
        "partition_capacity": 0,
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "jeniffer.doe@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Doe",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1005",
                "name": "Jeniffer Doe",
                "id": "100000000000041924",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Jeniffer",
                "job_title": null
            }
        ]
    }
}

Get List Room

This operation helps to get the list of all rooms

Url

<service domain|custom domain>/app/<portal>/api/v3/space_rooms

Attributes

id (long)
Unique identifier to identify the room

id (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

name (string)
Name to identify the room [max-length: 250]

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

description (string)
Description of the room

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

space_code (string)
Unique name to identify the room [max-length: 250]

space_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

display_image (string)
Contains the image attachment id used as a default room image

display_image (string)
A text in a plain format. No rich text or new line characters allowed.

Example

Sample Content

total_capacity (long)
Indicates the total capacity of the room

total_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the room

occupied_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

type (sp_type)

Indicates the type of the room

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the room

space_attributes (space_attributes)

site (site)

Indicates the site of the room

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the room

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the room

criticalities (sp_criticality)

room_layouts (room_layout_mapping)

Contains the collection of room layouts available in the space with capacity

room_layouts (room_layout_mapping)

status (sp_status)

Indicates the status of the room

status (sp_status)

attachments (attachment)

Contains the attachments of the room

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the room

supervisors (technician)

area (JSONObject)

Indicates the area of the room along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the room

created_by (user)

created_time (datetime)read only

Indicates the time when the room is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

last_updated_by (user)read only

Indicates the user who recently edited the room

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the room was recently edited

last_updated_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

available_capacity (long)read only

Indicates the available capacity of the room

available_capacity (long)
Numerical digits which are considered to have larger values.

Example

234759602834500

space_campus (space)

Indicates the campus in which the room is present

space_campus (space)
Indicates the campus in which the room is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

space_building (space)

Indicates the building in which the room is present

space_building (space)
Indicates the building in which the room is present

Example

{
  "space_building": {
    "id": "99999000000043501",
    "name": "Signture Tower",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036768"
    }
  }
}

space_floor (space)

Indicates the floor in which the room is present

space_floor (space)
Indicates the floor in which the room is present

Example

{
  "space_floor": {
    "id": "99999000000043511",
    "name": "First Floor",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036772"
    }
  }
}

department (department)

Indicates the department of the room

department (department)
Indicates the department of the room

Example

{
  "department": {
    "id": "99999000000038431",
    "name": "Facility Services",
    "site": {
      "id": "99999000000006750"
    }
  }
}

is_room_partitionable (boolean)

Indicates whether the room contains partitions

is_room_partitionable (boolean)
Indicates whether the room contains partitions

Example

false

is_floating_capacity (boolean)

Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

is_floating_capacity (boolean)
Indicates whether the total capacity and occupied capacity of the room are included for parent level capacity calculations

Example

false

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/space_rooms\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/space_rooms";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = ;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/space_rooms"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @''@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/space_rooms"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
  "space_rooms": [
    {
      "occupied_capacity": "0",
      "common_module": "space_room",
      "space_building": {
        "name": "Signature Tower",
        "id": "100000000000043152",
        "type": {
          "id": "100000000000037122"
        }
      },
      "description": "meetings will be held here",
      "space_code": "Conf",
      "type": {
        "api_plural_name": "space_defaultrooms",
        "name": "space_defaultroom",
        "display_name_plural": "Default Room",
        "id": "100000000000037128",
        "display_name": "Default Room",
        "icon_name": null
      },
      "last_updated_by": null,
      "id": "100000000000043254",
      "department": {
        "site": {
          "id": "100000000000006824"
        },
        "name": "Space",
        "id": "100000000000038648"
      },
      "display_image": "55",
      "total_capacity": "20",
      "space_campus": {
        "name": "Estancia",
        "id": "100000000000043080",
        "type": {
          "id": "100000000000037120"
        }
      },
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "500"
      },
      "created_time": {
        "display_value": "Jan 30, 2025 01:37 PM",
        "value": "1738224452757"
      },
      "is_room_partitionable": false,
      "space_room": null,
      "is_floating_capacity": false,
      "created_by": {
        "email_id": "test@zmail.com",
        "is_technician": true,
        "sms_mail": "",
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": "",
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824",
          "is_default": true
        },
        "phone": "",
        "employee_id": "",
        "name": "tech",
        "id": "100000000000043064",
        "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "tech",
        "job_title": ""
      },
      "available_capacity": 20,
      "space_floor": {
        "name": "Ground floor",
        "id": "100000000000043222",
        "type": {
          "id": "100000000000037126"
        }
      },
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": null,
      "available_partition_capacity": "0",
      "name": "Conference hall",
      "partition_capacity": 0,
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      }
    },
    {
      "occupied_capacity": "0",
      "common_module": "space_room",
      "space_building": {
        "name": "Signature Tower",
        "id": "100000000000043152",
        "type": {
          "id": "100000000000037122"
        }
      },
      "description": "meetings will be held here",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultrooms",
        "name": "space_defaultroom",
        "display_name_plural": "Default Room",
        "id": "100000000000037128",
        "display_name": "Default Room",
        "icon_name": null
      },
      "last_updated_by": null,
      "id": "100000000000043274",
      "department": {
        "site": {
          "id": "100000000000006824"
        },
        "name": "Space",
        "id": "100000000000038648"
      },
      "display_image": null,
      "total_capacity": "20",
      "space_campus": {
        "name": "Estancia",
        "id": "100000000000043080",
        "type": {
          "id": "100000000000037120"
        }
      },
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "500"
      },
      "created_time": {
        "display_value": "Jan 30, 2025 01:38 PM",
        "value": "1738224510358"
      },
      "is_room_partitionable": false,
      "space_room": null,
      "is_floating_capacity": false,
      "created_by": {
        "email_id": "test@zmail.com",
        "is_technician": true,
        "sms_mail": "",
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": "",
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824",
          "is_default": true
        },
        "phone": "",
        "employee_id": "",
        "name": "tech",
        "id": "100000000000043064",
        "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "tech",
        "job_title": ""
      },
      "available_capacity": 20,
      "space_floor": {
        "name": "Ground floor",
        "id": "100000000000043222",
        "type": {
          "id": "100000000000037126"
        }
      },
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": null,
      "available_partition_capacity": "0",
      "name": "Copy of Conference hall-1",
      "partition_capacity": 0,
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "sort_field": "name",
    "row_count": 2
  }
}

Delete Room

This operation allows to delete Room

Url

<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}

$ curl <service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/{room_type_api_name}/{room_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}