Domain (Rest API) - Revision history

Appscp: /* Add/Edit (Reseller Only) */ document rsEmailProduct field

2017-04-05T18:31:11Z

‎Add/Edit (Reseller Only): document rsEmailProduct field

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:35:18Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:40:22Z

‎v1 - Current

Appscp at 18:36, 23 September 2014

2014-09-23T18:36:39Z

Show changes

Appscp: added documentation for domain transfer

2014-09-12T15:06:59Z

added documentation for domain transfer

Appscp at 15:03, 24 July 2014

2014-07-24T15:03:57Z

Appscp: /* Index */

2014-04-16T21:02:12Z

‎Index

Appscp: /* Index */

2014-04-16T19:58:58Z

‎Index

Appscp: v1 documentation

2013-12-04T22:21:11Z

v1 documentation

Appscp at 15:32, 23 October 2013

2013-10-23T15:32:08Z

@@ Line 212: / Line 212: @@
 | int
 | Maximum number of mailboxes allowed under the domain Exchange service. Required for Adding Exchange service
 |-
 | rsEmailBaseMailboxSize
@@ Line 289: / Line 293: @@
 | abc.com already exists as a domain or alternate domain
 |}
 === Move (Reseller Only)===

@@ Line 30: / Line 30: @@
 <pre>
-get '/customers/all/domains?size=100&offset=10', 'text/xml'
+get '/customers/all/domains?size=100&offset=10'
 </pre>
@@ Line 139: / Line 139: @@
 <pre>
-get '/customers/999999/domains/example.com', 'text/xml'
+get '/customers/999999/domains/example.com'
 </pre>
@@ Line 258: / Line 258: @@
 <pre>
