Hostway API Documentation - User contributions [en]

Accounts-accountId-action-interFranchiseMigration:GET

2016-05-09T14:14:37Z

Emanuela.mitreva:

= GET /accounts/''{accountId}''/action/interFranchiseMigration =
Get details about an account's migration to another franchise
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/action/interFranchiseMigration</code>

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

=== URI Parameters ===
None.

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

== Response ==

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

;403 Forbidden
: Forbidden access to accounts by a user not authorized for such access.

;404 Not Found
: The account Id was not found or a migration request has not been created for this account.

=== Response Body ===
<nowiki>
{
"status": "{status}",
"progress": {progress},
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: The status of the migration. Valid values are '''pending''', '''complete''', '''inprogress''' or '''unknown''' - in case there is no InterFranchise migration started on the account, for this case the progress is None.

; progress - ''float''
: A float from 0 to 1 representing the migration request's progress. The progress would indicated which is the current flow of the InterFranchise migration process - 0.1 would indicate that it is on the first flow, 0.9 on the last, 1 would indicated that the migration was completed. Can be ''null'' if the status is '''unknown'''.

; newAccountId - ''string''
: The newly-generated accountId for the target account in the target franchise. Available only when the status is '''complete'''.

; newFranchise - ''string''
: The target franchise this account was migrated to. Available only when the status is '''complete'''.

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

== Conditional Hypermedia ==
Hypermedia fields marked as optional will appear on the basis of the accessing user's permissions.

== Examples ==

=== Requesting the status of a migration that has been submitted but not started ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "pending",
"progress": 0,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is being processed (10% done) ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "inprogress",
"progress": 0.1,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is being processed (70% done) ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "inprogress",
"progress": 0.7,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is finished ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "complete",
"progress": 1,
"newAccountId": "acc853234524",
"newFranchise": "domainpeople_us_main",
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that was never started ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "unknown",
"progress": null,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that does not exist ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 404 Not Found'''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"guid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</nowiki>

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

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

Accounts-account-dedicatedServers:GET

2016-01-14T15:12:21Z

Emanuela.mitreva:

= GET /accounts/{account_number}/dedicatedServers =
Retrieves a list of fully provisioned dedicated servers
__TOC__

== Request ==
<code>GET /accounts/''{account_number}''/dedicatedServers</code>

<code>GET /accounts/''{account_number}''/dedicatedServers?page=page&pageSize=page-size&sortField=sortField&sortOrder=sortOrder</code>

==== Request Parameters ====
; account_number - ''string''
: The user account owning the dedicated servers

=== URI Parameters ===

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided.

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed value is '''serverName'''. If the field is missing the list will be ordered by serverName.

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''. If the field is missing the order is '''asc'''.

=== Request Headers ===

{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"list": [
{
"serverName": "{serverName}",
"details": "http://{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server_id}",
"productName": "{productName}",
"displayName": "{displayName}",
"serviceName": "{serviceName}",
"partnerId": "{partnerId}",
"serverLocation": "{serverLocation}",
"services": "http://{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server_id}/services"
}
],
"links":
[
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=2&pageSize=2",
"rel" : "self"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=2",
"rel" : "first"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=2",
"rel" : "previous"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=3",
"rel" : "next"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=3",
"rel" : "last"
}
]
} </nowiki>

==== Parameters ====
; serverName - ''string''
: The name of an individual dedicated server

; details - ''string''
: hypermedia to the give dedicated server

; productName - ''string''
: Name of the product

; displayName - ''string''
: Custom display name of the product

; serviceName- ''string''
: Name of the service

; partnerId- ''string''
: Parner id

; serverLocation - ''string''
: Location of the server - chicago, tampa, etc.

; services - ''string''
: link to services for each dedicated server

; links - ''list''
: [[Hypermedia]] for this resource. Link to self will preserve sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable

=== Expected Response Codes ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions to access the resource. The only user(s) who has access to the dedicated servers list must be a sales agent, the account owner, or the account technical admin.

; 404 Not Found
: The account does not exist.

== Examples ==

=== Get a list of dedicated servers ===
'''Request'''
<nowiki>
GET accounts/test-account123/dedicatedServers </nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1",
"productName": "Server10",
"displayName": "Advantage Dedicated Server",
"serviceName": "Advantage Dedicated Server",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1/services"
},
{
"serverName": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2",
"productName": "Server20",
"displayName": "Advantage Dedicated Server 2",
"serviceName": "Advantage Dedicated Server 2",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2/services"
},
{
"serverName": "Server Name 3",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3",
"productName": "Server30",
"displayName": "Advantage Dedicated Server 3",
"serviceName": "Advantage Dedicated Server 3",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3/services"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/",
"rel": "self"
}
]
} </nowiki>

=== Get a list of dedicated servers sorted by server name in an descending order ===
'''Request'''
<nowiki>
GET accounts/test-account123/dedicatedServers?sortField=serverName&sortOrder=desc </nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 3",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3",
"productName": "Server30",
"displayName": "Advantage Dedicated Server 3",
"serviceName": "Advantage Dedicated Server 3",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3/services"
},
{
"serverName": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2",
"productNmae": "Server20",
"displayName": "Advantage Dedicated Server 2",
"serviceName": "Advantage Dedicated Server 2",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2/services"
},
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1",
"productName": "Server10",
"displayName": "Advantage Dedicated Server",
"serviceName": "Advantage Dedicated Server",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1/services"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?sortField=serverName&sortOrder=desc",
"rel": "self"
}
]
} </nowiki>

=== Get a list of dedicated servers with pagination ===
'''Request'''
<nowiki>
GET accounts/test-account123/test.com/dedicatedServers?page=2&pageSize=2 </nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1",
"productName": "Server10",
"displayName": "Advantage Dedicated Server",
"serviceName": "Advantage Dedicated Server",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1/services"
},
{
"username": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2",
"productName": "Server20",
"displayName": "Advantage Dedicated Server 2",
"serviceName": "Advantage Dedicated Server 2",
"partnerId": "",
"serverLocation": "chicago",
"services": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2/services"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=2&pageSize=2",
"rel": "self"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=1&pageSize=2",
"rel": "first"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=3&pageSize=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=3&pageSize=2",
"rel": "last"
}
]
} </nowiki>

== See also ==
* [[Dedicated_Server_API|Dedicated Server API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Server API]]

ProductSpecifications-productSpecificationId-offerings-offeringId:GET

2015-10-15T11:38:58Z

Emanuela.mitreva:

= GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}'' =
Retrieves product specification offering details.
__TOC__

== Request ==
<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}'' </code>

==== Request Parameters ====
; productSpecificationId - ''string''
: Product specification Id for a particular product specification
; offeringId - ''string''
: Offering Id of the specific offering for a particular product specification

=== URI Parameters ===
;details - integer
: If set to 1, response will include list of pricing information. This is a short way to get both the offering details and [[ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET|offering prices]]

'''The following parameters are optional and work in combination with details=1.''' They are used for the pricing list '''filtering''', '''sorting''' and '''pagination'''.
;filterType
: Indicates that the result should be filtered by price type.
: The legal values for this parameter are 'fee', 'discount' and 'usage_fee'
: '''''fee''''' - all product specification and its service specifications prices (e.g. setup fee, recurring fee, etc.)
: '''''discount''''' - all product specification and its service specifications discounts
: '''''usage_fee''''' - all product specification and its service specifications usage prices
: This parameter CANNOT be used with values containing any wildcards (*)

;filterRecurrences
: Indicates that the result should be filtered by the number of recurrences
: This parameter is optional.
: The values for this parameter can be specified using a wildcard(*).

;filterRelatedServiceSpecification
: Indicates that the result should be filtered by linked service specification URI.
: A value of '' indicates that only results with relatedServiceSpecification='' should be returned.
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;filterName
: Indicates that the result should be filtered by name
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;sortField
: Indicates which field should be used for sorting.
: Legal values are 'name', 'type', 'recurrences' and 'relatedServiceSpecification'.
: This parameter is optional

;sortOrder
: Indicates the order in which the result should be sorted.
: Legal values are 'asc' and 'desc'
: This parameter is optional. If 'sortField' was specified and 'sortOrder' was omitted, then the result will be sorted in ascending order.

;pageSize
: Indicates the number of prices to be included on each page of the result (if pagination is desired)
: This parameter is optional. If 'page' is specified, 'pageSize' is required.

;page
: Indicates the 1-based index of the page to view.
: The value must be an integer between 1 and the maximum number of pages (returned in the 'last' element of the 'links' attribute of the result)
: This parameter is optional, but if 'pageSize' was specified, then 'page' is also required.

== Response ==
Returns a dictionary of product specification offering details

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

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

;404 Not Found
: Returned if the product specification Id or the offering Id could not be found.

=== Response Body ===
<nowiki>
{
"billingPeriod": 3,
"currency": "USD",
"default": 1,
"prices": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/prices",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/", "rel": "self"}
]
} </nowiki>

==== Parameters ====
; billingPeriod - ''integer''
: Price's billing period in months

; currency - ''string''
: Price's currency

; default - ''integer''
: Specifies whether the offering uses the default billing cycle. Allowed values are '''0''' and '''1'''

; prices - ''link''
: Hyperlink to the product's offerings prices
: If request contains '''details''' parameter - response will return [[ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET#Parameters|prices parameters]] instead of hyperlink
; links - ''list''
: [[Hypermedia]] for this resource.

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>GET /productSpecifications/{productSpecificationId}/offerings/{offeringId} </nowiki>

'''Response'''
<nowiki>
{
"billingPeriod": 3,
"currency": "USD",
"default": 1,
"prices": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/prices",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/productspecifications/{productSpecificationId}/offerings/{offeringId}/", "rel": "self"}
]
} </nowiki>

=== Request with details ===
'''Request'''
<nowiki>
GET /productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=2&pageSize=10 </nowiki>

'''Response'''
<nowiki>
{
"billingPeriod": 3,
"currency": "USD",
"default": 1,
"prices": [
{
"type": "fee"
"name": "recurring",
"deferred": 1,
"amount": 1125.0,
"billingPeriod": 3,
"recurrences": -1,
"relatedServiceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
},
{
"type" : "usage_fee",
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"relatedServiceSpecification" : "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"unit" : "mfg_mailbox_standard",
"rates" : [
{
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 0.0,
"includedPrice": 0.0,
"increment": 1.0
},
{
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0,
"includedPrice": 3.0,
"increment": 1.0
}
]
}
],
"links": [
{
"rel": "self",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=2"
},
{
"rel": "first",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=1"
},
{
"rel": "previous",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=1"
},
{
"rel": "next",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=3"
},
{
"rel": "last",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}?details=1&page=3"
},
]
} </nowiki>

== See also ==
* [[Products|Product Catalog API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Product Catalog API]]

ProductSpecifications-productSpecificationId-offerings-offeringId-prices:GET

2015-10-15T11:38:10Z

Emanuela.mitreva:

= GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''/prices =
Retrieves prices for a particular product specification offering.
__TOC__

== Request ==
<code>GET /productSpecifications/''{productSpecificationId}''/offerings/''{offeringId}''/prices</code>

=== URI Parameters ===
;filterType
: Indicates that the result should be filtered by price type.
: The legal values for this parameter are 'fee', 'discount' and 'usage_fee'
: '''''fee''''' - all product specification and its service specifications prices (e.g. setup fee, recurring fee, etc.)
: '''''discount''''' - all product specification and its service specifications discounts
: '''''usage_fee''''' - all product specification and its service specifications usage prices
: This parameter CANNOT be used with values containing any wildcards (*)

: This parameter is optional

;filterRecurrences
: Indicates that the result should be filtered by the number of recurrences
: This parameter is optional.
: The values for this parameter can be specified using a wildcard(*).

;filterRelatedServiceSpecification
: Indicates that the result should be filtered by linked service specification URI.
: A value of '' indicates that only results with relatedServiceSpecification='' should be returned.
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;filterName
: Indicates that the result should be filtered by name
: This parameter is optional
: This parameter CANNOT be used with values containing any wildcards (*)

;sortField
: Indicates which field should be used for sorting.
: Legal values are 'name', 'type', 'recurrences' and 'relatedServiceSpecification'.
: This parameter is optional

;sortOrder
: Indicates the order in which the result should be sorted.
: Legal values are 'asc' and 'desc'
: This parameter is optional. If 'sortField' was specified and 'sortOrder' was omitted, then the result will be sorted in ascending order.

;pageSize
: Indicates the number of prices to be included on each page of the result (if pagination is desired)
: This parameter is optional. If 'page' is specified and 'pageSize' is omitted, then the result will show 100 prices per page.

;page
: Indicates the 1-based index of the page to view.
: The value must be an integer between 1 and the maximum number of pages (returned in the 'last' element of the 'links' attribute of the result)
: This parameter is optional, but if 'pageSize' was specified, then 'page' is also required.

== Response ==
Returns a list of prices for a particular product specification offering Id.

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

;400 Bad Request
: Returned if incorrect parameters are specified for filtering, sorting or pagination. The response body will contain details about the nature of the error.

;404 Not Found
: Returned if the product specification Id or the offering Id could not be found.

