Change Access Privileges of Form/View - REST API - POST Method
Zoho Creator
REST style Web API allows changing the access type of an applications
form or view from private to public or
vice versa, using the HTTP POST method. In return the user gets a formatted XML/JSON response from the called method.
Who
can change the access type of Form/View?
Only the owner of the
application with a valid apikey can change the access type of Form/View in an
application.
Request URL
The request url to change the
access type of a form/view is given below:
XML :
http://creator.zoho.com/api/xml/formorview/changeaccess/
JSON : http://creator.zoho.com/api/json/formorview/changeaccess/
Request Parameters
The request parameters comprises of the application name, the
form/view name and the access type as given below:
Field
|
Description
|
applinkname
|
[string] - The application name as
specified in the deluge script. Refer http://creator.zoho.com/api/reference to
view the list of applications created, , the
form names and field names used in each application and the deluge field names.
|
componentname
|
[string]- The form name / view name
whose access type needs to be changed
|
| access |
[string] - Specify the new access type
as private / public |
Sample Form ( POST Method Format )
<form method="POST"
action="http://creator.zoho.com/api/xml/formorview/changeaccess/apikey=[APIKEY]
&ticket=[Ticket]">
<input type="text" name="applinkname" value="application name">
<input type="text" name="component name " value="form/view name">
<input type="text"
name="access " value="public/private">
<input type="submit" value="Change Access">
</form>
Note:
Refer http://creator.zoho.com/api/reference to
view the list of applications created, the form names and field names used in
each application and the deluge field names.
Sample
Request
Sample request to change the access type of a form named
"Employee" with deluge name "employee" from private to public. The
application name of this form is "Employee Database" with deluge name
"employee-database" .
<input type="text" name="applinkname" value="employee-database">
<input type="text" name="component
name" value="employee">
<input type="text" name="access" value="public">
Sample Response
XML Format
<response>
<application
name="employee-database"> <form
name="
employee">
<access>
public</access>
<status>
Success</status>
</form>
</application>
</response>
Equivalent JSON
format
{
"form":
{
"access":"public",
"status":"Success",
"name":"employee"
},
"application-name":"employee-database"
}
If there is an error in the request format, the corresponding error
code with the error message will be displayed. Please refer the topic, Error codes and description , to learn about the list of
error code displayed.
If the access privilege is
modified, the response message will be displayed with status as
"Success".
