POST Exchange Mailbox - Revision history

Corinne.chui: 1 revision

2016-05-30T19:36:20Z

1 revision

Vladimir.georgiev at 11:54, 15 October 2015

2015-10-15T11:54:03Z

Mike.robski: 1 revision: Release 103

2015-02-06T17:24:36Z

1 revision: Release 103

Dinh.anh: /* Request Body */

2014-11-27T15:43:03Z

Request Body

Mike.robski: 1 revision: Release 95

2014-07-02T05:59:31Z

1 revision: Release 95

Mike.robski at 13:34, 20 May 2013

2013-05-20T13:34:35Z

New page

Create an Exchange mailbox

'''POST''' <code>/accounts/''{account_number}''/exchange/''{domain_name}''/mailboxes</code>

== Parameters ==
; account_number - ''string''
: The account number that the Exchange resource belongs to

; domain_name - ''string''
: The domain name that is associated with the Exchange resource

== Request Body ==

<nowiki>{
"owner": {
"username": "john2",
"password": "secret2"
},
"admin": 0,
"notes": "some text",
"recipientLimit": 10,
"deliverRedirect": "zsds",
"forwardTo": "asdasd",
"name": {
"name": "John Smith",
"company": "My Company",
"department": "Sales",
"title": "President"
},
"address": {
"address": "100 Main St.",
"city": "Chicago",
"state": "IL",
"zip": "60001",
"country": "US"
},
"phones": {
"businessPhone": "555-555-5501",
"homePhone": "555-555-5502",
"fax": "555-555-5503",
"mobile": "555-555-5504"
}
}
</nowiki>

; owner - ''dictionary''
: -Contains attributes related to the mailbox user

;: username - ''string''
:: -The handle of the mailbox that is to be created

;: password - ''string''
:: -The password required to access the new mailbox

; admin - ''integer''
: -Whether the mailbox user will have administrative privileges

; notes - ''string''
: -User defined textual description

; recipientLimit - ''integer''
: -Specifies the recipient limit for the mailbox. Allowed values are -1 or a positive integer

; deliverRedirect - ''string''
: -Redirect address

; forwardTo - ''string''
: -Forward address

; address - ''dictionary''
: -Specifies the address details for the mailbox

; phones - ''dictionary''
: -Specifies phone details for the mailbox

==Response Codes==
;200
: Success

;202
: Accepted

;404
: Non-existent resource

;405
: Unsupported method

;409
: Duplicate entry

;502
: Internal server error

== Examples ==

'''POST {server_name}/accounts/{account_number}/exchange/{domain_name}/mailboxes '''

''- Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''- Request Body:''
<nowiki>{
"owner": {
"username": "test-username",
"password": "secret2"
},
"admin": 0,
"notes": "some text",
"recipientLimit": 10,
"deliverRedirect": "zsds",
"forwardTo": "asdasd",
"name": {
"name": "John Smith",
"company": "My Company",
"department": "Sales",
"title": "President"
},
"address": {
"address": "100 Main St.",
"city": "Chicago",
"state": "IL",
"zip": "60001",
"country": "US"
},
"phones": {
"businessPhone": "555-555-5501",
"homePhone": "555-555-5502",
"fax": "555-555-5503",
"mobile": "555-555-5504"
}
}
</nowiki>

''- Response:''
''Accepted (202)'':
<nowiki>{
"status" : "New",
"orderid": "00000135eca7015025dce1a2000a2480a2f03088"
"orderProducts" : {
"href" : "http://{server_name}/orders/{order_id}/products",
"rel" : "related"
},
"links" : {
"href" : "http://{server_name}/accounts/accountnumber/exchange/{domain_name}/mailboxes",
"rel" : "self"
},
"orderAccount" : {
"account" : {
"href" : "http://{server_name}/accounts/{account_number}",
"rel" : "related"
}
}
"orderAction" : {
"href" : "http://{server_name}/orders/{order_id}/action",
"rel" : "related"
}
}
</nowiki>

