APIDocumentation

Deutsch | English | Español

Currency:

CHF

Your country is:

Choose your country!

2.6. Contact
Prev	Chapter 2. Methods	Next

2.6. Contact

The contact object provides methods to manage (create, update, delete etc.) your contact handles.

2.6.1. contact.create

Creates a new contact handle.

2.6.1.1. Input

Table 2.69. Parameters

Parameter	Description	Type	Required	Default
type	Type of contact	contactType	true
name	First and lastname	text255	true
org	Organisation/company	text0255	false
street	Street address field 1	text64	true
city	Contact city	text64	true
pc	Contact postal code	text10	true
sp	Contact state province	text064	false
cc	Contact country	country	true
voice	Contact phone number	phone	true
fax	Contact fax number	phone	false
email	Contact email address	email	true
remarks	Contact handle remarks	remarks	false
forceNew	Force new contact handle creation	boolean	false	0
extData	Contact extra data	extData	false
testing	Execute command in testing mode	boolean	false	0

2.6.1.2. Output

Table 2.70. Parameters

Parameter	Description	Type	Optional
id	Contact handle id	int

2.6.2. contact.delete

Delete an existing contact handle.

2.6.2.1. Input

Table 2.71. Parameters

Parameter	Description	Type	Required	Default
id	Contact handle id	int	true
testing	Execute command in testing mode	boolean	false	false

2.6.2.2. Output

No additional return parameters

2.6.3. contact.info

Get contact handle details.

2.6.3.1. Input

Table 2.72. Parameters

Parameter	Description	Type	Required	Default
id	Contact handle id	int	true
wide	More detailed output	int	false	0

2.6.3.2. Output

Table 2.73. Parameters

Parameter	Description	Type	Optional
contact
... roId	Contact handle id	int
... id	Contact handle id name	int
... type	Type of contact handle	contactType
... name	First and lastname	text255
... org	Organisation/company	text0255
... street	Street address	text255
... city	City	text64
... pc	Postal code	text10
... sp	State province	text064	Yes
... cc	Country	country
... voice	Phone number	phone
... fax	Fax number	phone	Yes
... email	Email address	email
... remarks	Contact handle remarks	remarks	Yes
... usedCount	Total number of contact handle uses	int	Yes
... nicHandle	Contact NIC handle	nicHandleList	Yes

2.6.4. contact.list

List available contact handles.

2.6.4.1. Input

Table 2.74. Parameters

Parameter	Description	Type	Required	Default
order	Sort order of the result list	contactOrder	false	IDDESC
search	Search string	text64	false
readOnly	List only readable contact handle	int	false
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20
withoutVerification	Don't return the Verification Status	boolean	false	0
id	Retrieve only this one contact.	int	false

2.6.4.2. Output

Table 2.75. Parameters

Parameter	Description	Type	Optional
count	Total number of contact handles	int
contact
... roId	Contact handle id (Repository Object Identifier)	int
... id	Contact handle id name	int
... type	Type of contact handle	contactType
... name	First and lastname	text255
... org	Organisation/company	text0255
... street	Street address	text255
... city	City	text64
... pc	Postal code	text10
... sp	State province	text064	Yes
... cc	Country	country
... voice	Phone number	phone
... fax	Fax number	phone	Yes
... email	Email adress	email
... remarks	Contact handle remarks	remarks	Yes
... readOnly	Contact handle is read only	boolean
... usedCount	Total number of contact handle uses	int	Yes
... verificationStatus	Contact Verification Status	text64	Yes

2.6.5. contact.log

Log of changes to the contact handle.

2.6.5.1. Input

Table 2.76. Parameters

Parameter	Description	Type	Required	Default
id	Contact handle id	int	false

2.6.5.2. Output

Table 2.77. Parameters

Parameter	Description	Type
count	Total number of log entries	int
contact
... logId	Id of the log entry	int
... date	Log timestamp	dateTime
... id	Id of the altered contact handle	int
... status	Contact handle status after the action was performed	text64

2.6.6. contact.sendcontactverification

send Contact Verification

2.6.6.1. Input

Table 2.78. Parameters

Parameter	Description	Type	Required	Default
id	Contact handle id	int	true

2.6.6.2. Output

No additional return parameters

2.6.7. contact.update

Alter contact handle data.

2.6.7.1. Input

Table 2.79. Parameters

Parameter	Description	Type	Required	Default
id	Contact handle id	int	true
name	First and lastname	text255	false
org	Organisation/company	text0255	false
street	Street address field 1	text64	false
city	City	text64	false
pc	Postal code	text10	false
sp	State province	text064	false
cc	Country	country	false
voice	Contact phone number	text64	false
fax	Contact fax number	text064	false
email	Email address	email	false
remarks	Contact handle remarks	remarks	false
extData	Contact extra data	extData	false
testing	Execute command in testing mode	boolean	false	false