Site resource

Get site list - Get site list v1

OVERVIEW



Note: The latest specification for Collaborate 4.1.4 and above is here

API returns a list of sites from a Collaborate instance. 

Request

GET:   /sites

Query string parameters

 

Parameter Name

Value

Description

filterby

 

String

Possible values are {recent|favourite|category|all} Default for this field is “recent”

By default any filter will send back the first 20 sites if pagination is false

categoryid

Int

This parameter is used to get the site list based on the site category ID, please provide site categoryid in addition to setting the filterby property to category. 

example = /api/1/sites?filterby=category&categoryid=1 

returncount

Int

The no of sites returned. Default is 20. This option does not apply if the filterBy property is set to all

status

String

One of the various site statuses available in the system

{active|archived|readonly|preparation}

Default -> {active + readonly + preparation}

for filterBy={recent|favourite| category}]

if filterBy={all}  is set then all status become applicable.

Includefolderpermission

Boolean

{true|false}

default is false
name String

This parameter is used to search for a site by name. The site is included in the search result if the string appears  in the title of the site  (The results are returned in ascending order)

example: Retrieve sites having "HighQ" word in their name : /api/1/sites?name='HighQ'

This will return all sites having "HighQ" word in their site name. 

 
callFrom String The only valid value is HIGHQDRIVE. If set the site list filters out any sites that have any  restrictions on them. The conditions are as below. 

           1. 'Visible on HighQ Drive or Office Plugin' checkbox is not selected in Site->Admin->Advanced page.

            2. Password protected site

            3. 2FA enable site

            4. Terms & condition applied site

            5. IP Restricted sites

            6. document workflow enabled site

            7. checkin / checkout enabled site

            8. DRM enabled site

            9. Files module is disabled

example: exclude restricted site as  : /api/1/sites?callFrom=HIGHQDRIVE

 

Response XML

For Intenal Admin Response XML :

<?xml version="1.0" encoding="UTF-8"?>

<sites>

    <site>

        <id>1</id>

        <sitename>My site</sitename>

        <role></role>

        <sitedescription />

        <sitefolderID>1</sitefolderID>

        <sitefolderpermission>UPDATE</sitefolderpermission>

        <adminnote />

        <category>

            <id>1</id>

            <name>None</name>

        </category>

        <startdate/>

        <enddate />

        <createddate>14 Mar 2014</createddate>

        <type>Service</type>

        <clientno />

        <matterno />

        <status>Active</status>

         <siteowner>

               <firstname>First</firstname>

               <lastname>Last</lastname>

               <email>first.last@domain.com</email>

               <userid>103</userid>

        </siteowner>

    </site>

</sites>

For Other than internalAdmin Response XML :

<?xml version="1.0" encoding="UTF-8"?>

<sites>

    <site>

        <id>3</id>

        <sitename>My site</sitename>

        <sitedescription />

        <sitefolderID>16</sitefolderID>

        <category>

            <name>None</name>

        </category>

        <status>Active</status>

    </site>

</sites>

Response Code

Code Meaning
400

Problem with parsing XML or JSON object (Bad Request)
401 Unauthorised
403 Validation failed/ Forbidden
405 Method not allowed (calling API with wrong method)
500 Internal error occurred while getting site

 

Comments


0 Comments

Last Updated: Jun 09,2023