Difference between revisions of "SharePoint (Rest API)"

From Rackspace Email & Apps API
Jump to: navigation, search
(v1 documentation)
Line 1: Line 1:
 
__TOC__
 
__TOC__
  
== v0 - Current ==
+
== v1 - Current ==
  
 
=== Settings ===
 
=== Settings ===
Line 9: Line 9:
 
''URL'':  
 
''URL'':  
  
  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/sharepoint/settings</nowiki>
+
  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings</nowiki>
  
  
Line 43: Line 43:
  
 
''URL'':
 
''URL'':
  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/sharepoint/settings</nowiki>
+
  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings</nowiki>
  
  

Revision as of 12:38, 23 September 2014

v1 - Current

Settings

Show

URL:

[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings


Description:

Returns the status and quota size of the SharePoint service. For text/xml format, refer to the following schema document: SharePointSettings.xsd


Example:

get '/customers/999999/sharepoint/settings', 'text/xml'

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<SharePointSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:SharePointSettings">
  <enabled>true</enabled>
  <size>0.25</size>
</SharePointSettings>


Json Result Example:

{"enabled":true,"size":0.25}

Edit (Reseller Only)

URL:

[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings


Description:

This operation will modify SharePoint's settings.


Field Name Data Type Description
enabled boolean Whether SharePoint is enabled or not. By enabling SharePoint you and/or your customers are agreeing to Rackspace's SharePoint Services Terms and Conditions.
size double SharePoint's storage size in GB. Valid values are .25 and any integer between 1 and 50 inclusive. This field will be ignored when SharePoint is disabled. (default value is 0.25GB)

Example:

put '/customers/123456/sharepoint/settings', 'text/xml',
{
  'enabled' => 'true',
  'size' => '10.0'
}