;502 Bad Gateway
: Returned there is any internal API error.

=== Response Body ===
<nowiki>
{
"list": [
{
"type": "fee"
"name": "recurring",
"amount": 1125.0,
"deferred": 1,
"billingPeriod": 3,
"recurrences": -1,
"relatedServiceSpecification": "",
},
{
"type": "fee"
"name": "recurring",
"amount": 1125.0,
"deferred": 1,
"billingPeriod": 3,
"recurrences": -1,
"relatedServiceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
},
{
"type" : "usage_fee",
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"relatedServiceSpecification" : "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"unit" : "mfg_mailbox_standard",
"rates" : [
{
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 0.0,
"includedPrice": 0.0,
"increment": 1.0
},
{
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0,
"includedPrice": 3.0,
"increment": 1.0
}
]
}
],
"links": [
{
"rel": "self",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=3"
},
{
"rel": "first",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=1"
},
{
"rel": "previous",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=2"
},
{
"rel": "next",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=4"
},
{
"rel": "last",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{offeringId}/prices?pageSize={pageSize}&page=12"
},
]
} </nowiki>

==== Parameters ====
; list - ''list''
: List of product offering price details. Each element of the list has the following attributes:

:; type - ''string''
:: This can be either 'fee', 'discount' or 'usage_fee'. A fee represents a fee that will be charged. A discount represents a downward adjustment of the amount of a fee. An usage fee represents a fee that will be charged based on usage rate.

:; deferred - ''integer''
:: All fees (product and service specific fees) have deferred flag, which is showing whether the product/service has a delayed billing.

:; name - ''string''
:: A name for the price. This is NOT guaranteed to be unique.

:; billingPeriod - ''integer''
:: The billing frequency in months.

:; recurrences - ''integer''
:: The number of time this price will recur. A value of -1 means that the price will recur throughout the entire lifetime of the provisioned product.
:: This parameter is available for '''''fee''''' and '''''discount''''' types only

:; relatedServiceSpecification - ''string''
:: The URI of the service specification (associated with the product) to which this price is linked. If this is an empty string, then the price is linked to the product itself.

:; unit - ''string''
:: unit based on which a service is charged for.
:: This parameter is available for '''''usage_fee''''' type only

