SOAP API method Database_contactType

Back to API references

Description
The ID or name of a contact type can be given as parameter. This method returns 'false' if the supplied contact type is not in the database, or the contact type collection object if the database does hold the contact type.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'identifier' : string
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'contacttype' : Structure of type 'contacttype'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'contacttype'
This structure contacttype was mentioned above. This structure has the following properties:
Property 'id' : int
This ID of the contact type
Property 'name' : string
Name of the contact type
Property 'description' : string
The description of the contact type
Property 'icon' : string
The icon of the contact type