Hostway API Documentation - User contributions [en]

Accounts-accountId-products-productId-services-serviceId-action:POST

2016-01-22T16:18:33Z

Vladimir.georgiev:

= POST /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/action =
Upgrades/downgrades existing service.
__TOC__
== Request ==
<code>POST /accounts/''{accountId}''/products/''{productId}''/services/''{serviceId}''/action</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

; productId - ''string''
: The Id of the product.

; serviceId - ''string''
: The Id of the service.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

=== Request Body ===
<nowiki>
{
"action": "change",
"actionData": {
"targetServiceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}"
}
}
</nowiki>

==== Parameters ====
; action - ''string''
: The type of the requested action. Currently supported actions:
:: '''cost''' - show the available fees for PTC change
:: '''validate''' - validate if the service specification change is allowed
:: '''change''' - change the service specification (upgrade/downgrade)
:: '''changeQuantityCost''' - get the cost for changing a service quantity
:: '''changeQuantity''' - change the service quantity.

; actionData - ''dictionary''
: Contains action-specific data.
:: '''validate''' action:
::: targetServiceSpecification - the URI of the new service specification.
:: '''change''' action:
::: targetServiceSpecification - the URI of the new service specification
::: carryOverDiscounts - indicates whether current active discounts should be preserved (optional).
:: '''changeQuantityCost''' action:
::: quantity - the target quantity
::: carryOverDiscounts - indicates whether current active discounts should be preserved (optional).
:: '''changeQuantity''' action:
::: quantity - the target quantity
::: carryOverDiscounts - indicates whether current active discounts should be preserved (optional).

== Response ==
; Response for getting the fees
<nowiki>
{
"links": [{
"href": "http://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}/action/",
"rel": "self"
}],
"oneTimeFee": {
"currency": "USD",
"amount": "9.95"
},
"taxes": {
"amount": "0"
},
"total": {
"currency": "USD",
"amount": "19.90"
},
"subTotal": {
"currency": "USD",
"amount": "19.90"
}
}
</nowiki>

; Response for the validation

<nowiki>
{
"links": [{
"href": "http://api.hostway.com/accounts/{accountId}/products/{productId}/services/{serviceId}/action/",
"rel": "self"
}],
"allowed": 1
}
</nowiki>

=== Status Code ===
; 200 No Content
: The service update was successfully validated.

; 204 No Content
: The service update was successfully submitted.

; 400 Bad Request
: Request body is invalid.

; 401 Unauthorized
: The authorization credentials were not supplied or are invalid.

; 404 Not Found
: The account, product Id or service Id not found.

=== Response Body ===
None.

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Order-Domain

2015-10-15T12:08:12Z

Vladimir.georgiev:

= Order a new domain =
This is a step by step example of ordering a domain through the Hostway [[Orders|Ordering API]].

== Create a new order ==
Use [[Orders:POST|POST /orders]] to create a new order

=== Request ===
<nowiki>
POST /orders
Content-Type: application/json

{}
</nowiki>

=== Response ===
<nowiki>
201 Created

{
"orderId":"00000149334635c2a163f194007f000000010001",
"ownerId":"e497c8e7-8cf3-44ff-88d8-0c86521060da",
"links":[
{
"href":"http://coreapi01.ote.chicago.hostway:8100/orders/",
"rel":"self"
},
{
"href":"http://coreapi01.ote.chicago.hostway:8100/orders/00000149334635c2a163f194007f000000010001",
"rel":"item"
}
]
}
</nowiki>

== Add product to the order ==
The domain registration product specification offerings can be determined using the Hostway [[Products|Product Catalog API]]. Add a new domain product to the order by using [[Orders-orderId-account-products:POST|POST /orders/{order_id}/account/products]].

=== Request ===
<nowiki>
POST /orders/00000149334635c2a163f194007f000000010001/account/products
Content-Type: application/json

{ "offering": "http://coreapi01.ote.chicago.hostway:8100/productSpecifications/core.plan.dnr.only/offerings/USD-12" }
</nowiki>
=== Response ===
<nowiki>
201 Created
Content-Type : application/json; charset=UTF-8
Connection : close
Location : http://coreapi01.ote.chicago.hostway:8100/orders/00000149334635c2a163f194007f000000010001/account/products/0000014933463b7219be46f0007f000000010001/

