Table of Contents
Domain management API
Generic reference:
/domain/OPCODE/TLD/SLD/USER_ID/
Where:
OPCODE(operation type) availables values:create,status,check,all,alltld,trans-out-list |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
USER_ID: Your specific id assigned by BDOM system |
Description: Create a new Domain entry into BDOM system
Reference: /bdom/domain/create/TLD/SLD/USER_ID/
Operation Type: PUT
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Validation XSD:
Validator
Example 4.1. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <!-- the contact handles section --> <xs:element name="contact-ids"> <xs:complexType> <xs:all> <xs:element name="owner" type="HandleType"/> <xs:element name="admin" type="HandleType"/> <xs:element name="tech" type="HandleType"/> <xs:element name="zone" type="HandleType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="nameservers" type="NsListType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HostType"> <xs:restriction base="xs:string"> <xs:pattern value="(\w|\.|\-)+\w{2,10}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HandleType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z0-9]+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="NsListType"> <xs:sequence> <xs:element name="ns" maxOccurs="unbounded"> <xs:complexType> <xs:all> <xs:element name="hostname" type="HostType"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
Important | ||
---|---|---|
|
Important | |
---|---|
- NAMESERVERS entry from xml request must contain maximum 5 NS entries |
Example 4.2. Domain Create:valid
REQUEST:
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/create/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
<response><expiration>2010-12-10</expiration></response>
Example 4.3. Domain Create:invalid - data protection missing on predefined contact ACMEA0003
REQUEST:
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/create/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<error-list><umsg>Invalid field protection - - - </umsg><error><code>407</code><msg>[OBJECT_ERROR] Error Invalid field protection - - - [OBJECT_ERROR] Error Error creating contact.</msg></error></error-list>
RESOLUTION:
Update contact and set optional field protection to desired value:YES|NO
Description: Get Status information for a domain registered throught BDOM system
Reference: /bdom/domain/status/TLD/SLD/USER_ID/
Operation Type: GET
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Example 4.4. Domain Status: Valid request
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/status/de/example-nic-domain/13048/)
RESPONSE:
<response > <admin>ACMEA0003</admin> <cr_date>2009-12-10 10:12:58</cr_date> <expiration>2010-12-10 00:00:00</expiration> <nameservers> <nameserver>ns1.ns-serve.net</nameserver> <nameserver>ns2.ns-serve.net</nameserver> </nameservers> <object_id>1414544</object_id> <owner>ACMEA0003</owner> <password></password> <sld>example-nic-domain</sld> <status>OK</status> <tld>de</tld> <tech>ACMEA0003</tech> <user_id>13048</user_id> <zone>ACMEA0003</zone> <is_automatic>1</is_automatic> </response>
Example 4.5. Domain Status: Invalid request - wrong user_id
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/status/de/example-nic-domain/13047/)
RESPONSE:
<error-list> <umsg>Domain belongs to different user or does not exist</umsg> <error> <code>401</code> <msg>[OBJECT_ERROR] Error Domain belongs to different user or does not exist</msg> </error> </error-list>
Description: Check for a specific domain for availability
Reference: /bdom/domain/check/TLD/SLD/USER_ID/
Operation Type: GET
Where:
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
USER_ID: valid id assigned by BDOM system |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Example 4.6. Domain Status: SLD unavailable
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/check/de/denic/13048/)
RESPONSE:
<response><status>unavailable</status></response>
Example 4.7. Domain Status: SLD available
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/check/de/example-nic-domain/13048/)
RESPONSE:
<response><status>available</status></response>
Description: Get all domains registered throught BDOM system for a USER_ID
Reference: /bdom/domain/all/-/-/USER_ID/
Operation Type: GET
Where:
USER_ID: valid id assigned by BDOM system |
Example 4.8. Domain All: Valid request
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/all/-/-/13048/)
RESPONSE:
<response > <sld>example-nic-domain</sld> <tld>de</tld> </response> <multiresponse> <response > <sld>flateweb</sld> <tld>at</tld> </response> <response > <sld>hostingdomaintest</sld> <tld>info</tld> </response> <response > <sld>example-nic-domain</sld> <tld>de</tld> </response> </multiresponse>
Example 4.9. Domain Status: Invalid request - non existent user_id
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/all/-/-/13049/)
RESPONSE:
<error-list> <error> <code>401</code> <msg>[OBJECT_ERROR] Error User not exists</msg> </error> </error-list>
Description: Get all tlds available for operations in BDOM system. This request return up to date list of tld's from BDOM system including the latest aditinos that might not appear in documentation
Reference: /bdom/domain/alltld/-/-/USER_ID/
Operation Type: GET
USER_ID: valid id assigned by BDOM system |
Example 4.10. Domain All: Valid request
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/alltld/-/-/942/)
RESPONSE:
<response> <response > <ord>12</ord> <tld>am</tld> <tld_id>13</tld_id> <transfer>0</transfer> </response> <response > <ord>14</ord> <tld>asia</tld> <tld_id>82</tld_id> <transfer>1</transfer> </response> . . . <response > <ord>207</ord> <tld>ws</tld> <tld_id>12</tld_id> <transfer>1</transfer> </response> </response>
Description: Update a Domain entry from BDOM system
Reference: /bdom/domain/update/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Validation XSD:
Validator
Example 4.11. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="password" type="PasswordType" minOccurs="0"/> <xs:element name="contact-ids"> <xs:complexType> <xs:all> <xs:element name="owner" type="HandleType"/> <xs:element name="admin" type="HandleType"/> <xs:element name="tech" type="HandleType"/> <xs:element name="zone" type="HandleType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="nameservers" type="NsListType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PasswordType"> <xs:restriction base="xs:string"> <xs:pattern value=".{6,50}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HostType"> <xs:restriction base="xs:string"> <xs:pattern value="(\w|\.|\-)+\w{2,10}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HandleType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z0-9]+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="NsListType"> <xs:sequence> <xs:element name="ns" maxOccurs="unbounded"> <xs:complexType> <xs:all> <xs:element name="hostname" type="HostType"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
Important | ||
---|---|---|
|
Important | |
---|---|
- NAMESERVERS entry from xml request must contain maximum 5 NS entries |
Example 4.12. Domain Update:valid - change password
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/update/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <password>multipass</password> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<response>j7yRO9Ge5.xsf</response>
Example 4.13. Domain Update:nameserver error - no dns entry in indicated nameservers related to domain
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/update/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <password>multipass</password> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<error-list> <error> <code>406</code> <msg> response => Nameserver error - ERROR: No SOA record found on server (ns1.ns-serve.net./193.254.189.162, ns2.ns-serve.net./83.243.59.34)407[OBJECT_ERROR] Error Nameserver error - ERROR: No SOA record found on server (ns1.ns-serve.net./193.254.189.162, ns2.ns-serve.net./83.243.59.34) [OBJECT_ERROR] Error Error updating domain. </msg> </error> </error-list>
Description: Update a Domain adding or removing DNS-SEC
Reference: /bdom/domain/update-dnssec/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
Validation XSD:
Validator
Example 4.11-s. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="password" type="PasswordType" minOccurs="0"/> <xs:element name="contact-ids"> <xs:complexType> <xs:all> <xs:element name="owner" type="HandleType"/> <xs:element name="admin" type="HandleType"/> <xs:element name="tech" type="HandleType"/> <xs:element name="zone" type="HandleType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="nameservers" type="NsListType"/> <xs:element name="dnskeys" type="DnskeyListType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="DnskeyType"> <xs:restriction base="xs:string"> <xs:pattern value=".+\.\s\d+\sIN\sDNSKEY\s*(\d+)\s+(\d+)\s+(\d+)\s+(.+)\s*" /> </xs:restriction> </xs:simpleType> <xs:complexType name="DnskeyListType"> <xs:sequence> <xs:element name="dnskey" minOccurs="1" maxOccurs="unbounded" type="DnskeyType" /> </xs:sequence> </xs:complexType> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PasswordType"> <xs:restriction base="xs:string"> <xs:pattern value=".{6,50}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HostType"> <xs:restriction base="xs:string"> <xs:pattern value="(\w|\.|\-)+\w{2,10}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HandleType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z0-9]+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="NsListType"> <xs:sequence> <xs:element name="ns" maxOccurs="unbounded"> <xs:complexType> <xs:all> <xs:element name="hostname" type="HostType"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
Important | ||
---|---|---|
|
Important | |
---|---|
- NAMESERVERS entry from xml request must contain maximum 5 NS entries |
Example 4.12-s. Domain Update-dnssec:valid - add dns-key
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/update-dnssec/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <password>multipass</password> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> <dnskeys> <dnskey>test-secdns.org. 3600 IN DNSKEY 256 3 8 AwEAAb7eE4c6PFpHI0IyM1U23Dimgjt6YlafZlzOkKf42tIlArvGu1lf iSLnzyGvkJlwfzZ4tkpSgKkLiQ6vgKptM7Ij6iCA/fQYRwK0vizWmE5+ pZ0DfBBz+9MU3bGkVhVe4T8YggQvXmQ6gYrYfLHMDJaE2v7bn5VZFMCY ESxFbS/h</dnskey> <dnskey>test-secdns.org. 3600 IN DNSKEY 257 3 8 AwEAAcTGwSzEIZJy/7oAA1+aGt98SX3dwgSkhNevjW1ymT0bruauooPx 3Elxp81hywS/5Y0o+tWybVGeuh/6ec7kSP9m+AGKqcTHtEee1R0WOkKt 73ncrcGncfLMgr5jrYfZRw7jUbAuKtuWDeucRs8VxR1OCQWErFh7+ica x5Q9DSJt8xoAgYDtQSk3Bdv5Kbs/XDr3Pq02in9kvs7Dso3C7S8FwV3w TT8RvearN8am3eLB4bBb/poOZsdu6Yj6ZHvXGCh6vVOhKgx/4nh4B7Ep +NQSgPeTQWIXOEUpFZwCIdek6UMsATNLjT+Z0nnfMFBQvlK8YiaUkPaU CnAoD2asc3M=</dnskey> </dnskeys> </request>
RESPONSE:
<response>j7yRO9Ge5.xsf</response>
Example 4.13-s. Domain Update-dnssec:valid - remove dns-key
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/update-dnssec/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <password>multipass</password> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> <dnskeys> </dnskeys> </request>
RESPONSE:
<response>j7yRO9Ge5.xsf</response>
Description: Delete a Domain entry from BDOM system
Reference: /bdom/domain/delete/TLD/SLD/USER_ID/
Operation Type: DELETE
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Example 4.14. Domain Delete:valid
REQUEST:
Generic Operation: DELETE(http://backend.antagus.de/bdom/domain/delete/de/example-nic-domain/13048/)
RESPONSE:
<response>1</response>
Description: Sends DELETE request to registry for specified DOMAIN on specified date.
Reference: /bdom/domain/delete/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regex see below |
SLD: valid sld for specified tld - for IDN - chars must be UTF8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Validation XSD:
Validator
Example 4.15. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="exec-date" type="xs:date" minOccurs="0"/> <xs:element name="exec-on-expire" type="BoolType" minOccurs="0"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="BoolType"> <xs:restriction base="xs:string"> <xs:enumeration value="YES" /> <xs:enumeration value="NO" /> </xs:restriction> </xs:simpleType> </xs:schema>
Important:
Important | |
---|---|
- required fields for this operation are sld and exec-date - exec-date format YYYY-MM-DD - if exec-date<=now() request will have the same effect as normal DELETE operation. |
Important | ||
---|---|---|
|
Example 4.16. Domain Scheduled DELETE: valid
REQUEST:
- Generic Operation: POST(http://backend.antagus.de/bdom/domain/delete/de/example-nic-domain/942/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <exec-date>2010-01-01</exec-date> </request>
RESPONSE:
<response>3653262</response>*
Note | |
---|---|
- *represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Example 4.17. Domain Scheduled DELETE:invalid - wrong date
REQUEST:
- Generic Operation: POST(http://backend.antagus.de/bdom/domain/delete/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <exec-date>2010-14-01</exec-date> </request>
RESPONSE:
<error-list> <error> <code>406</code> <msg> [XML_ERROR] XML error Validation error: Illegal value '2010-14-01' in element <exec-date>, does not match required pattern. </msg> </error> </error-list>
Description: Transfer a Domain IN BDOM system
Supported TLD: com, net, org, info, de, at, co.at, or.at, name, biz, eu
Reference: /bdom/domain/transfer-in/TLD/SLD/USER_ID/
Operation Type: PUT
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Validation XSD:
Validator
Example 4.18. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="password" type="PasswordType" minOccurs="0"/> <xs:element name="contact-ids"> <xs:complexType> <xs:all> <xs:element name="owner" type="HandleType"/> <xs:element name="admin" type="HandleType"/> <xs:element name="tech" type="HandleType"/> <xs:element name="zone" type="HandleType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="nameservers" type="NsListType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PasswordType"> <xs:restriction base="xs:string"> <xs:pattern value=".{6,50}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HostType"> <xs:restriction base="xs:string"> <xs:pattern value="(\w|\.|\-)+\w{2,10}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HandleType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z0-9]+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="NsListType"> <xs:sequence> <xs:element name="ns" maxOccurs="unbounded"> <xs:complexType> <xs:all> <xs:element name="hostname" type="HostType"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
Important | ||
---|---|---|
|
Important | |
---|---|
- NAMESERVERS entry from xml request must contain maximum 5 NS entries |
Example 4.19. Domain Transfer-IN: valid
REQUEST:
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/transfer-in/de/nic-domain-example/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>nic-domain-example</sld> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<response>676256</response>*
Note | |
---|---|
*represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Example 4.20. Domain Transfer-IN:invalid - wrong xml
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/transfer-in/de/nic-domain-example/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>nic-domain-example</sld> <contact-id> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<error-list> <error> <code>406</code> <msg>[XML_ERROR] XML error Validation error: Found unexpected <contact-id> inside <request>. This is not a valid child element. </msg> </error> </error-list>
Description: Transfer a Domain OUT from BDOM system
Supported TLD: com, net, org, info, de, at, co.at, or.at, name, biz, eu
Reference: /bdom/domain/transfer-out/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^(mobi|es|fr|eu|com|net|org|info|ch|it|de|at|name|li|biz|ws|am|art\.do|bi|biz\.gg|biz\.nr|biz\.tt|bo|by |cg|com\.bo|com\.do|com\.nr|com\.pe|com\.pr|com\.tt|co\.gg|co\.je|co\.tt|cz|ec|gg|gm|gr|gs|gt|info\.gg|info\.nr|info\.tt|je|ki|mn|ms|name\.gg|name\.tt|net\.bo|net\.do|net\.gg|net\.je|net\.nr|net\.pr|net\.tt|nr|org\.bo|org\.do|org\.gg|org\.je|org\.nr|org\.pe|org\.pr|org\.tt|pro\.tt|rw|tc|ug|web\.do|nl|co\.uk|org\.uk|me\.uk|co\.at|or\.at)$/
Validation XSD:
Validator
Validation XSD:
Example 4.21. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="approve" type="BoolType"/> <xs:element name="operation" type="xs:string"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> </xs:schema>
Important | ||
---|---|---|
|
Example 4.22. Domain Transfer-OUT: ACK Operation
Important | |||
---|---|---|---|
Important fields from xml request:
|
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/transfer-out/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <approve>YES</approve> <operation>APPROVE</operation> </request>
RESPONSE:
<response>636936</response>*
Note | |
---|---|
*represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Example 4.23. Domain Transfer-OUT: NACK Operation
Important | |||
---|---|---|---|
Important fields from xml request:
|
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/transfer-out/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <approve>NO</approve> <operation>REJECT</operation> </request>
RESPONSE:
<response>637031</response>*
Note | |
---|---|
*represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Description: Get all domains on TRANSFER-OUT status for a USER_ID
Reference: /bdom/domain/trans-out-list/-/-/USER_ID/
Operation Type: GET
Where:
USER_ID: valid id assigned by BDOM system |
Example 4.24. Domain Transfer-Out-List: Valid request
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/trans-out-list/-/-/13048/)
RESPONSE:
<response> <cr_date>2009-12-16 19:05:58</cr_date> <domain>example-nic-domain.de</domain> <object_id>636936</object_id> <provider>Strato AG</provider> <user_id>13048</user_id> </response>
Example 4.25. Domain Transfer-Out-List: Invalid request - non existent user_id
REQUEST
Generic Operation:
Request: GET(http://backend.antagus.de/bdom/domain/trans-out-list/-/-/130048/)
RESPONSE:
<error-list> <error> <code>401</code> <msg>[OBJECT_ERROR] Error User not exists</msg> </error> </error-list>
Description: Sends HOLD request to registry for specified DOMAIN (operation supported just for .de domains)
Supported TLD: de
Reference: /bdom/domain/hold/TLD/SLD/USER_ID
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regex see below |
SLD: valid sld for specified tld - for IDN - chars must be UTF8 encoded |
/^(de)$/
Validation XSD:
Validator
Example 4.26. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="disconnect" type="BoolType"/> <xs:element name="exec-date" type="xs:date" minOccurs="0"/> <xs:element name="exec-on-expire" type="BoolType" minOccurs="0"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="BoolType"> <xs:restriction base="xs:string"> <xs:enumeration value="YES" /> <xs:enumeration value="NO" /> </xs:restriction> </xs:simpleType> </xs:schema>
Important | ||
---|---|---|
|
Important:
Important | |
---|---|
- required fields for this operation are sld and disconnect - disconect available values are (YES/NO) |
Example 4.27. Domain HOLD: valid
REQUEST:
- Generic Operation: POST(http://backend.antagus.de/bdom/domain/hold/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> <disconnect>YES</disconnect> </request>
RESPONSE:
<response>637542</response>*
Note | |
---|---|
- *represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Example 4.28. Domain HOLD:invalid - xml fails validation
REQUEST:
- Generic Operation: POST(http://backend.antagus.de/bdom/domain/hold/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>nic-test</sld> <disconnect>YES</disconect> </request>
RESPONSE:
<error-list> <error> <code>406</code> <msg>[XML_ERROR] XML error Validation error: Found unexpected <disconnect> inside <request>. This is not a valid child element. </msg> </error> </error-list>
Description: Send TRADE request to registry for specified DOMAIN (operation supported just for .eu domains)
Supported TLD: eu
Reference: /bdom/domain/trade/TLD/SLD/USER_ID
Operation Type: PUT
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regex see below |
SLD: valid sld for specified tld - for IDN - chars must be UTF8 encoded |
/^(eu)$/
Validation XSD:
Validator
Example 4.29. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> <xs:element name="password" type="PasswordType" minOccurs="0"/> <xs:element name="contact-ids"> <xs:complexType> <xs:all> <xs:element name="owner" type="HandleType"/> <xs:element name="admin" type="HandleType"/> <xs:element name="tech" type="HandleType"/> <xs:element name="zone" type="HandleType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="nameservers" type="NsListType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PasswordType"> <xs:restriction base="xs:string"> <xs:pattern value=".{6,50}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HostType"> <xs:restriction base="xs:string"> <xs:pattern value="(\w|\.|\-)+\w{2,10}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="HandleType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z0-9]+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="NsListType"> <xs:sequence> <xs:element name="ns" maxOccurs="unbounded"> <xs:complexType> <xs:all> <xs:element name="hostname" type="HostType"/> </xs:all> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
Important | ||
---|---|---|
|
Important | |
---|---|
- NAMESERVERS entry from xml request must contain maximum 5 NS entries |
Example 4.30. Domain Trade: valid
REQUEST:
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/trade/eu/nic-domain-example/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>nic-domain-example</sld> <contact-ids> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<response>676956</response>*
Note | |
---|---|
*represents BDOM internal object ID - based on this id request can be traced with TaskList request |
Example 4.31. Domain Trade:invalid - xml fails validation
Generic Operation: PUT(http://backend.antagus.de/bdom/domain/trade/eu/nic-domain-example/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>nic-domain-example</sld> <contact-id> <owner>ACMEA0003</owner> <admin>ACMEA0003</admin> <tech>ACMEA0003</tech> <zone>ACMEA0003</zone> </contact-ids> <nameservers> <ns> <hostname>ns1.ns-serve.net</hostname> </ns> <ns> <hostname>ns2.ns-serve.net</hostname> </ns> </nameservers> </request>
RESPONSE:
<error-list> <error> <code>406</code> <msg>[XML_ERROR] XML error Validation error: Found unexpected <contact-id> inside <request>. This is not a valid child element.</msg> </error> </error-list>
Description: Set the authorization information needed by .DE and .EU domain transfers
Reference: /bdom/domain/set-auth/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^de|eu$/
Validation XSD:
Validator
Example 4.32. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> </xs:schema>
Important | |
---|---|
|
Example 4.33. Domain set-auth:valid
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/set-auth/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> </request>
RESPONSE:
<response>CROki6gF4tGD8jyheko75djmJtR6jN8d</response>
Example 4.34. Domain set-auth: wrong tld
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/set-auth/com/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> </request>
RESPONSE:
<error-list> <error> <code>407</code> <msg> response => Operation not supported for this type and TLD [TLD: COM] [TYPE: Domain] [OPCODE: SET-AUTH]407[OBJECT_ERROR] Error Operation not supported for this type and TLD [TLD: COM] [TYPE: Domain] [OPCODE: SET-AUTH] </msg> </error> </error-list>
Description: Clears the authorization information needed by .DE domain transfers
Reference: /bdom/domain/reset-auth/TLD/SLD/USER_ID/
Operation Type: POST
Where:
USER_ID: valid id assigned by BDOM system |
TLD: valid tld available in BDOM system - for regexp see below |
SLD: valid sld for the specified tld - for IDN - chars must be UTF-8 encoded |
/^de$/
Validation XSD:
Validator
Example 4.35. Domain Validation XSD:
Source:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified"> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="sld" type="SldType"/> </xs:all> </xs:complexType> </xs:element> <xs:simpleType name="SldType"> <xs:restriction base="xs:string"> <xs:pattern value="\w[\w\-]{0,62}(\.\w[\w\-]{0,62})?" /> </xs:restriction> </xs:simpleType> </xs:schema>
Important | |
---|---|
|
Example 4.36. Domain reset-auth:valid
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/reset-auth/de/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> </request>
RESPONSE:
<response>OK</response>
Example 4.37. Domain reset-auth: wrong tld
REQUEST:
Generic Operation: POST(http://backend.antagus.de/bdom/domain/reset-auth/com/example-nic-domain/13048/,xml)
Where xml:
<?xml version="1.0" encoding="UTF-8"?> <request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sld>example-nic-domain</sld> </request>
RESPONSE:
<error-list> <error> <code>407</code> <msg> response => Operation not supported for this type and TLD [TLD: COM] [TYPE: Domain] [OPCODE: SET-AUTH]407[OBJECT_ERROR] Error Operation not supported for this type and TLD [TLD: COM] [TYPE: Domain] [OPCODE: SET-AUTH] </msg> </error> </error-list>