Object management
This section describes how the information, i.e. the data provided by the reseller and stored in our database, is structured. Instead of having a datasheet for each domain that contains the related contact information, the information is attached to distinct objects. NETIM defines two types of objects: domain objects and contact objects.
Every object is owned by exactly one reseller, namely the reseller that created the object. The owning reseller is the only reseller that can update, delete or retrieve information about an object. In the following sections the different object types are explained in more detail.
Contents |
Domain object
A domain object corresponds to a domain name. For each registered domain name there exists a domain object in our database. Domain objects can be identified by the corresponding domain name and have thus to be registry-uniqu
A domain object is defined with the data defined in StructDomainInfo. These can be obtained for a given domain with function domainInfo
A domain object is always in one and only one of the states listed in the table below
PENDING | The domain name is pending into our system following a registration or an
ingoing transfer |
QUARANTINE | The domain name has been deleted and is now in the quarantine status. (Between dateMaxRenew and dateMaxRestore) |
EXPIRED | The domain name is expired, but not deleted yet (Between dateExpire et dateMaxRenew) |
RESERVED | The domain name is reserved. This can occurs if the domain must be activated
by the owner or onto a waiting list |
ACTIVE | The domain name is registered and active at the registry |
An additionnal information can also be added to this status:
HOLD | The domain name is blocked generally because of an expired status. The
domain name is not functional and can't be updated. |
NOT DELEGATED | The domain name is not published into the DNS. This can occur if no
nameservers are defined or if the domain name is HOLD / EXPIRED |
DELEGATED | The domain name is published into the DNS and is fully functional over Internet |
Contact object
Contact objects are used to hold information about both domain owners and contacts, i.e a contact object is either a contact object holding information about a domain name owner or a contact object holding information about a contact (administrative, technical or billing).
A contact object can be defined with StructContact object. These can be obtained for a given contact with contactInfo function.
A contact object is defined with general information, that are mandatory for each contact, and additional information that are required for the domain name to be used for.
Contact types
A contact object is dedicated to be used as Owner or as domain contact, the distinction is done with the data "IsOwner" of the contact object:
If a contact object is defined as domain contact (idOwner=0), it can't be used as owner If a contact object is defined as owner (idOwner=1), it can't be used as domain contact The reseller ID is by default usable as domain contact If a contact object is defined as domain contact, it can be used as administrative, technical or billing contact for one or several domain names If a contact object is defined as owner, it can be used for one or several domain names according to its version
Contact versions
Note: The information in this section is only relevant for automation via the API
Following an evolution of our system, a version information has been added to the contact objects
An object created with the API <= 1.5 has version 1 and can not be used in the API >= 2.0 An object created with the API >= 2.0 API has version 2 and can not be used in the API <= 1.5
Contact ID
Creating a new contact generates a contact ID into our database. Furthermore, when the contact is used for a domain name, the corresponding registry or registries generate NIC handles for their own system. In general these NIC handles can be seen in the whois information of the domain name. However in any case, the reseller must use the contact ID generated by Netim, not the NIC Handle generated by registries.
Host object
This object corresponds to a nameserver declared at the relevant registry. These are needed if you use your own DNS servers or white labeled ones.
A host is declared directly with its IP address in the registry belonging to the domain name. It therefore has the following information:
string (255) | host | hostname |
ArrayOfString | ipv4 | ipv4 addresses array |
ArrayOfString | ipv6 | ipv6 addresses array |
13 IP adresses are allowed either in ipV4 either in ipV6
Important
They are normally declared implicitly by our system when needed, but you can create them manually with hostCreate function When changing your IPs, you must modify the object with hostUpdate function All registries doesn't manage Host objects The object can not be deleted if it is linked to a domain name
Hosting object
An Hosting object is defined with the data defined in StructHostingInfo. These can be obtained for a given hosting with function hostingInfo
An Hosting object is always in one and only one of the states listed in the table below
EXPIRED | The hosting is expired but not deleted yet (Between dateExpire et dateMaxRenew) |
ACTIVE | The hosting is online |
HOLD | The hosting is disabled |