Blogs  Forums  Creator Home Toll Free : 888 900 9646

API Home >> Creator API >> REST API >> REST API Methods >> Get Shared Details - POST Method

 


  Get Shared Details - REST API - POST Method

 

Zoho Creator REST style Web API enables client applications to get the shared details of a Zoho Creator application, using the HTTP POST method.   In return the user gets a formatted XML/JSON response from the called method.  

Who can get the shared detials of an application?

Only the owner of an application with a valid apikey can get the shared details of his application.


Request URL

The request url to get the shared details of an application in xml/json format is given below:

XML : http://creator.zoho.com/api/xml/shared-details/  
 
JSON : http://creator.zoho.com/api/json/shared-details/


Request Parameters

The request parameters comprises of  the application name whose shared details needs to be retrieved.

Field
Description
applinkname
[string] - The name of the application as specified in deluge script. Refer http://creator.zoho.com/api/reference to view the list of applications created and its deluge name.


Sample Form ( POST Method Format )


<form method=" POST " action="http://creator.zoho.com/api/xml/shared-details/apikey= [APIKEY] &ticket= [Ticket] ">

<input type="text" name="applinkname " value="Name of the application"> 

<input type="submit" value="Shared Details">

</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 get the shared details of an application named "issue-manager".

<input type="text" name="applinkname " value=" issue-manager ">



 Sample Response


XML Format

 


 <response>
    <application name="issue-manager">
      <sharedto>
        <userlist>
            <username>ptkanvignesh</username>
            <username>prem</username>
        </userlist>
     </sharedto>
  </application>
</response>



Equivalent JSON format

{
  "application":
    {
      "shared-to":
        {
          "userlist":
            [
              "ptkanvignesh","prem"
            ]
       },
           "name": "issue-manager"
    }
}




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.