{
"url":"http://coreapi01.ote.chicago.hostway:8100/orders/00000149334635c2a163f194007f000000010001/account/products/0000014933463b7219be46f0007f000000010001/",
"productId":"0000014933463b7219be46f0007f000000010001"
}
</nowiki>

== Add a service to the product ==
The domain registration service specification offerings can be determined using the Hostway [[Products|Product Catalog API]] for the corresponding core.dnr.{tld} product. Then add a new email service to the order by using [[Orders-orderId-account-products-productId-services:POST|POST /orders/{order_id}/account/products/{product_id}/services]].

=== Request ===
<nowiki>
POST /orders/00000149334635c2a163f194007f000000010001/account/products/0000014933463b7219be46f0007f000000010001/services
Content-Type: application/json

{
"name":"ng-test-fitnesse-20141021-1014.us",
"serviceSpecification":"http://coreapi01.ote.chicago.hostway:8100/serviceSpecifications/core.dnr.us",
"billingCycle":12
}
</nowiki>
=== Response ===
<nowiki>
201 Created
Content-Type : application/json; charset=UTF-8
Location : http://coreapi01.ote.chicago.hostway:8100/orders/00000149334635c2a163f194007f000000010001/account/products/0000014933463b7219be46f0007f000000010001/services/0000014933463eead40ac7ba007f000000010001/

{
"url":"http://coreapi01.ote.chicago.hostway:8100/orders/00000149334635c2a163f194007f000000010001/account/products/0000014933463b7219be46f0007f000000010001/services/0000014933463eead40ac7ba007f000000010001/",
"serviceId":"0000014933463eead40ac7ba007f000000010001"
}
</nowiki>

== Add attributes to the service ==
Use the [[Orders-orderId-account-products-productId-services-serviceId-attributes:PUT|PUT /orders/{order_id}/account/products/{product_id}/services/{service_id}/attributes]] call to add the attributes for the domain service. Note that the example below is using "extraParams" attribute which is only required for some TLDs (.us in this case).

=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account/products/0000014933613211db39d7c4007f000000010001/services/0000014933613528f83d7290007f000000010001/attributes
Content-Type: application/json

{
"domainName":"ng-test-fitnesse-20141021-1044.us",
"operation":"register",
"term":1,
"authInfo":"mysecret",
"nameservers":[
"ns1.test.com",
"ns2.test.com"
],
"extraParams":[
{
"name":"us_nexus",
"value":"C11"
},
{
"name":"us_purpose",
"value":"P1"
}
],
"contactInfo":{
"registrant":{
"type":"registrant",
"firstName":"John",
"lastName":"Doe",
"company":"ACME Inc.",
"street1":"123 First Str.",
"city":"Chicago",
"zipOrPostal":"34567",
"stateOrProvince":"IL",
"countryCode":"US",
"email1":"john.doe@test.com",
"phone1":"+1.312.456789098"
},
"administrative":{
"type":"administrative",
"firstName":"Jane",
"lastName":"Smith",
"street1":"123 First Str.",
"city":"Chicago",
"zipOrPostal":"34567",
"stateOrProvince":"IL",
"countryCode":"US",
"email1":"jane.smith@test.com",
"phone1":"+1.312.456789111",
"fax1":"+1.312.456789112"
},
"billing":{
"type":"billing",
"firstName":"James",
"lastName":"Johnson",
"street1":"123 First Str.",
"city":"Chicago",
"zipOrPostal":"34567",
"stateOrProvince":"IL",
"countryCode":"US",
"email1":"james.johnson@test.com",
"phone1":"+1.312.456789111"
},
"technical":{
"type":"technical",
"firstName":"Paul",
"lastName":"Stevenson",
"street1":"123 First Str.",
"city":"Chicago",
"zipOrPostal":"34567",
"stateOrProvince":"IL",
"countryCode":"US",
"email1":"paul.stevenson@test.com",
"phone1":"+1.312.456789111"
}
}
}
</nowiki>
=== Response ===
<nowiki>
204 No content
</nowiki>

== Create a new account for the order ==
Use [[Orders-orderId-account:PUT|PUT /orders/{order_id}/account]] to create an account or add an existing one to the order.