-post '/customers/123455/domains/newcompany.com', 'text/xml',
+post '/customers/123455/domains/newcompany.com',
+{
    'maxNumMailboxes' => '5',
@@ Line 266: / Line 266: @@
 <pre>
-put '/customers/123455/domains/newcompany.com', 'text/xml',
+put '/customers/123455/domains/newcompany.com',
+{
    'maxNumMailboxes' => '25',
@@ Line 321: / Line 321: @@
 <pre>
-put '/customers/123456/domains/newcompany.com', 'text/xml',
+put '/customers/123456/domains/newcompany.com',
+{
    'moveDomain' => 'true'
@@ Line 502: / Line 502: @@
 <pre>
-delete '/customers/12345678/domains/newcompany.com', 'text/xml'
+delete '/customers/12345678/domains/newcompany.com'
 </pre>
@@ Line 524: / Line 524: @@
 <pre>
-get '/customers/12345678/domains/test.com/alternatedomains', 'text/xml'
+get '/customers/12345678/domains/test.com/alternatedomains'
 </pre>
@@ Line 587: / Line 587: @@
 <pre>
-post '/customers/123456/domains/example.com/alternatedomains/accepteddomain.com', 'text/xml',
+post '/customers/123456/domains/example.com/alternatedomains/accepteddomain.com',
+{
    'type' => 'AcceptedDomain'
@@ Line 655: / Line 655: @@
 <pre>
-get '/customers/12345678/domains/company.com/splitdomainrouting', 'text/xml'
+get '/customers/12345678/domains/company.com/splitdomainrouting'
 </pre>
@@ Line 703: / Line 703: @@
 <pre>
-put '/customers/12345678/domains/company.com/splitdomainrouting', 'text/xml',
+put '/customers/12345678/domains/company.com/splitdomainrouting',
+{
    'externalServer' => 'email.externalserver.com',
@@ Line 740: / Line 740: @@
 <pre>
-get '/customers/12345678/domains/company.com/archivingSSOLoginURL', 'text/xml'
+get '/customers/12345678/domains/company.com/archivingSSOLoginURL'
 </pre>
@@ Line 770: / Line 770: @@
 <pre>
-get '/customers/12345678/domains/company.com/ex/publicFolders', 'text/xml'
+get '/customers/12345678/domains/company.com/ex/publicFolders'
 </pre>
@@ Line 806: / Line 806: @@
 <pre>
-put '/customers/12345678/domains/company.com/ex/publicFolders', 'text/xml',
+put '/customers/12345678/domains/company.com/ex/publicFolders',
+{
    'enabled' => 'true'
@@ Line 864: / Line 864: @@
 <pre>
-post'/customers/12345678/domains/example.com/emaileveryone', 'text/xml',
+post'/customers/12345678/domains/example.com/emaileveryone',
+{
    'fromName' => 'John Doe',
@@ Line 911: / Line 911: @@
 <pre>
-get '/customers/999999/domains/example.com/catchalladdress', 'text/xml'
+get '/customers/999999/domains/example.com/catchalladdress'
 </pre>
@@ Line 968: / Line 968: @@
 <pre>
-post'/customers/12345678/domains/example.com/emaileveryone', 'text/xml',
+post'/customers/12345678/domains/example.com/emaileveryone',
+{
    'address' => 'abc@example.com'
+}
 </pre>

@@ Line 25: / Line 25: @@
   <nowiki>'https://api.emailsrvr.com/v1/domains'</nowiki>.
-*The index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/DomainList.xsd DomainList.xsd]
+*The index operation only supports the GET HTTP verb.
 ''Example'':
@@ Line 127: / Line 127: @@
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Domain.xsd Domain.xsd]
+The show operation only supports the GET HTTP verb.
@@ Line 518: / Line 518: @@
 ''Description'':
-This operation returns a list of Domain Aliases and Accepted Domains for the domain. The type of the alternate domain is indicated by the 'type' data field. The XML schema for the returned data is [http://api.emailsrvr.com/Schemas/DomainSplitRouting.xsd DomainAlternateList.xsd]
+This operation returns a list of Domain Aliases and Accepted Domains for the domain. The type of the alternate domain is indicated by the 'type' data field.
@@ Line 649: / Line 649: @@
 ''Description'':
-Shows the current external email server. The XML schema document for the output of this command is [http://api.emailsrvr.com/Schemas/DomainSplitRouting.xsd DomainSplitRouting.xsd]
+Shows the current external email server.
@@ Line 766: / Line 766: @@
 ''Description'':
-Retrieves the Exchange Public Folders status for the domain. The XML schema for the returned data is [http://api.emailsrvr.com/Schemas/DomainPublicFolders.xsd DomainPublicFolders.xsd]
+Retrieves the Exchange Public Folders status for the domain.
 ''Example'':

@@ Line 300: / Line 300: @@
 ''Description'':
-Moves the domain to another customer account.
+Moves a domain among your account and subaccounts.
 {| class="wikitable"
@@ Line 327: / Line 326: @@
+}
 </pre>
 === Delete (Reseller Only)===

@@ Line 18: / Line 18: @@
 ''Remarks'':
 *To retrieve a list of domains owned by the account that is logged in, use "me" as the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v0/customers/me/domains'</nowiki>. To retrieve a list of domains owned by all customer sub-accounts and your own account, use "all" as the customer account number.
 *The index operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/DomainList.xsd DomainList.xsd]
@@ Line 86: / Line 91: @@
 {"name":"apidomain68.com","accountNumber":"100002","serviceType":"exchange","exchangeMaxNumMailboxes":"50","exchangeUsedStorage":"10","rsEmailMaxNumberMailboxes":"0","rsEmailUsedStorage":"0"}]}
 </pre>
 === Show ===

@@ Line 26: / Line 26: @@
 <pre>
 get '/customers/all/domains?size=100&offset=10', 'text/xml'
 </pre>
@@ Line 78: / Line 85: @@
 {"name":"apidomain66.com","accountNumber":"100001","serviceType":"rsemail","exchangeMaxNumMailboxes":"0","exchangeUsedStorage":"0","rsEmailMaxNumberMailboxes":"100","rsEmailUsedStorage":"40"},
 {"name":"apidomain68.com","accountNumber":"100002","serviceType":"exchange","exchangeMaxNumMailboxes":"50","exchangeUsedStorage":"10","rsEmailMaxNumberMailboxes":"0","rsEmailUsedStorage":"0"}]}
 </pre>

@@ Line 18: / Line 18: @@
 ''Remarks'':
-To retrieve a list of domains owned by the account that is logged in, use "me" as the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v0/customers/me/domains'</nowiki>. To retrieve a list of domains owned by all customer sub-accounts and your own account, use "all" as the customer account number.
+*To retrieve a list of domains owned by the account that is logged in, use "me" as the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v0/customers/me/domains'</nowiki>. To retrieve a list of domains owned by all customer sub-accounts and your own account, use "all" as the customer account number.
 ''Example'':
@@ Line 44: / Line 43: @@
        <accountNumber>100000</accountNumber>
        <serviceType>both</serviceType>
      </domain>
      <domain>
        <name>apidomain66.com</name>
        <accountNumber>100001</accountNumber>
-       <serviceType>both</serviceType>
+       <serviceType>rsemail</serviceType>
      </domain>
      <domain>
        <name>apidomain68.com</name>
        <accountNumber>100002</accountNumber>
-       <serviceType>both</serviceType>
+       <serviceType>exchange</serviceType>
      </domain>
    </domains>
@@ Line 64: / Line 75: @@
 <pre>
 {"offset":0,"size":50,"total":3,"domains":
-[{"name":"apidomain53.com","accountNumber":"100000","serviceType":"both"},
+[{"name":"apidomain53.com","accountNumber":"100000","serviceType":"both","exchangeMaxNumMailboxes":"10","exchangeUsedStorage":"4","rsEmailMaxNumberMailboxes":"10","rsEmailUsedStorage":"9"},
-{"name":"apidomain66.com","accountNumber":"100001","serviceType":"both"},
+{"name":"apidomain66.com","accountNumber":"100001","serviceType":"rsemail","exchangeMaxNumMailboxes":"0","exchangeUsedStorage":"0","rsEmailMaxNumberMailboxes":"100","rsEmailUsedStorage":"40"},
-{"name":"apidomain68.com","accountNumber":"100002","serviceType":"both"}]}
+{"name":"apidomain68.com","accountNumber":"100002","serviceType":"exchange","exchangeMaxNumMailboxes":"50","exchangeUsedStorage":"10","rsEmailMaxNumberMailboxes":"0","rsEmailUsedStorage":"0"}]}
 </pre>

@@ Line 1: / Line 1: @@
 __TOC__
-== Index ==
+=== Index ===
@@ Line 68: / Line 69: @@
 </pre>
-== Show ==
+=== Show ===
 ''URL'':
@@ Line 137: / Line 138: @@
 </pre>
-== Add/Edit (Reseller Only)==
+=== Add/Edit (Reseller Only)===
 ''URL'':
@@ Line 245: / Line 246: @@
 |}
-== Move (Reseller Only)==
+=== Move (Reseller Only)===
 ''URL'':
@@ Line 283: / Line 284: @@
 </pre>
-== Delete (Reseller Only)==
+=== Delete (Reseller Only)===
 ''URL'':
@@ Line 307: / Line 308: @@
-== Alternate Domains ==
+=== Alternate Domains ===
-=== Index (Reseller Only) ===
+==== Index (Reseller Only) ====
 ''URL'':
@@ Line 353: / Line 354: @@
 <pre>{"alternateDomains":[{"name":"domainalias.com","type":"DomainAlias"},{"name":"accepteddomain.com","type":"AcceptedDomain"}]}</pre>
-=== Add (Reseller Only) ===
+==== Add (Reseller Only) ====
@@ Line 421: / Line 422: @@
-=== Delete (Reseller Only) ===
+==== Delete (Reseller Only) ====
@@ Line 441: / Line 442: @@
 </pre>
-== Split Domain Routing ==
+=== Split Domain Routing ===
-=== Show Settings ===
+==== Show Settings ====
 ''URL'':
@@ Line 475: / Line 476: @@
 </pre>
-=== Edit Settings ===
+==== Edit Settings ====
 ''URL'':
@@ Line 521: / Line 522: @@
 |}
