Site object
OVERVIEW
<?xml version="1.0" encoding="UTF-8"?>
<sites>
    <site>
        <id>1</id> (Read only property)
        <sitename>My site</sitename>
        <role></role> (Read only property) (CONTENT_ADMIN, MEMBER_ADMIN, QA_ADMIN, REPORTING_ADMIN, SITE_ADMIN, SYSTEM_ADMIN, CREATE_SITE_ROLE)
        <sitedescription>site description</sitedescription>
        <sitetemplateid></sitetemplateid> (Only required when creating a new site using site template)
        <sitefolderID>1</sitefolderID> (Read only property)  //added in Collaborate 3.4.8
        <sitefolderpermission>UPDATE</sitefolderpermission> (Read only property)
        <adminnote>admin notes</adminnote>
        
        <categories> (Added in 4.3 )
            <category>
                <id>1</id>
                <name>None</name> (Read only property)
            </category>
            <category>
                <id>2</id>
                <name>Category name</name> (Read only property)
            </category>  
        </categories>
<!-- GET/LIST added in Collaborate 4.3.11 (available to Site admin, system admin and Create site (site creator) )-->
       <module> <!-- ADD/UPDATE -->
            <home enable="1" />
            <activity enable="1" />
            <document enable="1" />
            <wiki enable="0" />
            <blog enable="0" />
            <task enable="0" >
                        <timelineview>0/1</timelineview> <!-- available for GET/LIST from collaborate 5.0 onwards -->
            </task>
            <event enable="0" />
            <isheet enable="0" />
            <qa enable="0" />
            <people enable="0" />
        </module>        
        <startdate>20 Mar 2014</startdate>
        <enddate>24 Apr 2014</enddate>
        <createddate>14 Mar 2014</createddate> (Read only property)
        <archivedate>14 Mar 2014</archivedate> (Read only property)
        <type>Service</type> (Deprecated in 4.3)
        <clientno>123</clientno>
        <matterno>234</matterno>
        <status>Active</status> (Read only property)
        <size>49.34MB</size> (Read only property)
        <billingnotes>Paid</billingnotes>  (Read only property)   //added in Collaborate 3.3.5
        <billingnextinvoicedate>24 Oct 2015</billingnextinvoicedate> (Read only property)    //added in Collaborate 3.3.5
        <billinglastinvoicedate>24 Oct 2014</billinglastinvoicedate>  (Read only property)    //added in Collaborate 3.3.5
        <filepagecount>5</filepagecount> (Read only property)    //added in Collaborate 3.3.5 (Read only property)
        <maxpagecount>11</maxpagecount> (Read only property)     //added in Collaborate 3.3.5   (Read only property)
        
        <rawsitesize> (Added in 4.2 ) (Read only property)
            <activedocumentsize>51733834</activedocumentsize>
            <deleteddocumentsize>821711</deleteddocumentsize>
            <totalsize>52555545</totalsize>
        </rawsitesize>
        
        <issyncable>1</issyncable> (Read only property) (Added in 4.1.4 ) (0 : restriction applied, 1 : not restriction applied)
        <siteowner> (Update only property)
            <firstname>First</firstname>
            <lastname>Last</lastname>
            <email>first.last@domain.com</email>
            <userid>103</userid>
        </siteowner>
        <!--  Changes introduced in 4.3.4 -->
        <file> (Update only property)
            <permissionlevel>SITE_FOLDERS_AND_FILES</permissionlevel> //SITE_ONLY/SITE_AND_FOLDERS/SITE_FOLDERS_AND_FILES- Added in 4.1.4 ) 
            <!-- Enabled Approval workflow -->
            <approvaldocumentworkflow>1</approvaldocumentworkflow> 
            <!-- Enable "force" and "suppress" email notification options -->
            <emailnotification>1</emailnotification> 
            <!-- Enable bulk downloads -->
            <allowbulkdownload>1</allowbulkdownload> 
            <!-- Show Files Index / Enable index page -->
            <showsitemap>1</showsitemap> 
            <!-- Enable site inbox -->
            <inbox>
                <enable>0</enable>
                <accountname>0</accountname>
            </inbox>  
        </file>
        
        <enforceusergroups>1</enforceusergroups> (Update only property)
        
        <biddersite> (Update only property)
            <enable>0</enable>
            <advancedqapermission>0</advancedqapermission>
        </biddersite>
        
        <!-- If type is email then following will be returned -->
        <contactus> (Update only property)
            <type>email</type>
            <values>
                <value>POC@highq.com</value>
            </values>
            <values>
                <value>test@shahbaaz.com</value>
            </values>
            <values>
                <value>shahbaaz@ymail3.com</value>
            </values>
        </contactus>
        
        <!-- If type is url then following will be returned -->
        <contactus> (Update only property)
            <type>url</type>
            <values>
                <value>http://demo.local.com</value>
            </values>
        </contactus>
        <!-- Changes introduced in 4.3.4 -->