:; rates - ''dictionary''
:: tiers of usage on which a service is charged for. Each tier has:
::; start - ''float''
::: number of unit for which a service begins to be charged with the '''current''' tier's price. The start of a tier is '''inclusive for the current tier'''.

::; end - ''float''
::: number of unit for which a service begins to be charged with the '''next''' tier's price. The end of a tier is '''exclusive for the current tier'''. If the '''end''' parameter is '''-1''', then we have no limit for the tier.

::; pricePerIncrement - ''float''
::: Price per an increment to be charged.

::; increment - ''float''
::: usage increment size to be charged pricePerIncrement price.

::; includedPrice - ''float''
::: Fixed amount to be payied in a given tier.

== Examples ==

=== Get usage tiers for a given service specification of a product ===
'''Request'''

<nowiki>
GET http://127.0.0.1:6543/productSpecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee
</nowiki>

'''Response'''

'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 1.0
"includedPrice": 0.0,
"increment": 1.0
}, {
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0
"includedPrice": 3.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_standard"
}, {
"name" : "mfg_mailbox_activesync",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : -1.0,
"pricePerIncrement" : 2.0
"includedPrice": 0.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_activesync"
}, {
"name" : "mfg_mailbox_premium",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : -1.0,
"pricePerIncrement" : 3.0
"includedPrice": 0.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_premium"
} ],
"links" : [ {
"href" : "http://127.0.0.1:6543/productspecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee",
"rel" : "self"
} ]
} </nowiki>

=== Get usage tiers for a given service specification of a product filtered by an usage rate's name ===
'''Request'''

<nowiki>
http://127.0.0.1:6543/productSpecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee&filterName=mfg_mailbox_standard
</nowiki>

'''Response'''

'''HTTP/1.0 200 OK'''
<nowiki>
{
"list" : [ {
"name" : "mfg_mailbox_standard",
"billingPeriod" : 1,
"rates" : [ {
"start" : 1.0,
"end" : 3.0,
"pricePerIncrement" : 0.0
"includedPrice": 0.0,
"increment": 1.0
}, {
"start" : 3.0,
"end" : -1.0,
"pricePerIncrement" : 1.0
"includedPrice": 3.0,
"increment": 1.0
} ],
"relatedServiceSpecification" : "http://127.0.0.1:6543/serviceSpecifications/core.email.openxchange.xmail",
"type" : "usage_fee",
"unit" : "mfg_mailbox_standard"
} ],
"links" : [ {
"href" : "http://127.0.0.1:6543/productspecifications/core.plan.linux.webstart/offerings/USD-1/prices?filterRelatedservicespecification=/serviceSpecifications/core.email.openxchange.xmail&filterType=usage_fee&filterName=mfg_mailbox_standard",
"rel" : "self"
} ]
} </nowiki>

== See also ==
* [[Products|Product Catalog API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Product Catalog API]]

Dns-franchise-zone-rr:GET

2015-08-06T09:37:56Z

Emanuela.mitreva:

= GET /dns/''{franchise}''/''{zone}''/rr =
Returns the resource records for a specific DNS zone.
__TOC__
== Request ==
<code>GET /dns/''{franchise}''/''{zone}''/rr</code>

==== Parameters ====
; franchise - ''string''
: franchise
; zone - ''string''
: The name of the DNS zone.

==== URI Parameters ====
; name
: Optional. Specifies the record name to use to filter results.

; type
: Optional. Specifies the type of records to return: ''A'', ''AAAA'', ''NS'', ''TXT'', ''SRV'', ''MX'', ''CNAME''

; page - ''number''
: Optional. Specifies the page to return in paginated response. Default is 1.

; page_size - ''number''
: Optional. Specifies the number of records per page.

=== Request Headers ===
; Authorization
: Base64-encoded username:password string

== Response ==

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

;401 Unauthorized
: The server could not verify the credentials from the authorization header.

;404 Not Found
: The specified zone does not exist.

=== Response Body ===
<nowiki>
{
"count": 2,
"list": [
{
"id": {id},
"name": "{domain}",
"type: "AAAA",
"ttl": {ttl},
"address": "{ipv6_address}",
"owner": "{owner}"
},
{
"id": {id},
"name": "{domain}",
"type: "A",
"ttl": {ttl},
"address": "{ipv4_address}",
"owner": null
}
],
"page": 1,
"pageSize": 10,
}</nowiki>

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

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

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

2015-07-31T10:33:36Z

Emanuela.mitreva: /* Status Code */

= PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Updates a service in order builder.
Currently supports only updating the name and the billing cycle of the service.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
A dictionary containing the keys "billingCycle" and "name" and their values.
<nowiki>
{
"billingCycle": 12,
"name": "Service Name"
}
</nowiki>

=== Validation Rules ===
:# The service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) should point to a valid service already added to the product.
:# The dictionary key/value pairs should be valid billing cycle and service name.
:# The billingCycle and name parameters are required.
== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204 No Content
| -
| The operation was successfully completed.
|-
| rowspan="2"| 400 Bad Request
| POST data error
| Trying to update service with empty body or with invalid body.
|-
| Unable to change service: invalid cycle
| Trying to change the billing cycle to value that is not supported by the current service.
|-
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Service failed permission check
| The client does not have permissions to update the service.
|-
| 404 Not Found
| Resource not found
| The client is trying to update a non existing service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>
400 Bad Request - invalid or empty body is passed (required field is missing)
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required", "name": "Required"}
}
}

400 Bad Request - missing billingCycle
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required"}
}
}

400 Bad Request - missing name
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"name": "Required"}
}
}

400 Bad Request - invalid billing cycle
{
"computeFault": {
"guid": "7c72847f-5138-44e8-ad93-cc80bb5ba7bc",
"message": "Unable to change service: invalid cycle",
"code": 400,
"details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
404 Not Found - the order or product was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId:PUT

2015-07-31T10:25:25Z

Emanuela.mitreva: /* Error responses */

= PUT /orders/''{orderId}''/account/products/''{productId}'' =
Updates an existing product in order builder.
Currently supports only updating the billing cycle.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
A dictionary containing the key "billingCycle" and a value that is integer.
<nowiki>
{
"billingCycle": 12
}
</nowiki>

=== Validation Rules ===
:# The product URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}'' ) should point to a valid product already added to the order.
:# The billing cycle should be a valid integer between 1 and 120 and also a valid billing cycle as defined in ServicePlex.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204 No Content
| -
| The operation was successfully completed.
|-
| rowspan="4"| 400 Bad Request
| POST data error
| Missing billing cycle value.
|-
| POST data error
| Trying to add a billing cycle less than 1.
|-
| POST data error
| Trying to update the billing cycle to value > 120.
|-
| Unable to update the product 0000014ee39eee9c95fa4b5b007f000000010001
| Trying to update the billing cycle to value that is not available for the product.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permissions to update the product.
|-
| 404 Not Found
| Resource not found
| The client is trying to update the billing cycle for a non existing product or order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>
400 Bad Request - empty body is passed
{
"badRequest": {
"guid": "bd80dfdc-5752-4472-96f2-90f590ddb3f9",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required"}
}
}

400 Bad Request - invalid body is passed (required field is missing)
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "Required"}
}
}

400 Bad Request - invalid billing cycle is passed
{
"badRequest": {
"guid": "fdd0b796-c690-47af-9666-0478e2bcae27",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "0 is less than minimum value 1"}
}
}

400 Bad Request - invalid billing cycle is passed
{
"computeFault": {
"guid": "1e98f8ea-d298-4867-a9aa-0a6486dbefb0",
"message": "POST data error",
"code": 400,
"details": {"billingCycle": "122 is greater than maximum value 120"}
}
}

400 Bad Request - billing cycle is not available for the product
{
"computeFault": {
"guid": "1e98f8ea-d298-4867-a9aa-0a6486dbefb0",
"message": "Unable to update the product 0000014edfe57d8b9b2c78bf007f000000010001",
"code": 400,
"details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden

{
"forbidden": {
"guid": "6af8e3e6-c3dc-4083-8389-1c1a038c62c0",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order or product was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

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

2015-07-21T13:17:05Z

Emanuela.mitreva:

= PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/notes =
Updates the notes for a service in the order.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"notes": ["xx", "zz"]
}</nowiki>

==== Parameters ====
; notes - ''list''
: List of notes to update the existing notes for a the service

== Response ==
=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204 No Content
| -
| The notes were successfully added to the service.
|-
| rowspan="1"| 400 Bad Request
| POST data error
| Trying to update the notes without passing all the required attributes.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The request was not properly authorized.
|-
| 403 Forbidden
| Unauthorized: NotesView failed permission check
| The client does not have permissions to update the notes.
|-
| 404 Not Found
| Resource not found
| The order, product or service doesn't exist.
|-
| 405 Method not allowed
| Method not allowed
| Trying to update the notes for placed order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
None.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created</nowiki>

==== Error responses ====
<nowiki>
400 Bad Request - request body is missing some of the required attributes
{
"badRequest": {
"guid": "23bf964e-fb93-4bd6-816e-3dcb31b82755",
"message": "POST data error",
"code": 400,
"details": {
"notes": "Required"
}
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have access to update the notes.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: NotesView failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order, product or the service was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
{
"badMethod": {
"guid": "3e9418e0-5a5d-4652-ae50-0e665d39571a",
"message": "Method not allowed",
"code": 405,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId-notes:POST

2015-07-21T13:04:30Z

Emanuela.mitreva:

= POST /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/notes =
Adds a new note to a service in the order.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

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

=== Request Body ===
<nowiki>
{
"note": "xx"
}</nowiki>

==== Parameters ====
; note - ''string''
: The text of the note

== Response ==
=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| -
| The note was successfully added to the service.
|-
| rowspan="1"| 400 Bad Request
| POST data error
| Trying to create a note without passing all the required attributes.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The request was not properly authorized.
|-
| 403 Forbidden
| Unauthorized: NotesView failed permission check
| The client does not have permissions to add notes.
|-
| 404 Not Found
| Resource not found
| The order or product or service doesn't exist.
|-
| 405 Method not allowed
| Method not allowed
| Trying to add notes for placed order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
None.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created</nowiki>

==== Error responses ====
<nowiki>
400 Bad Request - request body is missing some of the required attributes
{
"badRequest": {
"guid": "23bf964e-fb93-4bd6-816e-3dcb31b82755",
"message": "POST data error",
"code": 400,
"details": {
"note": "Required"
}
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have access to add notes.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: NotesView failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order, product or the service was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
{
"badMethod": {
"guid": "3e9418e0-5a5d-4652-ae50-0e665d39571a",
"message": "Method not allowed",
"code": 405,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId-notes:OPTIONS

2015-07-21T12:40:16Z

Emanuela.mitreva:

= OPTIONS /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/notes=
Get list of supported methods for this resource, plus some hints on the expected resource structure.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

== Response ==

=== Response Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The request was not properly authorized.
|-
| 403 Forbidden
| Unauthorized: NotesView failed permission check
| The client does not have permissions for this operation.
|-
| 404 Not Found
| Resource not found
| The order, product or service doesn't exist.
|}

=== Response Headers ===
; Allow
: Contains a comma-separated list of methods that are allowed on this resource. For services that do not support attributes, this will contain only the OPTIONS method.

=== Response Body ===
A dictionary whose keys/values are specific to the service category of the service. Rather than returning actual service data, the body will contain a dictionary that provides hints for how to build the request body for a PUT request, for example:

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

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

Orders-orderId-account-products-productId-services-serviceId-notes:DELETE

2015-07-21T12:39:55Z

Emanuela.mitreva:

= DELETE /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/notes =
Removes notes from a service.
__TOC__

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

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

; productId - ''string''
: Product's unique Id.

; serviceId - ''string''
: UUID specifying the service to be deleted

=== URI Parameters ===
None.

=== Request Headers ===

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The request was not properly authorized.
|-
| 403 Forbidden
| Unauthorized: NotesView failed permission check
| The client does not have permissions to delete the notes.
|-
| 404 Not Found
| Resource not found
| The order, product or service is not found.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permissions to delete the notes.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: NotesView failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId-notes:GET

2015-07-21T12:39:19Z

Emanuela.mitreva:

= GET /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/notes =
Get all notes for a given service.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

=== Request Headers ===

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The notes for the service (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The request was not properly authorized.
|-
| 403 Forbidden
| Unauthorized: NotesView failed permission check
| The client does not have permissions to get information about the notes.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the notes for non existing order, product or service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"notes": ["xx", "zz"],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/notes", "rel": "self"}
]
} </nowiki>

===== Parameters =====
; notes - ''list''
: List of the notes for the given service.

; links - ''list''
: [[Hypermedia]] for the list of notes resources

==== Error responses ====
<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have access to get the information about the notes for a service.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: NotesView failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order, the product or the service doesn't exist.
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders

2015-07-17T13:22:53Z

Emanuela.mitreva: /* Ordering API */

= Ordering API =
The ordering API supports the operations of creating, building and placing orders.
The orders are the main method of creating new accounts and adding and managing the products for an account.
__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Orders ==
Order management resources.
* [[Orders:POST|POST /orders]] - Creates a new order
* [[Orders-orderId:GET|GET /orders/{orderId}]] - Returns order details
* [[Orders-orderId:DELETE|DELETE /orders/{orderId}]] - Deletes an order
* [[Orders-orderId-action:POST|POST /orders/{orderId}/action]] - Performs an action on an order

== Order Shorthand ==
An URL shortcut allowing the user to access the currently open order without specifying the order ID.
* [[Order Shorthand]]

== Order Attributes ==
Custom attributes for an Order.
* [[Orders-orderId-attributes:PUT|PUT /orders/{orderId}/attributes]] - Sets order attributes
* [[Orders-orderId-attributes:GET|GET /orders/{orderId}/attributes]] - Returns order attributes

== Account ==
Customer information in a given order. Only one account is allowed per order.
* [[Orders-orderId-account:PUT|PUT /orders/{orderId}/account]] - Add account to the order
* [[Orders-orderId-account:GET|GET /orders/{orderId}/account]] - Returns the account details

== Account Attributes ==
Custom attributes for an Account in a given Order.
* [[Orders-orderId-account-attributes:PUT|PUT /orders/{orderId}/account/attributes]] - Sets account attributes
* [[Orders-orderId-account-attributes:GET|GET /orders/{orderId}/account/attributes]] - Returns account attributes
* [[Orders-orderId-account-attributes:DELETE|DELETE /orders/{orderId}/account/attributes]] - Deletes all account attributes

== Account Contact Info ==
Various types of Contact Info set for an Account in a given Order.
* [[Orders-orderId-account-contactInfo-contactType:PUT|PUT /orders/{orderId}/account/contactInfo/{contactType}]] - Set contact details
* [[Orders-orderId-account-contactInfo-contactType:GET|GET /orders/{orderId}/account/contactInfo{contactType}]] - Returns contact details
* [[Orders-orderId-account-contactInfo:GET|GET /orders/{orderId}/account/contactInfo]] - Returns all account contacts
* [[Orders-orderId-account-contactInfo-contactType:DELETE|DELETE /orders/{orderId}/account/contactInfo/{contactType}]] - Deletes specific contact

== Account Payment Information ==
Payment method information for an Account in a given Order. An account cannot have multiple payment methods.
* [[Orders-orderId-account-paymentInfo:PUT|PUT /orders/{orderId}/account/paymentInfo]] - Sets the payment method for an account
* [[Orders-orderId-account-paymentInfo:GET|GET /orders/{orderId}/account/paymentInfo]] - Returns the payment method for an account

== Account User ==
User information for an Account in a given Order.
* [[Orders-orderId-account-user:PUT|PUT /orders/{orderId}/account/user]] - Sets the account user credentials
* [[Orders-orderId-account-user:GET|GET /orders/{orderId}/account/user]] - Returns information about account user credentials

== Products ==
Products included in the order.
* [[Orders-orderId-account-products:POST|POST /orders/{orderId}/account/products]] - Adds product to the account
* [[Orders-orderId-account-products:GET|GET /orders/{orderId}/account/products]] - Gets all products
* [[Orders-orderId-account-products-productId:GET|GET /orders/{orderId}/account/products/{productId}]] - Gets the product details
* [[Orders-orderId-account-products-productId:DELETE|DELETE /orders/{orderId}/account/products/{productId}]] - Removes product from the order

== Services ==
Services included in the products.
* [[Orders-orderId-account-products-productId-services:POST|POST /orders/{orderId}/account/products/{productId}/services]] - Adds service to a product
* [[Orders-orderId-account-products-productId-services:GET|GET /orders/{orderId}/account/products/{productId}/services]] - Gets all services for a product
* [[Orders-orderId-account-products-productId-services-serviceId:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}]] - Gets service details
* [[Orders-orderId-account-products-productId-services-serviceId:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}]] - Removes service from a product

== Service Attributes ==
Attributed for the included services.
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Adds service attributes
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Gets service attributes
* [[Orders-orderId-account-products-productId-services-serviceId-attributes:OPTIONS|OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes]] - Returns information about supported attributes
* [[ServiceAttributesStructure|Service Attributes Structure]] - Structure of attributes set supported by Hostway API

== Service Notes ==
Notes for services.
* [[Orders-orderId-account-products-productId-services-serviceId-notes:POST|POST /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Adds a service note
* [[Orders-orderId-account-products-productId-services-serviceId-notes:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Updates the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Gets all the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Deletes the service notes
* [[Orders-orderId-account-products-productId-services-serviceId-notes:OPTIONS|OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes]] - Returns information about supported attributes

== Promotion Codes ==
Describes handling of promotion codes.

=== Product Promotion Codes ===
* [[Orders-orderId-account-products-productId-promotion:PUT|PUT /orders/{orderId}/account/products/{productId}/promotion]] - Add or update promotion code for a product.
* [[Orders-orderId-account-products-productId-promotion:DELETE|DELETE /orders/{orderId}/account/products/{productId}/promotion]] - Removes the promotion code for a product.

=== Service Promotion Codes ===
* [[Orders-orderId-account-products-productId-services-serviceId-promotion:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/promotion]] - Add or update promotion code for a service.
* [[Orders-orderId-account-products-productId-services-serviceId-promotion:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/promotion]] - Removes the promotion code for a service.

== Custom Discounts ==
Custom discounts at the order, product and service levels. Managing discounts requires elevated permissions.

=== Order Discounts ===
* [[Orders-orderId-discounts:PUT|PUT /orders/{orderId}/discounts]] - Adds order discounts
* [[Orders-orderId-discounts:GET|GET /orders/{orderId}/discounts]] - Returns all order discounts
* [[Orders-orderId-discounts:DELETE|DELETE /orders/{orderId}/discounts]] - Removes all order discounts

=== Product Discounts ===
* [[Orders-orderId-account-products-productId-discounts:PUT|PUT /orders/{orderId}/account/products/{productId}/discounts]] - Adds product discounts
* [[Orders-orderId-account-products-productId-discounts:GET|GET /orders/{orderId}/account/products/{productId}/discounts]] - Returns all product discounts
* [[Orders-orderId-account-products-productId-discounts:DELETE|DELETE /orders/{orderId}/account/products/{productId}/discounts]] - Removes all product discounts

=== Service Discounts ===
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:PUT|PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Adds service discounts
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:GET|GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Returns all service discounts
* [[Orders-orderId-account-products-productId-services-serviceId-discounts:DELETE|DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts]] - Removes all service discounts

== Order Quote ==
Quote information for a given order.
* [[Orders-orderId-quote:GET|GET /orders/{orderId}/quote]] - Returns quote for the products and services in the order

== See also ==
* [[Common Features]]

= Order Flow Examples =
== Order Account Associations ==
* [[Order-Products-Account|Order Products Account]] - Example order flow with adding initially products and than account
* [[Order-Products-Account-Modify|Order Products Account Modify]] - Example order flow with adding initially products than account and modify it later

== Email Products ==
* [[Order-Email-Domain|Order Email Domain]] - Example order flow for purchasing an email domain
* [[Order-Domain-Alias|Order Domain Alias]] - Example order flow for purchasing an email domain alias

== Microsoft Exchange Products ==
* [[Order-Exchange|Order Exchange domain]] - Example order flow for purchasing exchange domain
* [[Order-Exchange-mailbox-free|Order Free Exchange Mailbox]]
* [[Order-Exchange-mailbox-paid|Order Paid Exchange Mailbox]]
* [[Order-Exchange-otherproduct|Ordering Other Exchange Products]] - Example order flow that applies to Exchange email encryption, archiving, mailing list and blackberry products

== Cloud Products ==
* [[Order-cloud-drive|Order Cloud Drive]] - Example order flow for purchasing a Cloud Drive
* [[Order-cloud-backup|Order Cloud Backup]] - Example order flow for purchasing a Cloud Backup

== WebsPlanet Products ==
* [[Order-webs-planet|WebsPlanet]] - Example order flow for purchasing a WebsPlanet

== VPS Virtuozzo Products ==
* [[Order-vps-virtuozzo|VpsVirtuozzo]] - Example order flow for purchasing VPS Virtuozzo products and services

== Domain Registration Products ==
* [[Order-Domain|Order Domain]] - Example order flow for purchasing a domain
* [[Order-Domain-Shortcut|Order Domain Shortcut]] - Example order flow for purchasing a domain by using the domain shortcut

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

Accounts-accountId-products-productId-usage:GET

2014-10-29T16:50:52Z

Emanuela.mitreva: /* GET /accounts/{accountId}/products/{productId}/usage?from={fromDate}&to={toDate}&rate=true */

= 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
|-
| hex2013.additionalquota * || mb|| Additional quota for HEX 2013
|}

'''Note:''' The additional quota unlike the other usage types is not directly retrieved, but rather it is calculated with the following formula:
<nowiki>
CoSM = Count of standard mailboxes
QfSM = Quota for standard mailboxes
CoPM = Count of premium mailboxes
QfPM = Quota for premium mailboxes

Additional Quota = Quota - CoSM * QfSM - CoPM * QfPM</nowiki>

== Examples ==

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

<nowiki>
GET {{APIBaseURL}}/accounts/smith182278/products/smith182278-0000013534cbbc0dc7182cea000aa37f798db0/usage?from=2012-01-01&to=2012-12-31&rate=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
}, {
"instance" : "smith182278-Test-VM",
"amount" : 1024,
"type" : "hex2013.additionalquota",
"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]]

Orders-orderId-account-products:POST

2014-10-17T12:33:10Z

Emanuela.mitreva: /* POST /orders/{orderId}/account/products */

= POST /orders/''{orderId}''/account/products =
Adds a new or existing Product to the Account's Order.

If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).

If there is already an Account in the order at the time this call is made, the currency of the specified product offering *must* match the currency of the Account.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products</code>

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

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
There are two possible formats. To add a new product that does not already exist:
<nowiki>
{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"promoCode": "{promoCode}",
"displayName": "My custom product name",
"partnerId": "PartnerId",
}</nowiki>

OR

To specify an existing product, use the following:
<nowiki>
{
"existingProductUrl": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}"
}</nowiki>

==== Parameters ====
; offering - ''string''
: Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
; promoCode - ''string'' (optional)
: A promotion code for the new product [[Orders#Promotion_Codes|promotion codes]].
; displayName - ''string'' (optional)
: A custom display name for the product.
; partnerId - ''string'' (optional)
: Partner id.
; existingProductUrl - ''string''
: Link to [[Account#Products_Management|an existing product]]. Only required when adding an existing product to the order.

=== Validation Rules ===
:# The product specification URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}'' ) should point to an existing product.
:# The product offering currency should match the account currency or if no account is specified should be allowed for the franchise.
:# The product offering URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}'' ) should point to an existing product offering.
:# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
:# The product offering should be valid according to the back-end.
:# The account product URL ( ''{APIBaseURL}}/accounts/{accountId}/products/{productId}'' ) should point to an existing product that is open and belongs to the account.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| -
| The operation was successfully completed.
|-
| rowspan="12"| 400 Bad Request
| POST data error
| Trying to create a product with invalid body.
|-
| Cannot add non-existent product \"fake\"
| Trying to create a product by passing fake offering.
|-
| Invalid offering URI
| Trying to create a product by passing invalid offering (missing currency, monthly cycle or productSpecifications)
|-
| The requested offering is invalid
| Trying to create a product with invalid monthly cycle (eg: 100)
|-
| Trying to add inconsistent currency: product {product} with FAKE while account uses USD
| Trying to create a product with currency, which does not match the account's currency
|-
| Currency FAKE not allowed for this franchise
| Trying to add a product with invalid for the franchise currency to an order for which no account has been set.
|-
| Trying to add Internal product {product} without authorization
| Trying to add product, which is internal, without the proper credentials.
|-
| Trying to add Internal View Only product {product}
| Trying to add product, which is internal view only, without the proper credentials.
|-
| Invalid product URI
| Tried to add an existing product with wrong existingProductUrl
|-
| The account of the order and the account of the product doesn't match
| Tried to add an existing product with account, which is different from the account of the order.
|-
| Product doesn't exist.
| Tried to add an existing product which does not exist
|-
| Cannot add a product that is not open.
| Tried to add an existing product that is not open.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permissions to add products.
|-
| 404 Not Found
| Resource not found
| The client is trying to add a product to non existing order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added product and the id of the product.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created
{
"productId": "00000148842a5f6448a61ce6007f000000010001",
"url" : "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000014884293798c68eafa5007f000000010001/account/products/00000148842a5f6448a61ce6007f000000010001/"
}</nowiki>
: '''''Note:''''' The product Id will change once the order is provisioned.

==== Error responses ====
<nowiki>
400 Bad Request - trying to order product, which is internal, without the proper authorization.
{
"computeFault": {
"guid": "c940c886-5343-4a49-b728-0b94cbb1a3e9",
"message": "Trying to add Internal product {product} without authorization",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product, which is internal view only, such products cannot be added via the Public API.
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Trying to add Internal View Only product {product}",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product without supplying the required attributes in the body.
{
"badRequest":{
"guid": "0f3e0435-21ac-43e5-acfd-ac33886fbe70",
"message": "POST data error",
"code": 400,
"details": {
"offering": "Required"
}
}
}

400 Bad Request - trying to add a product that does not exist.
{
"computeFault":{
"guid": "12cf7a72-3261-4c57-a82e-1f2f1c124d50",
"message": "Cannot add non-existent product \"fake\"",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product by supplying invalid offering URI (eg: "offering": "http://coreapi01.ote.chicago.hostway:8092/productSpecifications/core.plangroup.dedserver.plan4/offerings/")
{
"computeFault": {
"guid": "0ced627e-c9fc-4835-92da-1a4256165607",
"message": "Invalid offering URI",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid currency (case when account is set and the currency provided does not match the account's currency)
{
"computeFault": {
"guid": "742e193a-4667-47fd-a5ff-ec1f7788d459",
"message": "Trying to add inconsistent currency: product {product} with FAKE while account uses USD",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid for the franchise currency (case when an account is not set so the currency it is determined by the first added product, but the currency is not allowed for the franchise)
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Currency FAKE not allowed for this franchise",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid month cycle (eg: 100)
{
"computeFault": {
"guid": "8165a0b2-80f5-436f-ab47-075d824144d9",
"message": "The requested offering is invalid",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product with invalid existingProductUrl
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Invalid product URI",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that belongs to account different from the account of the order.
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "The account of the order and the account of the product doesn't match",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that does not exist
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Product doesn't exist.",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add an existing product that is not open
{
"computeFault": {
"guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"message": "Cannot add a product that is not open.",
"code": 400,
"details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to add products.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order does not exist
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services:POST

2014-10-02T15:09:13Z

Emanuela.mitreva: /* Status Code */

= POST /orders/''{orderId}''/account/products/''{productId}''/services =
Adds a new service to a product in the order.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products/''{productId}''/services</code>

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

; productId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"name": "john.smith1",
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"promoCode": "{promoCode}"
"billingCycle": 1,
"attributes": {
"{attribute-name}": "{attribute-value}",
....
}
}
</nowiki>

==== Parameters ====
; name - ''string''
: The name of the new service

; relatedTo - ''list'' (optional)
: A list containing other services related in some way to the newly created service. The relatedTo may be omitted, but relationships between some types of services have to be established for the order to be validated or submitted.

; serviceSpecification - ''string''
: Link to the [[Products|product catalog specification]] describing the new service

; billingCycle - ''integer''
: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

; attributes - ''dictionary'' (optional)
: a dictionary of the new service's attributes values. Each (''attribute-name'', ''attribute-value'') pair present the service attribute name and its relevant value to be set. The allowed attribute names depends on the ''serviceSpecification'' field value. See [[ServiceAttributesStructure | Service Attributes Structure]].

; promoCode - ''string'' (optional)
: A promotion code for the new service [[Orders#Promotion_Codes|promotion codes]].

=== Validation Rules ===
:# The service specification URL ( ''{{APIBaseURL}}/serviceSpecifications/{serviceSpecificationId}'' ) should point to an existing service.
:# Each service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) from the related services list should point to a valid service already added to the product.
:# The service billing cycle should be allowed for the product.
:# The product should support adding the service.

== Response ==
=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| -
| The service was successfully added to the order.
|-
| rowspan="7"| 400 Bad Request
| POST data error
| Trying to create a service without passing all the required attributes.
|-
| Invalid service specification
| Malformed serviceSpecification was passed or the service is not found in the backend.
|-
| Invalid cycle
| Trying to add service with wrong billingCycle.
|-
| Invalid relatedTo service ID provided: fake.service
| Trying to add a service with invalid relatedTo.
|-
| Product does not support this service
| Trying to add service to a product, which doesn't support the service.
|-
| Current service requires being a child service.
| The service that can be added only as a child is added as a service.
|-
| Cannot create domain alias to the same domain name.
| Trying to create domain alias to the same domain name.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Services failed permission check
| The client does not have permissions to add services.
|-
| 404 Not Found
| Resource not found
| The order or product doesn't exist.
|-
| rowspan="5" | 409 Conflict
! colspan="2" align="center" | Domain-dependent services:
|-
| Cannot create domain alias to the same domain name.
| Duplicate domain.
|-
! colspan="2" align="center" | Email domain alias service: A domain alias would produce impossible to delivery loops
|-
| rowspan="2" | Domain {domain_name} has circular forwards to alias {alias_name}
| There is an email forwarder from the target domain name to a mailbox of the domain alias with the same username
|-
| There is an email forwarder from the domain alias to a mailbox of the target domain name with the same username
|-
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added service and the id of the service.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created
{
"serviceId": "00000140735d43640f62c50f007f000000010001",
"url": "</nowiki>{{APIBaseURL}}<nowiki>/order/account/products/00000140728b013c52e249a4007f000000010001/services/00000140735d43640f62c50f007f000000010001/"
} </nowiki>
: '''''Note:''''' The service Id will change once the order is provisioned.

==== Error responses ====
<nowiki>
400 Bad Request - request body is missing some of the required attributes
{
"badRequest": {
"guid": "23bf964e-fb93-4bd6-816e-3dcb31b82755",
"message": "POST data error",
"code": 400,
"details": {
"serviceSpecification": "Required",
"billingCycle": "Required"
}
}
}

400 Bad Request - malformed serviceSpecification was passed or the service is not found in the backend
{
"computeFault": {
"guid": "e4443fe7-1139-4078-b407-39d868c02d26",
"message": "Invalid service specification",
"code": 400,
"details": ""
}
}

400 Bad Request - wrong billingCycle
{
"computeFault": {
"guid": "e4443fe7-1139-4078-b407-39d868c02d26",
"message": "Invalid cycle",
"code": 400,
"details": ""
}
}

400 Bad Request - invalid service was passed as relatedTo
{
"computeFault": {
"guid": "e4443fe7-1139-4078-b407-39d868c02d26",
"message": "Invalid relatedTo service ID provided: fake.service",
"code": 400,
"details": ""
}
}

400 Bad Request - the service is not supported by the product
{
"computeFault": {
"guid": "e4443fe7-1139-4078-b407-39d868c02d26",
"message": "Product does not support this service",
"code": 400,
"details": ""
}
}

400 Bad Request - the service that can be added only as a child is added as a service
{
"computeFault": {
"guid": "e4443fe7-1139-4078-b407-39d868c02d26",
"message": "Current service requires being a child service.",
"code": 400,
"details": ""
}
}

400 Bad Request - request body provided incorrect attributes
{
"badRequest": {
"guid": "5386544b-6dbf-4d21-b22a-879979070c01",
"message": "POST data error",
"code": 400,
"details": {"attributes.serverName": "Required"}
}
}

400 Bad Request - trying to create domain alias to the same domain name
{
"computeFault": {
"guid": "c270f3a1-331f-4736-b420-c006cbdae689",
"message": "Cannot create domain alias to the same domain name.",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add domain alias with invalid domain name
{
"badRequest": {
"guid": "6321f804-285a-43fb-890a-bbdbc1bd8db3",
"message": "POST data error", "code": 400,
"details": {"attributes.domain": "Invalid domain name in domain: invalid", "attributes.domain_alias": "Invalid domain name in domain_alias: invalid_alias"}
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have assess to get the information about the services.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order or product was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
409 Conflict
{
"conflict": {
"guid": "685b8586-c854-4dd8-ae9d-6233fe007a86",
"message": "Domain ng-test-hwus-drago-140723b.com has circular forwards to alias ng-test-hwus-drago-140723b-alias140814.com",
"code": 409,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

== Examples ==

=== Create a service with attributes ===
'''Request'''
<nowiki>
{
"name": "ng-test-hwus-test.com",
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/core.dedserver",
"billingCycle": 1,
"attributes": {
"serverName": "sampleServerName",
"serverLocation": "Tampa"
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

Orders-orderId-account-products-productId-services-serviceId-attributes:GET

2014-10-01T15:49:00Z

Emanuela.mitreva: /* Error responses */

= GET /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/attributes =
Get the Attributes of a given Service.
Not all services will have attributes; depending on the service, this call ''may'' return a response code of 405 (Method not supported).
If attributes are supported on the service, but have not yet been set, this call will return an empty dictionary in the response body.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The operation was successfully completed.
|-
| 400 Bad Request
| No attributes defined for the provided service specification
| Trying to get attributes for service with no attributes.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Attributes failed permission check
| The client does not have permissions for this operation.
|-
| 404 Not Found
| Resource not found
| The client is trying to add attribute for non existing order, product or service.
|-
| 405 Method Not Allowed
| -
| The service does not support attributes.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful responses ====
Will be a dictionary whose keys/values are specific to the service category of the service. See [[ServiceAttributesStructure | Service Attributes Structure]].

==== Error responses ====
<nowiki>
400 Bad Request - trying to get the attributes for a service that does not have attributes.
{
"computeFault": {
"guid": "756b755a-84cf-4692-b2c6-70808dc9d00d",
"message": "No attributes defined for the provided service specification",
"code": 400, "details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
404 Not Found - the order, product or service was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

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

2014-10-01T15:48:11Z

Emanuela.mitreva: /* PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes */

= PUT /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/attributes =
Adds Attributes to the Service.
Not all services support this call. Depending on the service, this call ''may'' return a response code of 405 (method not supported).
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
A dictionary whose keys/values will depend on the service category of the service. See [[ServiceAttributesStructure | Service Attributes Structure]].
<nowiki>
{
"key_one": "Value One",
"key_two": "Value Two",
...
}
</nowiki>

=== Validation Rules ===
:# The service URL ( ''{{APIBaseURL}}/orders/{orderId}/account/products/{productId}/services/{serviceId}'' ) should point to a valid service already added to the product.
:# The attribute key/value pair should be allowed for the service specification.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204 No Content
| -
| The operation was successfully completed.
|-
| rowspan="3"| 400 Bad Request
| POST data error
| Trying to create an attribute without body or with invalid body.
|-
| Invalid term supplied -1
| Trying to add attributes for transfer domain request with invalid value for term (should be 1).
|-
| No attributes defined for the provided service specification
| Trying to get attributes for service with no attributes.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Attributes failed permission check
| The client does not have permissions to add attributes.
|-
| 404 Not Found
| Resource not found
| The client is trying to add attribute for non existing order, product or service.
|-
| 405 Method Not Allowed
| -
| The service does not support attributes.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>
400 Bad Request - no request body is passed
{
"badRequest": {
"guid": "bd80dfdc-5752-4472-96f2-90f590ddb3f9",
"message": "POST data error",
"code": 400,
"details": ""
}
}

400 Bad Request - invalid body is passed (required field is missing)
{
"badRequest": {
"guid": "aae865ae-5102-49d9-b1ef-8a5419cc0ce7",
"message": "POST data error",
"code": 400,
"details": {"serverName": "Required"}
}
}

400 Bad Request - invalid attributes are passed
{
"badRequest": {
"guid": "fdd0b796-c690-47af-9666-0478e2bcae27",
"message": "POST data error",
"code": 400,
"details": {"serverLocation": "String does not match expected pattern"}
}
}

400 Bad Request - invalid term for transfer request is passed.
{
"computeFault": {
"guid": "1e98f8ea-d298-4867-a9aa-0a6486dbefb0",
"message": "Invalid term supplied -1",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to get the attributes for a service that does not have attributes.
{
"computeFault": {
"guid": "756b755a-84cf-4692-b2c6-70808dc9d00d",
"message": "No attributes defined for the provided service specification",
"code": 400, "details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
404 Not Found - the order or product was not found.
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

Accounts-accountId-products-productId:GET

2014-10-01T14:02:48Z

Emanuela.mitreva: /* GET /accounts/{accountId}/products/{productId} */

= GET /accounts/''{accountId}''/products/{productId} =
Get product information and (if requested) possible product changes.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/{productId}</code>

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

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

=== URI Parameters ===
; getTargetProductSpecifications - ''boolean''
: Optional. If set to 1 the response will include valid product specification change targets list.

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

== Response ==

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

; 401 Unauthorized
: Authorization credentials not submitted or invalid.

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

=== Response Body ===
The response body includes product specification change targets list when the ''getTargetProductSpecifications'' URI parameter is set to 1.

<nowiki>
{
"status": "open",
"name": "Product Name",
"displayName": "My custom product name",
"partnerId": "Partner Id",
"billingCycle": 12,
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}",
"changes": [
{
"type": "upgrade",
"id": "{targetProductSpecificationId}",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{targetProductSpecificationId}"
},
]
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''.

; name - ''string''
: Name of the product.

; billingCycle - ''integer''
: Billing cycle of the product in months.

; productSpecification - ''string''
: Link to the specification of the current product.

; changes - ''list''
: A list with the valid product change targets. Returned if ''getTargetProductSpecifications=1'' query parameter is passed

; displayName - ''string''
: A custom display name for the product.

; partnerId - ''string''
: Partner id.

; links - ''list''
: [[Hypermedia]] for the product resource

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

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

Accounts-accountId-products:GET

2014-10-01T14:02:17Z

Emanuela.mitreva: /* GET /accounts/{accountId}/products */

= GET /accounts/''{accountId}''/products =
Retrieves a list of all products associated with a given account.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products</code>

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

=== URI Parameters ===

; filterStatus - ''string''
: Optional. Only products with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

; filterDisplayName - ''string''
: Optional. Only products with displayName matching the value of the parameter will be returned.

; filterPartnerId - ''string''
: Optional. Only products with parnterId matching the value of the parameter will be returned.

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

== Response ==

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

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

;403 Forbidden
: Access to '''closed''' and '''suspended''' accounts requires elevated permissions

=== Response Body ===
<nowiki>
{
"list": [
{
"name": "Product 1",
"displayName": "My custom product name",
"partnerId": "Partner Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
"bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId1}/bandwidth/",
"usage": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId1}/usage/",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/{productId1}", "rel": "self"}
]
},
{
"name": "Product 2",
"displayName": "My custom product name",
"partnerId": "Partner Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
"bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}/bandwidth/",
"usage": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}/usage/",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}", "rel": "self"}
],
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about specific products

:; status - ''string''
:: Describes the status of a product. Valid values are '''open''', '''closed''' or '''suspended'''

:; name - ''string''
:: Descriptive name of the product

:; billingCycle - ''integer''
:: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

:; productSpecification - ''string''
:: [[Hypermedia]] for this product resource. Link to the product's specification.

:; bandwidth - ''string''
:: [[Hypermedia]] for this product resource. Link to the bandwidth's information.

:; usage - ''string''
:: [[Hypermedia]] for this product resource. Link to the usage's information.

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

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

== Alternative with partner Id ==
As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute [[Orders-orderId-account-attributes:PUT|partner_account_id]]. The response to this request is the same as the response to a request using the account Id.

<code>GET /partnerAccounts/''{partnerAccountId}''/products</code>

==== Parameters ====
; partnerAccountId - ''string''
: Partner account Id set via the [[Orders-orderId-account-attributes:PUT|partner_account_id]] attribute.

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

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

Orders-orderId-account-products-productId:GET

2014-10-01T13:58:47Z

Emanuela.mitreva: /* GET /orders/{orderId}/account/products/{productId} */

= GET /orders/''{orderId}''/account/products/''{productId}'' =
Get details about a specific Product in an account.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products/''{productId}''</code>

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

; productId - ''string''
: Product's unique Id.

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or are invalid
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permission to get the product.
|-
| 404 Not Found
| Resource not found
| The client is trying to get a product for non existing order or is trying to get non existing product.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"status" : "open",
"services" : "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services",
"offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"displayName": "My custom product name",
"partnerId": "Partner Id",
"links" : [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}", "rel": "self" }
]
}</nowiki>

===== Parameters =====
; status - ''string''
: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''closed''' and '''purged'''

