API_GENERAL
The following operations are supported. For a formal definition, please review the Service Description.
-
Contact_Add
Adds a new contact. Fieldvalues must be seperated by a | with sequence FirstName|LastName|Email|OrganisationName|AddressLine1|AddressLine2|City|Province|PostalCode|CountryCode|ContactNo|FaxNo|UserReference -
Contact_CancelUpdate
Cancel any updates pending on a contact. Fieldvalues must be seperated by a | with sequence UserReference. User reference field is used to retrieve current user -
Contact_Update
Updates a current contact. Fieldvalues must be seperated by a | with sequence FirstName|LastName|Email|OrganisationName|AddressLine1|AddressLine2|City|Province|PostalCode|CountryCode|ContactNo|FaxNo|UserReference. User reference field is used to retrieve current user -
DNS_AddARecord
Adds a new A record for a domain. Fieldvalues must be seperated by a | with sequence Domain name|Host Name|IP|TTL -
DNS_AddCNAMERecord
Adds a new CNAME record for a domain. Fieldvalues must be seperated by a | with sequence Domain name|Alias Name|Target Host Name|TTL -
DNS_AddDNSDomain
Adds a new DNS record. Fieldvalues must be seperated by a | with sequence Domain name -
DNS_AddMXRecord
Adds a new MX record for a domain. Fieldvalues must be seperated by a | with sequence Domain name|Host Name|Mail Server Address|Record Priority|TTL -
DNS_AddSRVRecord
Adds a new SRV record for a domain. Fieldvalues must be seperated by a | with sequence Domain name|Host Name|Priority|Weight|Target Host Name|Port|TTL -
DNS_AddTXTRecord
Adds a new TXT record for a domain. Fieldvalues must be seperated by a | with sequence Domain name|Host Name|Text|TTL -
DNS_DeleteDNSDomain
Deletes a DNS record. Fieldvalues must be seperated by a | with sequence Domain name -
DNS_RebuildDNSDomain
Removes and rebuilds all DNS records for a domain. Fieldvalues must be seperated by a | with sequence Domain name -
Domain_CancelPendingUpdate
Cancel pending update -
Domain_Delete
Deletes a specific domain -
Domain_ForceNSUpdate
Force name server update on domain -
Domain_Register
Registers a new domain -
Domain_Renew
Force name server update on domain -
Domain_Select
Retrieves all info for a specific domain -
Domain_SelectAll
Retrieves all active domains for user -
Domain_SelectAllDetailed
Retrieves all active domains for user -
Domain_SelectAll_ByContact
Retrieves all active domains for a specific contact -
Domain_Select_Info
Retrieves all info for a specific domain -
Domain_SendAuthCode
Send Auth Code -
Domain_SendVerification
Send Verification -
Domain_SetAutoRenew
Set auto renew flag on domain -
Domain_SetLock
Set lock on domain -
Domain_SetNameservers
Set name servers on domain -
Domain_SyncDomainInfo
Sync Domain Info -
Domain_Transfer
Transfer domain -
Nameserver_Add
Adds a new name server. Fieldvalues must be seperated by a | with sequence Nameserver|IPv4|IPv6 -
Nameserver_Delete
Deletes a new name server if it is not in use. Fieldvalues must be seperated by a | with sequence Nameserver -
Nameserver_Update
Updates a new name server. Fieldvalues must be seperated by a | with sequence Nameserver|IPv4|IPv6 -
Nameservergroup_Add
Adds a new name server group. Fieldvalues must be seperated by a | with sequence Nameservergroup|Nameserver 1|Nameserver 2|Nameserver 3|Nameserver 4|Nameserver 5. Add an empty string for empty name server in group -
Nameservergroup_Delete
Deletes a new name server if it is not in use. Fieldvalues must be seperated by a | with sequence Nameservergroup -
Nameservergroup_Update
Updates a new name server. Fieldvalues must be seperated by a | with sequence Nameservergroup|IPv4|IPv6 -
SSL_addSSLOrder
Queues order cancellation and refund -
SSL_cancelSSLOrder
Queues order cancellation and refund -
SSL_getAllContacts
Retrieves all certificate contacts -
SSL_getAllOrgs
Retrieves all certificate organisations -
SSL_getAllProducts
Retrieves all SSL products and pricing -
SSL_getOrderStatus
Retrieves order and related status for a certificate -
SSL_getWebservers
Retrieves all available web servers for a product -
SSL_validateCSR
Validates that CSR is correct for given product -
Whitelabel_ActivateUser
Activates a whitelabel user's account. Fieldvalues must be seperated by a | with sequence user name) -
Whitelabel_AddUser
Adds a new whitelabel user. Fieldvalues must be seperated by a | with sequence firstname|lastname|email|address|city|province|postalcode|country|mobile|IDNo|User or Reseller|companyname|tradingname|regno|vatno) -
Whitelabel_CreditAccount
Credits a whitelabel user's account. Fieldvalues must be seperated by a | with sequence user name|Amount) -
Whitelabel_DeactivateUser
Deactivates a whitelabel user's account. Fieldvalues must be seperated by a | with sequence user name) -
Whitelabel_DebitAccount
Debits a whitelabel user's account. Fieldvalues must be seperated by a | with sequence user name|Amount) -
Whitelabel_ResetPassword
Resets a whitelabel user's password. Fieldvalues must be seperated by a | with sequence user name)
This web service is using http://tempuri.org/ as its default namespace.
Recommendation: Change the default namespace before the XML Web service is made public.
Each XML Web service needs a unique namespace in order for client applications to distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.
Your XML Web service should be identified by a namespace that you control. For example, you can use your company's Internet domain name as part of the namespace. Although many XML Web service namespaces look like URLs, they need not point to actual resources on the Web. (XML Web service namespaces are URIs.)
For XML Web services creating using ASP.NET, the default namespace can be changed using the WebService attribute's Namespace property. The WebService attribute is an attribute applied to the class that contains the XML Web service methods. Below is a code example that sets the namespace to "http://microsoft.com/webservices/":
C#
[WebService(Namespace="http://microsoft.com/webservices/")] public class MyWebService { // implementation }
Visual Basic
<WebService(Namespace:="http://microsoft.com/webservices/")> Public Class MyWebService ' implementation End Class
C++
[WebService(Namespace="http://microsoft.com/webservices/")] public ref class MyWebService { // implementation };
For more details on XML namespaces, see the W3C recommendation on Namespaces in XML.
For more details on WSDL, see the WSDL Specification.
For more details on URIs, see RFC 2396.