Home / Get Share Info

Get Share Info

Tags:  

Get Share Info




Introduction

The Get Share Info API is used to fetch all the Sharing information of a Database. Only the Administrator of the database (one who created the database) can use this API.

Getting Started

It is recommended to go through the Zoho Reports API Prerequisites before using GETSHAREINFO API.


Request

The following is the sample request URL to get the shared information of a database:
https://reportsapi.zoho.com/api/your_account@zoho.com/SalesDB?ZOHO_ACTION=GETSHAREINFO
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0


Query String Parameters

The following table shows the list of Query String parameters that has to be passed along with the request URL.

This parameters should be in the same case as given in this document.

Parameter Name Description
ZOHO_ACTION This parameter value should be GETSHAREINFO.
 
authtoken
The authtoken parameter should hold the Auth Token of the Database Owner Account.

Response

The following sample response will be sent from the server.

XML Format:

response uri="/api/your_account@zoho.com/SalesDB" action="GETSHAREINFO"
result
usershareinfo shareinfo emailuser1@mydomain.com/email permissions perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exporttrue/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser4@mydomain.com/email permissions perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exporttrue/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser215@mydomain.com/email permissions perminfo viewname="finepick1" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuserlf12@mydomain.com/email permissions perminfo viewname="Parent" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser33@mydomain.com/email permissions perminfo viewname="Parent" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo perminfo viewname="sss" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser1@mydomain.com/email permissions perminfo viewname="finepick1" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser115@mydomain.com/email permissions perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exporttrue/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser11@mydomain.com/email permissions perminfo viewname="grp_pv1" sharedby="user@mydomain.com" permission readtrue/read exporttrue/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser214@mydomain.com/email permissions perminfo viewname="finepick1" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser104@mydomain.com/email permissions perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exporttrue/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser10@mydomain.com/email permissions perminfo viewname="Table2" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo shareinfo emailuser101@mydomain.com/email permissions perminfo viewname="Table1" sharedby="user@mydomain.com" permission readtrue/read exportfalse/export vudfalse/vud addrowfalse/addrow updaterowfalse/updaterow deleterowfalse/deleterow deleteallrowsfalse/deleteallrows appendimportfalse/appendimport updateimportfalse/updateimport truncateimportfalse/truncateimport deleteupdateaddimportfalse/deleteupdateaddimport sharefalse/share /permission /perminfo /permissions /shareinfo /usershareinfo publicshareinfo /publicshareinfo privatelinkshareinfo /privatelinkshareinfo groupshareinfo groupmembers memberuser10@mydomain.com/member memberuser1@mydomain.com/member /groupmembers /groupshareinfo dbownershareinfo dbowners memberuser13@mydomain.com/member memberuser1@mydomain.com/member /dbowners /dbownershareinfo /result
/response

JSON Format:

{  
   "response":{  
      "uri":"\/api\/user@mydomain.com\/DB1",
      "action":"GETSHAREINFO",
      "result":{  
         "usershareinfo":[  
            {  
               "shareinfo":{  
                  "email":"user1@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"true",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user4@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"true",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user215@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"finepick1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"userlf12@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Parent",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user33@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Parent",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     },
                     {  
                        "perminfo":{  
                           "viewname":"sss",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     },
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user1@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"finepick1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user115@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"true",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user11@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"grp_pv1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"true",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user214@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"finepick1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user104@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"true",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user10@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table2",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            },
            {  
               "shareinfo":{  
                  "email":"user101@mydomain.com",
                  "permissions":[  
                     {  
                        "perminfo":{  
                           "viewname":"Table1",
                           "sharedby":"user@mydomain.com",
                           "permission":{  
                              "read":"true",
                              "export":"false",
                              "vud":"false",
                              "addrow":"true",
                              "updaterow":"false",
                              "deleterow":"false",
                              "deleteallrows":"false",
                              "appendimport":"false",
                              "updateimport":"false",
                              "truncateimport":"false",
                              "deleteupdateaddimport":"false",
                              "share":"false"
                           }
                        }
                     }
                  ]
               }
            }
         ],
         "publicshareinfo":{  

         },
         "privatelinkshareinfo":{  

         },
         "groupshareinfo":{  
            "groupmembers":[  
               "user10@mydomain.com",
               "user1@mydomain.com"
            ]
         },
         "dbownershareinfo":{  
            "dbowners":[  
               "user13@mydomain.com",
               "user1@mydomain.com"
            ]
         }
      }
   }
}

Error Codes:

The following table shows the list of error codes sent from server on failure of Get Share Info API Request along with the reason and the solution for the same.

Error CodeReasonSolution
7301You (your full name) do not have the permission to do this operation. Only database owner has the permission.Provide the authtoken for the Administrator of the database
7103The Database Name mentioned in the API URL does not existsPlease provide an existing Database Name to get the sharing details

In case of any error other than the above said, mail the API request URL parameters and error response details to support@zohoreports.com. Zoho Reports will get back to you with the best possible solution.




     RSS of this page