The Zoom Web APIs allow web services or web clients to access the DAM and Workflow functions easily. Except for the UI Launcher and metadata API, all the other APIs are remote APIs and do not require a local working copy.<\/p>\n\n\n
These APIs are invoked on the Zoom Web Management Server<\/span>. Default TCP port: 8443. The role needed to execute these APIS: Project Admin<\/span> or Super Admin<\/span> unless otherwise stated.<\/p>\n\n\n\n Form request data refers to the Http Form data that must be sent either as a URL-encoded query parameter or in a POST.<\/p>\n\n\n\n Below is a list of a few our web administration APIs. Please refer to the Zoom Web Administration Reference guide for an exhaustive list of the APIs on our support site.<\/p>\n\n\n\n Get the current logged in user\u2019s profile.<\/p>\n\n\n\n Any authenticated user can access their profile<\/p>\n\n\n\n {<\/p>\n “success”: true,<\/p>\n “username”: “rahul”,<\/p>\n “firstname”: “Rahul”,<\/p>\n “lastname”: “Bhargava”,<\/p>\n “email”: “rahul@evolphin.com”,<\/p>\n “fullname”: “Rahul Bhargava”,<\/p>\n “rate”: 0,<\/p>\n “projectlist”: “Project With Jobs, Shared-Project, Perich, Job 7.2, FAAC, Job 7.1 Retail Chain Ad, Job 8.1, defproj”,<\/p>\n “password”: “rahul”,<\/p>\n “note”: “”,<\/p>\n “allowProfileEdit”: true<\/p>\n }<\/p>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n List all user profiles. Some filtering can be done through the control of request parameters, such as getting users starting from a specific list index, limiting the number of users in the response, and, getting only those users whose usernames start with the specified letters.<\/p>\n\n\n\n start: <index in user table><\/p>\n limit: <number of users to return><\/p>\n query: <prefix string – to get only those users whose usernames start with the given prefix string, if any><\/p>\n onlyName: <true \u2013 if only user name fields requested: displayname, username, lastname, firstname><\/p>\n<\/div>\n\n\n\n {<\/strong><\/p>\n “success”: true,<\/strong><\/p>\n “nentries”: “12”,<\/strong><\/p>\n “entries”: [<\/strong><\/p>\n {<\/strong><\/p>\n “username”: “gary”,<\/strong><\/p>\n “lastname”: “Harr”,<\/strong><\/p>\n “firstname”: “Gary”,<\/strong><\/p>\n “email”: “”,<\/strong><\/p>\n “password”: “gary.harr982”,<\/strong><\/p>\n “note”: “”,<\/strong><\/p>\n “rate”: “0”<\/strong><\/p>\n },<\/strong><\/p>\n {<\/strong><\/p>\n “username”: “min”,<\/strong><\/p>\n “lastname”: “Min”,<\/strong><\/p>\n “firstname”: “Min”,<\/strong><\/p>\n “email”: “”,<\/strong><\/p>\n “password”: “min”,<\/strong><\/p>\n “note”: “”,<\/strong><\/p>\n “rate”: “0”<\/strong><\/p>\n },<\/strong><\/p>\n \u2026\u2026\u2026\u2026\u2026..<\/strong><\/p>\n }<\/p>\n<\/div>\n\n\n\n Add a new user or edit the user\u2019s profile of the specified user<\/p>\n\n\n\n lastname:Cathy<\/p>\n firstname:Batee<\/p>\n password:cathy<\/p>\n cpassword:cathy<\/p>\n email:batee.cathy@evolphin.com<\/p>\n rate:0<\/p>\n note:<\/p>\n<\/div>\n\n\n\n {<\/p>\n “success”: “true”,<\/p>\n “info”: “User account updated!”<\/p>\n }<\/p>\n<\/div>\n\n\n\nGET USER PROFILE<\/h2>\n\n\n\n
Description:<\/h4>\n\n\n\n
Role required:<\/h4>\n\n\n\n
Request URL:<\/h4>\n\n\n\n
Sample Response JSON:<\/h4>\n\n\n\n
GET USER ACCOUNT LIST<\/h2>\n\n\n\n
Description:<\/h4>\n\n\n\n
Request URL:<\/h4>\n\n\n\n
Form Request Data<\/h4>\n\n\n\n
Sample Response JSON:<\/h4>\n\n\n\n
ADD OR MODIFY USER PROFILE<\/h2>\n\n\n\n
Description:<\/h4>\n\n\n\n
Request URL:<\/h4>\n\n\n\n
Add user:<\/h5>\n\n\n\n
http:\/\/zoom-server-address:8443\/jsp\/users\/modifyuserform.jsp<\/span><\/h5>\n\n\n\n
Edit user:<\/h5>\n\n\n\n
http:\/\/zoom-server-address:8443\/jsp\/users\/modifyuserform.jsp?edit=true&username=<user id><\/span><\/h5>\n\n\n\n
Form Request Data:<\/h4>\n\n\n\n
Sample Response JSON:<\/h4>\n\n\n\n
DELETE USER ACCOUNTS<\/h2>\n\n\n\n
Description:<\/h4>\n\n\n\n