Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:51:52Z

remove accept header from examples to avoid confusion

Kevin.lin: Sync to latest

2010-03-29T15:24:33Z

Sync to latest

New page

__TOC__

=== Index ===

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources</nowiki>

''Description'':

This operation returns a list of resource mailboxes associated with the domain.

''Remarks'':

The Index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/ResourceList.xsd ResourceList.xsd]

''Example'':
<pre>
get '/customers/12345678/domains/example.com/ex/resources?size=100&page=1&contains=conference', 'text/xml'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<resourceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resourceList">
<offset>0</offset>
<size>50</size>
<total>3</total>
<resources>
<resource>
<name>apiexresource43</name>
<displayName>API Test</displayName>
<type>room</type>
</resource>
<resource>
<name>apiexresource5</name>
<displayName>API Test</displayName>
<type>equipment</type>
</resource>
<resource>
<name>apiexresource85</name>
<displayName>API Test</displayName>
<type>room</type>
</resource>
</resources>
</resourceList>
</pre>

''Json Result Example'':

{"offset":0,"size":50,"total":3,"resources":[{"name":"apiexresource43","displayName":"API Test","type":"room"},{"name":"apiexresource5","displayName":"API Test","type":"equipment"},{"name":"apiexresource85","displayName":"API Test","type":"room"}]}

=== Show ===

''URL'':
[<nowiki>GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)</nowiki>

''Description'':

Returns the resource's details.

''Remarks'':

The show operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/Resource.xsd Resource.xsd]

''Example'':
<pre>
get '/customers/12345678/domains/example.com/ex/resource/conference.room', 'text/xml'
</pre>

''XML Result Example''

<pre>
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resource">
<name>apiexresource43</name>
<displayName>API Test</displayName>
<type>room</type>
</resource>
</pre>

''Json Result Example'':

{"name":"apiexresource43","displayName":"API Test","type":"room"}

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource is not found
| 404
| Resource not found
|-
| Entity is found but it's not a resource mailbox
| 404
| Mailbox is not a resource.
|}

=== Add/Edit ===

''URL'':
<nowiki>Add: [POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)
Edit: [PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)</nowiki>

''Description'':

Adds/edits the resource with the specified information. Required fields must be supplied when adding. Others are optional.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| displayName
| string
| Resource display name (Required for add)
|-
| type
| string
| The resource type, 'room' or 'equipment' (Required for add, not available for edit)
|-
| password
| string
| The password to change the settings of the mailbox or add/remove admins (Required for add)
|}

''Example'':
<pre>
post '/customers/12345678/domains/example.com/ex/resources/conference.room',
{
'displayName' => 'Conference Room'
'type' => 'room'
'password' => 'abcDEF123'
},
'text/xml'
</pre>

<pre>
put '/customers/12345678/domains/example.com/ex/resources/all.employees',
{
'displayName' => 'Conference Room A'
'password' => 'ABCd4321'
},
'text/xml',
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| New resource mailbox already exists
| 400
| The email address conference.room@abc.com is already in use
|-
| New resource mailbox name doesn't meet the naming requirements
| 400
| Invalid resource name
|-
| New display name doesn't meet the naming requirements
| 400
| Invalid display name
|-
| Invalid resource mailbox type
| 400
| Invalid Resource Type. The input must be: room/equipment.
|}

=== Delete ===

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)</nowiki>

''Description'':

Deletes the resource.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/ex/resources/all.employees', 'text/xml'
</pre>

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource is not found
| 404
| Resource not found
|-
| Entity is found but it's not a resource mailbox
| 404
| Mailbox is not a resource.
|}

=== Admins ===

This refers to the admins that can manage the resource.

==== Index Admin ====

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)/admins</nowiki>

''Description'':

Gets the list of resource admins.

''Remarks'':

The Index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/ResourceAdminList.xsd ResourceAdminList.xsd]

''Example'':
<pre>
get '/customers/12345678/domains/example.com/ex/resources/conference.room/admins', 'text/xml'
</pre>

''XML Result Example'':

<pre>
<?xml version="1.0" encoding="utf-8"?>
<resourceAdminList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:resourceAdminList">
<offset>0</offset>
<size>50</size>
<total>3</total>
<admins>
<admin>apiexmailbox70@apidomain90.com</admin>
<admin>apiexmailbox87@apidomain90.com</admin>
<admin>apiexmailbox89@apidomain90.com</admin>
</admins>
</resourceAdminList>
</pre>

''Json Result Example'':

{"offset":0,"size":50,"total":3,"admins":["apiexmailbox70@apidomain90.com","apiexmailbox87@apidomain90.com","apiexmailbox89@apidomain90.com"]}

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource is not found
| 404
| Resource not found
|-
| Entity is found but it's not a resource mailbox
| 404
| Mailbox is not a resource.
|}

==== Add Admin ====

''URL'':
<nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)/admins/(admin name)</nowiki>

''Description'':

Adds an admin to the resource.

''Example'':
<pre>
post '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', {}, 'text/xml'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource not found
| 404
| Resource not found
|}

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource is not found
| 404
| Resource not found
|-
| Entity is found but it's not a resource mailbox
| 404
| Mailbox is not a resource.
|-
| Admin is already on the resource admin list.
| 400
| User is already on the resource admin list.
|}

==== Delete Admin ====

''URL'':
<nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/ex/resources/(resource name)/admins/(admin name)</nowiki>

''Description'':

Removes the admin from the resource.

''Example'':
<pre>
delete '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', 'text/xml'
</pre>

''Errors'':

{| class="wikitable"
!''Description''
!''HTTP Response Code''
!''Sample Message''
|-
| Resource is not found
| 404
| Resource not found
|-
| Entity is found but it's not a resource mailbox
| 404
| Mailbox is not a resource.
|-
| Admin is not found on the resource admin list.
| 400
| User is not on the resource admin list.
|}

@@ Line 21: / Line 21: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/ex/resources?size=100&page=1&contains=conference', 'text/xml'
+get '/customers/12345678/domains/example.com/ex/resources?size=100&page=1&contains=conference'
 </pre>
@@ Line 78: / Line 78: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/ex/resource/conference.room', 'text/xml'
+get '/customers/12345678/domains/example.com/ex/resource/conference.room'
 </pre>
@@ Line 158: / Line 158: @@
    'type' => 'room'
    'password' => 'abcDEF123'
-},
 </pre>
@@ Line 167: / Line 166: @@
    'displayName' => 'Conference Room A'
    'password' => 'ABCd4321'
-},
 </pre>
@@ Line 210: / Line 208: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/ex/resources/all.employees', 'text/xml'
+delete '/customers/12345678/domains/example.com/ex/resources/all.employees'
 </pre>
@@ Line 252: / Line 250: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/ex/resources/conference.room/admins', 'text/xml'
+get '/customers/12345678/domains/example.com/ex/resources/conference.room/admins'
 </pre>
@@ Line 309: / Line 307: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', {}, 'text/xml'
+post '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', {}
 </pre>
@@ Line 360: / Line 358: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith', 'text/xml'
+delete '/customers/12345678/domains/example.com/ex/resources/conference.room/admins/john.smith'
 </pre>

Resource Mailbox (Rest API) - Revision history

Appscp: remove accept header from examples to avoid confusion

Kevin.lin: Sync to latest