=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account
Content-Type: application/json

{ "currency": "USD", "language": "en-US" }
</nowiki>
=== Response ===
<nowiki>
204 No content
</nowiki>

== Add user info ==
=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account/user
Content-Type: application/json

{ "userName": "quah@141021-104405.com", "password": "t0pSekr1t" }
</nowiki>
=== Response ===
<nowiki>
204 No content
</nowiki>

== Add billing contact ==
=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account/contactInfo/billing
Content-Type: application/json

{
"name":{
"firstName":"Billing",
"middleName":"X",
"lastName":"Customer",
"company":"Hostway"
},
"address":{
"street1":"100 n riverside",
"street2":"ste 800",
"city":"Chicago",
"stateOrProvince":"IL",
"postalCode":"60606",
"countryCode":"US"
},
"contactMedia":{
"phone1":"312-555-2222",
"phone2":"312-555-3333",
"fax":"312-555-1111",
"email1":"james.johnson@test.com",
"email1Format":"html",
"email2":"gah@wev.com",
"email2Format":"text"
}
}
</nowiki>
=== Response ===
<nowiki>
204 No Content
</nowiki>

== Add regular contact ==
=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account/contactInfo/regular
Content-Type: application/json

{
"name":{
"firstName":"Billing",
"middleName":"X",
"lastName":"Customer",
"company":"Hostway"
},
"address":{
"street1":"100 n riverside",
"street2":"ste 800",
"city":"Chicago",
"stateOrProvince":"IL",
"postalCode":"60606",
"countryCode":"US"
},
"contactMedia":{
"phone1":"312-555-2222",
"phone2":"312-555-3333",
"fax":"312-555-1111",
"email1":"james.johnson@test.com",
"email1Format":"html",
"email2":"gah@wev.com",
"email2Format":"text"
}
}
</nowiki>
=== Response ===
<nowiki>
204 No Content
</nowiki>

== Add payment info to the order ==
=== Request ===
<nowiki>
PUT /orders/0000014933612cf9fb1c626a007f000000010001/account/paymentInfo
Content-Type: application/json

{
"paymentInfoType":"credit_card",
"creditCardType":"visa",
"accountNumber":"4111111111111111",
"cardHolderName":"John Jello",
"expirationDate":"2015-06",
"verificationNumber":"521",
"billingAddress":{
"street1":"100 n riverside",
"street2":"ste 800",
"city":"Chicago",
"stateOrProvince":"IL",
"postalCode":"60606",
"countryCode":"US"
}
}
</nowiki>
=== Response ===
<nowiki>
204 No Content
</nowiki>

== Validate the order ==
=== Request ===
<nowiki>
POST /orders/0000014933612cf9fb1c626a007f000000010001/action
Content-Type: application/json

{ "action": "validate" }
</nowiki>
=== Response ===
<nowiki>
204 No Content
</nowiki>

== Get a quote ==
=== Request ===
<nowiki>
GET /orders/0000014933612cf9fb1c626a007f000000010001/quote
</nowiki>
=== Response ===
<nowiki>
200 OK
Content-Type : application/json; charset=UTF-8

