Get department user list - Zoho Webinar
Table of Contents
Note:
- This task is applicable to all services except Zoho Creator.
- Each time the zoho.webinar.getDepartmentUsersList integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
- Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.webinar.getDepartmentUsersList integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.
Overview:
This task is used to get users list in a specific department in Zoho Webinar.
This task is based on Zoho Webinar API: Department users list.
Syntax:
<variable> = zoho.webinar.getDepartmentUsersList(<portal_id>, <department_id>, <index>, <count>, <type>, <connection>);
where:
| Params | Data type | Description |
| <variable> | KEY-VALUE | Specifies the variable that will hold the response returned by Zoho Webinar. |
| <portal_Id> | NUMBER | Specifies the unique portal identifier where the department users list will be fetched from. |
| <department_Id> | NUMBER | Specifies the unique identifier of the department. |
| <index> | INTEGER | Specifies the pagination start index. Default: 1. |
| <count> | INTEGER | Specifies the number of user details from department to fetch. |
| <type> | TEXT | Specifies the types of users in Zoho Webinar, such as all users, admin users, and member users. Supported user type: all, admin, member. |
| <connection> | TEXT | Specifies the link name of the Zoho Webinar connection. Required scope: ZohoWebinar.department.READ |
Example:
response = zoho.webinar.getDepartmentUsersList(86367739,"645551000000025019",1,20,"all","webinar1");
where:
responseIs the KEY-VALUE returned by Zoho Webinar. It represents the department details.
8636773Is the NUMBER of the unique portal identifier.
645551000000025019Is the NUMBER of the department identifier.
1Is the INTEGER pagination start index.
20Is the INTEGER count.
"all"Is the TEXT user type.
"webinar"Is the TEXT connection name.
Sample response
Success response
{
"representation": [ { ... } ],
"resourceType": "/api/v2/86367739/department/645551000000025019/user"
}
"representation": [ { ... } ],
"resourceType": "/api/v2/86367739/department/645551000000025019/user"
}
Failure response
{
"error": {
"code": 1033,
"message": "User is not a departmnet admin and not a org admin"
}
}
"error": {
"code": 1033,
"message": "User is not a departmnet admin and not a org admin"
}
}