Difference between revisions of "SharePoint (Rest API)"
From Rackspace Email & Apps API
(v1 documentation) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
| − | == | + | |
| + | == v1 - Current == | ||
=== Settings === | === Settings === | ||
| Line 9: | Line 10: | ||
''URL'': | ''URL'': | ||
| − | <nowiki>[GET] https://api.emailsrvr.com/ | + | <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings</nowiki> |
''Description'': | ''Description'': | ||
| − | Returns the status and quota size of the SharePoint service. | + | Returns the status and quota size of the SharePoint service. |
| Line 20: | Line 21: | ||
<pre> | <pre> | ||
| − | get '/customers/999999/sharepoint/settings | + | get '/customers/999999/sharepoint/settings' |
</pre> | </pre> | ||
| Line 43: | Line 44: | ||
''URL'': | ''URL'': | ||
| − | <nowiki>[PUT] https://api.emailsrvr.com/ | + | <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/sharepoint/settings</nowiki> |
| Line 67: | Line 68: | ||
''Example'': | ''Example'': | ||
<pre> | <pre> | ||
| − | put '/customers/123456/sharepoint/settings | + | put '/customers/123456/sharepoint/settings', |
{ | { | ||
'enabled' => 'true', | 'enabled' => 'true', | ||
Latest revision as of 13:12, 15 September 2017
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.
Example:
get '/customers/999999/sharepoint/settings'
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',
{
'enabled' => 'true',
'size' => '10.0'
}