{
"quote":{
"PurchasedPlan":[
{
"Product":[
{
"ChildProduct":[

],
"Name":"ng-test-fitnesse-20141021-1044.us",
"MonthlyCycle":12,
"ConfigType":"core.dnr.us",
"Fees":[
{
"ProrationAllowed":"0",
"StartDate":"2014-10-21",
"NumCharged":"0",
"EndDate":"2015-10-20",
"Description":"Domain registration fee ng-test-fitnesse-20141021-1044.us",
"Discounts":[

],
"BaseAmount":"7.95",
"UnitAmount":"7.95",
"Prorated":"0",
"MonthlyCycle":"12",
"Currency":"USD",
"Amount":"7.95",
"NumCharges":"1",
"ProratedUnitAmount":"7.95",
"Type":"domain_registration_fee",
"Quantity":"1",
"Deferred":"0"
}
],
"Data":{
"Register":{
"ContactList":{
"Contact":[
{
"@city":"Chicago",
"@province":"IL",
"@first_name":"Paul",
"@fax":"",
"@address1":"123 First Str.",
"@address2":"",
"@phone":"+1.312.456789111",
"@country_code":"US",
"@last_name":"Stevenson",
"@postal":"34567",
"@type":"technical",
"@email":"paul.stevenson@test.com",
"@company":""
},
{
"@city":"Chicago",
"@province":"IL",
"@first_name":"Jane",
"@fax":"",
"@address1":"123 First Str.",
"@address2":"",
"@phone":"+1.312.456789111",
"@country_code":"US",
"@last_name":"Smith",
"@postal":"34567",
"@type":"admin",
"@email":"jane.smith@test.com",
"@company":""
},
{
"@city":"Chicago",
"@province":"IL",
"@first_name":"John",
"@fax":"",
"@address1":"123 First Str.",
"@address2":"",
"@phone":"+1.312.456789098",
"@country_code":"US",
"@last_name":"Doe",
"@postal":"34567",
"@type":"company",
"@email":"john.doe@test.com",
"@company":"ACME Inc."
},
{
"@city":"Chicago",
"@province":"IL",
"@first_name":"James",
"@fax":"",
"@address1":"123 First Str.",
"@address2":"",
"@phone":"+1.312.456789111",
"@country_code":"US",
"@last_name":"Johnson",
"@postal":"34567",
"@type":"billing",
"@email":"james.johnson@test.com",
"@company":""
}
]
},
"@term":"1",
"@lock":"",
"@domain_name":"ng-test-fitnesse-20141021-1044.us",
"@agreed":"",
"@nameservers":"ns1.test.com,ns2.test.com",
"AuthInfo":"mysecret",
"@reason":"",
"@legal_type":"",
"@agreement_version":"",
"@operation":"register",
"ExtraParams":[
{
"Name":"us_nexus",
"Value":"C11"
},
{
"Name":"us_purpose",
"Value":"P1"
}
]
}
},
"PromotionCode":null,
"ProductGUID":"0000014933613528f83d7290007f000000010001"
}
],
"DisplayName":"",
"Name":"DNR Only Plan",
"ReferralKey":null,
"MonthlyCycle":12,
"PartnerId":"",
"Plan":"core.plan.dnr.only",
"Fees":[
{
"ProrationAllowed":"0",
"StartDate":"2014-10-21",
"NumCharged":"0",
"EndDate":"2015-10-20",
"Description":"Recurring fee DNR Only Plan, ng-test-fitnesse-20141021-1044.us 10/21/2014 through 10/20/2015",
"Discounts":[

],
"BaseAmount":"0.00",
"UnitAmount":"0.00",
"Prorated":"0",
"MonthlyCycle":"12",
"Currency":"USD",
"Amount":"0.00",
"NumCharges":"-1",
"ProratedUnitAmount":"0.00",
"Type":"recurring",
"Quantity":"1",
"Deferred":"0"
}
],
"PlanNumber":"0000014933613211db39d7c4007f000000010001",
"PromotionCode":null,
"PurchasedPlanNumber":"acct258192-0000014933615c88d6149e83007f00000001000"
}
],
"Hash":"b2f4dba3062c44084d3339561781d3bbc7bb9f70",
"Currency":"USD",
"Total":"7.95",
"SubTotal":"7.95",
"OneTimeFeeAmount":"7.95",
"TaxTotal":"0",
"DeferredSubTotals": [],
"DeferredTaxes": [],
"DeferredTotals": []
},
"links":{
"self":{
"href":"http://coreapi01.ote.chicago.hostway:8100/orders/0000014933612cf9fb1c626a007f000000010001/quote/",
"rel":"self"
}
}
}
</nowiki>

== Submit the order ==
Use [[Orders-orderId-action:POST|POST /orders/{order_id}/action]] to submit the order.

=== Request ===
<nowiki>
POST /orders/0000014933612cf9fb1c626a007f000000010001/action
Content-Type: application/json

{
"action": "submit",
"quoteHash": "b2f4dba3062c44084d3339561781d3bbc7bb9f70"
}
</nowiki>
=== Response ===
<nowiki>
202 Accepted
</nowiki>