; services - ''string''
: A link to the services associated with the product

; offering - ''string''
: Link to the [[Products|product catalog offering]] specifying the given product

; displayName - ''string''
: A custom display name for the product.

; partnerId - ''string''
: Partner id.

; links - ''list''
: [[Hypermedia]] for the product resource

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to get the product.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products:GET

2014-10-01T13:58:25Z

Emanuela.mitreva: /* GET /orders/{orderId}/account/products */

= GET /orders/''{orderId}''/account/products =
Get all Product in an account.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products</code>

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The products for the order (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permission to get the products.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the products for non existing order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"list": [
{
"status": "open",
"services": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}/services",
"offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"displayName": "My custom product name",
"partnerId": "PartnerId",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
]
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/",
"rel": "self"
}
]
}</nowiki>

===== Parameters =====
; list - ''list''
: List of the products for the given account order. Each element of the list has the following attributes:

:; status - ''string''
:: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''closed''' and '''purged'''

:; services - ''string''
:: A link to the services associated with the product

:; displayName - ''string''
:: A custom display name for the product.

:; partnerId - ''string''
:: Partner id.

:; links - ''list''
:: [[Hypermedia]] for the product resource

:; offering - ''string''
:: Link to the product catalogue offering specifying the given product

; links - ''list''
: [[Hypermedia]] for the list of product resources

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to get the products.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - there is no such order.
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products:POST

2014-10-01T13:58:00Z

Emanuela.mitreva: /* POST /orders/{orderId}/account/products */

= POST /orders/''{orderId}''/account/products =
Adds a new Product to the Account's Order.

If, at the time the product is created, there is not yet an Account in the order, then this call will implicitly add a very rudimentary Account (containing only a default language & the currency of this product).

If there is already an Account in the order at the time this call is made, the currency of the specified product offering *must* match the currency of the Account.
__TOC__

== Request ==
<code>POST /orders/''{orderId}''/account/products</code>

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

=== URI Parameters ===
None.

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

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"offering": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"promoCode": "{promoCode}",
"displayName": "My custom product name",
"partnerId": "PartnerId",
}
</nowiki>

==== Parameters ====
; offering - ''string''
: Link to the [[Products#Product_Offerings|product catalog offering]] specifying the new product.
; promoCode - ''string'' (optional)
: A promotion code for the new product [[Orders#Promotion_Codes|promotion codes]].
; displayName - ''string'' (optional)
: A custom display name for the product.
; partnerId - ''string'' (optional)
: Partner id.

=== Validation Rules ===
:# The product specification URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}'' ) should point to an existing product.
:# The product offering currency should match the account currency or if no account is specified should be allowed for the franchise.
:# The product offering URL ( ''{{APIBaseURL}}/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}'' ) should point to an existing product offering.
:# The product use type (public, internal, internal view only, etc.) should be allowed for the current user.
:# The product offering should be valid according to the back-end.

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 201 Created
| -
| The operation was successfully completed.
|-
| rowspan="8"| 400 Bad Request
| POST data error
| Trying to create a product with invalid body.
|-
| Cannot add non-existent product \"fake\"
| Trying to create a product by passing fake offering.
|-
| Invalid offering URI
| Trying to create a product by passing invalid offering (missing currency, monthly cycle or productSpecifications)
|-
| The requested offering is invalid
| Trying to create a product with invalid monthly cycle (eg: 100)
|-
| Trying to add inconsistent currency: product {product} with FAKE while account uses USD
| Trying to create a product with currency, which does not match the account's currency
|-
| Currency FAKE not allowed for this franchise
| Trying to add a product with invalid for the franchise currency to an order for which no account has been set.
|-
| Trying to add Internal product {product} without authorization
| Trying to add product, which is internal, without the proper credentials.
|-
| Trying to add Internal View Only product {product}
| Trying to add product, which is internal view only, without the proper credentials.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permissions to add products.
|-
| 404 Not Found
| Resource not found
| The client is trying to add a product to non existing order.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
; Location
: Returned with successful response. Contains the URI of the newly added product and the id of the product.

=== Response Body ===
==== Successful response ====
<nowiki>
201 Created
{
"productId": "00000148842a5f6448a61ce6007f000000010001",
"url" : "</nowiki>{{APIBaseURL}}<nowiki>/orders/0000014884293798c68eafa5007f000000010001/account/products/00000148842a5f6448a61ce6007f000000010001/"
}</nowiki>
: '''''Note:''''' The product Id will change once the order is provisioned.

==== Error responses ====
<nowiki>
400 Bad Request - trying to order product, which is internal, without the proper authorization.
{
"computeFault": {
"guid": "c940c886-5343-4a49-b728-0b94cbb1a3e9",
"message": "Trying to add Internal product {product} without authorization",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product, which is internal view only, such products cannot be added via the Public API.
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Trying to add Internal View Only product {product}",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product without supplying the required attributes in the body.
{
"badRequest":{
"guid": "0f3e0435-21ac-43e5-acfd-ac33886fbe70",
"message": "POST data error",
"code": 400,
"details": {
"offering": "Required"
}
}
}

400 Bad Request - trying to add a product that does not exist.
{
"computeFault":{
"guid": "12cf7a72-3261-4c57-a82e-1f2f1c124d50",
"message": "Cannot add non-existent product \"fake\"",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product by supplying invalid offering URI (eg: "offering": "http://coreapi01.ote.chicago.hostway:8092/productSpecifications/core.plangroup.dedserver.plan4/offerings/")
{
"computeFault": {
"guid": "0ced627e-c9fc-4835-92da-1a4256165607",
"message": "Invalid offering URI",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid currency (case when account is set and the currency provided does not match the account's currency)
{
"computeFault": {
"guid": "742e193a-4667-47fd-a5ff-ec1f7788d459",
"message": "Trying to add inconsistent currency: product {product} with FAKE while account uses USD",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid for the franchise currency (case when an account is not set so the currency it is determined by the first added product, but the currency is not allowed for the franchise)
{
"computeFault": {
"guid": "3ee2bd37-81ee-4a57-bd63-dc84705b3985",
"message": "Currency FAKE not allowed for this franchise",
"code": 400,
"details": ""
}
}

400 Bad Request - trying to add a product with invalid month cycle (eg: 100)
{
"computeFault": {
"guid": "8165a0b2-80f5-436f-ab47-075d824144d9",
"message": "The requested offering is invalid",
"code": 400, "details": ""
}
}</nowiki>

<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to add products.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order does not exist
{
"itemNotFound": {
"guid": "e1792d8a-5b0a-43ef-adf5-34a0710c8fc5",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId-attributes:OPTIONS

2014-10-01T11:43:43Z

Emanuela.mitreva: /* Response */

= OPTIONS /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}''/attributes =
Get list of supported methods for this resource, plus some hints on the expected resource structure.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

== Response ==

=== Response Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The ''OwnerId'' cookie was not specified or is incorrect.
|-
| 403 Forbidden
| Unauthorized: Attributes failed permission check
| The client does not have permissions for this operation.
|-
| 404 Not Found
| Resource not found
| The client is trying to add attribute for non existing order, product or service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Headers ===
; Allow
: Contains a comma-separated list of methods that are allowed on this resource. For services that do not support attributes, this will contain only the OPTIONS method.

=== Response Body ===
A dictionary whose keys/values are specific to the service category of the service. Rather than returning actual service data, the body will contain a dictionary that provides hints for how to build the request body for a PUT request, for example:

<nowiki>
{
"name": "String",
"numWidgets": "Integer",
"widgets": [
{
"id": "String",
"widgetType": "String",
"otherAttribute": "String"
}
]
}
</nowiki>

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]
* [[ServiceAttributesStructure | Service Attributes Structure]]

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

Orders-orderId-account-products-productId-services:GET

2014-10-01T09:54:32Z

Emanuela.mitreva: /* Parameters */

= GET /orders/''{orderId}''/account/products/''{productId}''/services =
Get all Services in a given product.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products/''{productId}''/services</code>

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

; productId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The services for the order and product (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 403 Forbidden
| Unauthorized: Services failed permission check
| The client does not have permissions to get information about the services.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the services for non existing order or non existing product.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"list": [
{
"status": "new",
"name": "john.smith1",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/", "rel": "self"}
],
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/", "rel": "self"}
]
} </nowiki>

===== Parameters =====
; list - ''list''
: List of the services for the given product. Each element of the list has the following attributes:

:; status - ''string''
:: Current status of the service. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''', '''purge_pending''' and '''purged'''

