GET - Availability status of Resources based on Branch

Purpose

This API retrieves the availability of a particular resource based on the branch.

Request URL

https://calendar.zoho.com/api/v1/resources/freebusy

OAuth Scope

scope=ZohoCalendar.resources.ALL

or

scope=ZohoCalendar.resources.READ

 

ALL - Access all features.

READ - Gets free/ busy detail of a resource

Request Parameters

  • branch_idlong, mandatory
    • The branch ID can be fetched by using the Get Branch list API.
  • building_idlong, optional
    • The building ID can be fetched by using the Get Branch list/ Get Branch info API.
  • floor_idlong, optional
    • The floor ID can be fetched by using the Get Branch info API.
  • start_datestring, mandatory
    • The start date string denotes the starting date from when you want the free-busy data.
    • Supported date format - MM/dd/yyyy
  • end_datestring, mandatory
    • The end date string denotes the ending date until when you want the free-busy data.
    • Supported date format - MM/dd/yyyy
  • start_timestring, optional
    • The start time from when you want the free-busy data.
    • Denote it in 12 hours time format.
    • Provide am and pm along with the time.
    • Supported format: hh:mm a
    • Example: 05:00 am, 06:00 pm, 12:00 am, 12:00 pm.
  • end_timestring, optional
    • The start time from when you want the free-busy data.
    • Denote it in 12 hours time format.
    • Provide am and pm along with the time.
    • Supported format: hh:mm a
    • Example: 05:00 am, 06:00 pm, 12:00 am, 12:00 pm.
  • timezonestring, optional
    • The timezone in which the branch is located.

Note: The time difference between the start and end date should not exceed the "Booking duration" set in the Resource booking settings by the Admin.

Sample Request

Copiedhttps://calendar.zoho.in/api/v1/resources/freebusy?branch_id= 1587118394609000002&building_id= 1587118394618000011&floor_id= 1587118394619000012&start_date=05/06/2022&end_date=05/06/2022&start_time=06:00 pm&end_time=07:00 pm

Sample Response

Copied[
   {
      "building_id":"1587118394618000011",
      "category_name":"Meeting Room",
      "resource_type":0,
      "is_hidden":false,
      "description":"",
      "res_email_id":"60cdfb888c884ce583bfe397963e185d@m43.com",
      "resource_approval":false,
      "auto_gen_name":"60cdfb888c884ce583bfe397963e185d",
      "capacity":10,
      "is_available":true,
      "features":
         [
            {
               "feature_id":"1587118410665000004",
               "feature_value":"1"
            },
            {
               "feature_id":"1587118410671000010",
               "feature_value":"test1"
            },
            {
               "feature_id":"1587118410671000011",
               "feature_value":"test2"
            }
         ],
         "has_image":false,
         "branch_id":"1587118394609000002",
         "resource_id":"1587118423397000084",
         "location":"SCREEN 1,S2 MALLAPUR,JAPAN",
         "floor_id":"1587118394619000012",
         "resource_name":"TEL Meeting",
         "category":0
      },
      {
         "building_id":"1587118394618000011",
         "category_name":"Meeting Room",
         "resource_type":0,
         "is_hidden":false,
         "res_email_id":"97a7476ddadd4fc2bcb1e1e983730626@m43.com",
         "resource_approval":false,
         "auto_gen_name":"97a7476ddadd4fc2bcb1e1e983730626",
         "capacity":12,
         "is_available":false,
         "features":
      [
         {
            "feature_id":"1639037183398000001",
            "feature_value":"1"
         }
      ],
      "has_image":false,
      "branch_id":"1587118394609000002",
      "resource_id":"1639037209028000001",
      "location":"SCREEN 1,S2 MALLAPUR,JAPAN",
      "floor_id":"1587118394619000012",
      "resource_name":"FM",
      "category":0
   }
]