'''See also'''
* [[Products|Product Catalog API]]
* [[Orders|Ordering API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Order-Exchange-otherproduct

2015-10-15T12:03:13Z

Vladimir.georgiev:

== Ordering Other Exchange Products ==

This order flow applies to encryption, archiving, mailing list and blackberry products. The example illustrates ordering encryption.

== Create Encryption for a domain ==

=== Request ===
<nowiki>
PUT /accounts/acct999999/exchange/myexchangedomain.com/emailEncryption
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm
{
"adminEmail": "someone@somewhere.com"
}
</nowiki>

=== Response ===
<nowiki>
202 Accepted
Set-Cookie: OwnerId=73adb746-2443-4cc8-879e-886348385b9a; Path=/
Location: http://coreapi01.ote.chicago.hostway:8092/orders/00000145ffa79d31de17529f007f000000010001
no-body
</nowiki>

''Note'': specified order has not yet been submitted.

== Obtain a quote ==

=== Request ===
<nowiki>
GET /orders/00000145ffa79d31de17529f007f000000010001/quote
Cookie: OwnerId=73adb746-2443-4cc8-879e-886348385b9a; Path=/
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm
</nowiki>

=== Response ===
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8
{
"quote" : {
"Hash" : "b6a714a2ba76b6f15df9e46964df21ca726594a0",
"Currency" : "USD",
"Total" : "0.00",
"SubTotal" : "0.00",
"OneTimeFeeAmount" : "0",
"TaxTotal" : "0",
"DeferredSubTotals": [],
"DeferredTaxes": [],
"DeferredTotals": []
},
"links" : {
"self" : {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000145ffa79d31de17529f007f000000010001/quote/",
"rel" : "self"
}
}
}
</nowiki>

== Submit the order ==

=== Request ===
<nowiki>
POST /orders/00000145ffa79d31de17529f007f000000010001/action
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=73adb746-2443-4cc8-879e-886348385b9a; Path=/
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm
{"action": "submit"}
</nowkiki>

=== Response ===
<nowiki>
202 Accepted
no-body
</nowiki>

== Check for status ==

=== Request ===
<nowiki>
GET /orders/00000145ffa79d31de17529f007f000000010001
Cookie: OwnerId=73adb746-2443-4cc8-879e-886348385b9a; Path=/
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm
</nowiki>

=== Response ===
<nowiki>
200 OK
{
"order" : {
"Status" : "Processing", <- "Completed" means that everything has provisioned successfully
"Account" : "http://coreapi01.ote.chicago.hostway:8092/accounts/acct999999"
},
"links" : [ {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000145ffa79d31de17529f007f000000010001/",
"rel" : "self"
} ]
}

</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Order-Exchange-mailbox-paid

2015-10-15T12:01:46Z

Vladimir.georgiev:

== Order a new, paid Exchange mailbox ==

This example provides the steps for ordering a new Exchange mailbox in the case where a charge applies

== Create the mailbox ==

=== Request ===
<nowiki>
POST /accounts/acct999999/exchange/myexchangedomain.com/mailboxes
Content-Type: application/json; charset=UTF-8
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm

{
"owner": {
"username": "a.a",
"password": "tester1234"
},
"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 ===
<nowiki>
202 Accepted
Set-Cookie: OwnerId=bd048fa5-8714-462f-86f6-1feffd04023b; Path=/
{
"total" : [ "5.18", "USD" ],
"subtotal" : [ "5.18", "USD" ],
"deferredTotal": [],
"deferredSubtotal": [],
"quotehash" : "0dd6b20d1ce3ae0e44882f3db11124d03f60ba53",
"links" : [ {
"href" : "http://coreapi01.ote.chicago.hostway:8092/accounts/acct999999/exchange/myexchangedomain.com/mailboxes/",
"rel" : "self"
}, {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000145ff82ec6bf27d6421007f000000010001/action",
"rel" : "related"
} ]
}
</nowiki>

== Submit the order ==

=== Request ===
<nowiki>
POST /orders/00000145ff82ec6bf27d6421007f000000010001/action
Content-Type: application/json; charset=UTF-8
Cookie: OwnerId=bd048fa5-8714-462f-86f6-1feffd04023b; Path=/
{"action": "submit"}
</nowkiki>

=== Response ===
<nowiki>
202 Accepted
no-body
</nowiki>

== Check for status ==

=== Request ===
<nowiki>
GET /orders/00000145ff82ec6bf27d6421007f000000010001
Cookie: OwnerId=bd048fa5-8714-462f-86f6-1feffd04023b; Path=/
Authorization: Basic cXdlQHBhcnRuZXJfYXBpX2RldmVsb3Blcl91c19tYWluOml1MzR0OGhm
</nowiki>

=== Response ===
<nowiki>
200 OK
{
"order" : {
"Status" : "Processing", <- "Completed" means that everything provisioned successfully
"Account" : "http://coreapi01.ote.chicago.hostway:8092/accounts/acct999999"
},
"links" : [ {
"href" : "http://coreapi01.ote.chicago.hostway:8092/orders/00000145ff82ec6bf27d6421007f000000010001/",
"rel" : "self"
} ]
}

</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

POST Exchange Mailbox

2015-10-15T11:54:03Z

Vladimir.georgiev:

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
:: Allowed are lower only letters, numbers, underscores, dashes
:: Cannot use reserved words: "ADMINISTRATOR", "ADMINS", "HELPDESK"
:: Length 1 to 25

;: password - ''string''
:: -The password required to access the new mailbox
:: Length 8 to 20 , Must not contain only lower case letters,
:: Must contain letters, should be one word , and Password should have at least one digit

; admin - ''integer''
: -Whether the mailbox user will have administrative privileges
: Allowed values are 0 or 1

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

; recipientLimit - ''integer''
: -Specifies the recipient limit for the mailbox. Allowed values are integers from 1 to 100.

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

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

; name - ''dictionary''
: name - ''string''
: company - ''string''
: department - ''string''
: title - ''string''

; address - ''dictionary''
: -Specifies the address details for the mailbox
: address - ''string''
: city - ''string''
: state - ''string''
: zip - ''string''
: country - ''string''

; phones - ''dictionary''
: -Specifies phone details for the mailbox
: businessPhone - ''string''
: homePhone - ''string''
: fax - ''string''
: mobile - ''string''

==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>{
"links": [
{
"href": "http://{server_name}/accounts/{account_number}/exchange/{domain_name}/mailboxes/",
"rel": "self"
},
{
"href": "http://{server_name}/orders/{order_id}/action",
"rel": "related"
},
{
"href": "http://{server_name}/orders/{order_id}/account/products/{product_id}/services/{newly_created_mailbox_service_id}",
"rel": "edit"
}
]
}
</nowiki>

''- Response when adding an optional mailbox:''
''Success (202)'':
<nowiki>{
"total": ["8.00", "USD"],
"subtotal": ["8.00", "USD"],
"deferredTotal": ["8.00", "USD"],
"deferredSubtotal": ["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"
},
{
"href": "http://{server_name}/orders/{order_id}/account/products/{product_id}/services/{newly_created_mailbox_service_id}",
"rel": "edit"
}
]
}
</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]]

