GET api/Domain/TldDetails?domain={domain}
Get the details of the tld of this domain
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| domain |
domian name |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
tldDetails object on success
Collection of errors on failure
Return codes
200 - ok
404 - not found
500 - internal server error
| Name | Description | Type | Additional information |
|---|---|---|---|
| Country |
Country name |
string |
None. |
| CountryEN |
Country name in english |
string |
None. |
| ChildId |
Id of the child tld if this is a child |
integer |
None. |
| ValidOwnerCountries |
A list of valid countries for registrants when registry restricts |
Collection of string |
None. |
| RenewStart |
Number of days before expiry that auto renews are generated - default 15 |
integer |
None. |
| Errors |
Errors |
Collection of Error |
None. |
| ticketVersion | integer |
None. |
|
| tldProtocol | TldProtocols |
None. |
|
| tldName | string |
None. |
|
| sAutomatisationType | string |
None. |
|
| registry_id | string |
None. |
|
| id | integer |
None. |
|
| idTldProvider | integer |
None. |
|
| minRegistrationPeriod | integer |
None. |
|
| minRenewPeriod | integer |
None. |
|
| maxRegistrationPeriod | integer |
None. |
|
| maxRenewPeriod | integer |
None. |
|
| minLength | integer |
None. |
|
| maxLength | integer |
None. |
|
| explicitRenew | boolean |
None. |
|
| renewAble | boolean |
None. |
|
| isUpdatable | boolean |
None. |
|
| isZoneRequired | boolean |
None. |
|
| isIndividualRegistration | boolean |
None. |
|
| isUpdateFree | boolean |
None. |
|
| hasSrs | boolean |
None. |
|
| isCctld | boolean |
None. |
|
| isThinRegistry | boolean |
None. |
|
| transferAble | boolean |
None. |
|
| registrationTime | string |
None. |
|
| hasRegistrationDoc | boolean |
None. |
|
| hasAuthInfo | boolean |
None. |
|
| isStatusUpdateAble | boolean |
None. |
|
| hasUpdateDoc | boolean |
None. |
|
| hasTransferDoc | boolean |
None. |
|
| isLocalRegistration | boolean |
None. |
|
| isAutomated | boolean |
None. |
|
| TldCategory | integer |
None. |
|
| IsTop | boolean |
None. |
|
| registrationID | string |
None. |
|
| commentList | Dictionary of Object [key] and Object [value] |
None. |
Response Formats
application/json
{
"commentList": {
"FR": "Le .com est aujourd'hui l'extension préférée et la plus répandu au monde (environ 21.000.000 noms de domaine déposés en .com). <br> Il n'y a aucune restriction pour enregistrer un nom de domaine en .com.<br> L'enregistrement prend quelques secondes et se fait sur la base du premier arrivé premier servi.",
"EN": "The com is today the favorite extension and most widespread in the world (approximately 21.000.000). <br> It has no restriction there to record a domain name in .com.<br>\r\nThe registration takes a few seconds and is made on the basis of first come - first serve. ",
"IT": "The com is today the favorite extension and most widespread in the world (approximately 21.000.000). <br> It has no restriction there to record a domain name in .com.<br>\r\nThe registration takes a few seconds and is made on the basis of first come - first serve. "
},
"ticketVersion": 1,
"tldProtocol": 0,
"tldName": "com",
"sAutomatisationType": "",
"registry_id": "verisign",
"id": 1,
"idTldProvider": 1,
"minRegistrationPeriod": 1,
"minRenewPeriod": 1,
"maxRegistrationPeriod": 10,
"maxRenewPeriod": 9,
"minLength": 3,
"maxLength": 63,
"explicitRenew": true,
"renewAble": true,
"isUpdatable": true,
"isZoneRequired": false,
"isIndividualRegistration": true,
"isUpdateFree": true,
"hasSrs": true,
"isCctld": false,
"isThinRegistry": true,
"transferAble": true,
"registrationTime": "0",
"hasRegistrationDoc": false,
"hasAuthInfo": true,
"isStatusUpdateAble": true,
"hasUpdateDoc": false,
"hasTransferDoc": false,
"isLocalRegistration": false,
"isAutomated": true,
"TldCategory": 1,
"IsTop": true,
"registrationID": "088"
}
text/json
{
"commentList": {
"System.Object": {}
},
"Country": "sample string 1",
"CountryEN": "sample string 2",
"ChildId": 1,
"ValidOwnerCountries": [
"sample string 1",
"sample string 2"
],
"RenewStart": 1,
"Errors": [
{
"Code": 1,
"Detail": "sample string 2",
"Data": {}
}
],
"ticketVersion": 3,
"tldProtocol": 0,
"tldName": "sample string 4",
"sAutomatisationType": "sample string 5",
"registry_id": "sample string 6",
"id": 7,
"idTldProvider": 8,
"minRegistrationPeriod": 9,
"minRenewPeriod": 10,
"maxRegistrationPeriod": 11,
"maxRenewPeriod": 12,
"minLength": 13,
"maxLength": 14,
"explicitRenew": true,
"renewAble": true,
"isUpdatable": true,
"isZoneRequired": true,
"isIndividualRegistration": true,
"isUpdateFree": true,
"hasSrs": true,
"isCctld": true,
"isThinRegistry": true,
"transferAble": true,
"registrationTime": "sample string 25",
"hasRegistrationDoc": true,
"hasAuthInfo": true,
"isStatusUpdateAble": true,
"hasUpdateDoc": true,
"hasTransferDoc": true,
"isLocalRegistration": true,
"isAutomated": true,
"TldCategory": 33,
"IsTop": true,
"registrationID": "sample string 35"
}
application/xml, text/xml
<TldDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
<IsTop xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</IsTop>
<TldCategory xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">33</TldCategory>
<commentList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">
<d2p1:KeyValueOfanyTypeanyType>
<d2p1:Key />
<d2p1:Value />
</d2p1:KeyValueOfanyTypeanyType>
<d2p1:KeyValueOfanyTypeanyType>
<d2p1:Key />
<d2p1:Value />
</d2p1:KeyValueOfanyTypeanyType>
</commentList>
<explicitRenew xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</explicitRenew>
<hasAuthInfo xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</hasAuthInfo>
<hasRegistrationDoc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</hasRegistrationDoc>
<hasSrs xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</hasSrs>
<hasTransferDoc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</hasTransferDoc>
<hasUpdateDoc xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</hasUpdateDoc>
<id xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">7</id>
<idTldProvider xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">8</idTldProvider>
<isAutomated xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isAutomated>
<isCctld xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isCctld>
<isIndividualRegistration xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isIndividualRegistration>
<isLocalRegistration xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isLocalRegistration>
<isStatusUpdateAble xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isStatusUpdateAble>
<isThinRegistry xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isThinRegistry>
<isUpdatable xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isUpdatable>
<isUpdateFree xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isUpdateFree>
<isZoneRequired xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</isZoneRequired>
<maxLength xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">14</maxLength>
<maxRegistrationPeriod xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">11</maxRegistrationPeriod>
<maxRenewPeriod xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">12</maxRenewPeriod>
<minLength xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">13</minLength>
<minRegistrationPeriod xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">9</minRegistrationPeriod>
<minRenewPeriod xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">10</minRenewPeriod>
<registrationID xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">sample string 35</registrationID>
<registrationTime xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">sample string 25</registrationTime>
<registry_id xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">sample string 6</registry_id>
<renewAble xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</renewAble>
<sAutomatisationType xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">sample string 5</sAutomatisationType>
<ticketVersion xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">3</ticketVersion>
<tldName xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">sample string 4</tldName>
<tldProtocol xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">epp</tldProtocol>
<transferAble xmlns="http://schemas.datacontract.org/2004/07/Namebay.Objects">true</transferAble>
<ChildId>1</ChildId>
<Country>sample string 1</Country>
<CountryEN>sample string 2</CountryEN>
<Errors>
<Error>
<Code>1</Code>
<Data />
<Detail>sample string 2</Detail>
</Error>
</Errors>
<RenewStart>1</RenewStart>
<ValidOwnerCountries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ValidOwnerCountries>
</TldDetails>