APIDocumentation

Deutsch | English | Español

Currency:

CHF

Your country is:

Choose your country!

2.3. Application
Prev	Chapter 2. Methods	Next

2.3. Application

The application object provides methods to manage (create, update, delete etc.) domain applications.

2.3.1. application.check

Check availability of domain applications.

2.3.1.1. Input

Table 2.34. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	text64	true

2.3.1.2. Output

Table 2.35. Parameters

Parameter	Description	Type
domain	Domain name	text64
price	Domain application price	float
period	Domain registration period	int
scDate	Time of scheduled execution	timestamp
status	Domain check status	text10
appCount	Total number of equivalent applications	int

2.3.2. application.create

Create a domain preregistration.

2.3.2.1. Input

Table 2.36. Parameters

Parameter	Description	Type	Required
domain	Domain name	text64	true
price	Domain application price offer	float	false
registrant	Domain owner contact handle id	int	true
admin	Domain administrative contact handle id	int	false
tech	Domain technical contact handle id	int	false
billing	Domain billing contact handle id	int	false
ns	List of nameserver	nsList	true
type	Phase of application	text064	false
extData	Domain application extra data	extData	false

2.3.2.2. Output

Table 2.37. Parameters

Parameter	Description	Type	Optional
roId	Id (Repository Object Identifier) of the domain application	int
notifications	Information about not required contact types	array	Yes

2.3.3. application.delete

Delete a domain preregistration.

2.3.3.1. Input

Table 2.38. Parameters

Parameter	Description	Type	Required	Default
roId	Id (Repository Object Identifier) of the domain application	int	true

2.3.3.2. Output

No additional return parameters

2.3.4. application.info

Get domain application details.

2.3.4.1. Input

Table 2.39. Parameters

Parameter	Description	Type	Required	Default
roId	Id (Repository Object Identifier) of the domain application	int	true
wide	More detailed output	int	false	1

2.3.4.2. Output

Table 2.40. Parameters

Parameter	Description	Type	Optional
roId	Id (Repository Object Identifier) of the domain application	int
domain	Domain name of the application	text64
domain-ace	Domain ace name of the application	text64
type	Phase of application	text64
crDate	Time of domain application creation	dateTime	Yes
upDate	Time of last domain application update	dateTime	Yes
closedDate	Time of domain application close	dateTime	Yes
extData	Domain application extra data	extData	Yes
price	Domain application price	float	Yes
status	Status of application	text64	Yes
registrant	Domain owner contact handle id	int	Yes
admin	Domain administrative contact handle id	int	Yes
tech	Domain technical contact handle id	int	Yes
billing	Domain billing contact handle id	int	Yes
ns	List of nameserver	nsList	Yes
appPosition	Application queue position	text10	Yes
appCount	Total number of equivalent applications	int	Yes
appPrices	Highest application prices	array_float	Yes
contact			Yes
... registrant	Registrant contact handle details	contact
... admin	Administrative contact handle details	contact
... tech	Technical contact handle details	contact
... billing	Billing contact handle details	contact

2.3.5. application.list

List all doamin preregistrations.

2.3.5.1. Input

Table 2.41. Parameters

Parameter	Description	Type	Required	Default
domain	Domain search string	array_text64	false	*
wide	More detailed output	int	false	0
order	Sort order of result list	applicationOrder	false	DOMAINASC
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.3.5.2. Output

Table 2.42. Parameters

Parameter	Description	Type	Optional
count	Total number of preregistrations	int
sum	Sum of preregistration prices	float
domain
... roId	Id (Repository Object Identifier) of the domain application	int
... domain	Domain name of the application	text64
... domain-ace	Domain ace name of the application	text64
... type	Phase of application	text64
... registrant	Domain owner contact handle id	int	Yes
... admin	Domain administrative contact handle id	int	Yes
... tech	Domain technical contact handle id	int	Yes
... billing	Domain billing contact handle id	int	Yes
... crDate	Time of creation	dateTime	Yes
... upDate	Time of last last update	dateTime	Yes
... closedDate	Time of application close	dateTime	Yes
... extData	Domain application extra data	extData	Yes
... price	Domain application price	float	Yes
... status	Status of application	text64	Yes
... ns	List of nameserver	nsList	Yes
... appPosition	Application queue position	text10	Yes
... appCount	Total number of equivalent applications	int	Yes
... appPrices	Highest application prices	array_float	Yes
... contact			Yes
... ... registrant	Registrant contact handle details	contact
... ... admin	Administrative contact handle details	contact
... ... tech	Technical contact handle details	contact
... ... billing	Billing contact handle details	contact

2.3.6. application.update

Update domain preregistration.

2.3.6.1. Input

Table 2.43. Parameters

Parameter	Description	Type	Required
roId	Id (Repository Object Identifier) of the domain application	int	true
price	Domain application price offer	float	false
registrant	Domain owner contact handle id	int	false
admin	Domain administrative contact handle id	int	false
tech	Domain technical contact handle id	int	false
billing	Domain billing contact handle id	int	false
ns	List of nameserver	nsList	false
type	Phase of application	text064	false
extData	Domain application extra data	extData	false