Skip to content

Campus

It represents a physical location or premises, including buildings, floors, rooms and room partitions within an organisation.

Attributes

id (long)
Unique identifier to identify the campus

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

Example 

234759602834500

name (string)
Name to identify the campus [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 campus

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 campus [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 campus 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 campus [Read only]

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 campus [Read only]

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

Example 

234759602834500

type (sp_type)

Indicates the type of the campus

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the campus

space_attributes (space_attributes)

site (site)

Indicates the site of the campus

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the campus

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the campus

criticalities (sp_criticality)

status (sp_status)

Indicates the status of the campus

status (sp_status)

attachments (attachment)

Contains the attachments of the campus

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the campus

supervisors (technician)

area (JSONObject)

Indicates the area of the campus along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the campus

created_by (user)

created_time (datetime)read only

Indicates the time when the campus 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 campus

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the campus 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 campus[Read only]

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

Example 

234759602834500

Add Campus

This operation helps to create a campus

Mandatory Fields :- name

Url

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

Attributes

id (long)
Unique identifier to identify the campus

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

Example 

234759602834500

name (string)
Name to identify the campus [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 campus

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 campus [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 campus 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 campus [Read only]

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 campus [Read only]

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

Example 

234759602834500

type (sp_type)

Indicates the type of the campus

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the campus

space_attributes (space_attributes)

site (site)

Indicates the site of the campus

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the campus

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the campus

criticalities (sp_criticality)

status (sp_status)

Indicates the status of the campus

status (sp_status)

attachments (attachment)

Contains the attachments of the campus

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the campus

supervisors (technician)

area (JSONObject)

Indicates the area of the campus along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the campus

created_by (user)

created_time (datetime)read only

Indicates the time when the campus 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 campus

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the campus 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 campus[Read only]

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

Example 

234759602834500


$ curl <service domain|custom domain>/app/<portal>/api/v3/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
};
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/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}
'@
$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/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}'''
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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Bread Maker",
                "description": null,
                "id": "100000000000040479",
                "icon_name": "bread_maker"
            },
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "417798",
                "content_type": "image/png",
                "file_id": "49",
                "name": "Screenshot 2025-01-24 at 11.34.25\u202fAM.png",
                "content_url": "/space_defaultcampuses/100000000000043080/_uploads/49",
                "id": "100000000000043082"
            }
        ],
        "space_building": null,
        "description": "Chennai campus",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043080",
        "display_image": "49",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:05 PM",
            "value": "1738222517516"
        },
        "space_room": null,
        "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": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "name": "Estancia",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "bella.rice@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Mark",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1006",
                "name": "Bella Mark",
                "id": "100000000000041937",
                "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": "Bella",
                "job_title": null
            }
        ]
    }
}

Edit Campus

This operation helps to edit a Campus

Url

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

Attributes

id (long)
Unique identifier to identify the campus

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

Example 

234759602834500

name (string)
Name to identify the campus [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 campus

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 campus [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 campus 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 campus [Read only]

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 campus [Read only]

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

Example 

234759602834500

type (sp_type)

Indicates the type of the campus

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the campus

space_attributes (space_attributes)

site (site)

Indicates the site of the campus

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the campus

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the campus

criticalities (sp_criticality)

status (sp_status)

Indicates the status of the campus

status (sp_status)

attachments (attachment)

Contains the attachments of the campus

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the campus

supervisors (technician)

area (JSONObject)

Indicates the area of the campus along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the campus

created_by (user)

created_time (datetime)read only

Indicates the time when the campus 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 campus

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the campus 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 campus[Read only]

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

Example 

234759602834500


$ curl <service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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_defaultcampus": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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_defaultcampus": {
    "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/{campus_type_api_name}/{campus_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_defaultcampus": {
    "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/{campus_type_api_name}/{campus_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_defaultcampus": {
    "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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "Doctor on Call",
                "description": null,
                "id": "100000000000040494",
                "icon_name": "doctor_on_call"
            }
        ],
        "attachments": [
            {
                "size": "304296",
                "content_type": "image/png",
                "file_id": "50",
                "name": "Screenshot 2025-01-29 at 3.30.54\u202fPM (2).png",
                "content_url": "/space_defaultcampuses/100000000000043092/_uploads/50",
                "id": "100000000000043094"
            }
        ],
        "space_building": null,
        "description": "Situated in GST Road, Guduvancherry",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "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": "100000000000043092",
        "display_image": "50",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:07 PM",
            "value": "1738222663791"
        },
        "space_room": null,
        "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": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": {
            "display_value": "Jan 30, 2025 01:12 PM",
            "value": "1738222931838"
        },
        "name": "KRISP IT Park",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "heather.graham@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Graham",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1002",
                "name": "Heather Graham",
                "id": "100000000000041885",
                "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": "Heather",
                "job_title": null
            }
        ]
    }
}

Get Campus

This operation helps to get a single campus

Url

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

Attributes

id (long)
Unique identifier to identify the campus

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

Example 

234759602834500

name (string)
Name to identify the campus [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 campus

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 campus [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 campus 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 campus [Read only]

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 campus [Read only]

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

Example 

234759602834500

type (sp_type)

Indicates the type of the campus

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the campus

space_attributes (space_attributes)

site (site)

Indicates the site of the campus

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the campus

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the campus

criticalities (sp_criticality)

status (sp_status)

Indicates the status of the campus

status (sp_status)

attachments (attachment)

Contains the attachments of the campus

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the campus

supervisors (technician)

area (JSONObject)

Indicates the area of the campus along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the campus

created_by (user)

created_time (datetime)read only

Indicates the time when the campus 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 campus

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the campus 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 campus[Read only]

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

Example 

234759602834500


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Bread Maker",
                "description": null,
                "id": "100000000000040479",
                "icon_name": "bread_maker"
            },
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "417798",
                "content_type": "image/png",
                "file_id": "49",
                "name": "Screenshot 2025-01-24 at 11.34.25\u202fAM.png",
                "content_url": "/space_defaultcampuses/100000000000043080/_uploads/49",
                "id": "100000000000043082"
            }
        ],
        "space_building": null,
        "description": "Chennai campus",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043080",
        "display_image": "49",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:05 PM",
            "value": "1738222517516"
        },
        "space_room": null,
        "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": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "name": "Estancia",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "bella.rice@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Mark",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1006",
                "name": "Bella Mark",
                "id": "100000000000041937",
                "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": "Bella",
                "job_title": null
            }
        ]
    }
}

Get List Campus

This operation helps to get the list of all campuses

Url

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

Attributes

id (long)
Unique identifier to identify the campus

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

Example 

234759602834500

name (string)
Name to identify the campus [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 campus

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 campus [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 campus 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 campus [Read only]

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 campus [Read only]

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

Example 

234759602834500

type (sp_type)

Indicates the type of the campus

type (sp_type)

space_attributes (space_attributes)

Contains the udf fields of the campus

space_attributes (space_attributes)

site (site)

Indicates the site of the campus

site (site)

amenities (sp_amenity)

Contains the collection of amenities present in the campus

amenities (sp_amenity)

criticalities (sp_criticality)

Contains the collection of criticalities present in the campus

criticalities (sp_criticality)

status (sp_status)

Indicates the status of the campus

status (sp_status)

attachments (attachment)

Contains the attachments of the campus

attachments (attachment)

supervisors (technician)

Indicates the supervisors of the campus

supervisors (technician)

area (JSONObject)

Indicates the area of the campus along with unit 
show attribute

area (JSONObject)

created_by (user)read only

Indicates the user who created the campus

created_by (user)

created_time (datetime)read only

Indicates the time when the campus 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 campus

last_updated_by (user)

last_updated_time (datetime)read only

Indicates the time  when the campus 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 campus[Read only]

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

Example 

234759602834500


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/space_campuses\
      -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_campuses";
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_campuses"
$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_campuses"
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_campuses": [
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "100000"
      },
      "common_module": "space_campus",
      "created_time": {
        "display_value": "Jan 30, 2025 01:05 PM",
        "value": "1738222517516"
      },
      "space_building": null,
      "space_room": null,
      "description": "Chennai campus",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultcampuses",
        "name": "space_defaultcampus",
        "display_name_plural": "Default Campus",
        "id": "100000000000037120",
        "display_name": "Default Campus",
        "icon_name": null
      },
      "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": 0,
      "space_floor": null,
      "last_updated_by": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": null,
      "name": "Estancia",
      "id": "100000000000043080",
      "display_image": "49",
      "total_capacity": "0",
      "space_campus": null,
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      }
    },
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "100000"
      },
      "common_module": "space_campus",
      "created_time": {
        "display_value": "Jan 30, 2025 01:07 PM",
        "value": "1738222663791"
      },
      "space_building": null,
      "space_room": null,
      "description": "Modern business space",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultcampuses",
        "name": "space_defaultcampus",
        "display_name_plural": "Default Campus",
        "id": "100000000000037120",
        "display_name": "Default Campus",
        "icon_name": null
      },
      "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": 0,
      "space_floor": null,
      "last_updated_by": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": null,
      "name": "KRISP IT Park",
      "id": "100000000000043092",
      "display_image": "50",
      "total_capacity": "0",
      "space_campus": null,
      "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 Campus

This operation allows to delete Campus

Url

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


$ curl <service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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"
  }
}