<landingpage>files (root folder)</landingpage>
    </site>
</sites>
| Property | Expected values ( Default value) | Purpose | Operation (READ, WRITE, UPDATE) | 
|---|---|---|---|
| id | Integer (Autogenerated) | The ID of site | R | 
| sitename | String | Name of the site | RWU | 
| role | String (CONTACT values) | The role (Permissions) of the API user calling the API method | R | 
| sitedescription | String | The description of the site | RWU | 
| sitetemplateid | Integer (Autogenerated) | The ID of the site template. This should be used when creating a new site using a site template | RW | 
| sitefolderID | Integer (Autogenerated) | The ID of the root folder in the site. Use this value to get the list of folders and files in the site | R | 
| sitefolderpermission | String | The site folder access. Possible values are UPDATE/ADDFILE/VIEW | R | 
| adminnote | String | The note is visible to admins only | RWU | 
| categories category id | Integer (Autogenerated) | Category of the site | RWU | 
| categories category name | String | Site category name | R | 
| module home | String | Enable/disable home module | WU | 
| module activity | String | Enable/disable activity module | WU | 
| module document | String | Enable/disable document/file module | WU | 
| module wiki | String | Enable/disable wiki module | WU | 
| module blog | String | Enable/disable blog module | WU | 
| module task | String | Enable/disable task module | WU | 
| module event | String | Enable/disable event module | WU | 
| module isheet | String | Enable/disable isheet module | WU | 
| module qa | String | Enable/disable qa module | WU | 
| module people | String | Enable/disable people module | WU | 
| startdate | String | Date when site was created | RWU | 
| enddate | String | End date of site | RWU | 
| createddate | String | Date when site was created | R | 
| archivedate | String | Date when site was archived | R | 
| type | String | Deprecated in 4.3 | RWU | 
| clientno | String | Site client number | RWU | 
| matterno | String | Site matter number | RWU | 
| status | String | Status of site - Active, Read only, Archive and Preparation | R | 
| size | String | Size of site due to its content(files and folders) | R | 
| billingnotes | String | For billing purpose | R | 
| billingnextinvoicedate | String | For billing purpose | R | 
| billinglastinvoicedate | String | For billing purpose | R | 
| filepagecount | String | Page count of files accessed | R | 
| maxpagecount | String | Page count of all the files | R | 
| rawsitesize activedocumentsize | Long | Size of active documents | R | 
| rawsitesize deleteddocumentsize | Long | Size of deleted documents | R | 
| rawsitesize totalsize | Long | Total size | R | 
| issyncable | Integer | If site is supported for sync (For HighQ Drive use). | R | 
| siteowner firstname | String | Site owner first name | RU | 
| siteowner lastname | String | Site owner last name | RU | 
| siteowner email | String | Site owner email | RU | 
| siteowner userid | Integer (Autogenerated) | Site owner user ID in case of existing user | R | 
| file permissionlevel | String | File permission at site level. Possible values SITE_ONLY/SITE_AND_FOLDERS/SITE_FOLDERS_AND_FILES | RU | 
| file approvaldocumentworkflow | Integer | Enable/disable document workflow | RU | 
| file emailnotification | Integer | Enable/disable force and suppress email notifications for files while uploading | RU | 
| file allowbulkdownload | Integer | Enable/disable bulk download for normal user | RU | 
| file showsitemap | Integer | Enable/disable index page for normal user | RU | 
| file inbox enable | Integer | Enable/disable files inbox functionality | RU | 
| file inbox accountname | String | Email id from which files can be sent in files module through email | RU | 
| enforceusergroups | String | Enable/disable group based permissions in site | RU | 
| biddersite enable | Integer | Enable/disable normal bidder site | RU | 
| biddersite advancedqapermission | Integer | Enable/disable advanced bidder functionality in site | RU | 
| contactus type values value | String | For contact us link in footer as well as in notification emails | RU | 
| landingpage | String | Page to land when site is selected. This is mandatory when adding new site, non mandatory for update site. | RWU (Read from 4.3.6 onwards) | 
 
 
		 
												 
												
Comments
0 Comments