APIDocumentation

Chapter 2. Methods
Prev		Next

2.1.1. account.addrole

Add a role to an account

2.1.1.1. Input

Table 2.1. Parameters

Parameter	Description	Type	Required	Default
accountId	Id of the account	int	true
roleId	Id of the role (20000: Standard, 20001: Accounting, 20002: Domain, 20003: Hosting, 20004: DNS, 20005: Authcodes)	int	true

2.1.1.2. Output

No additional return parameters

2.1.2. account.changepassword

Change current password.

2.1.2.1. Input

Table 2.2. Parameters

Parameter	Description	Type	Required	Default
username	Customers username	text64	true
currentpassword	Throws EPP1200 if provided password doesn't matches current password	password	true
password	Customers password	password	true
testing	Execute command in testing mode	boolean	false	false

2.1.2.2. Output

No additional return parameters

2.1.3. account.check

Check whether you have currently a session.

2.1.3.1. Input

No parameters allowed

2.1.3.2. Output

Table 2.3. Parameters

Parameter	Description	Type	Optional
user	Your username	text64

2.1.4. account.create

Create a new account.

2.1.4.1. Input

Table 2.4. Parameters

Parameter	Description	Type	Required
username	accounts username	username	true
password	accounts password	password	true
title	title of the account	addressTitle	true
firstname	accounts firstname	text64	true
lastname	accounts lastname	text64	true
street	accounts street	text255	true
pc	accounts post code	text10	true
city	accounts city	text64	true
cc	accounts country code	country	true
email	accounts email address	email	true
org	accounts organisation/company	token0255	false
voice	accounts phone number	phone	false
fax	accounts fax machine number	phoneoptional	false
www	accounts website	token0255	false
language	interface language	language	false

2.1.4.2. Output

Table 2.5. Parameters

Parameter	Description	Type	Optional
id	ID of the created account	int

2.1.5. account.delete

Function for a main account to delete subaccounts

2.1.5.1. Input

Table 2.6. Parameters

Parameter	Description	Type	Required	Default
ids	One or more account id(s) to delete	array_int	true	false

2.1.5.2. Output

Table 2.7. Parameters

Parameter	Description	Type	Optional
countDeleted	Count of successfully deleted accounts	int

2.1.6. account.getroles

Get roles

2.1.6.1. Input

Table 2.8. Parameters

Parameter	Description	Type	Required	Default
accountId	Id of the account	int	false

2.1.6.2. Output

Table 2.9. Parameters

Parameter	Description	Type	Optional
roles	List of the roles	array

2.1.7. account.info

Get your account details.

2.1.7.1. Input

Table 2.10. Parameters

Parameter	Description	Type	Required	Default
wide	More detailed output	int	false

2.1.7.2. Output

Table 2.11. Parameters

Parameter	Description	Type	Optional
accountId	Account id	int
customerId	Customer id	int
customerNo	Your unique Customer number	int
username	Username	text64
title	Salutation title	addressTitle
firstname	Customers firstname	text64
lastname	Customers lastname	text64
org	Customers organisation/company	text064
street	Customers street	text255
pc	Customers postal code	text10
city	Customers city	text64
cc	Customers country	country
voice	Customers phone number	phone
fax	Customers fax number	phoneoptional
www	Customers web address	token0255
email	Customers email address	email
servicePin	Customers service pin	int
crDate	Customers date of account creation	dateTime
secureMode	Customers secure mode	boolean
signPdfs	Customer gets signed pdfs	boolean
summaryInvoice	Customer gets summary invoice	boolean
mailListId	List of subscribed mail-list-ids	array_int	Yes
language	Customers language	language
notificationEmail	Customer gets notification emails	boolean
notificationQueue	Customer uses notification queue	boolean
lowBalance	Customers low balance notification value	float
renewalReport	Customer gets renewal reports	boolean
paymentType	Customers type of payment	paymentType
bankAccHolder	Customers name of bank account holder	token255
bankName	Customers name of bank	token255
bankCode	Customers bank code	token255
bankAccHolderNo	Customers bank account number	text64
vat	Customers vat	int
vatNo	Customers company vat number	vatNo
whoisProvider	Default whois provider	token255
whoisUrl	Default whois url	token255
defaultRegistrant	Default registrant contact handle	int
defaultAdmin	Default administrative contact handle	int
defaultTech	Default technical contact handle	int
defaultBilling	Default billing contact handle	int
defaultNsset	Default nameserver set	int
defaultWeb	Default web nameserver entry	token0255	Yes
defaultMail	Default mail nameserver entry	text0255	Yes
defaultImportNS	Import NS in case of Domain Transfer	boolean	Yes
defaultRenewalMode	Default domain renewal mode	renewalMode
lastLogin	Date of last login	dateTime
loginCount	Count of logins	int
rowsPerPage	Default rows per page value	int
tfa	2-factor-authentification method	tfaMethod
lastIP	Customers ip address of last access	ip
verification	Customers data verfication pending flag	int
emailBilling	Customers email address for billing	email
emailAutomated	Email address for automated emails	email
currency	currency	customercurrency
isReseller	Defines if the customer is a reseller or not	boolean_3
serviceProviderId	The provider-id of the customer	int
supplimentInvoiceText	Suppliment text to the invoice	text0100
wdrpEmail	Email address for WDRP notifications	email