:; name - ''string''
:: The name of the specific service

:; links - ''list''
:: [[Hypermedia]] for the product resource

:; relatedTo - ''list''
:: A list containing other services in the current order related in some way to the current service

:; serviceSpecification - ''string''
:: Link to the product catalogue specification describing the given service

:; billingCycle - ''integer''
:: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

:; attributes - ''string''
:: A link to the attributes of the service

; links - ''list''
: [[Hypermedia]] for the list of product resources

==== Error responses ====
<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have assess to get the information about the services.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order or the product doesn't exist.
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId:GET

2014-10-01T09:53:27Z

Emanuela.mitreva: /* Parameters */

= GET /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Get details about a specific service in a given product.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The services for the order and product (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 403 Forbidden
| Unauthorized: Services failed permission check
| The client does not have assess to get the information about the service.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the information for a service for non existing order, product or service.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
{
"status": "new",
"name": "john.smith1",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/",
"rel": "self"
}
],
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{relatedServiceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}</nowiki>

===== Parameters =====
; status - ''string''
: Current status of the service. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''', '''purge_pending''' and '''purged'''

; name - ''string''
: The name of the specific service

; links - ''list''
: [[Hypermedia]] for the product resource

; relatedTo - ''list''
: A list containing other services related in some way to the current service

; serviceSpecification - ''string''
: Link to the product catalogue specification describing the given service

; billingCycle - ''integer''
: Billing cycle of the service. Allowed values are from '''1''' to '''120'''

; attributes - ''string''
: A link to the attributes of the service

==== Error responses ====
<nowiki>
401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have assess to get the information about the service.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found - the order, product or service doesn't exist.
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services-serviceId:DELETE

2014-09-30T16:57:50Z

Emanuela.mitreva: /* DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId} */

= DELETE /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Removes service from a product.
__TOC__

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

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

; productId - ''string''
: Product's unique Id.

; serviceId - ''string''
: UUID specifying the service to be deleted

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 403 Forbidden
| Unauthorized: Services failed permission check
| The client does not have permissions to delete a service.
|-
| 404 Not Found
| Resource not found
| The order, product or service is not found.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permissions to delete a service.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Services failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

Orders-orderId-account-products-productId:DELETE

2014-09-30T15:51:56Z

Emanuela.mitreva: /* Status Code */

= DELETE /orders/''{orderId}''/account/products/''{productId}'' =
Removes a product from the account's order.
__TOC__

== Request ==
<code>DELETE /orders/''{orderId}''/account/products/''{productId}''</code>

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

; productId - ''string''
: Product's unique Id.

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 204
| -
| The product was successfully deleted.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or invalid.
|-
| 403 Forbidden
| Unauthorized: Products failed permission check
| The client does not have permissions to delete products.
|-
| 404 Not Found
| Resource not found
| The client is trying to delete a non existing product or the order does not exist.
|-
| 502 Bad Gateway
| -
| Unexpected backend response.
|}

=== Response Body ===

==== Successful response ====
None.

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
403 Forbidden - the client does not have permission to delete products.
{
"forbidden": {
"guid": "d336dd8e-bc52-44f3-b672-9aa2fac7fbf4",
"message": "Unauthorized: Products failed permission check",
"code": 403,
"details": ""
}
}</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

<nowiki>
502 Bad Gateway - unexpected error from the backend.
{
"computeFault": {
"guid": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce",
"timestamp": "2014-09-10 20:59:50",
"code": 502,
"errorRefId": "8ced5fe7-f6a9-4e8f-8700-cfc9fa15e6ce"
}
}</nowiki>

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

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

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

2014-09-11T14:53:49Z

Emanuela.mitreva: /* Status Code */

Orders-orderId-account-products:POST

2014-09-11T14:16:03Z

Emanuela.mitreva: /* Status Code */

Orders-orderId-account-products-productId-services-serviceId:DELETE

2014-09-11T10:42:58Z

Emanuela.mitreva: /* Response */

Orders-orderId-account-products-productId-services-serviceId:GET

2014-09-11T10:39:44Z

Emanuela.mitreva: /* Successful response */

= GET /orders/''{orderId}''/account/products/''{productId}''/services/''{serviceId}'' =
Get details about a specific service in a given product.
__TOC__

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

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

; productId - ''string''
: UUID specifying the product

; serviceId - ''string''
: UUID specifying the service

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The services for the order and product (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the information for a service for non existing order, product or service.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
{
"status": "new",
"name": "john.smith1",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/",
"rel": "self"
}
],
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{relatedServiceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}</nowiki>

==== Parameters ====
; status - ''string''
: Current status of the service. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''

; name - ''string''
: The name of the specific service

; links - ''list''
: [[Hypermedia]] for the product resource

; relatedTo - ''list''
: A list containing other services related in some way to the current service

; serviceSpecification - ''string''
: Link to the product catalogue specification describing the given service

; billingCycle - ''integer''
: Billing cycle of the service. Allowed values are from '''1''' to '''120'''

; attributes - ''string''
: A link to the attributes of the service

==== Error responses ====
<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

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

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

Orders-orderId-account-products-productId-services:GET

2014-09-11T10:37:14Z

Emanuela.mitreva: /* Response Body */

= GET /orders/''{orderId}''/account/products/''{productId}''/services =
Get all Services in a given product.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products/''{productId}''/services</code>

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

; productId - ''string''
: UUID specifying the product

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The services for the order and product (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the services for non existing order or non existing product
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"list": [
{
"status": "new",
"name": "john.smith1",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/", "rel": "self"}
],
"relatedTo": [ "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}" ],
"serviceSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/serviceSpecifications/{serviceSpecificationId}",
"billingCycle": 1,
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes"
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services/", "rel": "self"}
]
} </nowiki>

==== Error responses ====
<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "3a422918-24c3-4c20-9bee-f1c61695e987",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>
==== Parameters ====
; list - ''list''
: List of the services for the given product. Each element of the list has the following attributes:

:; status - ''string''
:: Current status of the service. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''

:; name - ''string''
:: The name of the specific service

:; links - ''list''
:: [[Hypermedia]] for the product resource

:; relatedTo - ''list''
:: A list containing other services in the current order related in some way to the current service

:; serviceSpecification - ''string''
:: Link to the product catalogue specification describing the given service

:; billingCycle - ''integer''
:: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

:; attributes - ''string''
:: A link to the attributes of the service

; links - ''list''
: [[Hypermedia]] for the list of product resources

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

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

Orders-orderId-account-products-productId-services:POST

2014-09-11T09:36:28Z

Emanuela.mitreva:

Orders-orderId-account-products-productId:DELETE

2014-09-08T16:55:10Z

Emanuela.mitreva: /* Status Code */

Orders-orderId-account-products-productId:GET

2014-09-08T16:53:26Z

Emanuela.mitreva: /* Parameters */

= GET /orders/''{orderId}''/account/products/''{productId}'' =
Get details about a specific Product in an account.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products/''{productId}''</code>

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

; productId - ''string''
: Product's unique Id.

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The operation was successfully completed.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or are invalid
|-
| 404 Not Found
| Resource not found
| The client is trying to get the products for non existing order or non existing product.
|}

=== Response Body ===
==== Successful response ====
<nowiki>
200 OK
{
"status" : "open",
"services" : "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}/services",
"offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"links" : [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{productId}", "rel": "self" }
]
}</nowiki>

===== Parameters =====
; status - ''string''
: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''

; services - ''string''
: A link to the services associated with the product

; offering - ''string''
: Link to the [[Products|product catalog offering]] specifying the given product

; displayName - ''string''
: A custom display name for the product.

; partnerId - ''string''
: Partner purchased plan id.

; links - ''list''
: [[Hypermedia]] for the product resource

==== Error responses ====
<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

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

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

Orders-orderId-account-products:GET

2014-09-05T13:16:02Z

Emanuela.mitreva: /* Parameters */

= GET /orders/''{orderId}''/account/products =
Get all Product in an account.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/products</code>

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
{| class="wikitable"
! Status Code
! Error Message
! Description
|-
| 200 OK
| -
| The products for the order (if any) are successfully returned.
|-
| 401 Unauthorized
| This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
| The '''OwnerId''' cookie or the '''Authorization''' header are not specified or do not permit access to the specified order.
|-
| 404 Not Found
| Resource not found
| The client is trying to get the products for non existing order.
|}

=== Response Body ===

<nowiki>
200 OK
{
"list": [
{
"status": "open",
"services": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}/services",
"offering" : "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}/offerings/{productOfferingId}",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/{orderProductId}", "rel": "self"}
]
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/products/",
"rel": "self"
}
]
}</nowiki>

==== Parameters ====
; list - ''list''
: List of the products for the given account order. Each element of the list has the following attributes:

:; status - ''string''
:: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''

:; services - ''string''
:: A link to the services associated with the product

:; displayName - ''string''
:: A custom display name for the product.

:; partnerId - ''string''
:: Partner purchased plan id.

:; links - ''list''
:: [[Hypermedia]] for the product resource

:; offering - ''string''
:: Link to the product catalogue offering specifying the given product

; links - ''list''
: [[Hypermedia]] for the list of product resources

<nowiki>401 Unauthorized

This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.</nowiki>

<nowiki>
404 Not Found
{
"itemNotFound": {
"guid": "579951da-5f2c-4db7-9169-25658bfaafdb",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

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

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

Accounts-accountId-products-productId:GET

2014-09-05T11:25:08Z

Emanuela.mitreva: /* Parameters */

= GET /accounts/''{accountId}''/products/{productId} =
Get product information and (if requested) possible product changes.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products/{productId}</code>

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

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

=== URI Parameters ===
; getTargetProductSpecifications - ''boolean''
: Optional. If set to 1 the response will include valid product specification change targets list.

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

== Response ==

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

; 401 Unauthorized
: Authorization credentials not submitted or invalid.

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

=== Response Body ===
The response body includes product specification change targets list when the ''getTargetProductSpecifications'' URI parameter is set to 1.

<nowiki>
{
"status": "open",
"name": "Product Name",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"billingCycle": 12,
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecificationId}",
"changes": [
{
"type": "upgrade",
"id": "{targetProductSpecificationId}",
"href": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{targetProductSpecificationId}"
},
]
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId}/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: Current status of the product. Allowed values are '''new''', '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed''' and '''purge_pending'''.