Orders-orderId-account-products-productId-services-serviceId-discounts:PUT

2014-08-06T10:15:32Z

Vladimir.georgiev: /* Request Body */

= PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts =
Set discounts for the specified service. '''Note: This will replace any existing discounts that were configured for the specified service.'''
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/discounts</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

; productId - ''string''
: UUID specifying the product for which actions are to be performed

; serviceId - ''string''
: UUID specifying the service for which actions are to be performed

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
Body for adding an indefinite discount of 1 dollar for the recurring fee for the service:
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": 1.00
}
]
}</nowiki>

Body for adding a 1 dollar amount discount for the first cycle for a domain registration fee:
<nowiki>
{
"discounts": [
{
"priceName": "domain_registration_fee",
"recurrences": 1,
"type": "amount",
"value": 1.00
}
]
}</nowiki>

Body for adding a 10% discount for the first three monthly cycles for a service's recurring fee:
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": 3,
"type": "percent",
"value": 0.1
}
]
}</nowiki>
==== Parameters ====
; discounts - ''list''
: A list of discounts. Each discount contains the following:

:; priceName - ''string''
:: The type of price to which the discount will be applied.
:: Validation: Should match the fee types configured in the back-end (eg. 'recurring', 'domain_registration_fee', 'setup_fee' etc.) and should be configured for the corresponding franchise.