-== Archiving SSO Login URL ==
+=== Archiving SSO Login URL ===
 ''URL'':
@@ Line 557: / Line 558: @@
 |}
-== Domain Public Folders ==
+=== Domain Public Folders ===
-=== Show Status ===
+==== Show Status ====
 ''URL'':
   <nowiki>
@@ Line 584: / Line 585: @@
 </pre>
-=== Enable ===
+==== Enable ====
 ''URL'':
   <nowiki>
@@ Line 628: / Line 629: @@
-== Domain Email Everyone ==
+=== Domain Email Everyone ===
 ''URL'':
@@ Line 692: / Line 693: @@
-== Show Domain Catch-All Address ==
+=== Show Domain Catch-All Address ===
 ''URL'':
@@ Line 734: / Line 735: @@
-== Edit Domain Catch-All Address ==
+=== Edit Domain Catch-All Address ===
 ''URL'':

← Older revision		Revision as of 15:32, 23 October 2013
Line 88:		Line 88:

	# These two fields 'exchangeUsedStorage' and 'rsEmailUsedStorage' actually return the number of active mailboxes in each service respectively.		# These two fields 'exchangeUsedStorage' and 'rsEmailUsedStorage' actually return the number of active mailboxes in each service respectively.
−	# Due to a performance issue Domain Public Folder Status is now returned from an individual URL. See [[Domain_(Rest_API)#Show_Status \| Public Folders Status]]. The field 'publicFoldersEnabled' from Show Domain result always returns 'false' ~~at this moment~~.	+	# Due to a performance issue Domain Public Folder Status is now returned from an individual URL. See [[Domain_(Rest_API)#Show_Status \| Public Folders Status]]. The field 'publicFoldersEnabled' from Show Domain result always returns 'false'.