; name - ''string''
: Name of the product.

; billingCycle - ''integer''
: Billing cycle of the product in months.

; productSpecification - ''string''
: Link to the specification of the current product.

; changes - ''list''
: A list with the valid product change targets. Returned if ''getTargetProductSpecifications=1'' query parameter is passed

; displayName - ''string''
: A custom display name for the product.

; partnerId - ''string''
: Partner purchased plan id.

; links - ''list''
: [[Hypermedia]] for the product resource

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

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

Accounts-accountId-products:GET

2014-09-05T08:51:11Z

Emanuela.mitreva: /* Response Body */

= GET /accounts/''{accountId}''/products =
Retrieves a list of all products associated with a given account.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/products</code>

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

=== URI Parameters ===

; filterStatus - ''string''
: Optional. Only products with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

; filterDisplayName - ''string''
: Optional. Only products with displayName matching the value of the parameter will be returned.

; filterPartnerId - ''string''
: Optional. Only products with parnterId matching the value of the parameter will be returned.

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

== Response ==

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

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

;403 Forbidden
: Access to '''closed''' and '''suspended''' accounts requires elevated permissions

=== Response Body ===
<nowiki>
{
"list": [
{
"name": "Product 1",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId1}",
"bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId1}/bandwidth/",
"usage": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId1}/usage/",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/{productId1}", "rel": "self"}
]
},
{
"name": "Product 2",
"displayName": "My custom product name",
"partnerId": "Partner purchased plan Id",
"productSpecification": "</nowiki>{{APIBaseURL}}<nowiki>/productSpecifications/{productSpecId2}"
"bandwidth": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}/bandwidth/",
"usage": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}/usage/",
"status": "open",
"billingCycle": 1,
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products/{productId2}", "rel": "self"}
],
}
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/products", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about specific products

:; status - ''string''
:: Describes the status of a product. Valid values are '''open''', '''closed''' or '''suspended'''

:; name - ''string''
:: Descriptive name of the product

:; billingCycle - ''integer''
:: Billing cycle (length of billing period in months) of the service. Allowed values are from '''1''' to '''120'''

:; productSpecification - ''string''
:: [[Hypermedia]] for this product resource. Link to the product's specification.

:; bandwidth - ''string''
:: [[Hypermedia]] for this product resource. Link to the bandwidth's information.

:; usage - ''string''
:: [[Hypermedia]] for this product resource. Link to the usage's information.

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

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

== Alternative with partner Id ==
As an alternative to using the account Id the client can use a partner-specific Id set via the account attribute [[Orders-orderId-account-attributes:PUT|partner_account_id]]. The response to this request is the same as the response to a request using the account Id.

<code>GET /partnerAccounts/''{partnerAccountId}''/products</code>

