Change Access Privileges of Application - REST API - POST Method
Zoho Creator
REST style Web API allows changing the access type of an application
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 an application?
Only the owner of the
application with a valid api key can change the access type of an
application.
Request URL
The request url to change the
access type of a record in xml/json format is given below:
XML : http://creator.zoho.com/api/xml/application/changeaccess/
JSON : http://creator.zoho.com/api/json/application/changeaccess/
Request Parameters
The request parameters comprises of the application 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.
|
| 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/application/changeaccess/apikey=[APIKEY]&ticket=[Ticket]">
<input type="text" name="applinkname" value="application 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
1. Sample request to change
the access type of an application named "Employee Database" with deluge name
"employee-database" from private to public.
<input type="text" name="applinkname " value="employee-database">
<input type="text" name="access" value="public">
Sample Response
XML Format
<response>
<application
name="
employee-database">
<access>
public</access>
<status>
Success</status>
</application>
</response>
Equivalent JSON
format
{
"application":
{
"access":"public",
"status":"Success",
"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".