:; recurrences - ''integer''
:: The number of times that the discount will be applied. A value of "-1" means the discount will be applied every time the fee is charged.
:: Validation: Should be either a positive integer or -1.
:: Note: Value must be -1 if the priceName is "recurring".

:; type - ''string''
:: Specifies the discount type which determines the method used to calculate the amount that is discounted. Possible values are:
::: '''amount''': Discount will be treated as an exact amount
::: '''percent''': Discount will be treated as a percentage
:: Validation: Should be set to either '''amount''' or '''percent'''.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.
:: Validation: Should be a positive number.

== Response ==

=== Status Code ===
;200 OK
: The discount was successfully set.

;401 Unauthorized
: The request was not properly authorized.

;403 Forbidden
: The client does not have sufficient privileges.

;404 Not Found
: Returned if the order could not be found.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

Accounts-accountId-products-productId-usage:GET

2014-01-28T14:07:04Z

Vladimir.georgiev:

= GET /accounts/''{accountId}''/products/''{productId}''/usage?from=''{fromDate}''&to=''{toDate}''&rate=''true'' =
Get an aggregated services usage report of a product

Products that currently generate usage data:

: FlexCloud Server
: Exchange 2010 Mailbox Archiving
: Exchange 2010 E-mail Encryption

__TOC__

== Request ==
<code>GET /accounts/''{accountId}''/products/''{productId}''/usage?from=''{fromDate}''&to=''{toDate}''&rate=''true''</code>

==== Request Parameters ====
; accountId - ''string'' : The Id of the account.
; productId - ''string'' : The Id of the product.

=== URI Parameters ===
; fromDate - ''string'' - ''required'' : Start date of the usage report. Should be in '''YYYY-MM-DD''' format. The usage returned includes usage with dates from '''fromDate 00:00:00 UTC'''. ''fromDate'' must be older or equal to ''toDate''.

; toDate - ''string'' - ''required'' : Start date of the usage report. Should be in '''YYYY-MM-DD''' format. The usage returned includes usage with dates to '''toDate 23:59:59 UTC'''. ''toDate'' must be older than today's date in UTC.

; rate - ''string'' - ''optional'' : If set to ''true'', the response will include the price for each usage.
=== Request Headers ===
{{Authorization}}

=== Request Body ===
None

== Response ==

=== Status Code ===
; 200 OK : Success.

; 400 Bad Request : A request is considered ''bad'' any of the following situation is available:
:: - '''fromDate''' or '''toDate''' URI parameter is missing;
:: - '''toDate''' is older than '''fromDate''';
:: - today is older than or equal to '''toDate''' or '''fromDate''';

; 403 Forbidden : Forbidden access to regular accounts. Only Sales Agents have access to an ''usage'' resource.

; 404 Not Found : The account Id or product Id was not found.

=== Response Body ===
<nowiki>
{
"list": [
{
"instance": {instanceName},
"amount" : {amount},
"type": {usageType},
"unit": {usageUnit},
"ratedAmount": 0.95
} ,...,
{
"instance": {instanceName},
"amount": {amount},
"type": {usageType},
"unit": {usageUnit},
"ratedAmount": 10.00
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/smith182278/products/smith182278-0000013534cbbc0dc7182cea000aa37f798db0/usage?from=2012-01-01&to=2012-12-31",
"rel": "self"
}
]
}</nowiki>

==== Parameters ====
; list - ''list''
: a list of all services usage records. Each record consists of:
;: instanceName - ''string''
::: name of a service instance
;: usageType - ''string''
::: type of a resource used
;: amount - ''integer''
::: used resouce amount
;: unit - ''string''
::: measurement unit of the resource used
;: ratedAmount - ''integer/float'' - (optional)
::: the calculated price (charge) for the usage

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

==== Usage Types ====
Usage types under monitoring are the following:

{|class="wikitable" style="width: 100%"
|-
! Type !! Unit !! Description
|-
| ipaddress || hour || Flexible IP address uptime
|-
| loadbalancer || hour || Load Balancer uptime
|-
| vm || hour || Virtual Machine uptime
|-
| vm.app.office.2007.pro || hour || Virtual Machine uptime for Office 2007 Professional
|-
| vm.app.office.2007.std || hour || Virtual Machine uptime for Office 2007 Standard
|-
| vm.app.plesk || hour || Virtual Machine uptime for Plesk Control Panel
|-
| vm.app.plesk.domain100 || hour || Virtual Machine uptime for 100 Plesk domains
|-
| vm.app.plesk.powerpack || hour || Virtual Machine uptime for Plesk Powerpack
|-
| vm.app.plesk.powerpack || hour || Virtual Machine uptime for Plesk Powerpack
|-
| vm.app.sqlserver.std || hour || Virtual Machine uptime for SQL Server Standard Edition
|-
| vm.app.sqlserver.web || hour || Virtual Machine uptime for SQL Server Web Edition
|-
| vm.app.terminalservices.cal || hour || Virtual Machine uptime for 1 TS CAL
|-
| vm.cpu || hour || Virtual Machine CPU uptime
|-
| vm.disk.10gb || hour || Virtual Machine uptime for 10GB Disk Space
|-
| vm.memory.1gb || hour || Virtual Machine uptime for 1GB of Memory
|-
| vm.monitoring.port || hour || Virtual Machine uptime for Port Monitoring
|-
| vm.monitoring.url || hour || Virtual Machine uptime for URL Monitoring
|-
| vm.os.redhat || hour || Virtual Machine uptime for RedHat OS
|-
| vm.traffic.in || mb || Virtual Machine Incoming Traffic
|-
| vm.traffic.out || mb || Virtual Machine Outgoing Traffic
|-
| vm.traffic.total || mb || Virtual Machine Total Traffic
|-
| volume.disk.10gb || hour || Storage Volume uptime for 10GB of Space
|-
| vpn || hour || VPN uptime
|-
| vpn.remote5 || hour || VPN uptime for 5 remote points
|-
| vpn.sitetosite || hour || VPN uptime for site-to-site access
|}

== Examples ==

=== GET call ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/smith182278/products/smith182278-0000013534cbbc0dc7182cea000aa37f798db0/usage?from=2012-01-01&to=2012-12-31&rated=true
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"list" : [ {
"instance" : "smith182278-Test-VM.1",
"amount" : 24,
"type" : "vm.disk.10gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.0",
"amount" : 24,
"type" : "vm.disk.10gb",
"unit" : "hour",
"ratedAmount" : 0.95
}, {
"instance" : "smith182278-Test-VM.3",
"amount" : 24,
"type" : "vm.disk.10gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.2",
"amount" : 24,
"type" : "vm.disk.10gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.4",
"amount" : 24,
"type" : "vm.disk.10gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.1",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.0",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.3",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 10.00
}, {
"instance" : "smith182278-Test-VM.2",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour"
}, {
"instance" : "smith182278-Test-VM.5",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 11.05
}, {
"instance" : "smith182278-Test-VM.4",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 10.0
}, {
"instance" : "smith182278-Test-VM.7",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 10
}, {
"instance" : "smith182278-Test-VM.6",
"amount" : 24,
"type" : "vm.memory.1gb",
"unit" : "hour",
"ratedAmount" : 0.5
}, {
"instance" : "",
"amount" : 6488,
"type" : "vm.traffic.total",
"unit" : "mb",
"ratedAmount" : 0.99
}, {
"instance" : "smith182278-Test-VM",
"amount" : 354,
"type" : "vm.traffic.in",
"unit" : "mb",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM",
"amount" : 24,
"type" : "vm.app.plesk",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.1",
"amount" : 24,
"type" : "vm.cpu",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.0",
"amount" : 24,
"type" : "vm.cpu",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.3",
"amount" : 24,
"type" : "vm.cpu",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM.2",
"amount" : 24,
"type" : "vm.cpu",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM",
"amount" : 24,
"type" : "vm",
"unit" : "hour",
"ratedAmount" : 0
}, {
"instance" : "smith182278-Test-VM",
"amount" : 6134,
"type" : "vm.traffic.out",
"unit" : "mb",
"ratedAmount" : 0
} ],
"links" : [ {
"href" : "{{APIBaseURL}}/accounts/smith182278/products/smith182278-0000013534cbbc0dc7182cea000aa37f798db0/usage?from=2012-01-01&to=2012-12-31",
"rel" : "self"
} ]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]