==== Parameters ====
; partnerAccountId - ''string''
: Partner account Id set via the [[Orders-orderId-account-attributes:PUT|partner_account_id]] attribute.

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

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

ServerSnapshotCreate

2013-07-12T12:03:20Z

Emanuela.mitreva: /* Response Codes */

This operation will create a new server snapshot of a server. Server snapshot creation is asynchronous, the progress can be checked with the URL in the response Location header or the self link in the body.

='''POST''' /accounts/''{accountId}''/flexcloud/servers/''{server_id}''/snapshots=
This operation will create a new server snapshot. Server snapshot creation is asynchronous, the progress can be checked with the URL in the response Location header or the self link in the body.

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

; server_id
: The unique identifier of the server.

=== JSON ===
<nowiki>
{
"snapshot": {
"name": "{name}",
"description": "{description}"
}
}</nowiki>

; name - ''string''
: Display name for this server snapshot

; description - ''string''
: Description for this server snapshot

== Result ==
=== JSON ===
<nowiki>
{
"snapshot": {
"id": "{snapshot_id}",
"name": "{snapshot_name}"
"description": "{description}",
"status": "{status}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{relation_guid}",
"create_time": "{create_time}",
"links": [{"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/snapshots/{snapshot_id}/",
"rel": "self"}],
}
}
</nowiki>
* When a server snapshot is in pending status (has not completed the provisioning process), the create_time, guid, parent_guid, and relation_guid will be empty strings.
; id - ''string''
: Unique identifier for this server snapshot.

; name - ''string''
: Display name of this server snapshot.

; description - ''string''
: Description of this server snapshot.

; guid - ''string''
: GUID of this server snapshot.

; parent_guid - ''string''
: Parent GUID of this server snapshot.

; relation_guid - ''string''
: Relation GUID of this server snapshot.

; status - ''string''
: Status of this server snapshot; Values: 'ACTIVE', 'BUILD', 'DELETED'

; create_time - ''string''
: Created time of this server snapshot

; links - ''array''
: [[Hypermedia]] for this resource.

== Response Codes ==
; Success:
:''HTTP/1.1 202 Accepted''
::Request is accepted.

; Failure:
:''HTTP/1.1 400 Bad Request''
::The snapshot cannot be created because the server contains extra volumes.

:''HTTP/1.1 404 itemNotFound''
::The resource does not exist

:''HTTP/1.1 409 Conflict''
::The snapshot name must be unique in a server.

:''HTTP/1.1 413 Request entity too large''
::The snapshot can be created up to 3 in a server.

== Examples ==
'''Successfully create a new server'''
:'''POST''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/snapshots</nowiki>

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

''Request Body:''
<nowiki>
{
"snapshot": {
"name": "fitnesse snapshot",
"description": "fitnesse test snapshot"
}
}</nowiki>

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

''Response Body:''
<nowiki>
{
"snapshot": {
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a",
"name": "test snapshot"
"description": "test snapshot description",
"status": "BUILD",
"guid": "",
"parent_guid": "",
"relation_guid": "",
"create_time": "0000-00-00 00:00:00",
"links": [
{"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a/",
"rel": "self"}],
}
}</nowiki>

'''Failure while trying to update server with a wrong account number'''
:'''POST''' <nowiki>http://{api_server}/accounts/fake/flexcloud/servers/{server_id}/snapshots</nowiki>

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

== Alternative URI /servers/{server_id}/snapshots ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>POST /servers/{server_id}/snapshots</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServerSnapshot

2013-07-12T11:59:32Z

Emanuela.mitreva: /* Response Codes */

This article describes operations for getting details of a server snapshot.
Other types of operations on a server snapshot are: [[ServerSnapshotCreate]], [[ServerSnapshotActions]], etc.

='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{server_id}''/snapshots/''{snapshot_id}''=
This operation will return details of a single server.

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

; server_id
: The unique identifier of the server.

; snapshot_id
: The unique identifier of the server snapshot to get

== Result ==
=== JSON ===
<nowiki>
{
"snapshot": {
"id": "{snapshot_id}",
"name": "{snapshot_name}"
"description": "{description}",
"status": "{status}",
"guid": "{guid}",
"parent_guid": "{parent_guid}",
"relation_guid": "{relation_guid}",
"create_time": "{create_time}",
"links": [{"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/snapshots/{snapshot_id}/",
"rel": "self"}],
}
}</nowiki>

; id - ''string''
: Unique identifier for this server snapshot.

; name - ''string''
: Display name of this server snapshot.

; description - ''string''
: Description of this server snapshot.

; guid - ''string''
: GUID of this server snapshot.

; parent_guid - ''string''
: Parent GUID of this server snapshot.

; relation_guid - ''string''
: Relation GUID of this server snapshot.

; status - ''string''
: Status of this server snapshot; Values: 'ACTIVE', 'BUILD', 'DELETED'

; create_time - ''string''
: Created time of this server snapshot

; links - ''array''
: [[Hypermedia]] for this resource.

== Response Codes ==
; Success:OK (200)

; Failure:
: Unauthorized (401) : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ItemNotFound (404) : The resource requested is not found.

== Examples ==
'''Successfully get server details'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a

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

''- Response:''
''OK (200)'':
<nowiki>
{
"snapshot": {
"id": "snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a",
"name": "fitnesse snapshot"}
"description": "fitnesse test snapshot",
"status": "ACTIVE",
"guid": "a4e76fdf-8696-4848-ba81-cfe090e1401d",
"parent_guid": "491aee4b-34bc-45e5-ac47-7ef9fb96c4c4",
"relation_guid": "42130087-f34c-4823-885d-8a908017ed8d",
"create_time": "2012-07-19 16:28:09",
"links": [{"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/jello614636-USOTE-0214/snapshots/snapshot_jello614636-USOTE-0214_2012Jul19_m5yf9Bz8a/", "rel": "self"}],
}</nowiki>

* When a server is in pending status (has not completed the provisioning process), the creation timestamp and hostId that are returned will be empty strings.

'''Failure while trying to get server details without proper authorization'''
''- Response:''
''Unauthorized (401)'':
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to get server details for a non-existent server id'''
''- Response:''
''ItemNotFound (404)'':
{
"itemNotFound":
{
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

='''DELETE''' /accounts/{accountId}/flexcloud/servers/{server_id}/snapshots/{snapshot_id}=
This operation will delete a single server snapshot.

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

; server_id - ''string''
: The selected server Id.

; snapshot_id - ''string''
: Id of the server snapshot to delete.

== Response Codes ==
; Success
: ''HTTP/1.1 202 Accepted'' or ''HTTP/1.1 204 No Content''

; Failure
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.

== Examples ==
'''Successfully delete a specific server'''
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/123/snapshots/567

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to update a non-existent server'''
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/123/snapshots/{fake_server_id}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

'''Failure while trying to update server with a wrong account number'''
:'''DELETE''' http(s)://{api_server}/accounts/fake/flexcloud/servers/123/snapshots/567

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

== Alternative URI /servers/{server_id}/snapshots/{snapshot_id} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /servers/{server_id}/snapshots/{snapshot_id}</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServerActionUpgradePlesk

2013-07-12T11:34:07Z

Emanuela.mitreva:

This operation will upgrade the Plesk license for the specified [[Server]].

='''POST''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/action=

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

; id
: The unique identifier of the server.

== Request==
=== JSON ===
<nowiki>
{
"upgradePlesk" : {
"username": "{plesk_server_username}",
"password": "{plesk_server_password}",
"port_number": "{plesk_server_port}",
"addon_textkey": "{plesk_addon_textkey}"
}
}</nowiki>

====upgradePlesk====
; username - ''string''
: The username used for authentication for managing Plesk license.

; password - ''string''
: The password used for authentication for managing Plesk license.

; port_number - ''string''
: The port used for managing Plesk license.

; addon_textkey - ''string''
: Plesk addon textkey to upgrade to.

== Response Codes ==
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter / Server not found
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 403 Forbidden'' : The server understood the request, but is refusing to fulfill it.
: ''HTTP/1.1 404 Not Found'' : The resource does not exist.
: ''HTTP/1.1 409 Conflict'' : The request could not be completed due to a conflict with the current state of the resource. / Wrong Addon TextKey

== Examples ==
'''Successfully upgrade Plesk server license'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to upgrade Plesk while server is processing another task'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
{
"conflict": {
"message": "PleskStillUpgrading",
"code": 409,
"details": "Some task is in processing for this instance. please wait for a while",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Unauthorized access'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to upgrade Plesk with an empty parameter body'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
empty
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad Request",
"code": 400,
"details": "Multiple actions per request are not allowed",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to upgrade Plesk with incorrect Plesk server credentials'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "fake-plesk-username",
"password": "fake-plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to upgrade Plesk for a non-existent port server'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "1222",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk addon textkey'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "fake.plesk.addon.textkey"
}
}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
{
"conflict": {
"message": "WrongAddonTextkey",
"code": 409,
"details": "Please specify proper addon textkey",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk server'''
:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/fake_server_name/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk server with invalid account number'''
:'''POST''' http(s)://{api_server}/accounts/fake_account/flexcloud/servers/test_server_0013/action

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

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}

== Alternative URI /servers/{id}/action ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>POST /servers/{id}/action</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

FlavorListDetails

2013-07-12T10:49:05Z

Emanuela.mitreva: /* Response */

= GET /accounts/''{accountId}''/flexcloud/flavors/detail?minDisk=''{diskInGB}''&minRam=''{ramInMB}'' =
This operation will list all available flavors with size details optionally limited by the query parameters.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/flavors/detail?minDisk=''{diskInGB}''&minRam=''{ramInMB}''</code>

=== URI Parameters ===
; accountId - ''string''
: The selected account Id.

; minDisk - ''int''
: ''Optional'' Only flavors only with a disk size greater than or equal to minDisk will be returned. Specified in GB.

; minRam - ''int''
: ''Optional'' Only flavors with a memory size greater than or equal to minRam will be returned. Specified in MB.

''Also see [[Pagination]]''

== Response ==

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

; 401 Unauthorized
: Failure - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

; 404 Not Found
: Failure - Resource does not exist

=== Response Body ===
<nowiki>
{
"flavors":[
{
"name":"{display_flavor_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
],
"vcpu":1,
"ram":512,
"disk":10,
"id":"{flavor_id}"
},
{
"name":"{display_flavor_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
],
"vcpu":4,
"ram":16384,
"disk":60,
"id":"{flavor_id}"
}
]
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this flavor.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this flavor.

; ram - ''number''
: Memory allocated with this flavor. Specified in MB.

; disk - ''number''
: Disk space allocated with this flavor. Specified in GB.

; vcpu - ''number''
: Number of CPUs allocated with this flavor.

== Examples ==

=== Successfully list flavors with details ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/detail
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
200 OK

{
"flavors":[
{
"name":"Small",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel":"self"}
],
"vcpu":1,
"ram":512,
"disk":10,
"id":"1"
},
{
"name":"Large",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/2/", "rel":"self"}
],
"vcpu":4,
"ram":16384,
"disk":60,
"id":"2"
}
]
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/detail
Authorization: Basic {invalid authorization}</nowiki>

'''Response'''
<nowiki>
401 Unauthorized</nowiki>

=== Account not found ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/detail
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== Alternative URI /flavors/detail ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /flavors/detail</code>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

FlavorList

2013-07-12T10:47:38Z

Emanuela.mitreva: /* Status Code */

= GET /accounts/''{accountId}''/flexcloud/flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}'' =
Lists all available flavors optionally limited by the query parameters.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}''</code>

=== URI Parameters ===
; accountId - ''string''
: The selected account Id.

; minDisk - ''int''
: ''Optional'' Only flavors with a disk size greater than or equal to minDisk will be returned. Specified in GB.

; minRam - ''int''
: ''Optional'' Only flavors with a memory size greater than or equal to minRam will be returned. Specified in MB.

''Also see [[Pagination]]''

== Response ==

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

; 401 Unauthorized
: Failure - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

; 404 Not Found
: Failure - Resource does not exists

=== Response Body ===
<nowiki>
{
"flavors":[
{
"id":"{flavor_id}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
],
"name":"{display_flavor_name}"
},
{
"id":"{flavor_id}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
],
"name":"{display_flavor_name}"
}
]
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this flavor.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this flavor.

== Examples ==

=== Successfully list available flavors ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
200 OK

{
"flavors": [
{
"name": "Small",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel": "bookmark"}
],
"id": "1"
},
{
"name": "Large",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/3/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/3/", "rel": "bookmark"}
],
"id": "3"
}
]
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors
Authorization: Basic {invalid authorization}</nowiki>

'''Response'''
<nowiki>
401 Unauthorized</nowiki>

=== Account not found ===
'''Request'''
<nowiki>
GET /accounts/fake/flexcloud/flavors
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

== Alternative URI /flavors ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /accounts/{accountId}/flexcloud/flavors</code>

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ImageList

2013-07-12T10:36:39Z

Emanuela.mitreva: /* Status Code */

= GET /accounts/''{accountId}''/flexcloud/images?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}'' =
Lists all images.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/images?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}''</code>

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