''- Response when adding an optional mailbox:''
''Success (202)'':
<nowiki>{
"total": ["8.00", "USD"],
"subtotal": ["8.00", "USD"],
"quotehash": "{quote_id}",
"links": [
{
"href": "http://{server_name}/accounts/{account_number}/exchange/{domain_name}/mailboxes/",
"rel": "self"
},
{
"href": "http://{server_name}/orders/{order_id}/action",
"rel": "related"
}
]
}
</nowiki>

----

''- Request Body with Invalid data:''
<nowiki>{
"owner": {
"username": "(^%*&^*&^)*",
"password": "weakpass"
},
"admin": 0,
"notes": "",
"recipientLimit": 10,
"deliverRedirect": "zsds",
"forwardTo": "asdasd",
"name": {
"name": "John Smith",
"company": "My Company",
"department": "Sales",
"title": "President"
},
"address": {
"address": "100 Main St.",
"city": "Chicago",
"state": "IL",
"zip": "60001",
"country": "US"
},
"phones": {
"businessPhone": "555-555-5501",
"homePhone": "555-555-5502",
"fax": "555-555-5503",
"mobile": "555-555-5504"
}
}
</nowiki>
''- Response:''
''BadRequest (400)'':
{
"badRequest": {"message": "POST data error", "code": 400,
"details": {"notes": "Required",
"owner.username": "Has invalid characters.Allowed are lower only letters, numbers, underscores, dashes",
"owner.password": "Must not contain only lower case letters"}
}
}

[[Category:Hostway API]]
[[Category:Exchange API]]

@@ Line 181: / Line 181: @@
    "total": ["8.00", "USD"],
    "subtotal": ["8.00", "USD"],
    "quotehash": "{quote_id}",
    "links": [

@@ Line 49: / Line 49: @@
 ;: username - ''string''
 :: -The handle of the mailbox that is to be created
 ;: password - ''string''
 :: -The password required to access the new mailbox
 ; admin - ''integer''
 : -Whether the mailbox user will have administrative privileges
 ; notes - ''string''
@@ Line 60: / Line 66: @@
 ; recipientLimit - ''integer''
-: -Specifies the recipient limit for the mailbox. Allowed values are -1 or a positive integer
+: -Specifies the recipient limit for the mailbox. Allowed values are integers from 1 to 100.
 ; deliverRedirect - ''string''
@@ Line 67: / Line 73: @@
 ; forwardTo - ''string''
 : -Forward address
 ; address - ''dictionary''
 : -Specifies the address details for the mailbox
+: address - ''string''
 ; phones - ''dictionary''
 : -Specifies phone details for the mailbox
 ==Response Codes==
@@ Line 138: / Line 159: @@
 ''Accepted (202)'':
   <nowiki>{
-   "status" : "New",
+   "links": [
-  "orderid": "00000135eca7015025dce1a2000a2480a2f03088"
-  "orderProducts" : {
+      "href": "http://{server_name}/accounts/{account_number}/exchange/{domain_name}/mailboxes/",
-    "href" : "http://{server_name}/orders/{order_id}/products",
+      "rel": "self"
-    "rel" : "related"
+    },
-  },
-  "links" : {
+      "href": "http://{server_name}/orders/{order_id}/action",
-    "href" : "http://{server_name}/accounts/accountnumber/exchange/{domain_name}/mailboxes",
+      "rel": "related"
-    "rel" : "self"
+    },
-  },
-  "orderAccount" : {
+       "href": "http://{server_name}/orders/{order_id}/account/products/{product_id}/services/{newly_created_mailbox_service_id}",
-     "account" : {
+       "rel": "edit"
-       "href" : "http://{server_name}/accounts/{account_number}",
-       "rel" : "related"
+     }
-−
+   ]
-  "orderAction" : {
-      "href" : "http://{server_name}/orders/{order_id}/action",
-      "rel" : "related"
-−
+  }
 </nowiki>
@@ Line 175: / Line 190: @@
        "href": "http://{server_name}/orders/{order_id}/action",
        "rel": "related"
+     }
+   ]