GET api/AutoRenew?user={user}&reseller={reseller}&object_class={object_class}&object_handle={object_handle}&status={status}&latest={latest}&last_date={last_date}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| user | string |
None. |
|
| reseller | string |
None. |
|
| object_class | string |
None. |
|
| object_handle | string |
None. |
|
| status | string |
None. |
|
| latest | boolean |
Default value is False |
|
| last_date | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of AutoRenew| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id of autorenewal |
integer |
None. |
| TransactionId |
Transaction id of the renewal order |
string |
None. |
| ObjectHandle |
Handle of the object |
string |
None. |
| Class |
Object class |
string |
None. |
| Status |
Status - new, pending, completed, failed, error. Setting the status to new will relaunch the process |
string |
None. |
| Detail |
Details of failure or error |
string |
None. |
| ProduitId |
Product id |
integer |
None. |
| Period |
Period to renew |
integer |
None. |
| TotalTtc |
Total ttc of the renewal |
decimal number |
None. |
| BillingHandle |
Handle of the billing contact |
string |
None. |
| ProductName |
Product name |
string |
None. |
| VerifyAccount |
Flag to indicate if the account should be verified for this renewal |
boolean |
None. |
Response Formats
application/json, text/json
[
{
"Id": 1,
"TransactionId": "sample string 2",
"ObjectHandle": "sample string 3",
"Class": "sample string 4",
"Status": "sample string 5",
"Detail": "sample string 6",
"ProduitId": 7,
"Period": 8,
"TotalTtc": 1.0,
"BillingHandle": "sample string 9",
"ProductName": "sample string 10",
"VerifyAccount": true
},
{
"Id": 1,
"TransactionId": "sample string 2",
"ObjectHandle": "sample string 3",
"Class": "sample string 4",
"Status": "sample string 5",
"Detail": "sample string 6",
"ProduitId": 7,
"Period": 8,
"TotalTtc": 1.0,
"BillingHandle": "sample string 9",
"ProductName": "sample string 10",
"VerifyAccount": true
}
]
application/xml, text/xml
<ArrayOfAutoRenew xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.AutoRenew">
<AutoRenew>
<BillingHandle>sample string 9</BillingHandle>
<Class>sample string 4</Class>
<Detail>sample string 6</Detail>
<Id>1</Id>
<ObjectHandle>sample string 3</ObjectHandle>
<Period>8</Period>
<ProductName>sample string 10</ProductName>
<ProduitId>7</ProduitId>
<Status>sample string 5</Status>
<TotalTtc>1</TotalTtc>
<TransactionId>sample string 2</TransactionId>
<VerifyAccount>true</VerifyAccount>
</AutoRenew>
<AutoRenew>
<BillingHandle>sample string 9</BillingHandle>
<Class>sample string 4</Class>
<Detail>sample string 6</Detail>
<Id>1</Id>
<ObjectHandle>sample string 3</ObjectHandle>
<Period>8</Period>
<ProductName>sample string 10</ProductName>
<ProduitId>7</ProduitId>
<Status>sample string 5</Status>
<TotalTtc>1</TotalTtc>
<TransactionId>sample string 2</TransactionId>
<VerifyAccount>true</VerifyAccount>
</AutoRenew>
</ArrayOfAutoRenew>