2.1.8. account.list

Function for a main account to get a list of all their subaccounts

2.1.8.1. Input

No parameters allowed

2.1.8.2. Output

Table 2.12. Parameters

Parameter	Description	Type
adminId	Admin account id	int
accounts	List of subaccounts	array
... id	Account ID.	int
... username	Account username.	text64
... firstname	Account first name.	text64
... lastname	Account last name.	text64
... org	Account organisation/company.	text064
... street	Account address, street.	text255
... pc	Account postal code.	text10
... city	Account city.	text64
... cc	Account country code.	country
... voice	Account phone number.	phone
... fax	Account fax number.	phoneoptional
... email	Account email address.	email
... tfaEnabled	2-factor-authentification status.	boolean

2.1.9. account.login

Log in to API.

2.1.9.1. Input

Table 2.13. Parameters

Parameter	Description	Type	Required	Default
user	Your username	text64	true
pass	Your password	password	true
case-insensitive	Case insensitivity for username	boolean	false	false

2.1.9.2. Output

Table 2.14. Parameters

Parameter	Description	Type
customerId	Customers id	int
customerNo	Your unique Customer number	int
accountId	Customers account id	int
tfa	2-factor-authentification method	tfaMethod
builddate	API date of build	text64
version	API version	int

2.1.10. account.logout

Log out from API.

2.1.10.1. Input

No parameters allowed

2.1.10.2. Output

No additional return parameters

2.1.11. account.removerole

Remove role of an account

2.1.11.1. Input

Table 2.15. Parameters

Parameter	Description	Type	Required	Default
accountId	Id of the account	int	true
roleId	Id of the role	int	true

2.1.11.2. Output

No additional return parameters

2.1.12. account.unlock

Unlock your account

2.1.12.1. Input

Table 2.16. Parameters

Parameter	Description	Type	Required	Default
tan	Your TAN (Transaction number)	text10	false

2.1.12.2. Output

No additional return parameters

2.1.13. account.update

Update customers account data.

2.1.13.1. Input

Table 2.17. Parameters

Parameter	Description	Type	Required	Default
username	Customers username	username	false
title	Customers salutation title	addressTitle	false
firstname	Customers firstname	text64	false
lastname	Customers lastname	text64	false
org	Customers organisation/company	token0255	false
street	Customers street	text255	false
pc	Customers postal code	text10	false
city	Customers city	text64	false
cc	Customers country	country	false
voice	Customers phone number	phone	false
fax	Customers fax number	phoneoptional	false
www	Customers web address	token0255	false
email	Customers email address	email	false
emailAutomated	Customers automated email address	emailoptional	false
emailBilling	Customers email address for billing	emailoptional	false
renewalReportEmail	Customers renewal report email address	emailoptional	false
servicePin	Customers service pin	text64	false
summaryInvoice	Customer gets summary invoice	boolean	false
mailListId	One or more mail-list-id(s)	array_int	false
language	Customers language	language	false
notificationEmail	Customer get notification emails	boolean	false
notificationQueue	Customer uses notification queue	boolean	false
renewalReport	Customer gets renewal reports emails	boolean	false
lowBalance	Customers low balance notification value	float_signed	false
bankAccHolder	Customers name of bank account holder	token255	false
bankCode	Customers bank code	text64	false
bankName	Customers name of bank	text64	false
bankAccHolderNo	Customers bank account number	text64	false
vatNo	Customers company vat number	vatNoInternational	false
whoisProvider	Default whois provider	token0255	false
whoisUrl	Default whois url	token0255	false
defaultRegistrant	Default registrant contact handle	int	false
defaultAdmin	Default admin contact handle	int	false
defaultTech	Default tech contact handle	int	false
defaultBilling	Default billing contact handle	int	false
defaultNsset	Default nameserver set	int	false
defaultWeb	Default web nameserver entry	token0255	false
defaultMail	Default mail nameserver entry	text0255	false
defaultImportNS	Import NS in Case of Domain Transfer	boolean	false
defaultRenewalMode	Default domain renewal mode	renewalMode	false
supplimentinvoicetext	Suppliment text to the invoice	text0100	false
password	Customers password	password	false
rowsPerPage	Default rows per page value	int	false
isReseller	Is Customer a reseller?	boolean_3	false
testing	Execute command in testing mode	boolean	false	false
nif	NIF of a natural person or company (only for customers of InternetworX SLU)	text10	false
idCard	Your ID card number (only for natural person with residence in the EU for InternetworX SLU)	text64	false
disablepremium	Are premium domains disabled by the customer?	boolean	false
wdrpEmail	Specify the email address for WDRP notifications	emailoptional	false
wdrpEmailName	Specify the sender name for WDRP notifications	text0255	false
errpEmail	Specify the sender email address for ERRP notifications	emailoptional	false
errpEmailName	Specify the sender name for ERRP notifications	text0255	false
foaEmail	Specify the sender email address for FOA notifications	emailoptional	false
foaEmailName	Specify the sender name for FOA notifications	text0255	false