; name - ''string''
: ''Optional'' image name to search for.

; status - ''string''
: ''Optional'' Image status to search for. Values: '''ACTIVE''', '''SAVING''', '''DELETED'''.

; type - ''string''
: ''Optional'' type of the image to search for. Values: '''BASE''', '''SERVER'''.

; zone - ''string''
: ''Optional'' the zone where the image is available.

== Response ==

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

; 401 Unauthorized
: Failure - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

; 404 Not Found
: Failure - The Resource does not exist

=== Response Body ===
<nowiki>
{
"images":[
{
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"bookmark"}
],
"id": "{image_id}",
"zones": ["{zone_id_1}", "{zone_id_2}"]
},
{
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"bookmark"}
],
"id":"{image_id}",
"zones": ["{zone_id}"]
}
]
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this image.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this image.

; zones - ''string''
: Zones where the image is available.

== Examples ==

=== Successfully list images ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
200 OK

{
"images": [
{
"name": "test_public_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/123/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/123/", "rel": "bookmark"}
],
"id": "123",
"zones": ["AUS001"]
},
{
"name": "test_debian_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/290/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/290/", "rel": "bookmark"}
],
"id": "290",
"zones": ["AUS001"]
},
{
"name": "test_private_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/233/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/233/", "rel": "bookmark"}
],
"id": "233",
"zones": ["AUS001"]
}
]
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images
Authorization: Basic {invalid authorization} </nowiki>

'''Response'''
<nowiki>
401 Unauthorized </nowiki>

=== Account Number not found ===
'''Request'''
<nowiki>
GET /accounts/fake/flexcloud/images
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== Alternative URI /images ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /images</code>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ListServerIPs

2013-07-11T16:50:37Z

Emanuela.mitreva:

This operation will list all flexible IPs assigned to a specific [[Server]].

='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/ips''=

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

; id
: The unique identifier of the server.

== Result ==
=== JSON ===
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/ips",
"rel": "self"
}
]
}</nowiki>

; addr - ''string''
: The address of the allocated flexible IP.

; links - ''array''
: [[Hypermedia]] for this resource.

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''
; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - Resource not found.

== Examples ==

'''Successfully list all flexible IPs assigned to the specified server'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips

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

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"addresses" : {
"public" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
],
"private" : [
{
"version" : 4,
"addr" : "{ip_address}"
}
]
},
"links" : [
{
"href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips",
"rel": "self"
}
]
}</nowiki>

'''Unauthorized access'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to list flexible IPs for a non-existent server'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{fake_server_id}/ips

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

'''Failure while trying to pass invalid account number'''
:'''GET''' http(s)://{api_server}/accounts/fake/flexcloud/servers/test_server_0013/ips

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /servers/{id}/ips ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /servers/{id}/ips</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ServerList

2013-07-11T16:36:56Z

Emanuela.mitreva: /* Response Codes */

This operation returns a list of all [[Server|servers]].

='''GET''' /accounts/''{accountId}''/flexcloud/servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=

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

; name - ''string''
: ''Optional'' Server name to search for.

; status - ''string''
: ''Optional'' Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''

; image - ''string''
: ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/''

; zone - ''string''
: ''Optional'' Zone textkey

== Result ==
=== JSON ===
<nowiki>
{
"servers":[
{
"id":"{server_id}",
"zone": "{zone_textkey}",
"links":[
{
"href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
"rel":"self"
}
]
},
{
"id":"{server_id}",
"zone": "{zone_textkey}",
"links":[
{
"href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
"rel":"self"
}
]
}
]
}</nowiki>

; id - ''string''
: Unique identifier for this server.

; zone
: Zone text key

; links - ''array''
: [[Hypermedia]] for this resource.

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''

; Failure:
:''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' : Resource does not exist

== Examples ==
'''Successfully list servers'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers

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

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"servers" : [
{
"id": "test_server_0001",
"zone": "AUS001",
"links": [
{
"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0001/",
"rel": "self"
}
]
},
{
"id": "test_server_0013",
"zone": "zone",
"links": [
{
"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/",
"rel": "self"
}
]
},
{
"id": "test_server_0015",
"zone": "AUS001",
"links": [
{
"href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0015/",
"rel": "self"
}
]
}
]
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''GET''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/servers</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /servers ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /servers</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Image

2013-07-11T16:34:42Z

Emanuela.mitreva:

= GET /accounts/''{accountId}''/flexcloud/images/''{id}'' =
Returns details for a single image.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/images/''{id}''</code>

=== Parameters ===
; accountId
: The selected account Id.

; id
: The unique identifier of the image to be retrieved. ''Note see warnings in [[Hypermedia]]''.

== Response ==

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

; 401 Unauthorized
: This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

; 403 Forbidden
; The resource is forbidden for this user

; 404 Not Found
: The resource does not exist

=== Response Body ===
<nowiki>
{
"image":{
"status":"SAVING",
"updated":null,
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"bookmark"}
],
"created":"yyyy-mm-ddThh:mm:ss",
"id":"{image_id}",
"zones":["{zone_id}"]
}
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this image.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this image.

; status - ''string''
: Current state of this image. Valid values are ACTIVE, SAVING, DELETED.
:: '''ACTIVE''' - Image is ready to be used.
:: '''SAVING''' - Image is being uploaded or saved from a running [[Server]] instance.
:: '''DELETED''' - Image was recently deleted or is in the process of being deleted.

; created - ''string''
: The date and time the image was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

; updated
: Unused always null.

; zones - ''string''
: Zones where the image is available.

== Examples ==

=== Successfully view image ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/133
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
200 OK

{
"image": {
"status": "SAVING",
"updated": null,
"name": "test_debian_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/133/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/133/", "rel": "bookmark"}
],
"created": "2011-09-30T02:38:57",
"id": "133",
"zones": ["AUS001"]
}
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/133
Authorization: Basic {invalid authorization} </nowiki>

'''Response'''
<nowiki>
401 Unauthorized </nowiki>

=== Permission denied failure ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/122
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
403 Forbidden

{
"forbidden": {
"message": "forbidden",
"code": 403,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
} </nowiki>

=== Failure while trying to request for an image that does not exist ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/missing_image_id
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
404 Not Found

{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
} </nowiki>

=== Account Number not found ===
'''Request'''
<nowiki>
GET /accounts/fake/flexcloud/images/122
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== Alternative URI /images/{id} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /images/{id}</code>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

ImageListDetails

2013-07-11T16:32:16Z

Emanuela.mitreva:

= GET /accounts/''{accountId}''/flexcloud/images/detail?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}'' =
This operation will list all images including their details.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/images/detail?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}''</code>

=== URI Parameters ===
; accountId - ''string''
: The ID of the selected account.

; name - ''string''
: ''Optional'' image name to search for.

; status - ''string''
: ''Optional'' Image status to search for. Values: '''ACTIVE''', '''SAVING''', '''DELETED'''.

; type - ''string''
: ''Optional'' type of the image to search for. Values: '''BASE''', '''SERVER'''.

; zone - ''string''
: ''Optional'' the Zone where the image is available.

== Response ==

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

; 401 Unauthorized
: Failure - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

; 404 Not Found
: Failure - The Resource was not found

=== Response Body ===
<nowiki>
{
"images":[
{
"status":"{status}",
"updated":null,
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"bookmark"}
],
"created":"yyyy-mm-ddThh:mm:ss",
"id":"{image_id}",
"zones": ["{zone_id}"]
},
{
"status":"{status}",
"updated":null,
"name":"{display_image_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"self"},
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/{image_id}/", "rel":"bookmark"}
],
"created":"yyyy-mm-ddThh:mm:ss",
"id":"{image_id}",
"zones": ["{zone_id_1}", "{zone_id_2}"]
}
]
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this image.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this image.

; status - ''string''
: Current state of this image. Valid values are ACTIVE, SAVING, DELETED.
:: '''ACTIVE''' - Image is ready to be used.
:: '''SAVING''' - Image is being uploaded or saved from a running [[Server]] instance.
:: '''DELETED''' - Image was recently deleted or is in the process of being deleted.

; created - ''string''
: The date and time the image was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

; updated
: Unused always null.

; zones
: Zones where the image is available.

== Examples ==

=== Successfully list image details ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/detail
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
200 OK

{
"images": [
{
"status": "ACTIVE",
"updated": null,
"name": "test_public_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/123/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/123/", "rel": "bookmark"}
],
"created": "2011-11-09T03:19:48",
"id": "123",
"zones": ["AUS001"]
},
{
"status": "SAVING",
"updated": null,
"name": "test_debian_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/233/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/233/", "rel": "bookmark"}
],
"created": "2011-09-30T02:38:57",
"id": "233",
"zones": ["AUS001"]
},
{
"status": "ACTIVE",
"updated": null,
"name": "test_private_image",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/145/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/images/145/", "rel": "bookmark"}
],
"created": "2011-11-09T03:19:01",
"id": "145",
"zones": ["AUS001"]
}
]
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/images/detail
Authorization: Basic {invalid authorization} </nowiki>

'''Response'''
<nowiki>
401 Unauthorized </nowiki>

=== Account Number not found ===
'''Request'''
<nowiki>
GET /accounts/fake/flexcloud/images
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== Alternative URI /images/detail?name=''{imageName}''&status=''{imageStatus}''&type=''{imageType}''&zone=''{zoneId}'' ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /images/detail</code>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Flavor

2013-07-11T16:27:43Z

Emanuela.mitreva:

= GET /accounts/''{accountId}''/flexcloud/flavors/detail/''{id}'' =
This operation will return size details of a single flavor.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/flexcloud/flavors/detail/''{id}''</code>

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

; id
: The unique identifier of the flavor to be retrieved. ''Note see warnings in [[Hypermedia]]''.

== Response ==

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

: 401 Unauthorized
; This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

: 403 Forbidden
; The resource cannot be accessed by the user

: 404 Not Found
; The requested resource does not exist

=== Response Body ===
<nowiki>
{
"flavor":{
"name":"{display_flavor_name}",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
],
"vcpu":"1",
"ram":512,
"disk":10,
"id":"{flavor_id}"
}
}</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this flavor.

; links - ''array''
: [[Hypermedia]] for this resource.

; name - ''string''
: Display name for this flavor.

; ram - ''number''
: Memory allocated with this flavor. Specified in MB.

; disk - ''number''
: Disk space allocated with this flavor. Specified in GB.

; vcpu - ''number''
: Number of CPUs allocated with this flavor.

== Examples ==

=== Successfully view flavor details ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/1
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
200 OK

{
"flavor":{
"name":"Small",
"links":[
{"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel":"self"}
],
"vcpu":"1",
"ram":512,
"disk":10,
"id":"1"
}
}</nowiki>

=== Failure while trying to make an unauthorized request ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/1
Authorization: Basic {invalid authorization}</nowiki>

'''Response'''
<nowiki>
401 Unauthorized</nowiki>

=== Failure while trying to access a flavor that is not allowed for this user ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/101
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
403 Forbidden

{
"forbidden": {
"message": "forbidden",
"code": 403,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

=== Failure while trying to access a flavor that does not exist ===
'''Request'''
<nowiki>
GET /accounts/{accountId}/flexcloud/flavors/missing_flavor_id
Authorization: Basic {Base64-encoded username:password string} </nowiki>

'''Response'''
<nowiki>
404 Not Found

{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
} </nowiki>

=== Account not found ===
'''Request'''
<nowiki>
GET /accounts/fake/flexcloud/flavors/101
Authorization: Basic {Base64-encoded username:password string}</nowiki>

'''Response'''
<nowiki>
{
"itemNotFound": {
"guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
"message": "Resource not found",
"code": 404,
"details": ""
}
}</nowiki>

== Alternative URI /flavors/detail/{id} ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>GET /flavors/detail/{id}</code>

== See also ==
* [[FlexCloud Server|FlexCloud Server API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Delete Firewall Group Rule

2013-07-11T16:12:27Z

Emanuela.mitreva:

This operation will delete a firewall group rule.

='''DELETE''' /accounts/''{accountId}''/flexcloud/os-security-group-rules/''{id}''=
This operation will delete a firewall group rule.

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

; id - ''string''
: The unique firewall group rule identifier.

== Response Codes ==
; Success:
:''HTTP/1.1 204 No Content''
; Failure:
:''HTTP/1.1 401 Unauthorized'' - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
:''HTTP/1.1 404 Not Found'' - The resource does not exist.

== Examples ==

'''Successfully delete the specified firewall group rule'''
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_id}

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

''Response Code:''
<pre>HTTP/1.1 204 No Content</pre>

'''Failure while trying to delete a non-existent firewall group rule'''
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{fake_firewall_group_rule_id}

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

'''Failure while trying to make unauthorized access'''
:'''DELETE''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-group-rules/{firewall_group_rule_id}

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to pass invalid account number'''
:'''DELETE''' http(s)://{api_server}/accounts/fake/flexcloud/os-security-group-rules/{firewall_group_rule_id}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}</nowiki>

== Alternative URI /os-security-group-rules/id ==
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].

<code>DELETE /os-security-group-rules/{id}</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]