Professional Documents
Culture Documents
Table of Contents
Introduction.......................................................................................16
Purpose..........................................................................................16
Audience.........................................................................................17
Using HTTPS Post to Access OpenSRS....................................................17
Authenticating with the OpenSRS API.................................................17
Testing environment.........................................................................17
Connection Information.....................................................................18
MD5 authentication........................................................................18
Construction of the POST Data...........................................................18
Response Messages..........................................................................19
Troubleshooting HTTPS Post...............................................................20
OpenSRS protocol...............................................................................21
Protocol message structure................................................................21
OPS message examples....................................................................25
Semantic validity and API implementation...........................................27
Submitting API commands without end-user credentials...........................30
Required parameter.......................................................................30
Potential issues................................................................................31
Not permitted: apply_to_all flag.................................................31
Incorrect credentials.................................................................31
Writing Your Own Client.......................................................................32
XML client protocol fundamentals.......................................................32
MD5 Examples.................................................................................32
Coding Examples..............................................................................34
Perl example.................................................................................34
PHP example................................................................................38
VB6 example................................................................................39
VB .NET example...........................................................................44
Java example................................................................................45
Data exchange.................................................................................51
Authentication handshake.................................................................52
Encryption.......................................................................................54
Reseller Agent Return Codes..............................................................55
Purchasing Trust Services..................................................................59
Before you begin...........................................................................60
Submitting a Trust Service SSL certificate order.................................60
Purchasing goMobi Services...............................................................61
Integrating with OpenSRS..............................................................61
Publishing Service API error response codes......................................62
Contact Set........................................................................................64
Examples for contact set...................................................................65
2
Domain contacts..............................................................................67
Default contact requirements..........................................................73
EPP contact requirements...............................................................74
.BE owner and tech contact requirements.........................................75
.CA owner, admin, and tech contact requirements..............................75
.DE admin contact requirements......................................................77
.DE owner contact requirements......................................................77
.DE zone and tech contact requirements...........................................78
.ES postal codes............................................................................79
.EU owner and tech contact requirements.........................................80
.IT contact requirements................................................................81
.MX contact requirements...............................................................83
.PRO contact requirements.............................................................84
.UK transfer-no change-admin contact requirements..........................84
.UK contact requirements...............................................................85
Trust Service contacts....................................................................86
Trust Service Admin, Billing, Signer and Tech contact requirements......88
Trust Service Organization contact requirements................................89
TLD Data........................................................................................90
.AERO registrant_extra_info............................................................90
.ASIA ced_info..............................................................................91
.AU au_registrant_info...................................................................92
.CL registrant_extra_info................................................................96
.COM.AR, .PT, and .COM.PT registrant_extra_info..............................97
.COM.BR tld_data..........................................................................97
.COOP registrant_extra_info...........................................................98
.DE registrant_extra_info................................................................98
.DK registrant_extra_info...............................................................99
.FI. MY, and .SG registrant_extra_info..............................................99
.FR registrant_extra_info..............................................................100
.HK registrant_extra_info..............................................................102
.HU, and .CO.HU registrant_extra_info...........................................102
.IT it_registrant_info....................................................................103
.JOBS registrant_extra_info..........................................................105
.LV and .COM.LV registrant_extra_info............................................106
.MX, .COM.MX, and .CO.ZA registrant_extra_info.............................107
.NO registrant_extra_info.............................................................107
.NYC registrant_extra_info............................................................108
.PM, .RE, .TF, .WF, and .YT registrant_extra_info..............................108
.PRO professional_data.................................................................110
.RO, and .COM.RO registrant_extra_info.........................................110
.RU registrant_extra_info..............................................................111
.SE and .NU registrant_extra_info..................................................113
.TRAVEL registrant_extra_info.......................................................114
.US nexus...................................................................................114
.XXX ipr_data..............................................................................115
Lookup Commands............................................................................117
belongs_to_rsp..............................................................................119
Request parameters for belongs_to_rsp..........................................119
Response parameters for belongs_to_rsp........................................119
Examples for belongs_to_rsp.........................................................120
cira_email_pwd..............................................................................123
Request parameters for cira_email_pwd..........................................123
Response parameters for cira_email_pwd........................................123
Examples for cira_email_pwd........................................................124
get_balance...................................................................................126
Request parameters for get_balance..............................................126
Response parameters for get_balance............................................126
Examples for get_balance.............................................................127
get_ca_blocker_list.........................................................................129
Request parameters for get_ca_blocker_list....................................129
Response parameters for get_ca_blocker_list..................................130
Examples for get_ca_blocker_list...................................................131
get_cert........................................................................................133
Request parameters for get_cert....................................................133
Response parameters for get_cert..................................................134
Examples for get_cert..................................................................136
get_contract..................................................................................149
Request parameters for get_contract..............................................149
Response parameters for get_contract............................................149
Examples for get_contract............................................................150
get_deleted_domains......................................................................152
Request parameters for get_deleted_domains.................................152
Response parameters for get_deleted_domains...............................154
Examples for get_deleted_domains................................................155
get (domain).................................................................................158
Request parameters for get (domain).............................................158
Response parameters for get (domain)...........................................161
Get domain examples...................................................................171
For type = admin or tech.........................................................171
For type = all_info..................................................................178
For type = ca_whois_display_setting.........................................190
For type = domain_auth_info...................................................191
For type = expire_action.........................................................193
For type = forwarding_email....................................................195
For type = list........................................................................197
For type = nameservers..........................................................200
For type = owner, admin, billing, or tech....................................202
For type = rsp_whois_info.......................................................203
For type = status....................................................................207
For type = tld_data.................................................................209
For type = waiting history........................................................220
For type = whois_privacy_state................................................222
4
request_on_demand_scan...............................................................501
Request parameters for request_on_demand_scan...........................501
Response parameters for request_on_demand_scan.........................501
Examples for request_on_demand_scan.........................................502
resend_approve_email....................................................................506
Request parameters for resend_approve_email................................506
Response parameters for resend_approve_email..............................506
Examples for resend_approve_email..............................................507
resend_cert_email..........................................................................509
Request parameters for resend_cert_email......................................509
Response parameters for resend_cert_email....................................509
Examples for resend_cert_email....................................................510
revoke (domain).............................................................................512
Request parameters for revoke (domain)........................................512
Response parameters for revoke (domain)......................................513
Examples for revoke (domain).......................................................513
send_CIRA_approval_email..............................................................516
Request parameters for send_CIRA_approval_email.........................516
Response parameters for send_CIRA_approval_email.......................517
Examples for send_CIRA_approval_email........................................517
send_registrant_verification_email....................................................519
Request parameters for send_registrant_verification_email...............519
Response parameters for send_registrant_verification_email.............519
Examples for send_registrant_verification_email..............................520
set_domain_affiliate_id...................................................................522
Request parameters for set_domain_affiliate_id...............................522
Response parameters for set_domain_affiliate_id.............................522
Examples for set_domain_affiliate_id.............................................523
sw_register (domain or trust_service)...............................................525
Request parameters for sw_register (domain or trust_service)...........525
Nameserver pair.....................................................................532
.BE registrations and transfers..................................................533
.CA registrations.....................................................................534
.EU registrations and transfers.................................................536
.IT transfers...........................................................................538
.MOBI registrations.................................................................538
.NAME registrations................................................................539
Trust Service orders................................................................540
Response parameters for sw_register (domain or trust_service).........548
Domain registration examples.......................................................550
For domain = .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, and .MOBI
............................................................................................550
For domain = .AERO...............................................................558
For domain = .ASIA................................................................562
For domain = .AU...................................................................564
For domain = .CA...................................................................567
For domain = .DE...................................................................573
For domain = .DK...................................................................576
8
process_transfer............................................................................795
Request parameters for process_transfer........................................795
Response parameters for process_transfer......................................795
Examples for process_transfer.......................................................796
rsp2rsp_push_transfer....................................................................798
Request parameters for rsp2rsp_push_transfer................................798
Response parameters for rsp2rsp_push_transfer..............................799
Examples for rsp2rsp_push_transfer..............................................799
send_password (transfer)................................................................802
Request parameters for send_password (transfer)............................802
Response parameters for send_password (transfer)..........................802
Examples for send_password (transfer)..........................................803
trade_domain................................................................................805
Request parameters for trade_domain............................................805
Response parameters for trade_domain..........................................806
Examples for trade_domain...........................................................807
Bulk Changes Commands...................................................................815
bulk_transfer.................................................................................816
Request parameters for bulk_transfer (domains)..............................816
Response parameters for bulk_transfer (domains)............................817
Examples for bulk_transfer (domains)............................................818
submit (bulk_change).....................................................................822
Request parameters for submit (bulk_change).................................823
Response parameters for submit (bulk_change)...............................832
Examples for submit (bulk_change)...............................................832
submit_bulk_change (WHOIS Privacy)...............................................849
Request parameters for submit_bulk_change...................................849
Response parameters for submit_bulk_change.................................850
Examples for submit_bulk_change.................................................850
Nameserver Commands.....................................................................852
advanced_update_nameservers........................................................853
Request parameters for advanced_update_nameservers...................853
Response parameters for advanced_update_nameservers.................854
Examples for advanced_update_nameservers..................................855
create (nameserver).......................................................................858
Request parameters for create (nameserver)...................................858
Response parameters for create (nameserver).................................859
Examples for create (nameserver).................................................859
delete (nameserver).......................................................................868
Request parameters for delete (nameserver)...................................868
Response parameters for delete (nameserver).................................869
Examples for delete (nameserver).................................................869
get (nameserver)...........................................................................873
Request parameters for get (nameserver).......................................873
Response parameters for get (nameserver).....................................873
Examples for get (nameserver)......................................................875
11
modify (nameserver)......................................................................880
Request parameters for modify (nameserver)..................................880
Response parameters for modify (nameserver)................................881
Examples for modify (nameserver).................................................881
registry_add_ns.............................................................................885
Request parameters for registry_add_ns.........................................885
Response parameters for registry_add_ns.......................................886
Examples for registry_add_ns.......................................................887
registry_check_nameserver.............................................................890
Request parameters for registry_check_nameserver.........................890
Response parameters for registry_check_nameserver.......................891
Examples for registry_check_nameserver.......................................891
DNS Zone Commands........................................................................895
create_dns_zone............................................................................896
Request parameters for create_dns_zone........................................896
Response parameters for create_dns_zone......................................898
Examples for create_dns_zone......................................................901
delete_dns_zone............................................................................906
Request parameters for delete_dns_zone........................................906
Response parameters for delete_dns_zone......................................906
Examples for delete_dns_zone......................................................907
force_dns_nameservers..................................................................909
Request parameters for force_dns_nameservers..............................909
Response parameters for force_dns_nameservers............................909
Examples for force_dns_nameservers.............................................910
get_dns_zone................................................................................912
Request parameters for get_dns_zone............................................912
Response parameters for get_dns_zone..........................................912
Examples for get_dns_zone..........................................................915
reset_dns_zone..............................................................................919
Request parameters for reset_dns_zone.........................................919
Response parameters for reset_dns_zone.......................................919
Examples for reset_dns_zone........................................................922
set_dns_zone................................................................................928
Request parameters for set_dns_zone............................................928
Response parameters for set_dns_zone..........................................932
Examples for set_dns_zone...........................................................934
Domain Forwarding Commands...........................................................941
create_domain_forwarding..............................................................942
Request parameters for create_domain_forwarding..........................942
Response parameters for create_domain_forwarding........................942
Examples for create_domain_forwarding.........................................943
delete_domain_forwarding...............................................................945
Request parameters for delete_domain_forwarding..........................945
Response parameters for delete_domain_forwarding........................945
Examples for delete_domain_forwarding.........................................946
12
get_domain_forwarding...................................................................948
Request parameters for get_domain_forwarding..............................948
Response parameters for get_domain_forwarding............................948
Examples for get_domain_forwarding.............................................950
set_domain_forwarding...................................................................955
Request parameters for set_domain_forwarding...............................955
Response parameters for set_domain_forwarding.............................957
Examples for set_domain_forwarding.............................................957
User Commands................................................................................961
add (subuser)................................................................................962
Request parameters for add (subuser)............................................962
Response parameters for add (subuser)..........................................963
Examples for add (subuser)..........................................................963
delete (subuser).............................................................................965
Request parameters for delete (subuser)........................................965
Response parameters for delete (subuser)......................................965
Examples for delete (subuser).......................................................967
get (subuser).................................................................................969
Request parameters for get (subuser)............................................969
Response parameters for get (subuser)..........................................969
Examples for get (subuser)...........................................................970
get (userinfo)................................................................................972
Request parameters for get (userinfo)............................................972
Response parameters for get (userinfo)..........................................972
Examples for get (userinfo)...........................................................975
modify (subuser)............................................................................978
Request parameters for modify (subuser).......................................978
Response parameters for modify (subuser).....................................979
Examples for modify (subuser)......................................................979
Authentication Commands..................................................................981
change (ownership)........................................................................982
Request parameters for change (ownership)....................................982
Response parameters for change (ownership)..................................983
Examples for change (ownership)..................................................983
change (password).........................................................................985
Request parameters for change (password).....................................985
Response parameters for change (password)...................................985
Examples for change (password)...................................................986
send_authcode...............................................................................988
Request parameters for send_authcode..........................................988
Response parameters for send_authcode........................................988
Examples for send_authcode.........................................................989
send_password (domain).................................................................991
Request parameters for send_password (domain)............................991
Response parameters for send_password (domain)..........................992
Examples for send_password (domain)...........................................992
13
Cookie/Session Commands.................................................................994
delete (cookie)...............................................................................995
Request parameters for delete (cookie)..........................................995
Response parameters for delete (cookie)........................................995
Examples for delete (cookie).........................................................996
quit (session).................................................................................998
Request parameters for quit (session)............................................998
Response parameters for quit (session)..........................................998
Examples for quit (session)...........................................................998
set (cookie).................................................................................1000
Request parameters for set (cookie).............................................1000
Response parameters for set (cookie)...........................................1001
Examples for set (cookie)............................................................1002
update (cookie)............................................................................1005
Request parameters for update (cookie)........................................1005
Response parameters for update (cookie)......................................1005
Examples for update (cookie)......................................................1006
WHOIS Privacy Command.................................................................1009
change_wp_expiry_date................................................................1010
Request parameters for change_wp_expiry_date............................1010
Response parameters for change_wp_expiry_date..........................1011
Examples for change_wp_expiry_date..........................................1011
Publishing Service Commands...........................................................1013
create_alias.................................................................................1014
Request parameters for create_alias.............................................1014
Response parameters for create_alias...........................................1014
Examples for create_alias...........................................................1015
create (publishing)........................................................................1017
Request parameters for create (publishing)...................................1017
Response parameters for create (publishing).................................1018
Examples for create (publishing)..................................................1018
delete_alias.................................................................................1021
Request parameters for delete_alias.............................................1021
Response parameters for delete_alias...........................................1021
Examples for delete alias............................................................1022
delete (publishing)........................................................................1024
Request parameters for delete (publishing)...................................1024
Response parameters for delete (publishing).................................1024
Examples for delete (publishing)..................................................1025
disable (publishing).......................................................................1027
Request parameters for disable (publishing)..................................1027
Response parameters for disable (publishing)................................1027
Examples for disable (publishing).................................................1028
enable (publishing).......................................................................1030
Request parameters for enable publishing.....................................1030
Response parameters for enable publishing...................................1030
14
15
Introduction
Welcome to the OpenSRS API guide for the registration and management of
domain names and domain related services. This document is intended for
OpenSRS Resellers who offer domains and supporting services to their
customers.
Using this document, you can provide OpenSRS functionality to your
customers by integrating the API commands into your website that can send
XML requests to OpenSRS over HTTPS Post. You can also use the API
commands to run queries or automate tasks you would otherwise perform
manually using the OpenSRS Reseller Web Interface (RWI).
You can leverage the API to allow registrants to view and update their
contact details, nameservers, transfer Authcodes, domain locking, whois
privacy, and username and password settings. Additionally, the API can be
used to perform domain availability lookups, provide domain search
suggestions and aftermarket domain lookups, as well as process
registrations, transfers, and renewals.
Registrants are set up with a profile in which multiple domains can be stored.
A profile is defined by a username, password, and one of the domains in the
profile. When requesting information or updating domain information, an
authorization cookie needs to be requested first using a domain in the profile
and the username and password for the profile. The cookie is then submitted
with the request to look up or modify a domain's details, as well as when
changing name servers assigned to a registered domain. For information on
submitting commands without using a cookie, see Submitting API
commands with end-user credentials.
Purpose
The method of sending commands to OpenSRS using HTTPS Post supports
communication between a client process and the OpenSRS system. This
document describes how to formulate the XML commands and how to use
HTTPS Post to send the XML commands to OpenSRS.
Using this document as a reference, you can use any programming language
to write an implementation that supports this communication. If you are
writing your own implementation, please refer to the "Design Considerations"
section.
The process for executing commands consists of formulating the command in
XML and sending it to OpenSRS via HTTPS Post. This guide outlines the basic
method for creating the XML in a format usable by OpenSRS and includes
some language-specific methods.
The protocol assumes that the client process that is requesting an action
waits for a result from the server process in response to the requested
action. The protocol does not support session tracking.
16
Audience
This document assumes that you are familiar with XML document design and
the methods for sending data via HTTPS Post.
Testing environment
OpenSRS provides a full test environment to assist with developing and
testing API integration. The Horizon test environment duplicates the
functionality of the Live environment, and is connected to the test
environments of all the registry platforms.
Transactions on Horizon are not real in other words, if you register a
domain using Horizon, it is registered on the test environment of the registry
in question, but the domain does not resolve. Your Horizon account is funded
with money to simulate payment for transactions you perform. If you
required additional testing funds, you can contact Reseller Support.
The Test environment API also requires a private key, but unlike the Live
environment, it doesn't require you to authorize your IP address.
17
Connection Information
Live production environment
Server: rr-n1-tor.opensrs.net/
Port: 55443
MD5 authentication
The MD5 Signature provides the authentication required by OpenSRS. The
process involves two steps:
Obtain an MD5 signature of the XML Content and the Private Key.
Note: The XML and the Private Key are concatenated.
Perform another MD5 of the signature from Step 1 with the Private
Key.
Note: The MD5 Signature from Step 1 and the Private key are
concatenated.
See the section "Writing Your Own Client" for examples of adding an MD5
Signature and creating the XML packet.
Following this header should be one blank line followed by the XML document
that contains the OpenSRS command data. The header combined with the
XML makes up the packet that is sent to OpenSRS to execute your command.
This packet is what is sent to the server and port listed above, depending on
your environment, to execute the command.
For more information regarding the transmission of data over HTTPS, refer to
this document: http://www.ietf.org/rfc/rfc2616.txt
18
Response Messages
The process returns a response message to a client in answer to an action
that was executed on its behalf. Responses contain data appropriate for the
action that was executed. In some cases, this may be simple strings; in other
cases, this may be lists of information. This response is returned in the form
of an XML document.
Common fields
There are a few common fields that all responses share, regardless of the
action to which they are responding. The following fields comprise a standard
response message. Some actions only use standard response messages.
Parameter
name
Definition/Value
protocol
action
response_code
response_text
is_success
Optional fields
In addition, the structure may contain the following fields, depending on the
specific action that was requested.
Parameter
name
Definition/Value
attributes
19
Check that you are using the correct Private Key for the right system
Horizon or Production.
Check that you have the correct RSP username.
Check that the IP address of the machine transmitting the data to the
OpenSRS server is in your list of allowed IP addresses in the Reseller
Web Interface.
If the above checks are correct, the problem is with the MD5:
Ensure that you have concatenated the XML content and the Private
Key.
Ensure that you have performed an MD5 twice. See the MD5 section
for more information.
Ensure that your HTTP Post implementation is not adding any extra
information. Some implementations of HTTP Post add a NULL to the
end of the HTTP Request. This is reflected in the MD5 and causes an
authentication error.
If you are still not connecting properly, check the result of the MD5
Hash:
Some MD5 algorithms put the MD5 hash in uppercase. Make sure that
the result is in lowercase before sending it to OpenSRS.
Some MD5 algorithms need to convert the string to bytes before
generating the hash. Make sure this is done properly. You can test your
script by performing an MD5 on the following text:
Text:
ConnecttoOpenSRSviaSSL
MD5 Result:
e787cc1d1951dfec4827cede7b1a0933
20
OpenSRS protocol
Purpose
The purpose of the OpenSRS Protocol (OPS) is to support the passing of
messages between processes in the OpenSRS Architecture.
Design considerations
The OPS uses XML-based messages. By using a meta language to describe
the protocol, it can remain programming language-neutral.
Any appropriate transport mechanism can be used to pass OPS protocol
messages between processes, provided the message is reassembled
precisely on the receiving end. Discussion of transport mechanisms is outside
the scope of this document.
Process flow
When a process sends a message to another process, it generates an OPS
protocol message that represents the data being sent. The OPS message is
then passed to the other process, which can act on it as required and return
any information that is needed (again, as a protocol message).
The generation of protocol messages is done with an API that is written for
the particular programming language being used (for example, Perl or C++).
The API handles the details of encoding and decoding protocol messages
from and to appropriate data structures for the language being used.
-->
<!-- Envelope -->
<!ELEMENT OPS_envelope (header,body)>
<!-- header part -->
<!ELEMENT header (version)>
<!-- body part -->
<!ELEMENT body (data_block)>
<!-- data block -->
<!ELEMENT data_block (dt_assoc | dt_array |
dt_scalar| dt_scalarref)>
<!-- data types -->
<!ELEMENT dt_assoc (dt_assoc | dt_array|
dt_scalar | dt_scalarref|
(item)*)>
<!ELEMENT dt_array (dt_assoc | dt_array |
dt_scalar | dt_scalarref |
(item)*)>
<!ELEMENT dt_scalar (#PCDATA | dt_assoc | dt_array |
dt_scalar | dt_scalarref)*>
<!ELEMENT dt_scalarref (#PCDATA | dt_assoc | dt_array |
dt_scalar | dt_scalarref)*>
<!ELEMENT item (#PCDATA |
dt_assoc | dt_array |
dt_scalar | dt_scalarref)*>
<!ATTLIST item
key
CDATA #REQUIRED
>
22
Description
The preamble of an OPS message must contain encoding and DOCTYPE
information specifying the correct DTD (ops.dtd).
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
A message consists of two basic parts: a header and a body. The header is
delimited by <header> and </header> and contains information that is
related to protocol transport. Currently the OPS protocol version is
supported. It is delimited by <version> and </version> tags.
The body is delimited by <body> and </body> tags. Currently the body can
only contain one component, which is the 'data_block'. The data block
contains an XML representation of a data structure, which in turn contains
the information being passed by the process. The data block is delimited by
<data_block> and </data_block> tags.
Example
<OPS_envelope>
<header>
?
</header>
<body>
<data_block>
?
</data_block>
</body>
</OPS_envelope>
The data structure within the data block is a represented according to data
type. The following data types are supported:
Data type
Definition/Value
associative
<dt_assoc></dt_assoc>
23
Data type
Definition/Value
array (hash)
array
<dt_array></dt_array>
array or
associative
array elements
scalars (for
example,
strings,
integers)
<dt_scalar></dt_scalar>
Data types can be arbitrarily nested. For example, you could have an array of
an array of associative arrays. Any complex data type can be represented,
provided the base data type is an array or an associative array.
24
Example 2
This example shows an OPS message that encodes an associative array that
contains other associative arrays:
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>1.0</version>
</header>
25
<body>
<data_block>
<dt_assoc>
<dt_assoc>
<item key='owner'>
<dt_assoc>
<item key='first_name'>Tom</item>
<item key='last_name'>Jones</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Anne</item>
<item key='last_name'>Smith</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
This example shows an OPS message that encodes a scalar value:
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>1.0</version>
</header>
<body>
<data_block>
<dt_scalar>Tom Jones</dt_scalar>
</data_block>
26
</body>
</OPS_envelope>
Alternatively,
let MSG A' := encode (MSG A)
then MSG A
Example 1
The following two data blocks are considered semantically the same. Notice
that the order of elements is not the same, but the key values allow the data
blocks to be decoded into the same memory structure (array).
MSG A
<data_block>
<dt_assoc>
<item key='domain_list'>
<dt_array>
<item key='0'>ns1.example.com</item>
<item key='1'>ns2.example.com</item>
<item key='2'>ns3.example.com</item>
27
</dt_array>
</dt_assoc>
</data_block>
MSG B
<data_block>
<dt_assoc>
<item key='domain_list'>
<dt_array>
<item key='2'>ns3.example.com</item>
<item key='1'>ns2.example.com</item>
<item key='0'>ns1.example.com</item>
</dt_array>
</dt_assoc>
</data_block>
Example 2
The following two data blocks are considered semantically the same. Notice
that the order of fields is not the same, but the key values allow the data
blocks to be decoded into the same memory structure (associative array).
MSG A
<data_block>
<dt_assoc>
<item key='first_name'>Tom</item>
<item key='last_name'>Jones</item>
</dt_assoc>
</data_block>
MSG B
<data_block>
<dt_assoc>
<item key='last_name'>Jones</item>
<item key='first_name'>Tom</item>
</dt_assoc>
</data_block>
28
29
Required parameter
When you submit API commands without end-user credentials, you must
include the domain parameter to identify the domain that will be affected by
the command.
Example
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="data">nexus_info</item>
....
30
Potential issues
Not permitted: apply_to_all flag
The apply_to_all flag is normally used to apply a change to all domains in
the Reseller's profile; however, you cannot use the apply_to_all flag when
you submit commands without credentials. If you submit the apply_to_all
flag without credentials, the command will fail.
Incorrect credentials
If end-user credentials are submitted, but they are incorrect, the command
will fail.
31
Example
Content-length: 55\015\012
XCP allows empty space to be placed in the XML message, as long as the
XML is still valid, so empty lines or end-of-line characters may be inserted
(though they must be counted in the byte count).
For more information regarding the transmission of data over HTTPS, refer to
this document: http://www.ietf.org/rfc/rfc2616.txt
MD5 Examples
The following examples show how to add an MD5 Signature and create an XML packet
for the various client languages.
PERL
use Digest::MD5 qw/md5_hex/;
md5_hex(md5_hex($xml, $private_key),$private_key)
32
PHP
md5(md5($xml.$private_key).$private_key);
VB6
Using the di_MD5DLL.dll from DI Management
This free cryptographic software code was written or adapted in Visual Basic
and ANSI C by David Ireland.
http://www.di-mgt.com.au/crypto.html#MD5
Private Declare Function MakeMD5Digest Lib "di_MD5DLL.dll" _
(ByVal sData As String, ByVal sDigest As String) As Long
Public Function MD5Encode(ByVal sData As String) As String
Dim iRet As Long
Dim sDigest As String
' Set sDigest to be 32 chars
sDigest = String(32, " ")
iRet = MakeMD5Digest(sData, sDigest)
MD5Encode = Trim(sDigest)
End Function
VB .NET
Public Function cMD5(ByVal str As String) As String
'Must have Imports System.Web.Security in General Declarations
Dim Hash As String =
FormsAuthentication.HashPasswordForStoringInConfigFile(str, "MD5")
Return Hash.ToLower
End Function
JAVA
protected String md5Sum(String str) {
String sum = new String();
33
try {
MessageDigest md5 = MessageDigest.getInstance("MD5");
sum = String.format("%032x", new BigInteger(1,
md5.digest(str.getBytes())));
} catch (Exception ex) {
}
return sum;
}
public String getSignature(String xml) {
return md5Sum(md5Sum(xml + privateKey) + privateKey);
}
Coding Examples
Perl example
#!/usr/bin/perl
use strict;
use warnings;
########################################################
# Example script that takes registrant credentials in
# from CGI variables and pulls all info about a domain.
# A cookie is requested via a subroutine and is the
# first of two calls to the API. The second is the query
# for the domain's information.
########################################################
## Reseller Configuration Variables
my $rspusername = 'username'; # Your OpenSRS Reseller User Name
my $private_key='privatekey'; # Your Private Key Generated In The RWI
## Connection Location:
my $REMOTE_HOST = "horizon.opensrs.net:55443";
## CGI Variable Handling Definitions
use vars qw(%in $cgi);
( %in, $cgi) = ();
# Required Perl Modules
34
<item key='cookie'>$cookie</item>
<item key='attributes'>
<dt_assoc>;
<item key='type'>all_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>";
# Connection And Post To OpenSRS API For Domain Info
my $request = POST (
"https://$REMOTE_HOST",
'Content-Type' => 'text/xml',
'X-Username' => $rspusername,
'X-Signature' => md5_hex(md5_hex($xml, $private_key), $private_key),
'Content' => $xml);
my $response = $ua -> request($request);
## Response Handling
#
my $hashresponse = $xmltohash->XMLin($response->{'_content'});
# Return Of Cookie Value From Hash
return ($hashresponse->{'body'}->{'data_block'}->{'dt_assoc'}>{'item'}->{'attributes'}->{'dt_assoc'}->{'item'}->{'cookie'}>{'content'});
}
PHP example
<html>
<body>
<?php
$username = "RSPUsername";
$private_key = "PrivateKey";
$signature = md5(md5($xml.$private_key).$private_key);
$host = "horizon.opensrs.net";
$port = 55443;
$url = "/";
$header = "";
$header .= "POST $url HTTP/1.0\r\n";
$header .= "Content-Type: text/xml\r\n";
$header .= "X-Username: " . $username . "\r\n";
$header .= "X-Signature: " . $signature . "\r\n";
$header .= "Content-Length: " . strlen($xml) . "\r\n\r\n";
# ssl:// requires OpenSSL to be installed
$fp = fsockopen ("ssl://$host", $port, $errno, $errstr, 30);
echo "<pre>";
if (!$fp) {
print "HTTP ERROR!";
} else {
# post the data to the server
fputs ($fp, $header . $xml);
while (!feof($fp)) {
$res = fgets ($fp, 1024);
echo htmlEntities($res);
}
fclose ($fp);
}
echo "</pre>";
?>
</body>
VB6 example
Thanks to Serguei Seleznev from Softcom Technology for developing this
script.
This Script is using di_MD5DLL.dll from DI Management. This is free
cryptographic software code that David Ireland has written or adapted in
Visual Basic and ANSI C.
39
http://www.di-mgt.com.au/crypto.html#MD5
Dim ErrNumber As Long
Dim ErrDescription As String
Const strUserName = "RSP_USERNAME"
Const strPrivateKey = "Your Private Key Gos here
Const strURL = "https://horizon.opensrs.net:55443"
Sub Main()
' POST XML document using VB6 and MSXML4(has to be installed)
Exit Sub
End If
Set DocToSend = Nothing
Exit Sub
err_Main:
ErrNumber = Err.Number
ErrDescription = "Run-time ERROR in Main. " & Err.Description
MsgBox "Error " & ErrNumber & ", " & ErrDescription, vbCritical
End Sub
pcTmp = xmlHttp.responseXML.xml
Set xmlHttp = Nothing
SendRequestXML = True
''
''
''
''
''
xmlHttp.setRequestHeader "X-Signature",
MD5Encode(MD5Encode(pXMLDoc.xml & strPrivateKey) & strPrivateKey)
''
xmlHttp.send pXMLDoc.xml
''
PauseSeconds 1
''
pcTmp = ""
''
If xmlHttp.readyState = 4 Then
''
'wait
'we got it
''
pcTmp = xmlHttp.responseXML.xml
''
SendRequestXML = True
''
''
End If
Else
''
PauseSeconds 3
''
If xmlHttp.readyState = 4 Then
''
''
cTmp = xmlHttp.responseXML.xml
''
SendRequestXML = True
''
''
''
End If
End If
End If
Exit Function
err_SendRequestXML:
If IsObject(xmlHttp) Then Set xmlHttp = Nothing
ErrNumber = Err.Number
ErrDescription = "Run-time ERROR in SendRequestXML. " &
Err.Description
Err.Clear
End Function
42
ReadXMLDocument = False
pXMLDoc.async = False
pXMLDoc.resolveExternals = False
refered DTD
pXMLDoc.validateOnParse = False
pXMLDoc.Load pDocName
If pXMLDoc.parseError.errorCode = 0 Then
ReadXMLDocument = True
Else
ErrNumber = pXMLDoc.parseError.errorCode
ErrDescription = "Errors in " & pXMLDoc.parseError.url & ",
line " & pXMLDoc.parseError.Line & ", pos " & pXMLDoc.parseError.linepos
ErrDescription = ErrDescription & ". Error #" & ErrNumber & ".
" & pXMLDoc.parseError.reason
End If
Exit Function
err_ReadXMLDocument:
ErrNumber = Err.Number
ErrDescription = "Run-time ERROR in ReadXMLDocument " &
Err.Description & " for " & pDocName
Err.Clear
End Function
<header>
43
'
<version>0.9</version>
'
</header>
'
<body>
'
'
<data_block>
<dt_assoc>
'
<item key="object">DOMAIN</item>
'
<item key="attributes">
'
<dt_assoc>
'
<item key="domain">MyDomainToLookup.com</item>
'
</dt_assoc>
'
</item>
'
<item key="protocol">XCP</item>
'
<item key="action">LOOKUP</item>
'
'
'
</dt_assoc>
</data_block>
</body>
'</OPS_envelope>
VB .NET example
Dim mypost As New OpenSRS_XMLPOST
TextBox1.Text = mypost.sendPost(RESPONSE_TEXT)
-----------------Imports System.Web.Security
Public Class OpenSRS_XMLPOST
Public Const URL_BASE = "https://horizon.opensrs.net:55443"
44
Java example
package net.client;
import javax.net.ssl.*;
import javax.net.SocketFactory;
import java.net.*;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.IOException;
import java.security.MessageDigest;
import java.util.Hashtable;
import java.math.BigInteger;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.PostMethod;
45
import org.apache.commons.httpclient.protocol.*;
import com.pureload.task.api.TaskExecuteException;
public class SslClient {
private String privateKey;
private String
host;
}
catch (Exception ex) {
throw new UnknownHostException("Problems to connect " + host +
ex.toString());
}
}
public Socket createSocket(Socket socket, String host, int port,
boolean flag) throws IOException, UnknownHostException {
TrustManager[] trustAllCerts = getTrustManager();
try {
SSLContext sc = SSLContext.getInstance("SSL");
sc.init(null, trustAllCerts, new java.security.SecureRandom());
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
SocketFactory socketFactory =
HttpsURLConnection.getDefaultSSLSocketFactory();
return socketFactory.createSocket(host, port);
}
catch (Exception ex) {
throw new UnknownHostException("Problems to connect " + host +
ex.toString());
}
}
public Socket createSocket(String host, int port, InetAddress
clientHost, int clientPort) throws IOException, UnknownHostException {
TrustManager[] trustAllCerts = getTrustManager();
try {
SSLContext sc = SSLContext.getInstance("SSL");
sc.init(null, trustAllCerts, new java.security.SecureRandom());
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
SocketFactory socketFactory =
HttpsURLConnection.getDefaultSSLSocketFactory();
return socketFactory.createSocket(host, port, clientHost, clientPort);
}
catch (Exception ex) {
throw new UnknownHostException("Problems to connect " + host +
ex.toString());
}
}
47
}
public SslClient(String host, int port, String userName, String
privateKey) {
this.host=host;
this.port = port;
this.userName = userName;
this.privateKey = privateKey;
}
protected String md5Sum(String str) {
String sum = new String();
try {
MessageDigest md5 = MessageDigest.getInstance("MD5");
sum = String.format("%032x", new BigInteger(1,
md5.digest(str.getBytes())));
} catch (Exception ex) {
}
return sum;
}
public String getSignature(String xml) {
return md5Sum(md5Sum(xml + privateKey) + privateKey);
}
public String sendRequest(String xml) throws TaskExecuteException {
HttpClient client = new HttpClient();
client.setConnectionTimeout(60000);
client.setTimeout(60000);
String response = new String();
String portStr = String.valueOf(port);
Protocol.registerProtocol("https", new Protocol("https", new
MySSLSocketFactory(), port));
String signature = getSignature(xml);
String uri = "https://" + host + ":" + portStr + "/";
PostMethod postRequest = new PostMethod(uri);
postRequest.addRequestHeader("Content-Length",
String.valueOf(xml.length()));
postRequest.addRequestHeader("Content-Type", "text/xml");
48
postRequest.addRequestHeader("X-Signature", signature);
postRequest.addRequestHeader("X-Username", userName);
postRequest.setRequestBody(xml);
System.out.println("Sending https request....."+postRequest.
toString());
try {
client.executeMethod(postRequest);
}
catch (Exception ex) {
throw new TaskExecuteException("Sending post got exception ", ex);
}
response = postRequest.getResponseBodyAsString();
headers = postRequest.getRequestHeaders();
return response;
}
public String getPrivateKey() {
return privateKey;
}
public void setPrivateKey(String privateKey) {
this.privateKey = privateKey;
}
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
public String getUserName() {
return userName;
49
}
public void setUserName(String userName) {
this.userName = userName;
}
public Header[] getHeaders() {
return headers;
}
public void setHeaders(Header[] headers) {
this.headers = headers;
}
"</item>"+
"<item key='object'>DOMAIN</item>"+
"<item key='action'>LOOKUP</item>"+
"<item key='protocol'>XCP</item>"+
"</dt_assoc>"+
"</data_block>"+
"</body>"+
"</OPS_envelope>";
SslClient sslclient = new
SslClient(host,port,userName,privateKey);
try {
String response = sslclient.sendRequest(xml);
System.out.println("\nResponse is:\n"+response);
}
catch (TaskExecuteException e) {
e.printStackTrace();
}
}
}
Data exchange
For each line of data passed, you must prepend the data with the length of
the string packed in 'network' or big-endian order. In Perl, this is
accomplished by:
$length = pack('n', length($data));
Since you must always send the length of the string first, it will not work to
simply telnet to the OpenSRS server and begin issuing commands.
51
Authentication handshake
The first step in communicating with the server process is the authentication
handshake. This proceeds between the Reseller Client and Reseller Agent
(server) as follows:
Process
Description
Reseller Client
Reseller Agent
Reseller Client
Process
Description
'version' => 'XML:0.1',
'state' => 'ready',
}
}
The only difference here is the value of the sender
attribute. Again, the only valid state at this point is
'ready'.
Reseller Client
Reseller Agent
Reseller Client
Reseller Agent
Process
Description
'response_code' => '200',
'response_text' => 'Authentication Successful'
}
If the Reseller Agent deems that the Reseller Client has
failed the challenge, it closes the socket without sending a
decline reply because it is assumed that the Reseller
Client cannot understand any of the encrypted messages
anyway.
Another possible response code would be code 310, if the
Reseller's command rate is exceeded.
Reseller Client
Encryption
Supported ciphers
OpenSRSWe currently supports the DES and Blowfish encryption algorithms.
The suggested method of using these encryption types is through their
respective Perl modules, Crypt::DES and Crypt::Blowfish, which are then
accessed through a common interface created by Crypt::CBC. For your
convenience, Crypt::CBC is now included in the OpenSRS client distribution.
If you are unable to install Crypt::DES or Crypt::Blowfish there is a third
option available: Crypt::Blowfish_PP, which is a module for Blowfish written
in Pure Perl (PP). Our initial testing has shown this module to be at least 10
times slower than the standard Crypt::Blowfish, but it may be used as a last
resort.
Private key
DES only supports keys of 8 bytes, while Blowfish supports keys of up to 56
bytes for greater security.
Private keys in OpenSRS are 112 characters in length (56 bytes), to provide
the maximum security for people using Blowfish. If you are an existing
customer and you are using an old key (8 bytes), you will not be able to use
the Blowfish cipher until you generate a new key. We recommend that you
generate a new private key to ensure the strongest encryption possible. Old
keys were 8 bytes in length and new keys are 56 bytes in length.
54
You can continue using the (old) 8-byte key if you only wish to use DES as
your cipher. Even if you have a new key (56 bytes), you can still use it with
the DES cipher, since Crypt::CBC only uses the portion of the private key that
is needed (in the case of DES, it simply ignores everything after the first 8
bytes).
When creating your encryption cipher, do not use the private key in raw form.
Instead, first pack the key into a hexadecimal binary string. In Perl this is
accomplished with:
$private_key = pack('H*', $private_key);
You may then use the private key to create your encryption cipher,
authenticate, and begin sending data to the server.
200
Command Successful.
Authentication Successful.
Closing Connection.
Registration Successful.
Modification Successful.
Nameserver Update Successful.
Nameserver Added.
Nameserver Created.
Nameserver deleted.
No nameserver changes necessary.
Query Successful.
Registration successful.
210
Domain available.
211
Domain taken.
221
250
260
300
310
Code
350
Number of command per connection exceeded limit. Client must reauthenticate with server.
A maximum of 100 commands can be sent through one
connection/session. After 100 commands have been submitted, the
connection is closed and a new connection must be opened to submit
outstanding requests.
400
403
404
405
410
415
430
Invalid command.
435
436
This error occurs when the RM does not know what to do with the
response code returned by the RA after it talked with the registry.
56
Code
437
440
445
447
460
No Cookie Supplied.
No Domain Supplied.
Modify type not specified.
Required field 'username' not provided.
Required field 'password' not provided.
Missing required field.
Missing required field: fqdn.
Missing required field: ip.
Info type not specified.
Required field 'reg_username' not provided.
Required field 'reg_password' not provided.
465
Code
480
481
485
Domain taken.
Nameserver already mapped to domain.
Nameserver $fqdn already exists (as result of request in DB or RRP).
Nameserver in use.
New nameserver hostname already in registry.
486
487
541
58
Code
552
555
557
Nameserver locked.
An attempt has been made to modify or delete a name server that is
hosting a TLD in the root zone. Modifications to the root zone can
only be made with the approval of the U.S. Department of Commerce
and IANA, so if the registrar absolutely needs to modify or delete
such a name server; the action needs to be coordinated through the
registry operator using an out-of-band communications channel.
(Extracted from the RRP spec.)
702
703
704
705
Note: Some Trust Service products have associated services that can be
initiated, or turned on or off. When making such a request, it is the product
itself that is referenced, not the order record.
Some organization vetted certificates also validate the domain and require
that an approver email is chosen. Organization verification may require
additional company information to be submitted directly to the certificate
provider as part of the review process.
60
Partial integration
A partial integration allows you to integrate with the OpenSRS API to process
purchases of the goMobi service. You can then direct your customers to the
unbranded self management portal that is provided by OpenSRS so that they
can access the goMobi control panel to set up and manage their mobile
websites.
This interface requires a username and password as access credentials. The
interface is accessible at a URL that includes your Reseller username.
61
Example: https://[Reseller_username].domainadmin.com
The self management interface allows the customer to manage one or more
mobile domains, access the goMobi control panel, and generate redirection
code.
In this case, when provisioning the goMobi service, you must supply your
customer with a username and password to access the self management
portal.
New orders for an existing user account require only that the username be
submitted.
Important: If customer credentials are not supplied in the provisioning
request, the customer profile will not be created and it cannot be added at a
later time.
Full integration
You can also choose to implement a full integration with the OpenSRS API
and build your own portal for your customers to use to set up and manage
the mobile website service.
In this case, end user authentication information does not need to be
provided, nor does a user account need to be created. By leveraging the
commands described in this guide, you can build a portal to allow your
customers to fully manage the mobile website service.
The OpenSRS API allows you to generate the redirection code when
requested by a customer. It also allows you to generate a temporary unique
URL that can be used to load the goMobi control panel within a frameset of
an existing web portal.
In addition, there are commands that allow you to update and manage the
configuration details and lifecycle of the goMobi service.
997
998
Response text/Explanation
Code
Response text/Explanation
63
Contact Set
Rather than including the entire contact set in every command example in
this guide, where it is required, contact details are listed in a separate topic.
Every command that requires contact details contains an ellipsis (...) that
links to the topic where the contact_set parameter is defined.
Example
This example shows a portion of the sw_register command with a link to the
contact_set example.
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
...
64
<item key="postal_code">90210</item>
</dt_assoc>
</item>
<item key="billing">
<dt_assoc>
<item key="first_name">Bill</item>
<item key="last_name">Burton</item>
<item key="phone">+1.4165550123x1248</item>
<item key="fax">+1.4165550136</item>
<item key="email">burton@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 200</item>
<item key="address3">Billing</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
<item key="country">US</item>
<item key="postal_code">90210</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="first_name">Tim</item>
<item key="last_name">Tucker</item>
<item key="phone">+1.4165550123x1243</item>
<item key="fax">+1.4165550125</item>
<item key="email">tucker@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 100</item>
<item key="address3">Tech</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
<item key="country">US</item>
<item key="postal_code">90210</item>
66
</dt_assoc>
</item>
</dt_assoc>
</item>
...
Domain contacts
The following tables list the contacts that are required for each gTLD and
ccTLD.
gTld
Owner
Admin
Billing
Tech
.aero
.asia
.biz
.coop
.com
.info
.jobs
.mobi
.name
.net
.org
.pro
.tel
.xxx
ccTld
Owner
Admin
Billing
Tech
.ac
.ae
.af (.af,
.com.af,
.net.ag, .org.af)
.ag (.ag, .co.ag,
.com.ag,
67
ccTld
Owner
Admin
Billing
Tech
.net.ag,
.nom.ag, .org.ag)
.ai (.com.ai,
.net,ai, .off.ai,
.org.ai)
.am
.ar (.com.ar)
.as
.at
.au (.asn.au,
.com.au,
.net.au, .id.au,
.org.au)
.be
.br (.com.br)
.bz
.ca
.cc
.cd
.ch
.cl
.cm
.co.cm
.com.cm
.net.cm
.co (.co, .com.co,
.net.co, .nom.co)
.cx
.cz
.de
.dk
68
ccTld
Owner
Admin
Billing
Tech
.ec (.ec,
.com.ec, .fin.ec,
.info.ec,
.med.ec,
.net.ec, .pro.ec)
.es (.es,
.com.es,
.nom.es, .org.es)
.eu
.fi
.fm
.fr
.gd
.gg (.gg,
.co.gg, .net.gg,
.org.gg)
.gl (.gl, .co.gl,
.com.gl, .net.gl,
.org.gl)
.gr (.com.gr,
.edu.gr, .net.gr,
.org.gr)
.gs
.gy (.gy,
.co.gy,
.com.gy, .net.gy)
.hk
.hm
.hn (.hn, .com.hn,
.net.hn, .org.hn)
.hr (.com.hr)
.ht (.ht,
.com.ht,
.info.ht, .net.ht,
.org,ht)
.hu (.hu, .co.hu)
.il (.co.il)
.im (.im, .co.im,
69
ccTld
Owner
Admin
Billing
Tech
.com.im,
.net.im, .org.im)
.in (.in, .co.in,
.firm.in, .gen.in,
.ind.in, .net.in,
.org.in)
.io
.is
.it
.je (.je, .co.je)
.jp
.kg
.ki (.biz.ki,
.com.ki,
.info.ki,
.mobi.ki,
.net.ki, .tel.ki)
.kr
.co.kr
.la
.lc (.lc, .co.lc,
.com.lc, .l.lc,
.net.lc, .org.lc,
.p.lc)
.li
.lt
.lu
.lv
.com.lv
.ly (.ly, .com.ly)
.ma
.co.ma
.md
.me
70
ccTld
Owner
Admin
Billing
Tech
.mn
.ms
.mu
.mx (.mx,
.com.mx)
.my (.my,
.com.my, .net.my,
.org.my)
.nl
.no
.nu
.nz (.co.nz,
.net.nz, .org.nz)
.pe (.pe,
.com.pe, .net.pe)
ph (.ph, .com.ph,
.net.ph, .org.ph)
.pl (.pl, .biz.pl
.com.pl, .edu.pl,
.info.pl, .net.pl,
.nom.pl, .org.pl,
.shop.pl, .waw.pl)
.pm
.pr (.com.pr)
.pt (.pt, .com.pt)
.pw
.qa
.re
.ro (.ro, .com.ro)
.ru (.ru, .com.ru)
.sb (.com.sb,
.net.sb, .org.sb)
71
ccTld
Owner
Admin
Billing
Tech
.sc
.com.sc
.net.sc
.org.sc
.se
.sg
.sh
.si
.so (.so, .com.so,
.net.so, .org.so)
.sr
.st
.sx
.tc
.tf
.tk
.tl
.tm
.to
.tv
.tw (.tw,
.com.tw, .org.tw,
idv.tw)
.ua (.com.ua)
.uk (.co.uk,
.ltd.uk, .me.uk,
.net.uk,
.org.uk, .plc.uk)
.us
72
ccTld
Owner
Admin
Billing
Tech
.uy (.com.uy)
.vc (.vc, .com.vc,
.net.vc, .org.vc)
.ve (.co.ve,
.com.ve)
.vg
.wf
.ws
.yt
.za (.co.za)
Parameter
name
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
Maximum 32 alphanumeric characters.
country =
.CA, .US, or .ES
Not required
for .NL
postal_code
Required
country
Required
phone
Required
Parameter
name
Obligation
Format/Constraints
(optional).
fax
Optional
Required
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
Maximum 32 alphanumeric characters.
country = CA or
US
Not required
for .NL
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
74
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
Maximum length: 32 alphanumeric characters.
country = CA or
US
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
lang
Required
vat
Optional
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Optional for
individuals
75
Parameter
name
Obligation
Format/Constraints
address1
Optional
address2
Optional
address3
Optional
city
Required for
admin and
tech; optional
for owner
state
Required for
admin and
tech; optional
for owner
Alberta = AB
British Columbia = BC
Manitoba = MB
New Brunswick = NB
Northwest Territories = NT
Nova Scotia = NS
Nunavut = NU
Ontario = ON
Quebec = QC
Saskatchewan = SK
Yukon = YT
postal_code
Required for
admin and
tech; optional
for owner
country
Required for
admin and
tech; optional
for owner
phone
Required for
admin and
tech; optional
for owner
fax
Optional
Required for
admin and
tech; optional
for owner
76
Parameter
name
Obligation
Format/Constraints
lang
Required
EN = English
FR = French
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
country = CA
or US
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
Additional rules
SUM (org_name address1 address2 address3) not to exceed 255 characters.
Obligation
Format/Constraints
first_name
Required
Parameter
name
Obligation
Format/Constraints
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
Maximum length: 32 alphanumeric characters.
country = CA or
US
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
Additional rules
SUM (first_name last_name address1 address2 address3 postal_code city)
must not exceed 248 characters.
SUM (org_name address1 address2 address3) not to exceed 255 characters.
Parameter
name
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
Parameter
name
Obligation
Format/Constraints
state
Required if
Maximum length: 32 alphanumeric characters.
country = CA or
US
postal_code
Required
country
Required
phone
Required
fax
Required
Required
Additional rules
SUM(org_name address1 address2 address3) not to exceed 255 characters.
Province
Postal code
prefix
Province
01
Araba
27
Lugo
02
Albacete
28
Madrid
03
Alicante
29
Malaga
04
Almeria
30
Murcia
05
Avila
31
Navarr
06
Badajoz
32
Ourense
07
Illes Balears
33
Asturias
08
Barcelona
34
Palencia
09
Burgos
35
Palmas, Las
10
Caceres
36
Pontevedra
79
Postal code
prefix
Province
Postal code
prefix
Province
11
Cadiz
37
Salamanca
12
Castellon
38
13
Ciudad Real
39
Cantabria
14
Cordoba
40
Segovia
15
Corua, A
41
Sevilla
16
Cuenca
42
Soria
17
Girona
43
Tarragona
18
Granada
44
Teruel
19
Guadalajara
45
Toledo
20
Gipuzkoa
46
Valencia
21
Huelva
47
Valladolid
22
Huesca
48
Bizkaia
23
Jaen
49
Zamora
24
Leon
50
Zaragoza
25
Lleida
51
Ceuta
26
Rioja, La
52
Melilla
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
Parameter
name
Obligation
Format/Constraints
state
Optional
postal_code
Optional
country
Required
phone
Required
fax
Optional
Required
lang
Required
vat
Optional
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required if
entity_type is Maximum length: 64 alphanumeric characters.
not 1
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required
81
Parameter
name
Obligation
Format/Constraints
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
entity_type
Required
nationality_
code
Optional
3Freelance workers/professionals
4Non-profit organizations
5Public organizations
6Other subjects
82
Parameter
name
Obligation
Format/Constraints
reg_code
Required
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
Required if
state/province country = CA,
MX, or US
postal_code
Required
country
Required
phone
Required
Parameter
name
Obligation
Format/Constraints
verified according to EPP.
fax
Optional
Required
Parameter
name
Obligation
Format/Constraints
first_name
Optional
last_name
Optional
org_name
Optional
address1
Optional
address2
Optional
address3
Optional
city
Optional
state
Optional
postal_code
Optional
country
Optional
phone
Optional
fax
Optional
Parameter
name
Obligation
Format/Constraints
Required
Parameter
name
Obligation
Format/Constraints
first_name
Required
last_name
Required
org_name
Optional
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
Maximum length: 32 alphanumeric characters.
country = CA or
US
postal_code
Required
country
Required
phone
Required
fax
Optional
Required
85
Billing
Tech
Organization
Signer
Comodo
EV SSL
InstantSSL
PremiumSSL
PremiumSSL Wildcard
SSL
SSL Wildcard
GeoTrust
QuickSSL
QuickSSL Premium
True BusinessID
True BusinessID
Wildcard
True BusinessID with EV
SiteLock
Basic
Premium
SMB Enterprise Secure
Symantec
SecureSite
SecureSite Pro
SecureSite with EV
SecureSite Pro with EV
thawte
SSL123
86
Admin
Billing
Tech
Organization
Signer
SGC SuperCerts
SSL Webserver
Certificate
SSL Webserver
Certificate with EV
SSL Webserver
Certificate Wildcard
TRUSTe
Privacy Policy
Privacy Policy with Seal
Trustwave
Domain Vetted (DV)
Premium EV
Premium SSL
Premium SSL Wildcard
87
Obligation
Format/Constraints
first_name
Required
last_name
Required
title
Required for
thawte and
Symantec certs
Maximum 64 alphanumeric characters.
as well as
truebizid_ev
certs
org_name
Optional
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
country = CA,
US, or .ES
postal_code
Required if
country = CA
or US
country
Required
Parameter
name
Obligation
Format/Constraints
phone
Required
fax
Optional
Required
Obligation
Format/Constraints
first_name
Optional
last_name
Optional
org_name
Required
address1
Required
address2
Optional
address3
Optional
city
Required
state
Required if
country = CA,
US, or .ES
postal_code
Required if
country = CA
or US
country
Required
phone
Required
fax
Optional
89
TLD Data
The tld_data associative array contains that contains additional information
that is required by some registries, such as the residency of the registrant.
For instance, .ASIA domains require Charter Eligibility Declaration (CED)
information to demonstrate that at least one of the contacts is a member of
the .ASIA community, and this information is provided within the tld_data
associative array, under ced_info.
The allowed values for tld_data are:
domains.
ipr_dataSponsored Community information associated with .XXX
domains.
it_registrant_infoRegional presence requirements for .IT domains.
nexusAmerican presence requirements for .US domains.
professional_dataThe professional designation information that is
associated with the .PRO domain.
registrant_extra_infoAdditional parameters that are required by
various domain registries. See below for specific requirements for each
TLD.
The tld_data information is used by the following commands: sw_register,
modify domain, get domain, get_order_info, and trade domain (.FR only).
.AERO registrant_extra_info
Registration of .AERO domains is restricted to members of the aviation
community such as airlines, airports, and qualifying companies and
individuals.
To prove that they meet the requirements, registrants must provide an
Eligibility and Name Selection (ENS) ID and password, which can be obtained
by applying to the registry through this site:
http://www.nic.aero/registration/manage_your_aero_id/apply.
Parameters within the registrant_extra_info associative array are described
below.
Parameter name Definition/Value
sw_register
(request)
aero_ens_id
Required
aero_ens_password
Required
90
.ASIA ced_info
The ced_info associative array contains Charter Eligibility Declaration (CED)
information to satisfy regional presence requirements of the .ASIA registry,
including the stated purpose of the domain, the category of the registrant
and the country code validator.
Parameters within the ced_info associative array are described below.
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
contact_
type
Required
Required
Always
returned
Always
returned
id_number
Identification number or
code of reference for the
specified id_type, for
example, a passport
number.
Required
Required
Always
returned
Always
returned
id_type
Required
Required
Always
returned
Always
returned
Required if
id_type =
other
Returned if
id_type =
other
Returned if
id_type =
other
Required
Always
returned
Always
returned
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
Required if
legal_
entity_
type =
other
Required if
legal_
entity_
type =
other
Returned if
legal_
entity_
type =
other
Optional
Optional
Returned if Returned if
submitted
submitted
in the order in the order
locality_
country
Required
Always
returned
locality_
state_prov
Optional
Returned if Returned if
submitted
submitted
in the order in the order
government,
politicalParty, society,
institution, or other.
Optional
Returned if
legal_
entity_
type =
other
Always
returned
.AU au_registrant_info
The au_registrant_info associative array contains information about specific
requirements that registrants of .AU domains must meet.
Parameters within the au_registrant_info associative array are described
below.
Parameter Definition/Value
name
sw_
register
(request)
eligibility_id
Required for
.ASN.AU,
.COM.AU
.NET.AU, and
.ORG.AU
Always
returned
Returned if
submitted in
the order
92
Parameter Definition/Value
name
eligibility_id
_type
sw_
register
(request)
Note: This
value is
optional for
.ID.AU unless
you specify an
eligibility_id_
type, in which
case this value
is required.
Required for
.ASN.AU,
.COM.AU,
.NET.AU, and
.ORG.AU
Always
returned
Returned if
submitted in
the order
Parameter Definition/Value
name
sw_
register
(request)
TM.
Allowed value for
Partnership is ABN.
eligibility_
name
Returned if
submitted in
the order
Returned if
submitted in
the order
eligibility_
type
Always
returned
Always
returned
Charity
Club
Incorporated
Association
Non-profit
Organization
Trade Union
Company
Partnership
Pending TM
94
Parameter Definition/Value
name
sw_
register
(request)
Owner
Registered
Business
Sole Trader
Trademark
Owner
Returned if
submitted in
the order
Returned if
submitted in
the order
Required if
registrant_
id_type =
ACN or ABN
Always
returned
Always
returned
Required
Always
returned
Always
returned
registrant_
id
1The name
exactly matches
the acronym or
abbreviation of the
registrant's
company or trading
name, organization
or association
name, or
trademark.
2The name is
connected closely
and substantially to
the registrant. This
is the default.
registrant_
id_type
ACNAustralian
Company Number
ABNAustralian
95
Parameter Definition/Value
name
sw_
register
(request)
Required
Always
returned
Business Number
registrant
name
Always
returned
.CL registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_
name
Value
register
(request)
id_card_
number
registrant_
type
registrant_
vat_id
The number of
the
individual's
identity card.
Optional; can
be submitted
when
registrant_
type =
individual
trade
domain
(request)
get domain
(response)
get_order_
info
(response)
Optional; can
be submitted
when
registrant_
type =
individual
Returned if
applicable and
is_success =
true
Returned if
applicable and
is_success =
true l
Required
Returned if
is_success =
true
Returned if
is_success =
true
Optional; can
be submitted
when
registrant_
type =
organization
Returned if
applicable and
is_success =
true
Returned if
applicable and
is_success =
true
The entity
type of
registrant.
Allowed values Required
are individual
or
organization.
Value Added
Tax
registration
number.
Optional; can
be submitted
when
registrant_
type =
organization
96
id_card_
number
The number of
the
individual's
identity card.
Required when
registrant_
type =
individual
Required when
registrant_
type =
individual
Returned if
Returned if
is_success = is_success =
true
true and
registrant_
type =
individual
registrant_
The entity
type of
registrant.
Required
Required
Returned if
Returned if
is_success = is_success =
true
true
Required
Required
Returned if
Returned if
is_success = is_success =
true
true
type
Allowed values
are individual
or
organization.
tax_number The number
used for tax
purposes.
.COM.BR tld_data
The tld_data associative array contains information contains information to
satisfy requirements of the registry.
Parameters within the tld_data associative array are described below.
Parameter Definition/Value
name
sw_
register
(request)
get
get_order_
domain
info
(response) (response)
Returned if Returned if
is_success is_success
= true
= true
97
.COOP registrant_extra_info
Registration of .COOP domains is restricted to cooperatives and related
organizations. The registrant_extra_info associative array contains
information to satisfy requirements of the .COOP registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/
name
Value
coop_
verification_
code
sw_
register
(request)
The coop
Required
verification code
(CVC) is issued
by dotCoop, and
proves that the
registrant is
eligible to
register the
domain name.
modify
domain
(request)
get
get_order
domain
_
(response) info
(response)
Required
Returned if Returned if
is_success is_success
= true
= true
.DE registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_register
name
Value
(request)
get domain
(response)
get_order_info
(response)
registrant_
type
Returned if
is_success =
true
Returned if
is_success =
true
The entity
type of
registrant.
Required
Allowed values
are individual
or
organization.
98
.DK registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_registe trade
name
Value
r
domain
(request)
(request)
get domain
(response)
get_order_
info
(response)
registrant_
type
The entity
type of
registrant.
Required
Required
Returned if
is_success =
true
Returned if
is_success =
true
Required
when
registrant_
type =
organization
Required when
registrant_
type =
organization
Returned if
is_success =
true and type
= organization
Returned if
is_success =
true and type
=
organization
Allowed values
are individual
or
organization.
registrant_
vat_id
Value Added
Tax
registration
number.
trade
domain
(request)
id_card_
number
The number of
the
individual's
identity card.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
registrant_
type
The entity
type of
registrant.
Required
Required
Returned if
is_success
= true
Returned if
is_success
= true
Allowed values
99
trade
domain
(request)
Required
when
registrant_
type =
organization
Returned if
is_success
= true and
registrant_
type =
organization
are individual
or
organization.
registration_ The business Required
number
number of the when
organization. registrant_
type =
organization
Returned if
is_success
= true and
registrant_
type =
organization
.FR registrant_extra_info
.FR domains are available to any individuals and organizations located in the
European Union, Switzerland, Norway, Iceland, or Liechtenstein. Individuals
must reside within one of the qualifying countries; organizations must have
their registered or main office located in a qualifying country; therefore,
when registering or transferring .FR domains, you must provide additional
residency information.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/Value
name
sw_
register
(request)
get_order trade
_info
domain
(response) (request)
Returned
when
registrant
_type =
individual
Required
when
registrant_
type =
individual
date_of_
birth
Returned
when
registrant
_type =
individual
Required
when
registrant_
type =
individual
place_of_
birth
Returned
when
registrant
_type =
individual
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
and country_
of_birth =
FR
100
Parameter Definition/Value
name
sw_
register
(request)
get_order trade
_info
domain
(response) (request)
postal_
code_of_
birth
Required
when
registrant_
type =
individual
and country_
of_birth =
FR
Returned
when
registrant
_type =
individual
Required
when
registrant_
type =
individual
registrant_
type
Always
returned
Required
registrant_
vat_id
Optional, but
recommended
for
organizations
located in
France
siren_siret
Optional, but
recommended
for
organizations
located in
France
Optional, but
recommended
for
organizations
located in
France
101
.HK registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_
name
Value
register
(request)
trade
domain
(request)
get domain
(response)
get_order_
info
(response)
date_of_
birth
The
registrant's
date of birth in
the format
YYYY-MM-DD.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
id_card_
number
The number of
the
individual's
identity card.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
registrant_
type
The entity
type of
registrant.
Required
Required
Returned if
is_success =
true
Returned if
is_success =
true
Required
when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Allowed values
are individual
and
organization.
registration_ The business Required
number
number of the when
organization. registrant_
type =
organization
102
id_card_
number
registrant_
type
registrant_
vat_id
get domain
(response)
get_order_
info
(response)
Required when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Required
Returned if
is_success =
true
Returned if
is_success =
true
Value Added
Tax
registration
number.
Required when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
The number of
the
individual's
identity card.
trade
domain
(request)
Required when
registrant_
type =
individual
The entity
type of
registrant.
Required when
registrant_
type =
organization
.IT it_registrant_info
The it_registrant_info associative array contains information to satisfy the
regional presence requirements of the registry.
Parameters within the it_registrant _info associative array are described
below.
Parameter Definition/Value
name
sw_
register
(request)
Required
Always
returned
Always
returned
1Italian and
foreign natural
persons
2Companies/one
man companies
3Freelance
workers/professiona
ls
4Non-profit
103
Parameter Definition/Value
name
sw_
register
(request)
Optional
Returned if
submitted in
order
Returned if
submitted in
order
Always
returned
Always
returned
organizations
5Public
organizations
6Other subjects
7Foreigners who
match 2-6
An identifying number,
Required
usually the VAT or Codice
Fiscale (numeric tax code).
The value that you need to
enter depends on the
entity type of the
registrant.
Italian companies,
freelancers, and
other subjects must
enter their 11 digit
VAT number or tax
identification
number.
Italian non-profit
organizations must
104
Parameter Definition/Value
name
sw_
register
(request)
.JOBS registrant_extra_info
Registration of .JOBS domains is restricted to those who are involved in
Human Resource management. To be eligible, registrants must be a member
of the Society for Human Resource Management (SHRM) or involved in HR
practices that meet any of the following criteria:
Possess salaried-level human resource management experience.
Are certified by the Human Resource Certification Institute.
Are supportive of the SHRM Code of Ethical and Professional Standards
in Human Resource Management, as amended from time to time.
Consequently, when registering a .JOBS domain, registrants must complete
some additional information.
Definition/Value
sw_register modify
(request)
domain
(request)
jobs_admin_
type
Required
get domain
(response)
Always
returned
105
Parameter
name
Definition/Value
sw_register modify
(request)
domain
(request)
get domain
(response)
Required
Required
Always
returned
Optional
Optional
Returned if
submitted in
order
jobs_title
Optional
Optional
Returned if
submitted in
order
jobs_website
Required
Required
Always
returned
modify
domain
(request)
id_card_
number
Required when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
Required when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Returned if
is_success
= true and
registrant_
type =
organization
registrant_
type
Required
Returned if
Returned if
is_success = is_success
true
= true
The number of
the
individual's
identity card.
The entity
type of
registrant.
Required
when
registrant_
type =
individual
Required
Allowed values
are
106
modify
domain
(request)
Required when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
individual or
organization.
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization
Required
when
registrant_
type =
organization
Returned if
is_success
= true and
registrant_
type =
organization
modify
domain
(request)
registrant_
type
Required
Returned if
Returned if
is_success = is_success =
true
true
The entity
type of
registrant.
Required
Allowed values
are
individual or
organization.
.NO registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_
name
Value
register
(request)
trade
domain
(request)
Required
Returned if
Returned if
is_success = is_success =
true
true
107
.NYC registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/ sw_register
name
Value
(request)
get domain
(response)
get_order_info
(response)
registrant_
type
Returned if
is_success =
true
Returned if
is_success =
true
The entity
type of
registrant.
Required
Allowed values
are individual
or
organization.
trade
domain
(request)
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
date_of_
birth
The
registrant's
date of birth in
the format
YYYY-MM-DD.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
place_of_
birth
The city in
which the
individual was
born.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
Returned if
is_success
= true and
registrant_
type =
108
trade
domain
(request)
and
country_of_
birth = FR
individual
Required
when
registrant_
type =
individual
and
country_of_
birth = FR
Required
when
registrant_
type =
individual
and
country_of_
birth = FR
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
registrant_
type
Required
Required
Returned if
Returned if
is_success = is_success
true
= true
Optional. May
be used when
registrant_
type =
organization
Optional. May
be used when
registrant_
type =
organization
Returned if
is_success =
true if
submitted in
the order
Returned if
is_success
= true if
submitted in
the order
Optional, but
recommended
for
organizations
located in
France
Returned if
is_success =
true if
submitted in
the order
Returned if
is_success
= true if
submitted in
the order
trademark_
number
Optional but
recommended
when
registrant_
type =
organization
Returned if
is_success =
true if
submitted in
the order
Returned if
is_success
= true if
submitted in
the order
The entity
type of
registrant.
Allowed values
are individual
and
organization.
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization.
The number
assigned to
the
organizations
pending or
registered
trademark.
Optional but
recommended
when
registrant_
type =
organization
109
.PRO professional_data
In order to register a .PRO domain name, the registrant must belong to an
accredited profession.
Parameters within the professional_data associative array are described
below.
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
authority
Optional
Optional
Returned if Returned if
submitted submitted
in order
in order
authority_
website
Optional
Optional
Returned if Returned if
submitted submitted
in order
in order
license_
number
Optional
Optional
Returned if Returned if
submitted submitted
in order
in order
profession
Required
Required
Always
returned
Always
returned
trade
domain
(request)
id_card_
number
Required when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
The number of
the
individual's
identity card.
Required
when
registrant_
type =
individual
Returned if
is_success
= true and
registrant_
type =
individual
110
trade
domain
(request)
Required when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
registrant_
type
Required
Required
Returned if
Returned if
is_success = is_success
true
= true
Required
when
registrant_
type =
organization
Required when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
The entity
type of
registrant.
Returned if
is_success
= true and
registrant_
type =
organization
Allowed values
are
individual or
organization.
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization
Returned if
is_success
= true and
registrant_
type =
organization
.RU registrant_extra_info
The registrant_extra_info associative array contains information to satisfy
requirements of the registry.
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition sw_
name
/Value
register
(request)
trade
domain
(request)
date_of_
birth
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
The
registrant's
date of
birth in the
format
YYYY-MMDD.
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
111
trade
domain
(request)
id_card_
authority
The name
of the
issuer.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
id_card_
issue_date
The date
that the ID
card was
issued, in
the format
YYYY-MMDD.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
id_card_
number
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
place_of_
birth
The city in
which the
individual
was born.
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
registrant_
type
The entity
type of
registrant.
Required
Required
Returned if
Returned if
is_success = is_success =
true
true
Allowed
values are
individual
and
organizati
on.
112
trade
domain
(request)
Required
when
registrant_
type =
individual
Required
when
registrant_
type =
individual
Returned if
is_success =
true and
registrant_
type =
individual
registrant_
type
Required
Required
Returned if
Returned if
is_success = is_success =
true
true
Required
when
registrant_
type =
organization
Required
when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Required
when
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
Returned if
is_success =
true and
registrant_
type =
organization
The entity
type of
registrant.
Returned if
is_success =
true and
registrant_
type =
individual
Allowed values
are
individual or
organization.
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization
113
.TRAVEL registrant_extra_info
In order to register a .TRAVEL domain name, the registrant must be a
participant in the travel and tourism industry, and they must have a Unique
Identifying Number (UIN).
Parameters within the registrant_extra_info associative array are described
below.
Parameter Definition/Value
name
travel_uin
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
Optional
Returned if Returned if
submitted submitted
in order
in order
.US nexus
The nexus associative array contains Nexus information for .US domains, to
satisfy the American presence requirements of the registry.
Parameters within the nexus associative array are described below.
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
app_
purpose
Required
Required
Always
returned
Always
returned
Required
Required
Always
returned
Always
returned
category
A description of the
domain's application
purpose:
P1Business use
for profit.
P2Non-profit
business, club,
association,
religious
organization, and so
on.
P3Personal use.
P4Education
purposes.
P5Government
purposes.
A description of the
domain's nexus category:
C11A citizen of
114
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
validator
C12A permanent
resident of the U.S.
or any of its
territories.
C21An
organization
incorporated within
the U.S.
Returned if
category
= C31 or
C32
.XXX ipr_data
.XXX domains are available to those within the adult entertainment industry
who are members of the Sponsored Community (SC). The ipr_data
associative array contains information to prove that the registrant is a
member of the Sponsored Community.
Parameters within the ipr_data associative array are described below.
Parameter Definition/Value
name
sw_
register
(request)
icm_
The ID number that was
Optional
membership provided when the
_id
registrant successfully
completed the XXX
Sponsored Community
validation process. If this
value is not submitted with
the domain registration,
the registry will contact the
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
Optional
Returned if Returned if
submitted submitted
in the order in the
order
115
Parameter Definition/Value
name
sw_
register
(request)
modify
domain
(request)
get
get_order
domain
_info
(response) (response)
N/A
N/A
N/A
Optional
N/A
N/A
Returned if
submitted
in the
order
N/A
N/A
N/A
ipr_name
ipr_non_
resolver
116
Lookup Commands
This section contains the following commands:
or .org.uk) with the same registrar and reseller, and if so, returns
the owner contact details.
118
belongs_to_rsp
Description
Action & object
action = belongs_to_rsp
object = domain
Usage
Determines whether the domain belongs to the RSP who issued the
command.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
119
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
belongs_to_rsp
domain_expdate
Returned when
belongs_to_RSP = 1
and is_success = true
Definition/Value
Response
If belongs to RSP
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="belongs_to_rsp">1</item>
<item key="domain_expdate">2007-08-26 11:40:14</item>
</dt_assoc>
</item>
<item key="response_text">Query successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="belongs_to_rsp">0</item>
</dt_assoc>
</item>
<item key="response_text">Query successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
122
cira_email_pwd
Description
Action & object
action = cira_email_pwd
object = domain
Usage
Sends the CIRA login information (used for confirming critical changes) to the
email address associated with a .CA domain's admin contact.
Important: This command has been deprecated. If this command is part of
your current integration, it will continue to work; however, the results will be
ignored. The response will return 'is_success' => '1'.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition / Value
domain
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
123
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
124
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">domain</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command verified</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
125
get_balance
Description
Action & object
action = get_balance
object = balance
Usage
Queries the requester's account, and returns the total amount of money in
the account and the amount that is allocated to pending transactions.
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition / Value
balance
Returned if
The total amount of money in the requester's
is_success = account, including the amount that is allocated to
true
pending transactions.
126
Parameter
name
Obligation
Definition / Value
hold_balance
Returned if
The amount of money in the requester's account
is_success = that is allocated to pending transactions.
true
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
127
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">BALANCE</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="balance">8549.18</item>
<item key="hold_balance">1676.05</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
128
get_ca_blocker_list
Description
Action & object
action = get_ca_blocker_list
object = domain
Usage
Before a .CA domain can be registered, it is checked against the CIRA
registry for any conflicting domains. If a variation of the requested domain is
already registered, the requested domain registration is put on hold. For
example, if a registrant owns 'domain.ca' or 'domain.pv.ca' (where .pv is the
provincial code), the CIRA system automatically reserves all variants of the
name.
This command checks for any domains blocking the registration of a new .CA
domain, and returns a list of those domains, if any exist. If blockers exist,
the .CA domain cannot be registered until the owners of the blocker domains
consent.
Important: This command has been deprecated. If this command is part of
your current integration, it will continue to work; however, the results will be
ignored. The response will return 'is_success' => '1'.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition / Value
domain
Optional
129
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition / Value
blocker_list
Returned if
Contains a list of all .CA domains that are blocking
is_success = the registration of the specified .CA domain.
true
For more information, see the Blocker_List table
below.
Blocker_List
Parameters within the blocker_list associative array are described below.
Parameter
name
Obligation
Definition / Value
admin_email
Always returned
owner_org
Always returned
registrar
Always returned
tech_email
Always returned
130
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
131
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">get_ca_blocker_list command is
deprecated</item>
<item key="attributes">
<dt_assoc>
<item key="blocker_list">
<dt_assoc>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
132
get_cert
Description
Action & object
action = get_cert
object = trust_service
Usage
Returns the certificate for the specified Trust Service product as well as
associated product information.
Note: This command can only be used for orders whose status is Completed.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
order_id
Required if
The Trust Service order ID number.
product_id is not
submitted
product_id
Required if
order_id is not
submitted
return_ca_certs
Optional
return_pkcs7_cert
Optional
133
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
cert_data
Returned if
is_success =
true
Returned if
is_success =
true
contact_email
Returned if
is_success =
true
expiry_date
Returned if
is_success =
true
issue_date
Returned if
is_success =
true
product_id
Returned if
is_success =
true
134
Parameter
name
Obligation
Definition/Value
product_type
Returned if
is_success =
true
start_date
Returned if
is_success =
true
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
truebizid
truebizid_ev
truebizid_wildcard
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
135
Parameter
name
Obligation
Definition/Value
state
Returned if
is_success =
true
expired
active
renewing
renewed
revoked
cert_data
Parameters within the cert_data associative array are described below.
Parameter
name
Obligation
Definition/Value
ca_certificates
Returned if
An array that includes the ROOT or
return_ca_certs = Intermediate CA certificates chain, in order.
1
Note: Trustwave does not return CA
certificates; however, the intermediate
bundle can be downloaded by visiting the
Trustwave Support page.
certificate
Returned if
is_success = true
pkcs7
Returned if
The PKCS#7 format certificate that was
return_pkcs7_cert issued.
=1
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
136
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_cert</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='return_pkcs7_cert'>1</item>
<item key='return_ca_certs'>1</item>
<item key='order_id'>7360</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
137
<dt_assoc>
<item key='cert_data'>
<dt_assoc>
<item
key='pkcs7'>MIIYFAYJKoZIhvcNAQcCoIIYBTCCGAECAQExADALBgkqhkiG9w0BBwGgghf
pMIIF
SzCCBDOgAwIBAgIQKBqJ8LG7xMORrbudRYUgPjANBgkqhkiG9w0BAQUFADByMQsw
CQYDVQQGEwJHQjEbMBkGA1UECBMSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQH
EwdTYWxmb3JkMRowGAYDVQQKExFDT01PRE8gQ0EgTGltaXRlZDEYMBYGA1UEAxMP
RXNzZW50aWFsU1NMIENBMB4XDTExMTAwNTAwMDAwMFoXDTEyMTAwNTIzNTk1OVow
gYUxITAfBgNVBAsTGERvbWFpbiBDb250cm9sIFZhbGlkYXRlZDEeMBwGA1UECxMV
SG9zdGVkIGJ5IFR1Y293cyBJbmMuMR4wHAYDVQQLExVFc3NlbnRpYWxTU0wgV2ls
ZGNhcmQxIDAeBgNVBAMUFyoucmVnNC5xYXJlZ3Jlc3Npb24ub3JnMIIBIjANBgkq
hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAukPlCL1vnnl9kgRhdRZ XQ2yo3FqnFbG
IBZkjg2dJ8X3M/hM Lat5u /A1rkHP3kNvchwjf2kOmh29Hul6JLkfFlv6ZfYNsT
va/28P4RMZ38CBiTomAEwsxxrU5zDZmOLOqY3mg1sifhXT7lma0tgGSCil8Ru9NF
/jbAnShJx/MdvRdKORo1LGYplwg0 Esho5ODbIOlgEY18qgEDg8f0ir3jlOdsUzH
1A/qyl332eowlzztSmaJkbkjOJhMl9WaGfp0LeybNk7nGiSyIMWsHotlrQdiaftE
Rg6SkS9eDFljYGXEnoexa5BbQGO0mpAGO5WbeB0KNWUyRAHYPdaZ1wIDAQABo4IB
xzCCAcMwHwYDVR0jBBgwFoAU2svqrVsIXcz//CZUzknlVcY49PgwHQYDVR0OBBYE
FLLQDNSlCLlxPNKvHiVYCm/SBridMA4GA1UdDwEB/wQEAwIFoDAMBgNVHRMBAf8E
AjAAMDQGA1UdJQQtMCsGCCsGAQUFBwMBBggrBgEFBQcDAgYKKwYBBAGCNwoDAwYJ
YIZIAYb4QgQBMEUGA1UdIAQ MDwwOgYLKwYBBAGyMQECAgcwKzApBggrBgEFBQcC
ARYdaHR0cHM6Ly9zZWN1cmUuY29tb2RvLmNvbS9DUFMwOwYDVR0fBDQwMjAwoC6g
LIYqaHR0cDovL2NybC5jb21vZG9jYS5jb20vRXNzZW50aWFsU1NMQ0EuY3JsMG4G
CCsGAQUFBwEBBGIwYDA4BggrBgEFBQcwAoYsaHR0cDovL2NydC5jb21vZG9jYS5j
b20vRXNzZW50aWFsU1NMQ0FfMi5jcnQwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3Nw
LmNvbW9kb2NhLmNvbTA5BgNVHREEMjAwghcqLnJlZzQucWFyZWdyZXNzaW9uLm9y
Z4IVcmVnNC5xYXJlZ3Jlc3Npb24ub3JnMA0GCSqGSIb3DQEBBQUAA4IBAQBo8rwM
rpd2iSi45Vl69urPeUwMTeuEugN1V5zW26gxUE7nMLuOwwaFKKJFnOrxYSLbYK7e
z61Oujx9AyNwRyCja/0JdMEV9PHJHsn/mkLjXLnkgFmoxX75dsISBpIjy5f Q0t5
xzbkVxBV3ZGW5OHRIy76h0gyrsRTNVr2BK3j apQUfQkdlPLq2DxHtJjuL5XrkVj
4mnUESS8Suhb8nEebc367kyXlVr453dHuQKfOUHtTmNOh5hin9yYOt0c1Dcyqsm
ue7TkHwniAryq4QsukxckiTyIAU4q 2BjO0gULy9C/3Nu8guFtLof DEO9t2g0sP
CFcn9QtLIdF oeMNMIIFAzCCA ugAwIBAgIQGLLLuqME8aAPwfLzJkYqSjANBgkq
hkiG9w0BAQUFADCBgTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFu
138
Y2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExp
bWl0ZWQxJzAlBgNVBAMTHkNPTU9ETyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAe
Fw0wNjEyMDEwMDAwMDBaFw0xOTEyMzEyMzU5NTlaMHIxCzAJBgNVBAYTAkdCMRsw
GQYDVQQIExJHcmVhdGVyIE1hbmNoZXN0ZXIxEDAOBgNVBAcTB1NhbGZvcmQxGjAY
BgNVBAoTEUNPTU9ETyBDQSBMaW1pdGVkMRgwFgYDVQQDEw9Fc3NlbnRpYWxTU0wg
Q0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCt8AiwcsargxIxF3CJ
hakgEtSYau2A1NHf5I5ZLdOWIY120j8YC0YZYwvHIPPlC92AGvFaoL0dds23Izp0
XmEbdaqb1IX04XiR0y3hr/yYLgbSeT1awB8hLRyuIVPGOqchfr7tZ291HRqfalsG
s2rjsQuqag7nbWzDypWMN84hHzWQfdvaGlyoiBSyD8gSIF/F03/o4Tjg27z5H6Gq
1huQByH6RSRQXScqoChBRVt9vKCiL6qbfltTxfEFFld Edc7tNkBdtzffRDPUanl
OPJ7FAB1WfnwWdsXPvev5gItpHnBXaIcw5rIp6gLSApqLn8tl2X2xQScRMiZln5
pN0vAgMBAAGjggGDMIIBfzAfBgNVHSMEGDAWgBQLWOWLxkwVN6RAqTCpIb5HNlpW
/zAdBgNVHQ4EFgQU2svqrVsIXcz//CZUzknlVcY49PgwDgYDVR0PAQH/BAQDAgEG
MBIGA1UdEwEB/wQIMAYBAf8CAQAwIAYDVR0lBBkwFwYKKwYBBAGCNwoDAwYJYIZI
AYb4QgQBMD4GA1UdIAQ3MDUwMwYEVR0gADArMCkGCCsGAQUFBwIBFh1odHRwczov
L3NlY3VyZS5jb21vZG8uY29tL0NQUzBJBgNVHR8EQjBAMD6gPKA6hjhodHRwOi8v
Y3JsLmNvbW9kb2NhLmNvbS9DT01PRE9DZXJ0aWZpY2F0aW9uQXV0aG9yaXR5LmNy
bDBsBggrBgEFBQcBAQRgMF4wNgYIKwYBBQUHMAKGKmh0dHA6Ly9jcnQuY29tb2Rv
Y2EuY29tL0NvbW9kb1VUTlNHQ0NBLmNydDAkBggrBgEFBQcwAYYYaHR0cDovL29j
c3AuY29tb2RvY2EuY29tMA0GCSqGSIb3DQEBBQUAA4IBAQAtlzR6QDLqcJcvgTtL
eRJ3rvuq1xqo2l/zodueTZbLN3qo6u6bldudu Ennv1F7Q5Slqz0J790qpL0pcRD
AB8OtXj5isWMcL2aejGjKdBZa0wztSz4iw SY1dWrCRnilsvKcKxudokxeRiDn55
w/65g onO7wdQ7VuF6r7yJiIatnyfKH2cboZT7g440LX8NqxwCPf3dfxp 0Jj1ag
q8MLy6SSgIGSH6lv Wwz3D5XxqfyH8wqfOQsTEZf6/Nh9yvENZ NWPU6g0QO2JOs
TGvMd/QDzczc4BxLXSXaPV7Od4rhPsbXlM1wSTz/Dr0ISKvlUhQVnQ6cGodWaK2c
CQBkMIIEqzCCA5OgAwIBAgIQLnmDLpCIh qLjvMabuZ6RDANBgkqhkiG9w0BAQUF
ADCBkzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQHEw5TYWx0IExh
a2UgQ2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMSEwHwYDVQQL
ExhodHRwOi8vd3d3LnVzZXJ0cnVzdC5jb20xGzAZBgNVBAMTElVUTiAtIERBVEFD
b3JwIFNHQzAeFw0wNjEyMDEwMDAwMDBaFw0yMDA1MzAxMDQ4MzhaMIGBMQswCQYD
VQQGEwJHQjEbMBkGA1UECBMSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHEwdT
YWxmb3JkMRowGAYDVQQKExFDT01PRE8gQ0EgTGltaXRlZDEnMCUGA1UEAxMeQ09N
T0RPIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIIBIjANBgkqhkiG9w0BAQEFAAOC
AQ8AMIIBCgKCAQEA0ECLi3LjkRv3UcEbVASY06m/weaKXTuH 7uIzg3jLz8GlvCi
KVCZrts7oVewdFFxze1CkU1B/qnI2GqGd0S7WWaXUF601CxwRM/aN5VCaTwwxHGz
139
FDASBgNVBAoTC0FkZFRydXN0IEFCMSYwJAYDVQQLEx1BZGRUcnVzdCBFeHRlcm5h
bCBUVFAgTmV0d29yazEiMCAGA1UEAxMZQWRkVHJ1c3QgRXh0ZXJuYWwgQ0EgUm9v
dDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALf3GjPm8gAELTngTlvt
H7xsD821 iO2zt6bETOXpClMfZOfvUq8k 0DGuOPz VtUFrWlymUWoCwSXrbLpX9
uMq/NzgtHj6RQa1wVsfwTz/oMp50ysiQVOnGXw94nZpAPA6sYapeFI eh6FqUNzX
mk6vBbOmcZSccbNQYArHE504B4YCqOmoaSYYkKtMsE8jqzpPhNjfzp/haW 710LX
a0Tkx63ubUFfclpxCDezeWWkWaCUN/cALw3CknLa0Dhy2xSoRcRdKn23tNbE7qzN
E0S3ySvdQwAl mG5aWpYIxG3pzOPVnVZ9c0p10a3CitlttNCbxWyuHv77 ldU9U0
WicCAwEAAaOB3DCB2TAdBgNVHQ4EFgQUrb2YejS0Jvf6xCZU7wO94CTLVBowCwYD
VR0PBAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wgZkGA1UdIwSBkTCBjoAUrb2YejS0
Jvf6xCZU7wO94CTLVBqhc6RxMG8xCzAJBgNVBAYTAlNFMRQwEgYDVQQKEwtBZGRU
cnVzdCBBQjEmMCQGA1UECxMdQWRkVHJ1c3QgRXh0ZXJuYWwgVFRQIE5ldHdvcmsx
IjAgBgNVBAMTGUFkZFRydXN0IEV4dGVybmFsIENBIFJvb3SCAQEwDQYJKoZIhvcN
AQEFBQADggEBALCb4IUlwtYj4g WBpKdQZic2YR5gdkeWxQHIzZlj7DYd7usQWxH
YINRsPkyPef89iYTx4AWpb9a/IfPeHmJIZriTAcKhjW88t5RxNKWt9x Tu5w/Rw5
6wwCURQtjr0W4MHfRnXnJK3s9EK0hZNwEGe6nQY1ShjTK3rMUUKhemPR5ruhxSvC
Nr4TDea9Y355e6cJDUCrat2PisP29owaQgVR1EX1n6diIWgVIEM8med8vSTYqZEX
c4g/VhsxOBi0cQ azcgOno4uG GMmIPLHzHxREzGBHNJdmAPx/i9F4BrLunMTA5a
mnkPIAou1Z5jJh5VkpTYghdae9C8x49OhgQ=
-----END CERTIFICATE-----</item>
<item key='1'>-----BEGIN CERTIFICATE----MIIEpjCCA46gAwIBAgIQRurwlgVMxeP6Zepun0LGZDANBgkqhkiG9w0BAQUFADBv
MQswCQYDVQQGEwJTRTEUMBIGA1UEChMLQWRkVHJ1c3QgQUIxJjAkBgNVBAsTHUFk
ZFRydXN0IEV4dGVybmFsIFRUUCBOZXR3b3JrMSIwIAYDVQQDExlBZGRUcnVzdCBF
eHRlcm5hbCBDQSBSb290MB4XDTA1MDYwNzA4MDkxMFoXDTIwMDUzMDEwNDgzOFow
gZMxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJVVDEXMBUGA1UEBxMOU2FsdCBMYWtl
IENpdHkxHjAcBgNVBAoTFVRoZSBVU0VSVFJVU1QgTmV0d29yazEhMB8GA1UECxMY
aHR0cDovL3d3dy51c2VydHJ1c3QuY29tMRswGQYDVQQDExJVVE4gLSBEQVRBQ29y
cCBTR0MwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDf7lgQoituVcSO
vy5GCefgCA8uK3oTlBu99raAjmUFkwAevK/iD44ZDRJH7Kyto/oucPjebvtWQhWe
LlzvI94huQV2JxkPT9bDnLS lBlj8qYRCutTSJy 8ik7FugaoEymyfQYWWjAcPJT
AMBeUIKlVm82 UrgRIagTU7WR25JSstn16bEBbmOHvT8/83nNuCcBWyyMyIV0LTg
zBfAssD0/jI/KSqVe9jyp04PVHyhDYCzCQPB/1zdXpo vK68R4pqrnHKH7EquF9C
BQvsRjDRcgvK6VZt9e/feL5hurKlrgRMvKisaRWXve/rtIy/NfjUw9EoDlw6n3AY
MyB3xKKvAgMBAAGjggEXMIIBEzAfBgNVHSMEGDAWgBStvZh6NLQm9/rEJlTvA73g
142
JMtUGjAdBgNVHQ4EFgQUUzLRs89/ uDxoF2FTpLSnkUdtE8wDgYDVR0PAQH/BAQD
AgEGMA8GA1UdEwEB/wQFMAMBAf8wIAYDVR0lBBkwFwYKKwYBBAGCNwoDAwYJYIZI
AYb4QgQBMBEGA1UdIAQKMAgwBgYEVR0gADB7BgNVHR8EdDByMDigNqA0hjJodHRw
Oi8vY3JsLmNvbW9kb2NhLmNvbS9BZGRUcnVzdEV4dGVybmFsQ0FSb290LmNybDA2
oDSgMoYwaHR0cDovL2NybC5jb21vZG8ubmV0L0FkZFRydXN0RXh0ZXJuYWxDQVJv
b3QuY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQBjhpIQsRP6N76OKrYbikP1XK4OFN/3
aUB/vxpxAAnYv9QkSr/gk/8B2AvGD x R5ywXfd8FJ38wDOShFvSg/RS4iJYdPxD
Gz no1jaA/288Drk7cwSu8m5rnsEoARyv neLdKnUWYAc9K9fqqeU5Z9abIYPo6t
VlB 99Ww/zliZYKMllfDj/dg9sKNNIf8T0Pl278cqvaGzebfET NB/dtgxPAOIg5
YKF MOHjiD6ku2NvLOmKaCzulmmsBGHhT04OnXJM9nk4yMdIaW UD3S0vMjPV025
dXGWDYoGC vd0PA8fcYumEZqOMcCtci4smV13tqQCLZ3uFMAJctHynNf
-----END CERTIFICATE-----</item>
<item key='2'>-----BEGIN CERTIFICATE----MIIEqzCCA5OgAwIBAgIQLnmDLpCIh qLjvMabuZ6RDANBgkqhkiG9w0BAQUFADCB
kzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQHEw5TYWx0IExha2Ug
Q2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMSEwHwYDVQQLExho
dHRwOi8vd3d3LnVzZXJ0cnVzdC5jb20xGzAZBgNVBAMTElVUTiAtIERBVEFDb3Jw
IFNHQzAeFw0wNjEyMDEwMDAwMDBaFw0yMDA1MzAxMDQ4MzhaMIGBMQswCQYDVQQG
EwJHQjEbMBkGA1UECBMSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHEwdTYWxm
b3JkMRowGAYDVQQKExFDT01PRE8gQ0EgTGltaXRlZDEnMCUGA1UEAxMeQ09NT0RP
IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEA0ECLi3LjkRv3UcEbVASY06m/weaKXTuH 7uIzg3jLz8GlvCiKVCZ
rts7oVewdFFxze1CkU1B/qnI2GqGd0S7WWaXUF601CxwRM/aN5VCaTwwxHGzUvAh
TaHYujl8HJ6jJJ3ygxaYqhZ8Q5sVW7euNJH 1GImGEaaP vB fGQV useg2L23Iw
ambV4EajcNxo2f8ESIl33rXp 2dtQem8Ob0y2WIC8bGoPW43nOIv4tOiJovGuFVD
iOEjPqXSJDlqR6sA1KGzqSX DT nHbrTUcELpNqsOO9VUCQFZUaTNE8tja3G1CEZ
0o7KBWFxB3NH5YoZEr0ETc5OnKVIrLsm9wIDAQABo4IBCTCCAQUwHwYDVR0jBBgw
FoAUUzLRs89/ uDxoF2FTpLSnkUdtE8wHQYDVR0OBBYEFAtY5YvGTBU3pECpMKkh
vkc2Wlb/MA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MCAGA1UdJQQZ
MBcGCisGAQQBgjcKAwMGCWCGSAGG EIEATARBgNVHSAECjAIMAYGBFUdIAAwbQYD
VR0fBGYwZDAxoC gLYYraHR0cDovL2NybC5jb21vZG9jYS5jb20vVVROLURBVEFD
b3JwU0dDLmNybDAvoC2gK4YpaHR0cDovL2NybC5jb21vZG8ubmV0L1VUTi1EQVRB
Q29ycFNHQy5jcmwwDQYJKoZIhvcNAQEFBQADggEBANheksSuFNxDrcKkw2dFBx35
N6IZxxw3NZETHAfEfUKmDvCGXENrDkTPviRhOkKpzp1Mr3k5cN0OBCBOlZw83rdg
umNDQO1qD4FJRrsek8BL8/jhNkkbb7YMDfKQV4r8bZPyKMf6hgoosxcOWYoutr/N
143
4axMZmzyVZFWtzK/seR9teg6ti/bspzaUJOOTsWsmn5cnhI8O03GUHCzZSuO92uh
uyXAALv17BZlgQ771KMhlneaqHS8U6rCOVD/CwIJYcyVt9eIavZcxWjTFJUaR1/Z
y3kL48ThqsxE0ATrG7ttRAwixtQqc7ujMrrfLW5Fj3U m SbR6ivfsCSsVwvvE=
-----END CERTIFICATE-----</item>
<item key='3'>-----BEGIN CERTIFICATE----MIIFAzCCA ugAwIBAgIQGLLLuqME8aAPwfLzJkYqSjANBgkqhkiG9w0BAQUFADCB
gTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G
A1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxJzAlBgNV
BAMTHkNPTU9ETyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw0wNjEyMDEwMDAw
MDBaFw0xOTEyMzEyMzU5NTlaMHIxCzAJBgNVBAYTAkdCMRswGQYDVQQIExJHcmVh
dGVyIE1hbmNoZXN0ZXIxEDAOBgNVBAcTB1NhbGZvcmQxGjAYBgNVBAoTEUNPTU9E
TyBDQSBMaW1pdGVkMRgwFgYDVQQDEw9Fc3NlbnRpYWxTU0wgQ0EwggEiMA0GCSqG
SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCt8AiwcsargxIxF3CJhakgEtSYau2A1NHf
5I5ZLdOWIY120j8YC0YZYwvHIPPlC92AGvFaoL0dds23Izp0XmEbdaqb1IX04XiR
0y3hr/yYLgbSeT1awB8hLRyuIVPGOqchfr7tZ291HRqfalsGs2rjsQuqag7nbWzD
ypWMN84hHzWQfdvaGlyoiBSyD8gSIF/F03/o4Tjg27z5H6Gq1huQByH6RSRQXScq
oChBRVt9vKCiL6qbfltTxfEFFld Edc7tNkBdtzffRDPUanlOPJ7FAB1WfnwWdsX
Pvev5gItpHnBXaIcw5rIp6gLSApqLn8tl2X2xQScRMiZln5 pN0vAgMBAAGjggGD
MIIBfzAfBgNVHSMEGDAWgBQLWOWLxkwVN6RAqTCpIb5HNlpW/zAdBgNVHQ4EFgQU
2svqrVsIXcz//CZUzknlVcY49PgwDgYDVR0PAQH/BAQDAgEGMBIGA1UdEwEB/wQI
MAYBAf8CAQAwIAYDVR0lBBkwFwYKKwYBBAGCNwoDAwYJYIZIAYb4QgQBMD4GA1Ud
IAQ3MDUwMwYEVR0gADArMCkGCCsGAQUFBwIBFh1odHRwczovL3NlY3VyZS5jb21v
ZG8uY29tL0NQUzBJBgNVHR8EQjBAMD6gPKA6hjhodHRwOi8vY3JsLmNvbW9kb2Nh
LmNvbS9DT01PRE9DZXJ0aWZpY2F0aW9uQXV0aG9yaXR5LmNybDBsBggrBgEFBQcB
AQRgMF4wNgYIKwYBBQUHMAKGKmh0dHA6Ly9jcnQuY29tb2RvY2EuY29tL0NvbW9k
b1VUTlNHQ0NBLmNydDAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuY29tb2RvY2Eu
Y29tMA0GCSqGSIb3DQEBBQUAA4IBAQAtlzR6QDLqcJcvgTtLeRJ3rvuq1xqo2l/z
odueTZbLN3qo6u6bldudu Ennv1F7Q5Slqz0J790qpL0pcRDAB8OtXj5isWMcL2a
ejGjKdBZa0wztSz4iw SY1dWrCRnilsvKcKxudokxeRiDn55w/65g onO7wdQ7Vu
F6r7yJiIatnyfKH2cboZT7g440LX8NqxwCPf3dfxp 0Jj1agq8MLy6SSgIGSH6lv
Wwz3D5XxqfyH8wqfOQsTEZf6/Nh9yvENZ NWPU6g0QO2JOsTGvMd/QDzczc4BxL
XSXaPV7Od4rhPsbXlM1wSTz/Dr0ISKvlUhQVnQ6cGodWaK2cCQBk
-----END CERTIFICATE-----</item>
</dt_array>
</item>
144
<item key='product_type'>truebizid_wildcard</item>
<item key='domain'>*.example.com</item>
<item key='issue_date'>2011-10-05T00:00:00.000-04:00</item>
<item key='product_id'>1701</item>
<item key='contact_email'>zack@example.com</item>
<item key='start_date'>2011-10-05T00:00:00.000-04:00</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Uses the product ID to retrieve the properties for a Trust Service product.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_cert</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='product_id'>2096</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
146
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='cert_data'>
<dt_assoc>
<item key='certificate'>-----BEGIN CERTIFICATE----MIIEUTCCAzmgAwIBAgIDAX8yMA0GCSqGSIb3DQEBBQUAME8xCzAJBgNVBAYTAlVT
MRUwEwYDVQQKEwxHZW9UcnVzdCBJbmMxKTAnBgNVBAMTIEdlb1RydXN0IFByZS1Q
cm9kdWN0aW9uIFNVQiBDQSAzMB4XDTEyMDQyODIzNDIzMFoXDTEyMDUwODExMzQ0
OVowgZoxEzARBgNVBAsTCkdUMDgzMjUxNzMxMTAvBgNVBAsTKFNlZSB3d3cucmFw
aWRzc2wuY29tL3Jlc291cmNlcy9jcHMgKGMpMTIxLzAtBgNVBAsTJkRvbWFpbiBD
b250cm9sIFZhbGlkYXRlZCAtIFJhcGlkU1NMKFIpMR8wHQYDVQQDExZyYXBpZC5x
YXJlZ3Jlc3Npb24ub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
01fy13nKyEaR7BcXW/ZOzrgNbW/v57Q4HtJsFLhakoVU30C6N+xUwZMVMTpMlq5f
xmHjC8/bJN1vho9l3EI9W+QEFXcyh3O9F/11SPqFxStjA/F1R5uzIQuMwMpe4Z3o
EPAusTDDEZDn6KtDMrsjgDRXNUL6IjWHTErj9G4bl13bwqBUy6LyCQoGOpME5qNA
skJ3HWdv99xJy4b1XjOw5qekIrYYXcslV3INDnV+V+jR/LuU+JuqTaZKL5fnIp5i
147
n6WDTK1EYQ7L1KnA4WlXL0cOy7xCnH2AjR5iV+gOX0mypJ0RbCYWMWfQC+1BxLVP
/wlljvTkIaZkiGkJPz3KUwIDAQABo4HpMIHmMB8GA1UdIwQYMBaAFGV1riJo592U
KxNo1SwYK4YYVaDFMA4GA1UdDwEB/wQEAwIFoDAhBgNVHREEGjAYghZyYXBpZC5x
YXJlZ3Jlc3Npb24ub3JnMEQGA1UdHwQ9MDswOaA3oDWGM2h0dHA6Ly90ZXN0LWNy
bC5nZW90cnVzdC5jb20vY3Jscy9wcmVwcm9kc3ViY2EzLmNybDAMBgNVHRMBAf8E
AjAAMB0GA1UdDgQWBBQDOAEoYLLChTqOW8wOPRiHwcgQMjAdBgNVHSUEFjAUBggr
BgEFBQcDAQYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAMBPQE2zs+68mvwQ
xWs5ajDPkDerr5IGWwAPx9n9YonnIydHuB5wqAN6tr34f8wT4hqwMhGO1JPZzEyF
I3flV4Ca5P14bpLC96G4O8/XDG0off2tDYf5OVQgbNP/s93mvMhSo3jAHN3Enpn0
iLDRXuc+UVFmiakLrANsVGKzMReBeWtk0tej6ONSC0Ds6PGrlzHSXcWHR9WD1dVF
+1vKnaS2pp4nXBQthh1wbvk8+VekrYRaPy/5h3/9hRHVb85rb8hbLWSBfN6oyLRw
KZnecg3wOB449Hfi072JKEgEViBkuYJLr94KQ8gTSEtDlGmSLGCZaGsrtgmNbyne
aNzofSA=
-----END CERTIFICATE-----</item>
</dt_assoc>
</item>
<item key='expiry_date'>2012-05-08T07:34:49.000-04:00</item>
<item key='state'>active</item>
<item key='product_type'>quickssl</item>
<item key='domain'>example.com</item>
<item key='issue_date'>2012-04-30T11:27:59.000-04:00</item>
<item key='product_id'>2096</item>
<item key='contact_email'>zack@example.com</item>
<item key='start_date'>2012-04-28T19:42:30.000-04:00</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
148
get_contract
Description
Action & object
action = get_contract
object = domain
Usage
Retrieves the text of the Reseller agreement known as Exhibit A.
type
Required
Type of query.
Allowed value is exhibit_a.
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition / Value
contract
Returned if is_success
=1
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
150
151
get_deleted_domains
Description
Action & object
action =get_deleted_domains
object = domain
Usage
Lists domains that have been deleted due to expiration or deleted by request
(revoked). This command applies to all domains in a Reseller's profile.
Results include the domain, status, and deleted date.
All attributes are optional, but can be used to narrow the search criteria. If
no attributes are specified, the response contains all domains that were ever
deleted from your profile.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition / Value
admin_email
Optional
billing_email
Optional
del_from
Optional
Parameter
name
Obligation
Definition / Value
del_to
Optional
domain
Optional
exp_from
Optional
exp_to
Optional
limit
Optional
owner_email
Optional
page
Optional
tech_email
Optional
153
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition / Value
del_domains
page_size
Returned if specified in
the request and
is_success = true.
total
Del_Domains
Parameters within the del_domains associative array are described below.
Parameter name Obligation
Definition / Value
delete_date
delete_date_epoch
expire_date
expiredate_epoch
Definition / Value
name
reason
y-Request
xpired
ransferred
istorical
<item key="page">1</item>
<item key="billing_email">*</item>
<item key="exp_to">2014-10-10</item>
<item key="tech_email">*</item>
<item key="exp_from">2002-10-10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="page">1</item>
<item key="page_size">2</item>
<item key="total">2</item>
<item key="del_domains">
<dt_array>
156
<item key="0">
<dt_assoc>
<item
key="expiredate_epoch">1229135427</item>
<item key="delete_date">12-DEC-2004
21:31:30</item>
<item key="reason">By-Request</item>
<item
key="delete_date_epoch">1102905090</item>
<item key="name">pure1102905253608.com</item>
<item key="expiredate">12-DEC-2008
21:30:27</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item
key="expiredate_epoch">1229135516</item>
<item key="delete_date">12-DEC-2004
21:32:48</item>
<item key="reason">By-Request</item>
<item
key="delete_date_epoch">1102905168</item>
<item key="name">pure-
1102905358159.net</item>
<item key="expiredate">12-DEC-2008
21:31:56</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
157
get (domain)
Description
Action & object
action = get
object = domain
Usage
Queries various types of data regarding the user's domain. For example, the
all_info type allows you to retrieve all data for the domain linked to the
current cookie. The list type queries the list of domains associated with the
user's profile. The list type can also be used to return a list of domains that
expire within a specified range. The nameservers type returns the
nameservers currently acting as DNS servers for the domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
clean_ca_subset Optional
Definition / Value
Determines the type of contact_set values that
are returned for .CA domains when type =
admin or tech.
If clean_ca_subset = 1, the address data is
returned in the standard address fields
(address1, address2, and address3).
158
Parameter
name
Obligation
Definition / Value
If clean_ca_subset is not specified, the query
returns the values addr_address_number,
addr_corporative, addr_office,
addr_orientation, addr_street_cat, and
addr_street_name along with the standard
address fields (address1, address2, and
address3).
domain
Required if
cookie is not
submitted
limit
Optional
max_to_expiry
min_to_expiry
page
Optional
type
Required
auto_renew_flagDeprecated,
Returned list of domains.
Parameter
name
Obligation
Definition / Value
ca_whois_display_settingReturns the
current CIRA Whois Privacy setting for .CA
domains.
160
Deprecated
Parameter name
Obligation
Definition / Value
with_encoding_types
Deprecated
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
The response message returned varies depending on the value of the type
field that was used to send the request.
Obligation
Definition/Value
contact_set
descr
Obligation
Definition/Value
affiliate_id
Parameter name
Obligation
Definition/Value
is_success = 1
the domain.
descr
dns_errors
nameserver_list
registry_createdate
registry_expiredate
registry_transferdate
registry_updatedate
sponsoring_rsp
0Domain is
provisioned by a
different Reseller
162
Parameter name
Obligation
Definition/Value
tld_data
Deprecated
Parameter name
Obligation
Definition/Value
rant_no
Deprecated
Nameserver_List
Parameters within the nameserver_list associative array are described below.
Parameter
name
Obligation
Definition/Value
ip_address
ipv6
name
sort_order
163
Obligation
display
Returned if
Indicates the current setting for the CIRA WHOIS
is_success = Privacy setting.
true
Allowed values are:
individual
Returned if
is_success =
true
Definition/Value
Definition/Value
Obligation
Definition/Value
auto_renew
1Auto-renew.
164
Parameter
name
Obligation
Definition/Value
expiredate
let_expire
1Expire silently
Obligation
Definition/Value
forwarding_email
Obligation
Definition/Value
count
Returned when
type = list and
is_success =
true
domain_list
Returned when
type = list and
is_success =
true
ext_results
remainder
Returned when
type = list and
is_success =
true
Returned when
type = list and
is_success =
true
165
Domain_List
Parameters within the domain_list associative array are described below
Parameter
name
Obligation
Definition/Value
domain
Returned when
type = list and
is_success =
true
encoding_type
Returned when
type = list and
is_success =
true
Ext_Results
Parameters within the ext_results associative array are described below.
Parameter name Obligation
Definition/Value
auto_renew
Returned when
Status of the auto-renew flag:
type = list and
0Do not auto-renew
is_success = true
1Auto-renew
expiredate
Returned when
Expiration date of the domain.
type = list and
is_success = true
has_whois_privacy
Returned when
Indicates whether WHOIS Privacy is
type = list and
enabled:
is_success = true
0Disabled
1Enabled
let_expire
Returned when
Status of the let-expire flag:
type = list and
0Don't expire domain silently
is_success = true
1Expire domain silently
lock_state
Returned when
Flag indicating if the domain is locked to
type = list and
prevent transfers:
is_success = true
0Not locked.
sponsoring_rsp
1Locked.
Returned when
Flag indicating if the domain is sponsored
type = list and
by the reseller making the call:
is_success = true
0Not sponsoring RSP
1Sponsoring RSP
166
Deprecated
Parameter
name
Obligation
Definition/Value
wp_expiredate
Deprecated
wp_service
Deprecated
Obligation
Definition/Value
nameserver_list
Nameserver_List
Parameters within the nameserver_list associative array are described below.
Parameter
name
Obligation
Definition/Value
ipaddress
Returned when
type =
nameservers
name
Returned when
type =
nameservers
sortorder
Returned when
type =
nameservers
Deprecated
Parameter
name
Obligation
Definition/Value
encoding_type
Deprecated
Obligation
Definition/Value
business
domain_enabled
YEnabled
NDisabled
phone
rsp_enabled
url
YEnabled
NDisabled
Obligation
auctionescrow
can_modify
Definition/Value
0Not in escrow.
1In escrow.
domain_supports
1Can be modified.
Parameter name
Obligation
Definition/Value
is_success = true
lock_state
1Locked.
parkp_status
Optional
transfer_away_in_
progress
Optional
Obligation
Definition/Value
tld_data
Returned for
An associative array containing registrant
.ASIA, .AR, .AU,
information.
.BR, .CL. .COOP,
For more information, see tld_data.
.DE, .DK, .FI,
.HK, .HU, .IT,
.JOBS, .LV, .MX,
.NO, .PM, .PRO,
.PT, .RE, .RO,
.RU, .SE, .TF,
.US, .WF, .XXX, .YT,
and .ZA domains
169
Parameter
name
Obligation
Definition/Value
when type
tld_data and
is_success = true
Obligation
Definition / Value
state
Deprecated
Parameter
name
Obligation
Definition/Value
changeable
Deprecated
Obligation
Definition / Value
record_count
waiting_history
170
Waiting_History
Parameters within the waiting_history associative array are described below.
Parameter
name
Obligation
Definition / Value
create_time
current_state
reg_type
xpack_req_id
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
171
<item key="cookie">h5LkkIeCjbTDndsL:235293:6221</item>
<item key="action">GET</item>
<item key="attributes">
<dt_assoc>
<item key="clean_ca_subset">1</item>
<item key="type">admin</item>
</dt_assoc>
</item>
<item key="registrant_ip">10.0.62.128</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="contact_set">
<dt_assoc>
<item key="admin">
172
<dt_assoc>
<item key="address1">32 Oak Street</item>
<item key="address2"></item>
<item key="address3"></item>
<item key="city">Toronto</item>
<item key="state">ON</item>
<item key="postal_code">M1M1M1</item>
<item key="country">CA</item>
<item key="org_name">Example Company</item>
<item key="phone">+1.4165551212</item>
<item key="fax"></item>
<item key="first_name">Marlin</item>
<item key="last_name">Wilk</item>
<item key="email">test@example.com</item>
<item key="lang">EN</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without the clean_ca_subset parameter
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
173
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET</item>
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.62.128</item>
<item key="cookie">HyaiLx1KeHzxRWdX:235293:5217</item>
<item key="attributes">
<dt_assoc>
<item key="type">admin</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Query Successful</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
174
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="addr_address_number"></item>
<item key="addr_corporative"></item>
<item key="addr_office"></item>
<item key="addr_orientation"></item>
<item key="addr_street_cat"></item>
<item key="addr_street_name">32 Oak Street</item>
<item key="address1">32 Oak Street</item>
<item key="address2"></item>
<item key="address3"></item>
<item key="city">Toronto</item>
<item key="state">ON</item>
<item key="postal_code">M1M1M1</item>
<item key="country">CA</item>
<item key="org_name">Example Company</item>
<item key="first_name">Marlin</item>
<item key="last_name">Wilk</item>
<item key="lang">EN</item>
<item key="email">test@example.com</item>
<item key="phone">+1.4165551212</item>
<item key="fax"></item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
175
Example 3
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="domain">mydomain.com</item>
<item key="type">admin</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
176
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="contact_set">
<dt_assoc>
<item key="billing">
<dt_assoc>
<item key="org_name">Empire Limited Inc.</item>
<item key="first_name">George</item>
<item key="last_name">Walsh</item>
<item key="address1">44 Hemlock St.</item>
<item key="address2"></item>
<item key="address3"></item>
<item key="city">Tampa</item>
<item key="state">Florida</item>
<item key="country">US</item>
<item key="postal_code">90211</item>
<item key="phone">+1.4165551122</item>
<item key="fax"></item>
<item key="email">gwalsh@mydomain.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
177
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
178
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
<item key="auto_renew">0</item>
21:27:25</item>
21:27:25</item>
21:27:25</item>
<item key="registry_createdate">2006-12-12
<item key="registry_expiredate">2007-12-12
<item key="registry_updatedate">2006-12-12
<item key='affiliate_id'>NUAffiliate123</item>
<item key="sponsoring_rsp">1</item>
<item key="expiredate">2007-12-12 21:27:25</item>
<item key="let_expire">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="ipaddress">21.40.33.21</item>
<item key="sortorder">1</item>
<item key="name">ns1.systemdns.com</item>
</dt_assoc>
</item>
179
<item key="1">
<dt_assoc>
<item
key="ipaddress">207.136.100.142</item>
<item key="sortorder">2</item>
<item key="name">ns2.systemdns.com</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="ipaddress">24.22.23.28</item>
<item key="sortorder">3</item>
<item
key="name">patrick.example.com</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="ipaddress">24.22.23.24</item>
<item key="sortorder">4</item>
<item key="name">qa1.example.com</item>
</dt_assoc>
</item>
<item key="4">
<dt_assoc>
<item key="ipaddress">24.22.23.25</item>
<item key="sortorder">5</item>
<item key="name">qa2.example.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
180
</body>
</OPS_envelope>
Example 2
For .CA domains
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET</item>
<item key="object">DOMAIN</item>
<item key="cookie">NNMxlmPhKbMOWswr:654537:28355</item>
<item key="attributes">
<dt_assoc>
<item key="limit">10</item>
<item key="type">all_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
181
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Query Successful</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="registry_createdate">2009-10-26 00:00:00</item>
<item key="fqdn2">ns3.systemdns.com</item>
<item key="legal_type">CCT</item>
<item key="fqdn1">ns2.systemdns.com</item>
<item key="sponsoring_rsp">1</item>
<item key="expiredate">2010-10-26 00:00:00</item>
<item key="auto_renew">0</item>
<item key="registry_expiredate">2010-10-26 00:00:00</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="sortorder">1</item>
<item key="ipaddress"></item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns3.systemdns.com</item>
<item key="sortorder">2</item>
182
<item key="ipaddress"></item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="sortorder">3</item>
<item key="ipaddress"></item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="let_expire">0</item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
<dt_assoc>
<item key="org_name">Setter Sanctuary</item>
<item key="first_name">Owen</item>
<item key="last_name">Ottway</item>
<item key="address1">32 Oak St.</item>
<item key="address2">Suite 100</item>
<item key="address3"/>
<item key="city">Toronto</item>
<item key="state">ON</item>
<item key="postal_code">M1M1M1</item>
<item key="country">CA</item>
<item key="phone">+14165551212</item>
<item key="fax"></item>
<item key="email">ottway@example.com</item>
</dt_assoc>
</item>
<item key="admin">
<dt_assoc>
<item key="country">CA</item>
183
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
For .AU domains
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>CpnuM7wfv81zsYGl:685255:1736</item>
<item key='attributes'>
<dt_assoc>
<item key='type'>all_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
185
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="tld_data">
<dt_assoc>
<item key="au_registrant_info">
<dt_assoc>
<item key="eligibility_type">Charity</item>
<item key="registrant_id">38 144 482 002</item>
<item key="registrant_id_type">ABN</item>
<item key="registrant_name">Example Company Ltd</item>
<item key="policy_reason">1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="registry_createdate">2010-09-22 18:29:35</item>
<item key="auto_renew">1</item>
<item key="sponsoring_rsp">1</item>
<item key="expiredate">2012-09-22 18:29:35</item>
186
Example 4
For .XXX domains
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
187
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>DopdK7wvd8erYGl:502741:5622</item>
<item key='attributes'>
<dt_assoc>
<item key='type'>all_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Query Successful</item>
188
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='auto_renew'>1</item>
<item key='ipr_data'>
<dt_assoc>
<item key='icm_membership_id'>123456</item>
</dt_assoc>
</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='registry_updatedate'>2011-11-29 21:16:04</item>
<item key='sponsoring_rsp'>1</item>
<item key='registry_createdate'>2011-11-29 21:11:25</item>
<item key='expiredate'>2012-11-29 21:11:25</item>
<item key='let_expire'>0</item>
<item key='registry_expiredate'>2012-11-29 21:11:25</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='name'>ns1.systemdns.com</item>
<item key='sortorder'>1</item>
<item key='ipaddress'/>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='name'>ns2.systemdns.com</item>
<item key='sortorder'>2</item>
<item key='ipaddress'/>
</dt_assoc>
</item>
189
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol"> XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">OK</item>
<item key="attributes">
<dt_assoc>
<item key="individual">Y</item>
<item key="display">FULL</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">domain</item>
<item key="cookie">24128866:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="type">domain_auth_info</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
192
<item key="domain_auth_info">ewgnRwnH</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">domain</item>
<item key="cookie">24128866:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="type">expire_action</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
193
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="ext_results">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain1">
<dt_assoc>
<item key="auto_renew">1</item>
<item key="expiredate">2001-07-15
15:41:11</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
194
<item key="domain2">
<dt_assoc>
<item key="auto_renew">0</item>
<item key="expiredate">2001-11-21
14:16:23</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
<item key="count">33</item>
<item key="domain_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">domain1</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="remainder">1</item>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
195
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">domain</item>
<item key="cookie">24128866:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="type">forwarding_email</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
196
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="count">1</item>
<item key="remainder">0</item>
<item key="domain_list">
<dt_array>
<item key="0">example.com</item>
</dt_array>
</item>
<item key="ext_results">
<dt_array>
<item key="0">
<dt_assoc>
<item key="example.com">
<dt_assoc>
<item key="let_expire">0</item>
<item key="wp_service">0</item>
198
key="has_whois_privacy">0</item>
<item
<item key="sponsoring_rsp">1</item>
<item key="auto_renew">0</item>
<item key="lock_state">0</item>
<item key="expiredate">0</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
199
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
200
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
<item key="type">nameservers</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="ipaddress">21.40.33.21</item>
<item key="sortorder">1</item>
<item key="name">ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item
key="ipaddress">207.136.100.142</item>
<item key="sortorder">2</item>
<item key="name">ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
201
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
202
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<item key="object">domain</item>
<item key="cookie">24128866:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="type">rsp_whois_info</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="url"/>
<item key="domain_enabled">Y</item>
<item key="rsp_enabled">Y</item>
<item key="fax"/>
204
<item key="business">Example</item>
<item key="opt_info">This company may be contacted
for domain login/passwords, DNS/Nameserver changes, and general domain
support questions.</item>
<item key="email">fraser@example.com</item>
<item key="phone">+1.4165350123</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">DOMAIN</item>>
<item key="attributes">
<dt_assoc>
<item key="domain">mydomain.com</item
<item key="type">rsp_whois_info</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
205
</data_block>
</body>
</OPS_envelope>
Response
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="business">Enterprise Limited Inc</item>
<item key="email">rspemail@elimited.com</item>
<item key="domain_enabled">Y</item>
<item key="rsp_enabled">Y</item>
<item key="phone">+1351.3451212</item>
<item key="fax"></item>
<item key="url"></item>
<item key="opt_info"></item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
206
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
207
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="can_modify">0</item>
<item key="domain_supports">1</item>
<item key="auctionescrow">1</item>
<item key="parkp_status">enabled</item>
<item key="lock_state">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="can_modify">0</item>
<item key="domain_supports">1</item>
<item key="parkp_status"/>
<item key="lock_state">0</item>
<item key="transfer_away_in_progress">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>lQr4eKXz4ydiFBXL:698303:1653</item>
209
<item key='attributes'>
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Query Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='ced_info'>
<dt_assoc>
<item
key='legal_entity_type_info'>proprietorship</item>
<item key='locality_state_prov'>NSW</item>
<item key='id_type'>other</item>
210
<item key='contact_type'>tech</item>
<item key='locality_city'>Sydney</item>
<item key='locality_country'>AU</item>
<item key='id_type_info'>driver\'s license</item>
<item key='legal_entity_type'>other</item>
<item key='id_number'>AB1234567</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
For a .COOP domain
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>ndxOATL2zdtVpWXJ:710538:6469</item>
<item key='attributes'>
211
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Query Successful</item>
<item key='attributes'>
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='coop_verification_code'>123456789</item>
</dt_assoc>
</item>
</dt_assoc>
212
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
For a .DK domain
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>pKuqcg3if1AeYWB8:754002:2258</item>
<item key='attributes'>
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
213
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Query Successful</item>
<item key='attributes'>
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>organization</item>
<item key='registrant_vat_id'>123456789</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
214
Example 4
For a .JOBS domain
Request
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>7rQitruAeYGgKcBO:707623:6222</item>
<item key='attributes'>
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
215
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Query Successful</item>
<item key='attributes'>
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='jobs_admin_type'>Yes</item>
<item key='jobs_industry_type'>Supply Chain
Management</item>
<item key='jobs_title'>HR Generalist</item>
<item key='jobs_association_member'>Yes</item>
<item
key='jobs_website'>http://www.example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
216
Example 5
For .LV and .COM.LV domains
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>BOx2X6bZrHX4HeXp:710540:6468</item>
<item key='attributes'>
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
217
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Query Successful</item>
<item key='attributes'>
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>individual</item>
<item key='id_card_number'>987654321</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 6
For a .PRO domain
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
218
</header>
<body>
<data_block>
<dt_assoc>
<item key='attributes'>
<dt_assoc>
<item key='type'>tld_data</item>
</dt_assoc>
</item>
<item key='protocol'>XCP</item>
<item key='action'>get</item>
<item key='object'>domain</item>
<item key='cookie'>kXO4IpLLr7EJidWD:698312:17335</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Query Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
219
<dt_assoc>
<item key='tld_data'>
<dt_assoc>
<item key='professional_data'>
<dt_assoc>
<item key='profession'>Dentist</item>
<item key='license_number'>123456789</item>
<item key='authority_website'>http://www.cdaadc.ca/</item>
<item key='authority'>Canadian Dental
Association</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<item key="object">domain</item>
<item key="cookie">24128866:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="type">waiting_history</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
<item key="record_count">0</item>
<item key="waiting_history">
<dt_array/>
</item>
</dt_assoc>
221
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
222
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
<dt_assoc>
<item key="state">enabled</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET</item>
<item key="object">DOMAIN</item>
<item key="cookie">963351639</item>
<item key="attributes">
<dt_assoc>
<item key="type">xpack_waiting_history</item>
<item key="limit">10</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="attributes">
224
<dt_assoc>
<item key="record_count">1</item>
<item key="waiting_history">
<dt_array>
<item key="0">
<dt_assoc>
<item key="xpack_req_id">156013</item>
<item key="current_state">INITIATE</item>
<item key="create_time">05-JAN-2006
03:25:18</item>
<item key="req_type">domain_change</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
225
get_domain_affiliate_id
Description
Action & object
action = get_domain_affiliate_id
object = domain
Usage
Retrieves the affiliate id associated with a domain.
domain
Required
226
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition / Value
affiliate_id
Returned if is_success
=1
227
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='response_text'>Command Successful</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='affiliate_id'>UpdatedAffiliate</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
228
get_domains_contacts
Description
Action & object
action = get_domains_contacts
object = domain
Usage
Queries the contact information for the specified domains.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain_list
Always
returned
request
229
Attributes
The attributes array includes an array of associative arrays, one for each
domain queried. The associative array for each domain includes the contact
set for that domain.
230
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="js3.be">
<dt_assoc>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
<item key="js4.be">
<dt_assoc>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
231
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
232
get_domains_by_expiredate
Description
Action & object
action = get_domains_by_expiredate
object = domain
Usage
Retrieves domains that expire within a specified date range.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
exp_from
Required
exp_to
Required
limit
Optional - if not
The number of domains to return on each
specified, the default '40' page.
will be used.
page
Optional - if not
specified, the default '1'
will be used.
233
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
exp_domains
Returned if
Lists the domains that expire during the specified
is_success = period.
true
For more information, see the Exp_Domains table
below.
page
Returned if
The number of the page retrieved.
is_success =
true
remainder
Returned if
Indicates if some expiring domains were not
is_success = returned due to restrictions set by the page and
true
limit values.
total
Definition/Value
Returned if
The total number of domains expiring in the
is_success = specified date range.
true
Exp_Domains
Parameters within the exp_domains associative array are described below.
Parameter
name
Obligation
Definition/Value
expiredate
Always
Parameter
name
Obligation
Definition/Value
returned
f_auto_renew
Always
returned
f_let_expire
Always
returned
name
Always
returned
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Command successful</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="page">1</item>
<item key="total">2</item>
<item key="remainder">0</item>
<item key="exp_domains">
<dt_array>
<item key="0">
<dt_assoc>
<item key="f_let_expire">N</item>
<item key="name">katarina.biz</item>
<item key="expiredate">2009-12-18
23:59:59</item>
<item key="f_auto_renew">N</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
236
<item key="name">kristina.ch</item>
<item key="expiredate">2009-12-18
23:59:59</item>
<item key="f_let_expire">N</item>
<item key="f_auto_renew">N</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
237
get_notes
Description
Action & object
action = get_notes
object = domain
Usage
Retrieves the domain notes that detail the history of the domain, for
example, renewals and transfers.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
limit
Optional
order_id
Optional
page
Optional
transfer_id
Optional
type
Required
238
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
notes
Returned if
The contents of the note.
is_success =
timestampDate and time the note was
true
recorded, in the format DD-MMM-YYYY
hh:mm:ss.
page
Optional
page_size
Returned if
The maximum number of notes returned per page.
is_success =
true
total
Returned if
Total number of notes returned.
is_success =
true
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_notes</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="page">1</item>
<item key="order_id">123456</item>
<item key="type">order</item>
<item key="limit">100</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
240
241
get_order_info
Description
Action & object
action = get_order_info
object = domain or trust_service
Usage
Queries all the information on an order ID, but does not return sensitive
information such as username, password, and Authcode.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
order_id
Required
request
242
Domain attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name Obligation
field_hash
Definition/Value
Field Hash
Parameter name Obligation
Definition/Value
affiliate_id
Returned if
The associated affiliate ID.
is_success = true
and reg_type =
new, transfer,
premium, or sunrise
application_id
Returned if
is_success = true
and the order's
reg_type = sunrise
or landrush and the
order is for a .XXX
domain
application_status
Returned if
The status of the application. Allowed
is_success = true
values are:
and the order's
processedWaiting for
reg_type = sunrise
notification from registry.
and the order is for
completedDomain awarded
a .XXX domain
and manageable.
declinedDomain registration
unsuccessful.
not_availableThis status is
always returned for Sunrise B
applications.
comments
Optional
completed_date
Returned when
reg_type =
transfer
Definition/Value
cost
Returned if
is_success = true
domain
Returned if
is_success = true
encoding type
Returned if
The three-character tag that represents
is_success = true
the language encoding type for the
and reg_type =
domain. See "Appendix B: Encoding
new, transfer,
Types for IDNs".
premium, or sunrise
expiry_year
Returned if
is_success = true
and reg_type =
transfer
f_auto_renew
Returned if
is_success = true
f_lock_domain
Returned if
Indicates whether the domain is locked.
is_success = true
0Domain is not locked
and reg_type =
1Domain is locked
new, transfer,
premium, or sunrise
flag_saved_ns_
fields
Returned if
Indicates whether the nameserver
is_success = true
fields that were used were those
and reg_type =
submitted in the transaction request or
new, transfer,
the default nameserver information.
premium, or sunrise
flag_saved_tech_
fields
Returned if
Indicates whether the technical contact
is_success = true
fields that were used were those
and reg_type =
submitted in the transaction request or
new, transfer,
the default Reseller account technical
premium, or sunrise contact information.
forwarding_email
Returned if
The domain's e-mail address that is
is_success = true
used for forwarding purposes.
and reg_type =
new, transfer,
premium, or sunrise
fqdn1/2/3/4
Returned if
Nameservers submitted with the
is_success = true
registration.
and reg_type =
new, transfer,
premium, or sunrise
id
Returned if
is_success = true
244
Definition/Value
master_order_id
Returned if
The order ID for a group of domains
is_success = true
that are linked.
and reg_type =
new, transfer,
premium, or sunrise
notes
Returned if
is_success = true
order_date
Returned if
is_success = true
Returned if
is_success = true
and reg_type =
transfer
owner_request_
time
Returned if
is_success = true
and reg_type =
transfer
period
Returned if
is_success = true
processed_date
Returned if
is_success = true.
Empty for new
domain registration.
reg_domain
Returned if
An existing, active domain name in
is_success = true
OpenSRS, owned by the registrant that
and reg_type =
was used to link the newly registered or
new, transfer,
transferred domain to the profile of the
premium, or sunrise existing domain.
reg_type
Returned if
is_success = true
registry_request_
time
Returned if
is_success = true
and reg_type =
transfer
request_address
Returned if
Definition/Value
is_success = true
and reg_type =
transfer
status
Returned if
is_success = true
tld_data
transfer_notes
Returned if
is_success = true
and reg_type =
transfer
transfer_status
Returned if
is_success = true
and reg_type =
transfer
Obligation
Definition/Value
approver_email
Returned for
domain vetted
certificates if
is_success =
true.
contact_email
Returned if
The email contact from the order.
is_success = true
246
Parameter name
Obligation
Definition/Value
contact_set
Returned if
The current contact information for
is_success = true organization, admin, billing, and tech
contacts.
csr
Optional
domain
Optional
notes_list
Returned if
Event logging for the Trust Service order.
is_success = true For more information, see the Notes_list
table below.
order_id
Returned if
The ID of the Trust Service order.
is_success = true
period
Returned if
The number of years of the registration
is_success = true period. Allowed values are 1 4,
depending on the Trust Service.
comodo_evto 2
comodo_instantssl1 to 4
comodo_premiumssl1 to 4
comodo_premiumssl_wildcard1
to 4
comodo_ssl1 to 4
comodo_wildcard1 to 4
malwarescan1
quickssl1 to 4
quickssl_premium1 to 4
sgcsuper_certs1 to 4
sitelock_basic1
sitelock_premium1
sitelock_enterprise1
ssl1231 to 4
sslwebserver1 to 4
sslwebserver_wildcard1 to 2
sslwebserver_ev1 to 2
securesite1 to 4
securesite_ev1 to 2
securesite_pro1 to 4
securesite_pro_ev1 to 2
truebizid1 to 4
truebizid_wildcard1 to 4
247
Parameter name
Obligation
Definition/Value
truebizid_ev1 to 2
truste_hpp1 to 3
truste_tps1 to 3
trustwave_dv1 to 3
trustwave_ev1 to 2
trustwave_premiumssl1 to 3
trustwave_premiumssl_wildcard
1 to 3
price
Returned if
The price charged for the Trust Service.
is_success = true
product_id
Returned if
The ID number of the Trust Service
is_success = true product.
and order is
completed.
product_type
Returned if
The product type from the SSL Certificate
is_success = true inventory. The product types are detailed
in the allowed values section for this key.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
248
Parameter name
Obligation
Definition/Value
truebizid
truebizid_wildcard
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_
wildcard
reg_type
Returned if
Type of order, for example, new,
is_success = true renewal, transfer, upgrade.
server_type
Optional
Symantec,
thawte, and
GeoTrust
Comodo
apache2
apachessl
apacheapach
essl
citrix
apacheopens
sl
domino
ensim
apacheraven
hsphere
apachessl
iis4
c2net
iis6
cobaltseries
iis7
cobaltraq3
iplanet
cobaltraq2
cpanel
javawebserv
er
domino
netscape
ibmhttp
dominogo46
26
novell
dominogo46
25
oracle
other
ensim
plesk
hsphere
redhat
sap
249
Parameter name
Obligation
Definition/Value
Symantec,
thawte, and
GeoTrust
Comodo
iis
tomcat
iis4
webstar
iis5
whmcpanel
iplanet
ipswitch
netscape
ibmhttp
other
plesk
tomcat
weblogic
website
webstar
webstar4
zeusv3
Optional
state
Returned if
The state of the order
is_success = true Allowed values are:
approver-confirmedOwner has
confirmed the domain vetted
certificate.
awaiting-approvalOrder
processed successfully; waiting for
supplier approval.
completedOrder is complete.
in-progressOrder is in progress.
pendingOrder saved as
pending.
250
Parameter name
Obligation
Definition/Value
supplier_order_id
Returned if
The ID number for the vendor.
is_success = true
Notes_list
Parameters within the notes_list associative array are described below.
Parameter
name
Obligation
Definition/Value
date
Optional
note
Optional
type
Optional
251
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">3515690</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
252
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command completed
successfully</item>
<item key="attributes">
<dt_assoc>
<item key="field_hash">
<dt_assoc>
<item key="owner_first_name">Owen</item>
<item key="owner_last_name">Ottway</item>
<item key="owner_org_name">Example Inc.</item>
<item key="owner_address1">32 Oak St.</item>
<item key="owner_address2">Suite 500</item>
<item key="owner_address3"/>
<item key="owner_city">Santa Clara</item>
<item key="owner_state">CA</item>
<item key="owner_country">US</item>
<item key="owner_postal_code">90210</item>
<item
key="owner_phone">+1.4165550123x1902</item>
<item key="owner_fax">+1.4165550124</item>
<item key="owner_email">owner@example.com</item>
<item key="admin_first_name">Adler</item>
<item key="admin_last_name">Adams</item>
<item key="admin_org_name">Example Inc.</item>
<item key="admin_address1">32 Oak St.</item>
<item key="admin_address2">Suite 100</item>
<item key="admin_address3"/>
<item key="admin_city">Santa Clara</item>
253
<item key="admin_state">CA</item>
<item key="admin_country">US</item>
<item key="admin_postal_code">90210</item>
<item
key="admin_phone">+1.4165550123x1812</item>
<item key="admin_fax"/>
<item key="admin_email">admin@example.com</item>
<item key="billing_first_name">Bill</item>
<item key="billing_last_name">Burton</item>
<item key="billing_org_name">Example Inc.</item>
<item key="billing_address1">32 Oak St.</item>
<item key="billing_address2">Suite 200</item>
<item key="billing_address3"/>
<item key="billing_city">Santa Clara</item>
<item key="billing_state">CA</item>
<item key="billing_country">US</item>
<item key="billing_postal_code">90210</item>
<item
key="billing_phone">+1.4165550123x1248</item>
<item key="billing_fax"/>
<item
key="billing_email">burton@example.com</item>
<item key="tech_first_name">Ted</item>
<item key="tech_last_name">Tucker</item>
<item key="tech_org_name">Example Inc.</item>
<item key="tech_address1">32 Oak St.</item>
<item key="tech_address2">Suite 100</item>
<item key="tech_address3"/>
<item key="tech_city">Santa Clara</item>
<item key="tech_state">CA</item>
<item key="tech_country">US</item>
<item key="tech_postal_code">90210</item>
<item key="tech_phone">+1.4165550123x1243</item>
<item key="tech_fax">+1.4165550127</item>
<item key="tech_email">tucker@example.com</item>
<item key="comments"/>
254
2002.com</item>
17:07:42</item>
<item key="note">Transfer Request
message sent to owner@example.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="affiliate_id"/>
<item key="order_date">1083590189</item>
<item key="status">completed</item>
<item key="f_lock_domain">0</item>
<item key="forwarding_email"/>
<item key="flag_saved_ns_fields">1</item>
<item key="processed_date"/>
<item key="id">3515690</item>
<item key="encoding_type">undef</item>
<item key="flag_saved_tech_fields">1</item>
<item key="completed_date">1083590192</item>
<item key="f_auto_renew">Y</item>
<item key="fqdn1">ns1.systemdns.com</item>
<item key="fqdn2">ns2.systemdns.com</item>
<item key="fqdn3"/>
<item key="fqdn4"/>
<item key="fqdn5"/>
<item key="fqdn6"/>
<item key="reg_type">new</item>
<item key="notes">
<dt_array>
255
<item key="0">
<dt_assoc>
<item key="note">RSP Note: testing
first note</item>
<item key="timestamp">27-OCT-2007
11:15:03</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="note">RSP Note: testing
second note</item>
<item key="timestamp">27-OCT-2007
11:15:05</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="note">RSP Note: testing
third note</item>
<item key="timestamp">27-OCT-2007
11:15:07</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="master_order_id">0</item>
<item key="period">1</item>
<item key="cost">15</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
256
Example 2
For a .DK domain order
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='action'>get_order_info</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>607642</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> <OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
257
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully</item>
<item key='attributes'>
<dt_assoc>
<item key='field_hash'>
<dt_assoc>
<item key='owner_last_name'>Jensen</item>
<item key='owner_org_name'>Example Co.</item>
<item key='owner_address2'/>
<item key='owner_address3'/>
<item key='owner_city'>Copenhagen V</item>
<item key='owner_state'/>
<item key='owner_postal_code'>1610</item>
<item key='owner_phone'>+1.33257400</item>
<item key='owner_fax'>+1.33257410</item>
<item key='owner_email'>djensen@example.dk</item>
<item key='admin_org_name'>Example Co.</item>
<item key='admin_first_name'>Katrin</item>
<item key='admin_last_name'>Jensen</item>
<item key='admin_address1'>Gammel Kongevej 1</item>
<item key='admin_address2'/>
<item key='admin_address3'/>
<item key='admin_city'>Copenhagen V</item>
<item key='admin_state'/>
<item key='admin_country'>DK</item>
<item key='admin_postal_code'>1610</item>
<item key='admin_phone'>+1.33257400</item>
<item key='admin_fax'>+1.33257410</item>
<item key='admin_email'>kjensen@example.dk</item>
<item key='billing_org_name'>Example Co.</item>
<item key='billing_first_name'>Sarah</item>
<item key='billing_last_name'>Jensen</item>
<item key='billing_address1'>Gammel Kongevej 1</item>
<item key='billing_address2'/>
258
<item key='billing_address3'/>
<item key='billing_city'>Copenhagen V</item>
<item key='billing_state'/>
<item key='billing_postal_code'>1610</item>
<item key='billing_country'>DK</item>
<item key='billing_phone'>+1.33257400</item>
<item key='billing_fax'>+1.33257410</item>
<item key='billing_email'>sjensen@example.dk</item>
<item key='tech_org_name'>Example Co.</item>
<item key='tech_first_name'>Eric</item>
<item key='tech_last_name'>Jensen</item>
<item key='tech_address1'>Gammel Kongevej 1</item>
<item key='tech_address2'/>
<item key='tech_address3'/>
<item key='tech_city'>Copenhagen V</item>
<item key='tech_state'/>
<item key='tech_postal_code'>1610</item>
<item key='tech_country'>DK</item>
<item key='tech_phone'>+1.33257400</item>
<item key='tech_fax'>+1.33257410</item>
<item key='tech_email'>ejensen@example.dk</item>
<item key='affiliate_id'>affiliatetest1</item>
<item key='domain'>qatest1380643516039.dk</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>organization</item>
<item key='registrant_vat_id'>123456789</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='flag_saved_tech_fields'>1</item>
<item key='completed_date'>1380643717</item>
259
<item key='notes'>
<dt_array>
</dt_array>
</item>
<item key='reg_domain'/>
<item key='comments'/>
<item key='id'>607642</item>
<item key='cost'>15</item>
<item key='flag_saved_ns_fields'>1</item>
<item key='master_order_id'>0</item>
<item key='order_date'>1380643519</item>
<item key='f_auto_renew'>Y</item>
<item key='forwarding_email'/>
<item key='status'>completed</item>
<item key='fqdn1'>ns1.systemdns.com</item>
<item key='fqdn2'>ns2.systemdns.com</item>
<item key='fqdn3'/>
<item key='fqdn4'/>
<item key='fqdn5'/>
<item key='fqdn6'/>
<item key='reg_type'>new</item>
<item key='f_lock_domain'>0</item>
<item key='period'>1</item>
<item key='encoding_type'/>
<item key='processed_date'/>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
260
Example 3
For a .FR domain order
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_order_info</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>457700</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
261
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully</item>
<item key='attributes'>
<dt_assoc>
<item key='field_hash'>
<dt_assoc>
<item key='domain'>example.fr</item>
<item key='owner_org_name'>Example GmbH</item>
<item key='owner_first_name'>Astrid</item>
<item key='owner_last_name'>Bauer</item>
<item key='owner_address1'>Klostergasse 10</item>
<item key='owner_address2'/>
<item key='owner_address3'/>
<item key='owner_city'>Innsbruck</item>
<item key='owner_state'>Tirol</item>
<item key='owner_postal_code'>6020</item>
<item key='owner_country'>AT</item>
<item key='owner_phone'>+43 512 5333 10</item>
<item key='owner_fax'>+43 512 5333 11</item>
<item key='owner_email'>astrid@example.com</item>
<item key='admin_first_name'>Franz</item>
<item key='admin_last_name'>Bauer</item>
<item key='admin_org_name'>Example GmbH</item>
<item key='admin_address1'>Klostergasse 10</item>
<item key='admin_address2'/>
<item key='admin_address3'/>
<item key='admin_city'>Innsbruck</item>
<item key='admin_state'>Tirol</item>
<item key='admin_postal_code'>6020</item>
<item key='admin_country'>AT</item>
<item key='admin_phone'>+1.4165350125</item>
262
<item key='admin_fax'>+1.4165350124</item>
<item key='admin_email'>franz@example.com</item>
<item key='billing_first_name'/>
<item key='billing_last_name'/>
<item key='billing_org_name'/>
<item key='billing_address1'/>
<item key='billing_address2'/>
<item key='billing_address3'/>
<item key='billing_city'/>
<item key='billing_state'/>
<item key='billing_postal_code'/>
<item key='billing_country'/>
<item key='billing_phone'/>
<item key='billing_fax'/>
<item key='billing_email'/>
<item key='tech_first_name'>Jorg</item>
<item key='tech_last_name'>Bauer</item>
<item key='tech_org_name'>Example GmbH</item>
<item key='tech_address1'>Klostergasse 10</item>
<item key='tech_address2'/>
<item key='tech_address3'/>
<item key='tech_city'>Innsbruck</item>
<item key='tech_state'>Tirol</item>
<item key='tech_country'>AT</item>
<item key='tech_postal_code'>6020</item>
<item key='tech_phone'>+1.4165350125</item>
<item key='tech_fax'>+1.4165350124</item>
<item key='tech_email'>jorg@example.com</item>
<item key='processed_date'/>
<item key='fqdn1'>ns1.systemdns.com</item>
<item key='fqdn2'>ns2.systemdns.com</item>
<item key='fqdn3'/>
<item key='fqdn4'/>
<item key='fqdn5'/>
<item key='fqdn6'/>
263
<item key='period'>1</item>
<item key='encoding_type'/>
<item key='affiliate_id'/>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>individual</item>
<item key='date_of_birth'>1989-03-03</item>
<item key='country_of_birth'>FR</item>
<item key='postal_code_of_birth'>75008</item>
<item key='place_of_birth'>Paris</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='flag_saved_tech_fields'>1</item>
<item key='completed_date'>1329504888</item>
<item key='notes'>
<dt_array>
</dt_array>
</item>
<item key='reg_domain'/>
<item key='comments'/>
<item key='id'>457700</item>
<item key='cost'>15</item>
<item key='flag_saved_ns_fields'>1</item>
<item key='master_order_id'>0</item>
<item key='order_date'>1329504872</item>
<item key='f_auto_renew'>Y</item>
<item key='forwarding_email'/>
<item key='status'>completed</item>
<item key='reg_type'>new</item>
<item key='f_lock_domain'>0</item>
</dt_assoc>
264
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 4
For a .RE domain order
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">16732959</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
265
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully</item>
<item key='attributes'>
<dt_assoc>
<item key='field_hash'>
<dt_assoc>
<item key='owner_first_name'>Henrie</item>
<item key='owner_last_name'>LaFleur</item>
<item key='owner_org_name'>French Impressions</item>
<item key='owner_address1'>13 Rue Daze</item>
<item key='owner_address2'/>
<item key='owner_address3'/>
<item key='owner_city'>Paris</item>
<item key='owner_state'/>
<item key='owner_postal_code'>75002</item>
<item key='owner_country'>FR</item>
<item key='owner_phone'>+1.3365551212</item>
<item key='owner_fax'>>+1.3365550124</item>
<item key='owner_email'>lafleur@example.com</item>
<item key='admin_first_name'>Marie</item>
<item key='admin_last_name'>LaFleur</item>
266
<item key='tech_fax'>+1.3365550125</item>
<item key='tech_email'>pierre@example.com</item>
<item key='processed_date'/>
<item key='period'>1</item>
<item key='encoding_type'/>
<item key='affiliate_id'/>
<item key='domain'>example.re</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>individual</item>
<item key='date_of_birth'>1976-08-05</item>
<item key='country_of_birth'>FR</item>
<item key='postal_code_of_birth'>33023</item>
<item key='place_of_birth'>Bordeaux</item>
<item key='province_of_birth'>Gironde</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='flag_saved_tech_fields'>1</item>
<item key='completed_date'>1341517755</item>
<item key='notes'>
<dt_array>
</dt_array>
</item>
<item key='reg_domain'/>
<item key='fqdn1'>ns1.systemdns.com</item>
<item key='fqdn2'>ns2.systemdns.com</item>
<item key='fqdn3'>ns3.systemdns.com</item>
<item key='fqdn4'/>
<item key='fqdn5'/>
<item key='fqdn6'/>
<item key='comments'/>
268
<item key='id'>485395</item>
<item key='cost'>50</item>
<item key='flag_saved_ns_fields'>1</item>
<item key='master_order_id'>0</item>
<item key='order_date'>1341517725</item>
<item key='f_auto_renew'>Y</item>
<item key='forwarding_email'/>
<item key='status'>completed</item>
<item key='reg_type'>new</item>
<item key='f_lock_domain'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 5
For a .XXX order
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
269
<item key="attributes">
<dt_assoc>
<item key="order_id">457626</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully</item>
<item key='attributes'>
<dt_assoc>
<item key='field_hash'>
<dt_assoc>
<item key='owner_org_name'>Example Inc.</item>
<item key='owner_first_name'>Owen</item>
<item key='owner_last_name'>Ottway</item>
<item key='owner_address1'>32 Oak St.</item>
<item key='owner_address2'>Suite 500</item>
270
<item key='owner_address3'/>
<item key='owner_city'>Santa Clara</item>
<item key='owner_state'>CA</item>
<item key='owner_postal_code'>90210</item>
<item key='owner_country'>US</item>
<item key='owner_email'>owner@example.com</item>
<item key='owner_phone'>+1.4165550123x1902</item>
<item key='owner_fax'>+1.4165350124</item>
<item key='admin_org_name'>Example Inc.</item>
<item key='admin_first_name'>Adler</item>
<item key='admin_last_name'>Adams</item>
<item key='admin_address1'>32 Oak St.</item>
<item key='admin_address2'>Suite 100</item>
<item key='admin_address3'/>
<item key='admin_city'>Santa Clara</item>
<item key='admin_state'>CA</item>
<item key='admin_postal_code'>90210</item>
<item key='admin_country'>US</item>
<item key='admin_phone'>+1.4165550123x1812</item>
<item key='admin_fax'>+1.4165350124</item>
<item key='admin_email'>admin@example.com</item>
<item key='billing_first_name'>Bill</item>
<item key='billing_last_name'>Burton</item>
<item key='billing_org_name'>Example Inc.</item>
<item key='billing_address1'>32 Oak St.</item>
<item key='billing_address2'>Suite 200</item>
<item key='billing_address3'/>
<item key='billing_city'>Santa Clara</item>
<item key='billing_state'>CA</item>
<item key='billing_country'>US</item>
<item key='billing_postal_code'>90210</item>
<item key='billing_email'>burton@example.com</item>
<item key='billing_phone'>+1.4165550123x1248</item>
<item key='billing_fax'>+1.4165350124</item>
<item key='tech_first_name'>Ted</item>
271
<dt_assoc>
<item key='timestamp'>15-FEB-2012
18:08:50</item>
<item key='note'>Domain lock enabled</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='reg_domain'/>
<item key='fqdn3'/>
<item key='fqdn5'/>
<item key='comments'/>
<item key='id'>315169</item>
<item key='ipr_registration_date'>2011-01-01</item>
<item key='cost'>85</item>
<item key='flag_saved_ns_fields'>1</item>
<item key='application_status'>processed</item>
<item key='master_order_id'>0</item>
<item key='order_date'>1314713193</item>
<item key='f_auto_renew'>Y</item>
<item key='forwarding_email'/>
<item key='status'>completed</item>
<item key='fqdn6'/>
<item key='reg_type'>sunrise</item>
<item key='fqdn1'>ns1.systemdns.com</item>
<item key='tech_country'>CA</item>
<item key='f_lock_domain'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
273
Example 6
For a Trust Service order
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_order_info</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>780</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
274
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='special_instructions'>Test ABC</item>
<item key='period'>1</item>
<item key='notes_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='date'>2010-09-20T15:02:43.00004:00</item>
<item key='type'>order_processed</item>
<item key='note'>Order id [780] has been
processed, supplierOrderId is [141777].</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='date'>2010-09-20T15:02:43.00004:00</item>
<item key='type'>order_created</item>
created.</item>
04:00</item>
<item key='type'>money_held</item>
[780].</item>
<dt_assoc>
<item key='date'>2010-09-20T15:26:20.000-
04:00</item>
<item key='type'>supplier_product_created</item>
<item key='note'>The supplier product has been
created for order id [780].</item>
</dt_assoc>
</item>
<item key='4'>
<dt_assoc>
<item key='date'>2010-09-20T15:26:20.000-
04:00</item>
<item key='type'>money_charged</item>
<item key='note'>The money has been charged for
order id [780].</item>
</dt_assoc>
</item>
<item key='5'>
<dt_assoc>
<item key='date'>2010-09-20T15:26:21.000-
04:00</item>
<item key='type'>order_completed</item>
<item key='note'>The order with the id [780] has
been completed and product has been created with product id
[194].</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='order_id'>780</item>
<item key='state'>completed</item>
<item key='product_type'>truebizid</item>
<item key='domain'>truebiz.example.com</item>
<item key='product_id'>194</item>
<item key='contact_email'>qafive@example.com</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Adler</item>
276
<item key='last_name'>Adams</item>
<item key='title'>Director</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='org_name'>Example Inc.</item>
<item key='email'>adams@example.com</item>
<item key='phone'>+1.4165550123x1812</item>
<item key='fax'>+1.4165550125</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Tim</item>
<item key='last_name'>Tucker</item>
<item key='title'>Director</item>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='phone'>+1.4165550123x1243</item>
<item key='fax'>+1.41655501255</item>
<item key='email'>tucker@example.com</item>
</dt_assoc>
</item>
<item key='organization'>
<dt_assoc>
<item key='org_name'>Example Inc.</item>
<item key='duns'>12345</item>
<item key='address1'>32 Oak Street</item>
277
S4RMsP+XjVWzWZ+8v2bH6gapJ0tzXvTKwXzhUzElvVqpldpzO0FgnJtHmfJ/EOs5
gntzVIxzP12ZKFf0dYYUj0OKWU+aQodlic2oVxETyWKCoX5W7jQgpTV/vAF7nQY8
Y9VtV6SE5yQRYPJutDTk2PouEwIDAQABoAAwDQYJKoZIhvcNAQEEBQADggEBAAUr
DUNxyrYpt3t9r0GCIiIDVyQdJvY4tQUFIEJdxcvRo2TUcrgiWPyntGc1OCtUFE9Z
2JX4BNEmFVN1jUdBzh6/0loAA36iGYWTSB6CPVe5+y+dcgbViWcNV4or7FOslzRH
/Eu0CquMGmGtSdaT/DNIrJvM2iGOtuhFBhFyru61YMoeaQLU12i5XvK7bR4wHrG6
8DwlwUdzBRqiaq32rM/ZF2KmMzfLFKug1Hubt3OBQHSKwXz3CR7hrJSzf1q3lF/w
HD47TC982HXaUuskI+E0LcuR/qprLkvAO6hKT60CP+V/yNwcBu79Zjeg1MsAmH/W
SzFmc1swYutlFBxmyLU= -----END CERTIFICATE REQUEST-----</item>
<item key='reg_type'>new</item>
<item key='price'>99.0</item>
<item key='server_type'>apachessl</item>
<item key='supplier_order_id'>141777</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
279
get_orders_by_domain
Description
Action & object
action = get_orders_by_domain
object = domain
Usage
Retrieves information about orders placed for a specific domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
limit
Optional
order_from
Optional
order_to
Optional
page
Optional
280
Parameter
name
Obligation
Definition/Value
status
Optional
type
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
orders
Returned if
Contains arrays that list details about each
is_success = order.
true
For more information, see the Orders table
below.
page_size
Returned if
The maximum number of orders returned per
is_success = page.
true
Orders
Parameters within the orders associative array are described below.
Parameter
name
Obligation
Definition/Value
id
Always
returned
Parameter
name
Obligation
Definition/Value
order_date
Always
returned
status
Optional
type
Always
returned
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Command successful</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="page_size">100</item>
<item key="orders">
<dt_array>
<item key="0">
<dt_assoc>
<item key="order_date">16-OCT-2007 15:21:26</item>
<item key="status">pending</item>
<item key="type">new</item>
<item key="id">103789</item>
</dt_assoc>
</item>
283
<item key="1">
<dt_assoc>
<item key="order_date">16-OCT-2007 15:21:23</item>
<item key="status">pending</item>
<item key="type">new</item>
<item key="id">103788</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
284
get_price
Description
Action & object
action = get_price
object = domain
Usage
Queries the price of a domain, and can be used to determine the cost of a
billable transaction for any TLD. A returned price for a given domain does not
guarantee the availability of the domain, but indicates that the requested
action is supported by the system and calculates the cost to register the
domain (if available).
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
period
Optional
reg_type
Optional
285
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
price
Returned if
The price of the queried domain. This value includes
is_success = the OpenSRS price and the ICANN fee.
true
<item key="domain">example.com</item>
<item key="period">1</item>
<item key="reg_type">new</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="price">20.2</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
287
get_product_info
Description
Action & object
action = get_product_info
object = trust_service
Usage
Queries the properties of the specified Trust Service product.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
all_info
Optional
inventory_item_id
Optional; may be
used for
certificates that
were migrated
from TPP.
Required
product_id
288
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
contact_email
Returned if
The administrator email address.
is_success = true
csr
Returned if
Certificate Signing Request. The Trust
is_success = true Service provider uses this information to
generate the certificate.
domain
Returned if
The domain with which the Trust Service is
is_success = true associated.
expiry_date
Returned if
The date that the Trust Service certificate
is_success = true expires.
inventory_item_
id
Returned if
The certificate product ID number that was
is_success = true used in the TPP system.
and cert was
migrated from TPP
is_renewable
Returned if
Indicates whether the product is can be
is_success = true renewed at this time. Trust Service
products can be renewed between 60 days
before the expiry date and 15 days after
expiry date.
Allowed values are:
issue_date
Returned if
The date that the Trust Service certificate
is_success = true was issued.
289
Parameter
name
Obligation
Definition/Value
product_id
Returned if
is_success = true
product_type
Returned if
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
truebizid
truebizid_wildcard
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
290
Parameter
name
Obligation
Definition/Value
start_date
Returned if
The effective date for the Trust Service.
is_success = true
state
Returned if
The state of the product. Allowed values
is_success = true are:
expired
active
renewing
renewed
revoked
tpp__order_id
Returned if cert was The order number that was used in the TPP
migrated from TPP system.
and is_success =
true
upgrade_options
Returned if
is_success = true
and product_type
= sitelock_basic
or
sitelock_premium
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
291
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_product_info</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='product_id'>99</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='product_type'>truebizid_wildcard</item>
<item key='issue_date'>2010-09-14-04:00</item>
292
<item key='domain'>*.example.com</item>
<item key='product_id'>99</item>
<item key='contact_email'>qafive@example.com</item>
<item key='start_date'>2010-09-13-04:00</item>
<item key='expiry_date'>2010-09-22-04:00</item>
<item key='is_renewable'>0</item>
<item key='state'>expired</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Retrieves all information for a Trust Service product.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_product_info</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='all_info'>1</item>
<item key='product_id'>2071</item>
</dt_assoc>
</item>
293
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='csr_data'>
<dt_assoc>
<item key='country'>US</item>
<item key='organization_unit'>QA Dept</item>
<item key='valid_true_domain'>1</item>
<item key='state'>CA</item>
<item key='locality'>Santa Clara</item>
<item key='email'>qafive@example.com</item>
<item key='domain'>abc123.example.org</item>
<item key='valid_quick_domain'>1</item>
<item key='has_bad_extensions'>0</item>
<item key='organization'>Example Co.</item>
294
</dt_assoc>
</item>
<item key='notes_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='date'>2012-04-12T10:05:08.000-
05:00</item>
<item key='type'>product_active</item>
<item key='note'>The product with the id [2071] has
been created.</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='expiry_date'>2013-04-12T18:59:59.000-05:00</item>
<item key='state'>active</item>
<item key='product_type'>sitelock_premium</item>
<item key='domain'>trust.example.org</item>
<item key='issue_date'>2012-04-12T10:02:01.000-05:00</item>
<item key='product_id'>2071</item>
<item key='is_renewable'>0</item>
<item key='contact_email'>qafive@example.com</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Adler</item>
<item key='last_name'>Adams</item>
<item key='title'>Administrator</item>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
295
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='phone'>+1.4165550123x1812</item>
<item key='email'>adams@example.com</item>
<item key='fax'>+1.4165550125</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Tim</item>
<item key='last_name'>Tucker</item>
<item key='title'/>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='phone'>+1.4165550123x1243</item>
<item key='fax'>+1.4165550125</item>
<item key='email'>tucker@example.com</item>
</dt_assoc>
</item>
<item key='organization'>
<dt_assoc>
<item key='first_name'>Jim</item>
<item key='last_name'>Johnson</item>
<item key='title'>Director</item>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
296
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='email'>jjohnson@example.com</item>
<item key='phone'>+1.4165550125x1224</item>
<item key='fax'>+1.4165550126</item>
</dt_assoc>
</item>
<item key='billing'>
<dt_assoc>
<item key='first_name'>Bill</item>
<item key='last_name'>Burton</item>
<item key='title'/>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 200</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='phone'>+1.4165550123x1248</item>
<item key='fax'>+1.4165550136</item>
<item key='email'>burton@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC2TCCAcECAQAwgZMxIDAeBgNVBAMTF3NzbDEyMy5xYXJlZ3Jlc3Npb24ub3Jn
MQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8xDzAN
BgNVBAoTBlR1Y293czEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJARYR
cWFmaXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
AQDpKz48gJG4ImyJi76kH3AdDZoGNZCC8xgWBUDk4yNXPqe3NxJvZooZIoctP2o8
CX6+xoK8p6jMb9iIz7ZVC9LuoUmoYZZWdoatMUwaz3xIa4Fq7HeLtCE3misKMcZq
+QomhLFv2yMSgyzWWitHdW5oVDuT83Xs8FTZG33rI8gut1J9+5fhJV4WKuncfLwM
xMrj+5iWm+KwoE86dTarGAPwYhC2FepcblszVbz87Dp1clTJLaN4potMES83RHo1
teHHmJAilNzy2PfRoylbzlQ38x1n10wbhqjMcoDYk6CSB40PlduqbsMjpkOClwu4
H92c2Hmo3bqRGWM2K5SXkj29AgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEAKUh6
297
WH4WtC/LtlJhj+p5i3sLEG/L//8DQh30eOxwMxrSGGZUGTfLBT4RaeDA5JEIF5pK
v4MxvDw1+NExMQW3h/9eVWXpGGjvC2EoLgya3ri3OJlQNOyqSzOvNunk0EPaWoO+
v9o2yKdH88e7NQZp8Pw5jhE9RV9u3+mNw2sztqpzcXYDXW3kKI2UiIP3eur2/iiH
nSAIRl5NfUPgAzCem/zpM1lc3s+EVKysn2wF4bwOkNyYPo4DmgHCb7ggSQyhh5vN
UAoDkyqu2ZScDZTyDG7YOdobMqwbsCT5er5Bq+NWOZyUE+3zO/1VQpznJehaGLrQ
N7UAJliUAO+SFFGdxQ== -----END CERTIFICATE REQUEST-----</item>
<item key='upgrade_options'>sitelock_enterprise</item>
<item key='start_date'>2012-04-11T19:00:00.000-05:00</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
Retrieves all information for a Trust Service product that was migrated from
the TPP system.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>get_product_info</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='all_info'>1</item>
<item key='product_id'>2076</item>
</dt_assoc>
</item>
298
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='tpp_order_id'>9997602</item>
<item key='csr_data'>
<dt_assoc>
<item key='country'>US</item>
<item key='organization_unit'>QA Dept</item>
<item key='valid_true_domain'>1</item>
<item key='state'>CA</item>
<item key='locality'>Santa Clara</item>
<item key='email'>qafive@example.com</item>
<item key='domain'>renewtest.example.org</item>
<item key='valid_quick_domain'>1</item>
<item key='has_bad_extensions'>0</item>
299
been created.</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='date'>2012-04-12T11:20:59.000-
05:00</item>
<item key='type'>product_renewing</item>
<item key='note'>The product with the id [2076] is
in the process
of being renewed.</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='date'>2012-04-12T11:25:07.000-
05:00</item>
<item key='type'>product_renewed</item>
<item key='note'>The product with the id [2076] has
been renewed.</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='expiry_date'>2012-04-19T20:46:39.000-05:00</item>
<item key='inventory_item_id'>8887602</item>
300
<item key='state'>renewed</item>
<item key='product_type'>quickssl</item>
<item key='domain'>renewtest.example.org</item>
<item key='issue_date'>2012-04-12T11:19:11.000-05:00</item>
<item key='product_id'>2076</item>
<item key='is_renewable'>0</item>
<item key='contact_email'>qafive@examle.com</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Adler</item>
<item key='last_name'>Adams</item>
<item key='title'>Administrator</item>
<item key='org_name'>Example Co.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='postal_code'>90210</item>
<item key='country'>US</item>
<item key='phone'>+1.4165550123x1812</item>
<item key='fax'>+1.4165550125</item>
<item key='email'>adams@example.com</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Ted</item>
<item key='last_name'>Tucker</item>
<item key='title'/>
<item key='org_name'>Example Co.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
301
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='postal_code'>90210</item>
<item key='country'>US</item>
<item key='phone'>+1.4165550123x1243</item>
<item key='fax'>+1.4165550125</item>
<item key='email'>tucker@example.com</item>
</dt_assoc>
</item>
<item key='organization'>
<dt_assoc>
<item key='first_name'>Jim</item>
<item key='last_name'>Johnson</item>
<item key='title'>Director</item>
<item key='org_name'>Example Co.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='phone'>+1.4165550123x1224</item>
<item key='email'>jjohnson@example.com</item>
<item key='fax'>+1.4165550126</item>
</dt_assoc>
</item>
<item key='billing'>
<dt_assoc>
<item key='first_name'>Bill</item>
<item key='last_name'>Burton</item>
<item key='title'/>
<item key='org_name'>Example Co.</item>
<item key='address1'>32 Oak Street</item>
302
303
get_products
Description
Action & object
action = get_products
object = trust_service
Usage
Returns a list of the Trust Service products whose expiry dates are within a
specific date range.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
max_expiry_date Required
min_expiry_date Required
state
Optional
activated
active
expired
renewed
revoked
upgraded
304
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
product_list
Returned if
is_success =
true
product_list
Parameters within the product_list associative array are described below.
Parameter
name
Obligation
Definition/Value
contact_email
Returned if
is_success =
true
domain
Returned if
is_success =
true
expiry_date
Returned if
is_success =
true
is_renewable
Returned if
is_success =
true
Parameter
name
Obligation
Definition/Value
issue_date
Returned if
is_success =
true
product_id
Returned if
is_success =
true
product_type
Returned if
is_success =
true
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_ev
securesite_pro
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_ev
sslwebserver_wildcard
truebizid
truebizid_ev
truebizid_wildcard
trustwave_dv
306
Parameter
name
Obligation
Definition/Value
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
start_date
Returned if
is_success =
true
state
Returned if
is_success =
true
approver-confirmedOwner has
confirmed the domain vetted certificate.
awaiting-approvalOrder processed
successfully; waiting for supplier
approval.
completedOrder is complete.
in-progressOrder is in progress.
<dt_assoc>
<item key='min_expiry_date'>2012-04-23</item>
<item key='state'>expired</item>
<item key='max_expiry_date'>2012-09-22</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='product_list'>
<dt_array>
<item key='0'>
<dt_assoc>
04:00</item>
<item key='issue_date'>2012-04-16T09:17:46.000-
04:00</item>
<item key='domain'>example.org</item>
<item key='product_id'>2094</item>
<item key='contact_email'>qafive@example.com</item>
<item key='is_renewable'>0</item>
<item key='start_date'>2012-04-14T20:14:48.000-
04:00</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='expiry_date'>2012-05-08T07:34:49.000-
04:00</item>
<item key='state'>expired</item>
<item key='product_type'>securesite_pro</item>
<item key='issue_date'>2012-04-30T11:27:59.000-
04:00</item>
<item key='domain'>example.net</item>
<item key='product_id'>2096</item>
<item key='contact_email'>qafive@example.com</item>
<item key='is_renewable'>0</item>
<item key='start_date'>2012-04-28T19:42:30.000-
04:00</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
309
get_registrant_verification_status
Description
Action & object
action =get_registrant_verification_status
object = domain
Usage
When a domain is registered or transferred, or when the registrant contact
information is changed, the registrant must reply to an email requesting
them to confirm that the submitted contact information is correct. This
command returns the current state of the verification request.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition / Value
domain
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
days_to_suspend Returned if
is_success
= true
email_bounced
registrant_
verification_
status
Returned if
is_success
= true
verification_
deadline
311
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
312
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="registrant_verification_status">suspended</item>
<item key="verification_deadline">2013-112-02
00:00:00</item>
<item key="email_bounced">1</item>
<item key="days_to_suspend">2</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
313
lookup (domain)
Description
Action & object
action = lookup
object = domain
Usage
Determines the availability of a specified domain name.
Note: This command checks the availability of a single domain name. We
recommend that you use the much more robust name_suggest API instead.
In addition to checking the specified domain name, the name_suggest API
also checks whether the domain name is available in other TLDs (.COM, .NET,
.ORG, .INFO, and .BIZ), and it returns a list of suggested domains names
that are related to the specified name.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
no_cache
Optional
314
Deprecated
Parameter
name
Obligation
Definition/Value
pre_reg
Deprecated
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
email_available
Optional
has_claim
noservice
Returned for
.NAME if
is_success =
Parameter
name
Obligation
Definition/Value
true
1Supplier unavailable
status
Returned if
is_success =
true
Returned if
is_success =
true
</data_block>
</body>
</OPS_envelope>
Response
If domain is available
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">210</item>
<item key="response_text">Domain available</item>
<item key="attributes">
<dt_assoc>
<item key="status">available</item>
<item key="email_available">undef</item>
<item key="price_status">undef</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
If domain is unavailable
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
317
Example 2
Lookup request for a new TLD during the claims period
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
318
<msg_type>standard</msg_type>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>LOOKUP</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.guru</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?> <!DOCTYPE
OPS_envelope SYSTEM 'ops.dtd'> <OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_code'>210</item>
<item key='response_text'>Domain available</item>
<item key='attributes'>
<dt_assoc>
319
<item key='status'>available</item>
<item key='has_claim'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
320
name_suggest (domain)
Description
Action & object
action = name_suggest
object = domain
Usage
Checks whether a specified name, word, or phrase is available for registration
in gTLDs and ccTLDs, suggests other similar domain names for .COM,
.NET, .ORG, .INFO, .BIZ, .US, and .MOBI domains, and checks whether they
are available. Reseller must be enabled for the specified TLDs. Can also be
used to search for domains owned by external domain suppliers.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
languages
Optional
enEnglish
fr French
deGerman
itItalian
esSpanish
Definition/Value
that language.
max_wait_time
Optional
search_key
Optional
searchstring
Required
322
Definition/Value
service_override
Optional
Optional
skip_registry_lookup Optional
lookupCheck availability.
suggestionRequest suggestions.
personal_namesCheck the
availability of the specified personal
name, (firstname lastname).
premium_brokered_transferInclude
domain names that may be purchased
from external suppliers that use a broker
to complete the purchase process.
premium_make_offerInclude
domain names that may be purchased
from external suppliers where the buyer
and seller negotiate the purchase price.
Optional
Definition/Value
tlds
Required
Service_Override
Parameters within the service_override associative array are described
below.
Parameter
name
Obligation
Definition/Value
lookup
Optional
personal_names
Optional
premium
Optional
suggestion
Optional
Obligation
Definition/Value
maximum
Optional
324
Parameter
name
Obligation
Definition/Value
price_max
price_min
tlds
Required
Lookup
The following parameter may be used in the lookup associative array:
Parameter
name
Obligation
Definition/Value
no_cache_tlds
Optional
325
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
has_claim
is_search_completed
lookup
Returned if
is_success =
true
Optional
1Search completed.
326
Parameter name
Obligation
Definition/Value
personal_names
Optional
premium
Optional
premium_brokered_
transfer
Optional
premium_make_offer
Optional
search_key
suggestion
Returned if
is_success =
true and
is_search_
completed = 0
Optional
327
Obligation
Definition/Value
count
Always
returned
items
Always
returned
Items
Parameters within the items associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Always
returned
price
Optional
status
Always
returned
third_party_
offer_url
Returned for
premium_
make_offer
domains
undeterminedReturned if
skip_registry_lookup = 1 in the request,
or if the registry could not be contacted.
328
Example 1
For lookup, suggestion, premium, and personal names with suggestion
limited to .COM, .NET, and .ORG, in English, German, Italian, and Spanish.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>name_suggest</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='services'>
<dt_array>
<item key='0'>lookup</item>
<item key='1'>suggestion</item>
<item key='2'>premium</item>
<item key='3'>personal_names</item>
</dt_array>
</item>
<item key='searchstring'>search string</item>
<item key='languages'>
<dt_array>
<item key='0'>en</item>
329
<item key='1'>de</item>
<item key='2'>it</item>
<item key='3'>es</item>
</dt_array>
</item>
<item key='tlds'>
<dt_array>
<item key='0'>.com</item>
<item key='1'>.net</item>
<item key='2'>.org</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='response_text'>Command completed successfully</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
330
<dt_assoc>
<item key='lookup'>
<dt_assoc>
<item key='count'>6</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>searchstring.com</item>
<item key='status'>taken</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>searchstring.net</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>searchstring.org</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='3'>
<dt_assoc>
<item key='domain'>search-string.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
...
331
</dt_array>
</item>
</dt_assoc>
</item>
<item key='personal_names'>
<dt_assoc>
<item key='count'>6</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>search.stringham.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>search.stringhini.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item
key='domain'>search.stringfield.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='3'>
<dt_assoc>
<item key='domain'>search.stringer.net</item>
<item key='status'>available</item>
332
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='premium'>
<dt_assoc>
<item key='count'>20</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>badmintonstring.com</item>
<item key='status'>available</item>
<item key='price'>1349.00</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>cheapstring.com</item>
<item key='status'>available</item>
<item key='price'>1549.00</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>elasticstring.com</item>
<item key='status'>available</item>
<item key='price'>1399.00</item>
</dt_assoc>
333
</item>
<item key='3'>
<dt_assoc>
<item key='domain'>findcordblood.com</item>
<item key='status'>available</item>
<item key='price'>1688.00</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='suggestion'>
<dt_assoc>
<item key='count'>50</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item
key='domain'>amazonsearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item
key='domain'>archivesearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
334
<dt_assoc>
<item key='domain'>briefsearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
...
<item key='49'>
<dt_assoc>
<item key='domain'>search-string.org</item>
<item key='status'>available</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
For both lookup and suggestion with lookups limited to .COM and .INFO,
querying the registry (not OpenSRS cache) for .COM lookups, suggestions
limited to .COM and .ORG, and maximum 25 suggestions returned.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
335
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">name_suggest</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="searchstring">example@search.com</item>
<item key="service_override">
<dt_assoc>
<item key="suggestion">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
<item key="1">.org</item>
</dt_array>
</item>
<item key="maximum">25</item>
</dt_assoc>
</item>
<item key="lookup">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
<item key="1">.info</item>
</dt_array>
</item>
<item key = "no_cache_tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
</dt_assoc>
336
</item>
</dt_assoc>
</item>
<item key="services">
<dt_array>
<item key="0">lookup</item>
<item key="1">suggestion</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="response_text">Command completed
successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="lookup">
<dt_assoc>
337
<item key="count">8</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">example-
search.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="domain">examplesearch.info</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
key="domain">example.com</item>
<item
<item key="status">taken</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key="suggestion">
<dt_assoc>
<item key="count">25</item>
<item key="response_text"/>
338
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item
key="domain">modelhunt.org</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item
key="domain">modelfind.org</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
key="domain">problemfind.org</item>
<item
<item key="status">available</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
339
Example 3
For premium domains, limited to .COM and .NET.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>name_suggest</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='searchstring'>abc&d !</item>
<item key='service_override'>
<dt_assoc>
<item key='premium'>
<dt_assoc>
<item key='tlds'>
<dt_array>
<item key='0'>.com</item>
<item key='1'>.net</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='services'>
<dt_array>
340
<item key='0'>premium</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="premium">
<dt_assoc>
<item key="count">4</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
341
<item key="0">
<dt_assoc>
<item key="domain">abc-and-
d.com</item>
<item key="status">available</item>
<item key="price">299.98</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
key="domain">abcandd.com</item>
<item
<item key="status">available</item>
<item key="price">499.98</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
key="domain">abcandd.net</item>
<item
<item key="status">available</item>
<item key="price">99.78</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="domain">abcd.com</item>
<item key="status">available</item>
<item key="price">1523.45</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
342
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 4
For premium, lookup, and suggestion, limited to .COM, maximum 10
suggestions returned.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">name_suggest</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="service_override">
<dt_assoc>
<item key="premium">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
</dt_assoc>
343
</item>
<item key="suggestion">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
<item key="maximum">10</item>
</dt_assoc>
</item>
<item key="lookup">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="services">
<dt_array>
<item key="0">lookup</item>
<item key="1">suggestion</item>
<item key="2">premium</item>
</dt_array>
</item>
<item key="searchstring">abc&d</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
344
</OPS_envelope>
Response
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="response_text">Command completed
successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="lookup">
<dt_assoc>
<item key="count">2</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">abc-d.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
345
<item key="domain">abcd.com</item>
<item key="status">taken</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="premium">
<dt_assoc>
<item key="count">3</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">abc-and-
d.com</item>
<item key="status">available</item>
<item key="price">299.98</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
key="domain">abcandd.com</item>
<item
<item key="status">available</item>
<item key="price">499.98</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="domain">abcd.com</item>
<item key="status">available</item>
346
<item key="price">1523.45</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="suggestion">
<dt_assoc>
<item key="count">10</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item
key="domain">abcdlive.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item
key="domain">abcdpro.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item
key="domain">abcdslive.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
347
...
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 5
For lookup and suggestion, limited to .COM, not checking the availability of
the lookup domain, maximum 10 suggestions returned.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">name_suggest</item>
<item key="object">domain</item>
<item key="attributes">
<item key="services">
<dt_array>
<item key="0">lookup</item>
<item key="1">suggestion</item>
</dt_array>
348
</item>
<dt_assoc>
<item key="searchstring">smith</item>
<item key="skip_registry_lookup">1</item>
<item key="service_override">
<dt_assoc>
<item key="suggestion">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
<item key="maximum">10</item>
</dt_assoc>
</item>
<item key="lookup">
<dt_assoc>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
349
Response
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="response_text">Command completed
successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="lookup">
<dt_assoc>
<item key="count">1</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">smith.com</item>
key="status">undetermined</item>
<item
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
350
</item>
<item key="suggestion">
<dt_assoc>
<item key="count">10</item>
<item key="response_text"/>
<item key="response_code">0</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">smithmail.com</item>
<item key="status">taken</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
key="domain">smithfamily.com</item>
<item
<item key="status">taken</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item
key="domain">smithslive.com</item>
<item key="status">taken</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
351
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 6
For lookup, suggestion, premium, and personal names with suggestion
limited to .COM, .NET, .ORG, and .IN, in English, German, Italian, and
Spanish, with the command run time limited to 0.4 seconds.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>name_suggest</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='searchstring'>search string</item>
<item key='max_wait_time'>0.4</item>
<item key='languages'>
<dt_array>
<item key='0'>en</item>
<item key='1'>de</item>
<item key='2'>it</item>
<item key='3'>es</item>
</dt_array>
</item>
<item key='tlds'>
352
<dt_array>
<item key='0'>.com</item>
<item key='1'>.net</item>
<item key='2'>.org</item>
<item key='3'>.in</item>
</dt_array>
</item>
<item key='services'>
<dt_array>
<item key='0'>lookup</item>
<item key='1'>suggestion</item>
<item key='2'>premium</item>
<item key='3'>personal_names</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
The results were in the specified time; however, not all lookup results are
complete. Premium name results were returned but suggestion and personal
names could not be returned in the specified time. The returned unique_key
allows you to resubmit the command.
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
353
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='response_text'>Command completed successfully</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='is_search_completed'>0</item>
<item key='search_key'>vgL2FeBzZ8JuS5lIluIEYhDc7Vg</item>
<item key='attributes'>
<dt_assoc>
<item key='lookup'>
<dt_assoc>
<item key='count'>84</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>searchstring.com</item>
<item key='status'>taken</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>searchstring.net</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>searchstring.org</item>
<item key='status'>available</item>
</dt_assoc>
354
</item>
<item key='3'>
<dt_assoc>
<item key='domain'>searchstring.in</item>
<item key='status'>undetermined</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='premium'>
<dt_assoc>
<item key='count'>20</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>badmintonstring.com</item>
<item key='status'>available</item>
<item key='price'>1349.00</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>cheapstring.com</item>
<item key='status'>available</item>
<item key='price'>1549.00</item>
</dt_assoc>
</item>
<item key='2'>
355
<dt_assoc>
<item key='domain'>elasticstring.com</item>
<item key='status'>available</item>
<item key='price'>13998.00</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 7
Resubmits the previously run name_suggest command which did not return
complete lookup results during the specified max_wait_time. The command
can run for a maximum of 0.7 seconds.
Request
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>name_suggest</item>
<item key='object'>DOMAIN</item>
356
<item key='attributes'>
<dt_assoc>
<item key='search_key'>vgL2FeBzZ8JuS5lIluIEYhDc7Vg</item>
<item key='max_wait_time'>0.7</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
Complete results for lookup are returned as well as results for suggestion,
premium, and personal names.
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='response_text'>Command completed successfully</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='is_search_completed'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='lookup'>
<dt_assoc>
<item key='count'>84</item>
<item key='response_text'>Command completed
357
successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>searchstring.com</item>
<item key='status'>taken</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>searchstring.net</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>searchstring.org</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='3'>
<dt_assoc>
<item key='domain'>searchstring.in</item>
<item key='status'>undetermined</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='premium'>
358
<dt_assoc>
<item key='count'>20</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>badmintonstring.com</item>
<item key='status'>available</item>
<item key='price'>1349.00</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>cheapstring.com</item>
<item key='status'>available</item>
<item key='price'>1549.00</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>elasticstring.com</item>
<item key='status'>available</item>
<item key='price'>13998.00</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='personal_names'>
<dt_assoc>
359
<item key='count'>6</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>search.stringham.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>search.stringhini.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item
key='domain'>search.stringfield.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
<item key='suggestion'>
<dt_assoc>
<item key='count'>50</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
360
<item key='is_success'>1</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item
key='domain'>amazonsearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item
key='domain'>archivesearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='domain'>briefsearchstring.com</item>
<item key='status'>available</item>
</dt_assoc>
</item>
...
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
361
Example 8
For premium domains, limited to .COM and .NET names that cost between
$100 and $10000, maximum 10 suggestions returned.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='action'>name_suggest</item>
<item key='object'>domain</item>
<item key='protocol'>XCP</item>
<item key='attributes'>
<dt_assoc>
<item key='service_override'>
<dt_assoc>
<item key='premium'>
<dt_assoc>
<item key='tlds'>
<dt_array>
<item key='0'>.com</item>
<item key='1'>.net</item>
</dt_array>
</item>
<item key='maximum'>10</item>
<item key='price_min'>100</item>
<item key='price_max'>10000</item>
</dt_assoc>
</item>
</dt_assoc>
362
</item>
<item key='services'>
<dt_array>
<item key='0'>premium</item>
</dt_array>
</item>
<item key='searchstring'>computerstore</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully</item>
<item key='is_search_completed'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='premium'>
<dt_assoc>
<item key='count'>2</item>
<item key='response_text'>Command Successful</item>
363
<item key='response_code'>200</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>childhoodneglect.com</item>
<item key='status'>available</item>
<item key='price'>499.00</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='domain'>child-neglect.com</item>
<item key='status'>available</item>
<item key='price'>499.00</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='is_success'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 9
Lookup for one of the new TLDs.
Request
<?xml version='1.0' encoding='UTF-8'?> <OPS_envelope>
<header>
<version>0.9</version>
364
<msg_type>standard</msg_type>
</header>
<body>
<data_block>
<dt_assoc>
<item key='action'>name_suggest</item>
<item key='object'>domain</item>
<item key='protocol'>XCP</item>
<item key='attributes'>
<dt_assoc>
<item key='services'>
<dt_array>
<item key='0'>lookup</item>
</dt_array>
</item>
<item key='searchstring'>example</item>
<item key='tlds'>
<dt_array>
<item key='0'>guru</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
365
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='request_response_time'>0.065</item>
<item key='response_text'>Command completed
successfully</item>
<item key='is_search_completed'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='lookup'>
<dt_assoc>
<item key='count'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='items'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='domain'>example.guru</item>
<item key='status'>available</item>
<item key='has_claim'>1</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
366
</data_block>
</body>
</OPS_envelope>
Example 10
For premium, premium_brokered_transfer, and premium_make_offer
domains, limited to .COM, .NET, .ORG, and .DE names.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">NAME_SUGGEST</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="searchstring">testdomain</item>
<item key="tlds">
<dt_array>
<item key="0">.com</item>
<item key="1">.net</item>
<item key="2">.org</item>
<item key="3">.de</item>
</dt_array>
</item>
<item key="services">
<dt_array>
<item key="0">premium</item>
367
item key="1">premium_make_offer</item>
<item key="2">premium_brokered_transfer</item>
<item key="3">lookup</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="request_response_time">1.960</item>
<item key="response_text">Command completed successfully</item>
<item key="is_search_completed">1</item>
<item key="attributes">
<dt_assoc>
<item key="lookup">
<dt_assoc>
<item key="count">4</item>
<item key="response_text">Command completed successfully.</item>
368
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">testdomain.com</item>
<item key="status">taken</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="domain">testdomain.net</item>
<item key="status">taken</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="domain">testdomain.org</item>
<item key="status">taken</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="domain">testdomain.de</item>
<item key="status">taken</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="premium_brokered_transfer">
<dt_assoc>
<item key="count">5</item>
369
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="premium_make_offer">
<dt_assoc>
<item key="count">3</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">testdomain-mo-2606349.com</item>
<item key="status">available</item>
<item key="price">0.00</item>
<item
key="third_party_offer_url">http://www.sedo.com/search/details.php4?
language=us&partnerid=316601&domain=testdomain-mo-2606349.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="domain">testdomain-mo-2606349.net</item>
<item key="status">available</item>
<item key="price">0.00</item>
<item
key="third_party_offer_url">http://www.sedo.com/search/details.php4?
language=us&partnerid=316601&domain=testdomain-mo-2606349.net</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
371
<item key="domain">testdomain-mo-2606349.org</item>
<item key="status">available</item>
<item key="price">0.00</item>
<item
key="third_party_offer_url">http://www.sedo.com/search/details.php4?
language=us&partnerid=316601&domain=testdomain-mo-2606349.org</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="premium">
<dt_assoc>
<item key="count">12</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">testdomain-2606349.com</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="domain">testdomain-2606349.net</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
372
<item key="domain">testdomain-2606349.org</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="domain">testdomain2-2606349.com</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="4">
<dt_assoc>
<item key="domain">testdomain2-2606349.net</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="5">
<dt_assoc>
<item key="domain">testdomain2-2606349.org</item>
<item key="status">available</item>
<item key="price">1150.00</item>
</dt_assoc>
</item>
<item key="6">
<dt_assoc>
<item key="domain">moviesite.org</item>
<item key="status">available</item>
<item key="price">749.00</item>
</dt_assoc>
</item>
<item key="7">
<dt_assoc>
373
<item key="domain">testfax.com</item>
<item key="status">available</item>
<item key="price">2449.00</item>
</dt_assoc>
</item>
<item key="8">
<dt_assoc>
<item key="domain">testdsl.com</item>
<item key="status">available</item>
<item key="price">1849.00</item>
</dt_assoc>
</item>
<item key="9">
<dt_assoc>
<item key="domain">testact.com</item>
<item key="status">available</item>
<item key="price">2249.00</item>
</dt_assoc>
</item>
<item key="10">
<dt_assoc>
<item key="domain">religiontest.com</item>
<item key="status">available</item>
<item key="price">699.00</item>
</dt_assoc>
</item>
<item key="11">
<dt_assoc>
<item key="domain">psychopathtest.com</item>
<item key="status">available</item>
<item key="price">699.00</item>
</dt_assoc>
</item>
</dt_array>
</item>
374
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
375
uk_get_blocker_contact
Description
Action & object
action = uk_get_blocker_contact
object = domain
Usage
Until June 10, 2019, if you want to register an available second level .UK
domain name, and the name is already registered as a third level .UK domain
(for example. .co.uk or .org.uk), the owner contact information for the
second level .UK name must be an exact match to the owner contact
information of the equivalent third level .UK domain name.
This command checks whether the specified domain name is registered as a
third level .UK domain (for example. .co.uk or .org.uk) with the same
registrar and reseller, and if so, returns the owner contact details.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
376
request
Attributes
The owner contact details for the third level domain.
377
Response
If no equivalent third level domain is registered with the same
registrar and reseller
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">There is no domain blocking
example.uk</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successfully Completed</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="first_name">Spencer</item>
<item key="last_name">Gibbons</item>
<item key="address1">96 Mowat Ave</item>
<item key="address2"></item>
<item key="address3"></item>
<item key="city">Bristol</item>
<item key="state"></item>
<item key="country">GB</item>
<item key="postal_code">BS1 4AW </item>
<item key="uk_whois_opt">N</item>
<item key="org_name">Spencer Gibbons</item>
<item key="phone">+44.2075551234</item>
<item key="registrant_type">IND</item>
<item key="email">foo@gmail.com</item>
<item key="blocker">example.co.uk</item>
</dt_assoc>
</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">REPLY</item>
<item key="is_success">1</item>
<item key="response_text">Cannot get contact details for
example.co.uk which is blocking registration of example.uk because
example.co.uk is not with this registrar or not with this
reseller</item>
<item key="response_code">465</item>
<item key="attributes">
<dt_assoc>
<item key="blocker">example.co.uk</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<item key="response_code">211</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
381
Provisioning Commands
This section contains the following commands:
382
activate (domain)
Description
Action & object
action = activate
object = domain
Usage
Activates a parked .DE domain. The .DE registry requires a domain to be
parked on a valid nameserver. The domain can be parked prior to the
registration, or within thirty days of the successful registration. Use this
command within thirty days of registering the domain and after you park the
domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain
Required if
cookie is not
submitted
request
383
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
384
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>0</item>
<item key='response_code'>437</item>
<item key='response_text'>A request is currently waiting on
this domain</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
385
Usage
Cancels an active .CA order in OpenSRS. This command is useful if you have
placed a .CA order with OpenSRS and subsequently cancelled it, or were
unable to confirm the order with CIRA, but the OpenSRS system has not yet
been updated and still shows the order as active. In such a situation, you
cannot use OpenSRS to resubmit a revised order for the same .CA domain
until the original .CA order is cancelled with OpenSRS. You can either wait for
OpenSRS to be updated with CIRA's records, or you can cancel the order in
OpenSRS using this command. The cancel .CA order functionality is also
available in the Reseller Web Interface (RWI).
Note: OpenSRS synchronizes with CIRA once a day, during non-business
hours, EST, including weekends.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
order_id
386
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
387
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Cancellation successful</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
388
cancel_free_trial
Description
Action & object
action = cancel_free_trial
object = trust_service
Usage
Cancel a Trust Service 30 day free trial order.
Free trials are available for the following Trust Service products:
You can cancel the free trial at any time during the 30 day free trial period
without incurring a charge. If the product is not cancelled by the end of the
30 day period, the product is immediately activated, and the customer is
charged for the term that they selected when they placed the order. The
expiry date is calculated from the date that the paid term begins, not the
date that the free trial began.
For TRUSTe, the cancellation is processed immediately, but when GeoTrust
and Symantec require customer approval. The supplier sends the customer
an email asking them to approve the cancellation. Once the cancellation is
approved, the status of the order changes to Revoked/Declined.
Note: When you cancel a free trial, you will not be able to order another
Trust Service order for that domain until the full 30 days of the free trial
period have passed. For TRUSTe, a call needs to be made to the supplier to
get the domain unlocked.
389
Attributes
Parameters within the attributes associative array are described below.
Note: You must specify at least one of these parameters.
Parameter name
Obligation
Definition/Value
order_id
Optional
product_id
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
domain
Returned if
is_success =
true
product_id
Returned if
is_success =
true
state
Returned if
is_success =
true
approver-confirmedOwner has
confirmed the domain vetted
certificate.
awaiting-approvalOrder
processed successfully; waiting for
supplier approval.
390
Parameter
name
Obligation
Definition/Value
completedOrder is complete.
in-progressOrder is in progress.
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
391
392
cancel_order
Description
Action & object
action = cancel_order
object = trust_service
Usage
Cancel a Trust Service order.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
order_id
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
393
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
domain
Returned if
The domain with which the Trust Service order is
is_success = associated.
true
order_id
Returned if
The ID of the order.
is_success =
true
state
Returned if
The state of the order. Allowed values are:
is_success =
approver-confirmedOwner has
true
confirmed the domain vetted certificate.
awaiting-approvalOrder processed
successfully; waiting for supplier approval.
completedOrder is complete.
in-progressOrder is in progress.
394
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>578</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.org</item>
<item key='order_id'>578</item>
<item key='state'>declined</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
395
</body>
</OPS_envelope>
396
cancel_pending_orders
Description
Action & object
action = cancel_pending_orders
object = order
Usage
Cancels orders with a status of pending or declined.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
status
Optional
to_date
Required
request
response_code = response code indicating outcome of the request
397
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
cancelled
Returned if
Contains associative arrays identifying orders that
is_success = were cancelled. Valid values are domain,
true
reg_type, and id.
For more information, see the Cancelled table
below.
total
Returned if
The number of orders that were cancelled.
is_success =
true
Cancelled
Parameters within the cancelled associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Always
returned
id
Always
returned
reg_type
Always
returned
398
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">cancel_pending_orders</item>
<item key="object">order</item>
<item key="attributes">
<dt_assoc>
<item key="to_date">1115228160</item>
<item key="status">
<dt_array>
<item key="0">declined</item>
<item key="1">pending</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
399
<item key="object">ORDER</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="total">2</item>
<item key="cancelled">
<dt_array>
<item key="0">
<dt_assoc>
<item key="reg_type">new</item>
<item key="id">5261</item>
<item key="domain">example.de</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="reg_type">transfer</item>
<item key="id">5530</item>
<item key="domain">example.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
400
create_reseller
Description
Action & object
action = create
object = reseller
Usage
Creates a new Reseller account.
Important: This command is disabled by default. If you want to be enabled
for this command, please contact help@opensrs.com.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
admin_email
Required
contact_set
Required
nameservers
Required
password
Required
username
Required
401
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name Obligation
signup_reseller_id
Definition/Value
Returned if
The ID of the newly created Reseller.
is_success =
true
402
<item key='username'>reseller4574389</item>
<item key='nameservers'>
<dt_assoc>
<item key='fqdn3'>ns3.systemdns.com</item>
<item key='fqdn2'>ns2.systemdns.com</item>
<item key='fqdn1'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='password'>changeit</item>
<item key='admin_email'>robson@example.com</item>
<item key='contact_set'>
<dt_assoc>
<item key='address3'/>
<item key='state'>CA</item>
<item key='address2'>Suite 100</item>
<item key='address1'>32 Oak Street</item>
<item key='country'>US</item>
<item key='fax'>+1.4165352516</item>
<item key='org_name'>Example Inc.</item>
<item key='city'>Santa Clara</item>
<item key='first_name'>Adler</item>
<item key='phone'>+1.4165350123</item>
<item key='email'>adams@example.com</item>
<item key='postal_code'>90210</item>
<item key='last_name'>Adams</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
403
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>RESELLER</item>
<item key='response_text'>Provisioning of reseller
reseller4574389 is in progress.</item>
<item key='attributes'>
<dt_assoc>
<item key='signup_reseller_id'>842</item>
</dt_assoc>
</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
404
create_token
Description
Action & object
action = create_token
object = trust_service
Usage
Creates a SiteLock or TRUSTe account so that users can log in and manage
the Trust Service product. To use this command, the order cannot be in the
pending state.
Important: The resulting URL is valid for only a limited period of time that
may be as short as five minutes.
Attributes
Parameters within the attributes associative array are described below.
Note: You must enter at least one of these parameters.
Parameter
name
Obligation
Definition/Value
order_id
Optional
product_id
Optional
405
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
login_url
Returned if
The The URL where the user can log in to manage
is_success = the SiteLock or TRUSTe product.
true
406
<item key='attributes'>
<dt_assoc>
<item key='order_id'>50094</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='login_url'>https://www.sitelock.com/rlogin.php?
token=ccc038d24c91a7a67d0a12f46f29a260</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
407
</OPS_envelope>
408
modify (domain)
Description
Action & object
action = modify
object = domain
Usage
Changes information associated with a domain, such as contact info. The
action request message is different depending on the type of modification
being made, and is shown separately for each type.
This command also allows you to set an auto-renew flag for the domain from
which you logged in. If you are using the affected_domains option, you can
set the renewal action flags for all domains in the user's profile.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
affect_domains
Required
409
Parameter
name
Obligation
Definition/Value
to this profile.
data
Required
ca_whois_display_settingFor
changes to the CIRA Whois Privacy
setting for .CA domains. Only allowed for
individual registrants, including Canadian
citizens, Permanent residents, Legal
representatives, and Aboriginal peoples.
410
Parameter
name
Obligation
Definition/Value
domain.
domain
Required if
cookie is not
submitted
tld_data
Required for
An associative array that contains additional
changes to
information required by the registry, such as the
tld_data values residency of the registrant. If you submit a
for .ASIA,
request that contains this array, you must also
.COOP, .JOBS, include data = tld_data.
.LV, .MX,
Allowed values are:
.PRO, .RO, .US,
ced_infoAn array that contains Charter
ZA; optional
Eligibility (CED) information for .ASIA
for .XXX
domains.
it_registrant_infoFor changes to
the .IT identification information.
professional_dataUsed to make
changes to the professional designation
411
Parameter
name
Obligation
Definition/Value
information that is associated with the
.PRO domain.
registrant_extra_infoadditional
registrant information.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
display
Required
PRIVATEWhen a
WHOIS lookup is done on the domain name, do
not display personal information.
FULLWhen a
WHOIS lookup is done on the domain name,
display all of the data that is on the WHOIS
directory, including name, address, telephone
number and email address.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
change_tag_all
Optional
412
Parameter name
Obligation
Definition/Value
domain only; this is the default.
domain
Required if
cookie is not
submitted
gaining_registrar_tag
Required
rsp_override
Optional
Attributes
Parameters within the attributes associative array are described below.
Parameter Obligation
name
Definition/Value
address1
Optional
address2
Optional
address3
Optional
city
Optional
country
Optional
Optional
fax
Optional
first_name
Required
413
Parameter Obligation
name
Definition/Value
lang
Optional
ENEnglish
FRFrench
last_name
Required
legal_type
Required
ABOAboriginal
ASSAssociation
CCOCanadian Corporation
CCTCanadian Citizen
EDUEducational Institution
GOVGovernment
HOPHospital
INBIndian Band
LGRLegal Representative
PLTPolitical Party
PRTPartnership
RESPermanent Resident
TDMTrademark Owner
TRDTrade Union
TRSTrust
org_name
Optional for
individuals
phone
Optional
postal_code
Optional
Maximum 16 characters.
state
Optional
ABAlberta
BCBritish Columbia
MBManitoba
414
Parameter Obligation
name
Definition/Value
NBNew Brunswick
NTNorthwest Territories
NSNova Scotia
NUNunavut
ONOntario
QCQuebec
SKSaskatchewan
YTYukon
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
contact_set
Required
admin
billing
owner
Note: The owner contact for .IT domains
requires three additional parameters:
entity_type, nationality_code, and
reg_code. For information about these
parameters, see .IT contact requirements.
tech
415
Parameter
name
Obligation
Definition/Value
org_name
Required
Organization name.
report_email
Optional
Contact_Set
You can submit different contact information for each contact type, or you
can use the also_apply_to parameter to apply the changes to other contact
types.
Parameters within the contact_set associative array are described below.
Parameter
name
Obligation
Definition/Value
also_apply_to
Optional
contact information
owner Owner
admin
Administrator contact information
billing
Billing contact information
Note: This value is not supported for .IT
domains; if submitted, the command will fail.
contact information
tech Tech
416
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain_auth_info
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
auto_renew
Required
let_expire
Required
1Set to auto-renew.
417
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
forwarding_email
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
state
Required
418
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
all
Required
affect_domains
flag
Required
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
lock_state
Required
0Unlocked
1Locked
419
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
reg_type
Required
uk_affect_domains
uk_whois_opt
Optional
Required
INDIndividual
FINDForeign Individual
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
affect_domains
Required
420
Parameter
name
Obligation
Definition/Value
specified domain.
report_email
Optional
state
Required
421
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
details
Returned if
A case-by-case description of the success or
is_success = true failure of each affected domain.
The key is the name of the domain.
When you specify a contact_info
modification, you can specify that you want
the action to apply to all domains.
Because the modification may succeed or
fail on a case-by-case basis, you get a
response code for each domain that is
affected.
The key that is used to access this domain
success information is the name of the
domain itself, for example, 'mydomain.com'
or 'mydomain.co.uk'.
Each key contains a hash (described below)
that provides details on the action
performed on that domain.
encoding_type
Optional
response_code
Returned if
The response code associated with the
is_success = true modification on this domain.
response_text
Returned if
The response text associated with the
is_success = true modification on this domain
waiting_requests_ Returned if
The number of registry requests in the
no
is_success = true waiting state.
422
Deprecated
Parameter
name
Obligation
Definition/Value
waiting_request
Deprecated
Replaced by waiting_requests_no.
423
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">OK</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
424
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.11.121</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains">0</item>
<item key="data">change_ips_tag</item>
<item key="domain">example.me.uk</item>
<item key="gaining_registrar_tag">q1q1</item>
<item key="change_tag_all">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successfully
completed.</item>
</dt_assoc>
</data_block>
</body>
425
</OPS_envelope>
426
<item key="lang">FR</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">OK</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
427
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">MODIFY</item>
<item key="object">DOMAIN</item>
<item key="cookie">2121:1212</item>
<item key="registrant_ip">111.121.121.11</item>
<item key="attributes">
<dt_assoc>
<item key="data">contact_info</item>
<item key="affect_domains">0</item>
<item key="contact_set">
<dt_assoc>
<item key="also_apply_to">
<dt_array>
<item key="0">owner</item>
<item key="1">billing</item>
</dt_array>
</item>
<item key="admin">
<dt_assoc>
<item key="first_name">Adler</item>
<item key="last_name">Adams</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak St.</item>
<item key="address2">Suite 100</item>
<item key="address3"/>
428
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
429
Example 2
In this example, admin and tech contact information is changed for a .CA
domain.
Note: For .CA domains when data = contact_info, instead of address1,
address2, and address3, you can specify these address attributes:
addr_office, addr_address_number, addr_street_name, addr_street_cat,
and addr_orientation.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
430
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">MODIFY</item>
<item key="object">DOMAIN</item>
<item key="cookie">853675384:13254444</item>
<item key="registrant_ip">72.53.78.221</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains">0</item>
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="org_name">Example Co.</item>
<item key="first_name">Adler</item>
<item key="last_name">Adams</item>
<item key="ddress1">32 Oak Street</item>
<item key="address2">Suite 100</item>
<item key="address3"/>
<item key="city">Saskatoon</item>
<item key="state">SK</item>
<item key="country">CA</item>
<item key="postal_code">M1M1M1</item>
<item key="phone">+1/4165551212</item>
<item key="fax">+1.4165552222</item>
<item key="email">adams@example.ca</item>
<item key="language">EN</item>
</dt_assoc>
</item>
<item key="also_apply_to">
<dt_array>
<item key="0">tech</item>
</dt_array>
431
</item>
</dt_assoc>
</item>
<item key="report_email"></item>
<item key="data">contact_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Modification(s) successful</item>
<item key="attributes">
<dt_assoc>
<item key="details">
<dt_assoc>
<item key="example.ca">
<dt_assoc>
<item key="response_text">Contact
modification successful</item>
432
<item key="response_code">200</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
In this example, owner contact information is modified for a .IT domain.
The .IT owner contact requires three additional parameters:
nationality_code, reg_code, and entity_type.
Note: The other contact types do not require these additional parameters, so
if you change the owner contact information, and you use also_apply_to to
apply the changes to another type, for example, tech, the command will be
successful, but those additional parameters and values are ignored by the
other contact type. However, also_apply_to billing is not supported for .IT
domains, and if you submit that value, the command will fail. When the
domain owner is a person (entity_type = 1), changing the owner contact
information also changes the admin contact information as these are
considered to be the same at the Registry.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">MODIFY</item>
433
<item key="object">DOMAIN</item>
<item key="cookie">EKQygsAX2t5OqLM2:256400:25530</item>
<item key="registrant_ip">10.0.62.128</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains"></item>
<item key="report_email"></item>
<item key="data">contact_info</item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
<dt_assoc>
<item key="entity_type">1</item>
<item key="nationality_code">IT</item>
<item key="first_name">Mario</item>
<item key="last_name">Segale</item>
<item key="org_name"></item>
<item key="address1">Via del Campidoglio, 1</item>
<item key="address2"></item>
<item key="address3"></item>
<item key="city">Rome</item>
<item key="state">RM</item>
<item key="country">IT</item>
<item key="postal_code">00123</item>
<item key="email">mario@example.com</item>
<item key="reg_code">SGLMRA80A01H501E</item>
<item key="phone">+39.0612345678</item>
<item key="fax"></item>
</dt_assoc>
</item>
<item key="also_apply_to"/>
</dt_assoc>
</item>
</dt_assoc>
</item>
434
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command completed successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="details">
<dt_assoc>
<item key="example033.it">
<dt_assoc>
<item key="response_text">Command completed
successfully</item>
<item key="waiting_requests_no">0</item>
<item key="encoding_type"></item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</item>
</dt_assoc>
435
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
436
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Domain auth code modification
Successful</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
437
<item key="action">modify</item>
<item key="object">domain</item>
<item key="cookie">692767317:3214395</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains">0</item>
<item key="auto_renew">0</item>
<item key="let_expire">0</item>
<item key="data">expire_action</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Update successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
438
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
439
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Domain forwarding email
modification Successful</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
440
<item key="data">parkpage_state</item>
<item key="domain">example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Parked page successfully enabled
for domain example.com</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
441
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="cookie">631119177:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains">0</item>
<item key="flag">Y</item>
<item key="all">1</item>
<item key="data">rsp_whois_info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
442
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successfully
Completed</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 1
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="affect_domains">0</item>
<item key="lock_state">0</item>
<item key="data">status</item>
443
<item key="domain">example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Lock disabled for
example.com</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
444
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="lock_state">0</item>
<item key="data">status</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Lock disabled for example.com</item>
445
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
446
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
447
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Modification Successful</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
448
<dt_assoc>
<item key="affect_domains">0</item>
<item key="report_email"/>
<item key="state">disable</item>
<item key="data">whois_privacy_state</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Whois Privacy successfully
disabled</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
449
Example 2
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="state">enable</item>
<item key="data">whois_privacy_state</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
450
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Whois Privacy successfully disabled</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
451
<item key="affect_domains">0</item>
<item key="data">tld_data</item>
<item key="tld_data">
<dt_assoc>
<item key='ced_info'>
<dt_assoc>
<item key="contact_type">tech</item>
<item key="legal_entity_type">other</item>
<item key="legal_entity_type_info">add some
text here</item>
<item key="id_type">other</item>
<item key="id_type_info">other</item>
<item key="id_number">8675309</item>
<item key="locality_city">Sydney</item>
<item key="locality_state_prov">NSW</item>
<item key="locality_country">AU</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
452
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Data modification
Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.asia</item>
<item key="data">tld_data</item>
<item key="tld_data">
<dt_assoc>
453
<item key='ced_info'>
<dt_assoc>
<item key="contact_type">tech</item>
<item key="id_number">8675309</item>
<item key="id_type">passport</item>
<item
key="legal_entity_type">corporation</item>
<item key="locality_city">Sydney</item>
<item key="locality_state_prov">NSW</item>
<item key="locality_country">AU</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">CED Data modification Successful</item>
<item key="response_code">200</item>
454
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
455
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">OK</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
456
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>modify</item>
<item key='object'>domain</item>
<item key='cookie'>jL81QUn9BKTJAdSN:698497:1284</item>
<item key='attributes'>
<dt_assoc>
<item key='data'>tld_data</item>
<item key='tld_data'>
<dt_assoc>
<item key='it_registrant_info'>
<dt_assoc>
<item key='entity_type'>1</item>
<item key='reg_code'>SGLMRA80A01H501E</item>
<item key='nationality_code'>it</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
457
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Command completed successfully</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="details">
<dt_assoc>
<item key="feb22test1.it">
<dt_assoc>
<item key="response_text">Command completed
successfully</item>
<item key="waiting_requests_no">0</item>
<item key="encoding_type"></item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
458
459
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Nexus Data modification
Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0" encoding="UTF-8" standalone='yes'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
460
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.us</item>
<item key="data">tld_data</item>
<item key='tld_data'>
<dt_assoc>
<item key="nexus">
<dt_assoc>
<item key="validator">CA</item>
<item key="category">C31</item>
<item key="app_purpose">P1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
461
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Nexus Data modification Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
462
<dt_assoc>
<item key='professional_data'>
<dt_assoc>
<item key='authority_website'>http://www.cdaadc.ca</item>
<item key='license_number'>987654321</item>
<item key='authority'>Canadian Dental
Association</item>
<item key='profession'>Dentist</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>OK</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
463
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
464
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>OK</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
465
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>modify</item>
<item key='object'>domain</item>
<item key='cookie'>7rQitruAeYGgKcBO:707623:6222</item>
<item key='attributes'>
<dt_assoc>
<item key='data'>tld_data</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='jobs_admin_type'>Yes</item>
<item
key='jobs_website'>http://www.example.com</item>
<item key='jobs_association_member'>Yes</item>
<item key='jobs_title'>HR Generalist</item>
<item key='jobs_industry_type'>Logistics
Management</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
466
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>OK</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
467
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='date_of_birth'>1976-08-05</item>
<item key='id_card_authority'>Republic of
Khakassia </item>
<item key='id_card_issue_date'>2001-01-01</item>
<item key='id_card_number'>987654321</item>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>OK</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
468
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
469
parse csr
Description
Action & object
action = parse_csr
object = trust_service
Usage
Parses the CSR and identifies its data elements.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
csr
Required
Required
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
quickssl
quickssl_premium
securesite
securesite_pro
470
Parameter
name
Obligation
Definition/Value
securesite_ev
securesite_pro_ev
sgcsuper_certs
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
truebizid
truebizid_wildcard
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
csr_data
Returned if
A list of the data elements of the CSR. For more
is_success = information, see the csr_data table.
true
471
csr_data
Parameters within the csr_data associative array are described below.
Parameter name
Obligation
Definition/Value
country
Always returned
domain
Always returned
Always returned
has_bad_extensions
Always returned
locality
Always returned
organization
Always returned
organization_unit
Always returned
state
Always returned
valid_quick_domain
valid_true_domain
0No
1Yes
0No
1Yes
472
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>parse_csr</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='product_type'>quickssl</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIBqTCCARICAQAwaTELMAkGA1UEBhMCQ0ExCzAJBgNVBAgTAm9uMRAwDgYDVQQH
Ewd0b3JvbnRvMQ8wDQYDVQQKEwZ0dWNvd3MxCzAJBgNVBAsTAnFhMR0wGwYDVQQD
ExR3d3cucWFyZWdyZXNzaW9uLm9yZzCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkC
gYEAz+hbqqnE5BSW0THf7txxsJxF8Vtca2uL52iutI1SRTm9J6NNtAjgMbL9upOm
SFnObpWKriUIlvxKrecygGWkjiMeyU/F6auAS9/vwDdxYEVT2szK+Q2At1FgU433
Pds53v2J/vyB6SL+k/w54H2gF4ORpU1hjUggo7fM353TeeMCAwEAAaAAMA0GCSqG
SIb3DQEBBAUAA4GBAIYvVThVeocN7N7HbsO/au9AXnx6LULQ5LMDWx6FlyBB5g9h
5HYZa6xieYCYDxYIsjLjR3qx1BWl9+0kSL2MW4EdDPzbcrZvHAtrw2/hPrm9EGA3
2w3a26W79N3clCkrahnpcNFLFyzU3CtZASJ+VuixGXTEkdiBAliqtGp+QBhf -----END
CERTIFICATE REQUEST-----</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
473
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='csr_data'>
<dt_assoc>
<item key='country'>US</item>
<item key='organization_unit'>QA</item>
<item key='valid_true_domain'>1</item>
<item key='state'>CA</item>
<item key='locality'>Santa Clara</item>
<item key='email'/>
<item key='domain'>www.example.com</item>
<item key='valid_quick_domain'>1</item>
<item key='has_bad_extensions'>0</item>
<item key='organization'>Example Inc.</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
474
process_pending
Description
Action & object
action = process_pending
object = domain or trust_service
Usage
Processes or cancels pending orders; also applicable to any order that is
declined. The order is cancelled and a new order is created. Can also be used
to process cancelled domain orders, provided the cancelled order was a new
order or a transfer.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
command
Optional
fax_received
Optional
0No
1Yes
order_id
Required
owner_address
Optional
475
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
attributes
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
async_reason
Included in domain
response for
asynchronous
requests
domain
Included in Trust
Service response if
is_success = true
f_auto_renew
Included in domain
response if
is_success = true
id
order_id
Included in Trust
Service response if
is_success = true
registration
expiration date
state
Included in Trust
Service response if
is_success = true
awaiting-approvalOrder
476
Parameter
name
Obligation
Definition/Value
processed successfully; waiting for
supplier approval.
in-progressOrder is in progress.
Deprecated
Parameter
name
Obligation
Definition / Value
transaction_id
Deprecated
Deprecated
477
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
If successful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="f_auto_renew">Y</item>
<item key="id">3343012</item>
<item key="registration expiration date">2007-12-05
15:23:15</item>
</dt_assoc>
</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text"> Domain registration successfully
completed
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
478
If unsuccessful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">0</item>
<item key="response_code">480</item>
<item key="response_text">Order 535242 is not a pending or
declined order and cannot be processed</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
479
480
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed
successfully.</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">6617</item>
<item key="supplier_order_id">219</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
481
query_approver_list
Description
Action & object
action = query_approver_list
object = trust_service
Usage
Queries the list of approvers for the Trust Service that is associated with the
specified domain.
Note: This command is currently not supported for Trustwave certificates.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
product_type
Required
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
482
Parameter
name
Obligation
Definition/Value
securesite_pro_ev
sgcsuper_certs
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
truebizid
truebizid_wildcard
truebizid_ev
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
approver_list
Returned if
The list of approvers and their properties. For more
is_success = information, see the approver_list table.
true
Approver_list
Parameters within the approver_list associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Always
returned
483
Parameter
name
Obligation
Definition/Value
Always
returned
type
Always
returned
genericGenerated by pre-pending
predefined list of prefixes to the domain
name. Prefixes include admin, administrator,
hostmaster, root, webmaster, postmaster,
and support.
484
</OPS_envelope>
485
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='approver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='email'>qafive@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>MANUAL</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='email'>ottway@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>MANUAL</item>
</dt_assoc>
</item>
486
<item key='2'>
<dt_assoc>
<item key='email'>admin@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
<item key='3'>
<dt_assoc>
<item key='email'>administrator@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
<item key='4'>
<dt_assoc>
<item key='email'>hostmaster@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
<item key='5'>
<dt_assoc>
<item key='email'>root@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
<item key='6'>
<dt_assoc>
<item key='email'>webmaster@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
487
<item key='7'>
<dt_assoc>
<item key='email'>postmaster@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>GENERIC</item>
</dt_assoc>
</item>
<item key='8'>
<dt_assoc>
<item key='email'>support@example.com</item>
<item key='domain'>example.com</item>
<item key='type'>MANUAL</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
488
query_queued_request
Description
Action & object
action = query_queued_request
object = domain
Usage
Queries the status of a queued request.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
request_id
Required
request
489
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
queue_date
Returned if
The date the order was queued, in the format
is_success = true DD-MMM-YYYY hh:mm:ss.
request_data
Returned if
The content of the original queued request. All
is_success = true data is returned in a single variable.
490
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command completed
successfully</item>
<item key="attributes">
<dt_assoc>
<item key="queue_date">04-MAR-2004 10:27:01</item>
<item key="request_data">
<dt_assoc>
<item key="ip">10.0.11.121</item>
<item key="username">purple</item>
<item key="action">SW_REGISTER</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
491
redeem (domain)
Description
Action & object
action = redeem
object = domain
Usage
Redeems a .COM, .NET, .CA, .IT, or .NL domain that has expired but is within
the redemption grace period.
Note: Domain redemptions may incur addition fees.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
domain
Required
492
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
493
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="action">REPLY</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
494
renew (domain)
Description
Action & object
action = renew
object = domain
Usage
Renews a domain and allows you to set the auto-renewal flag on a domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
affiliate_id
Optional
auto_renew
Required
1Set to auto-renew
currentexpirationyear
Required
domain
Required
f_parkp
Optional
495
Parameter name
Obligation
Definition/Value
is displayed. The ads generate revenue
whenever a visitor clicks on one of the links,
and that revenue is shared with you, the
Reseller.
Important: Enabling Parked Pages changes
the nameservers of that domain, and any
existing website will not display.
Parked Pages functionality is available for
these TLDs: .COM, .NET, .ORG, .INFO,
.BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA,
.CC, .CO, .EU, .IN, .ME, .NL, .TV, .UK,
.US, .WS and .XXX.
Required
immediately
period
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
496
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name Obligation
Definition/Value
admin_email
Returned if
is_success =
true
auto_renew
Returned if
is_success =
true
1Set to auto-renew
id
Returned if
is_success =
true and order is
not queued
order_id
Returned if
is_success =
true
queue_request_id
Returned if
is_success =
true and order is
queued
Returned if
is_success =
true
registration
expiration date
Response codes
Response
Code
Response Text
Explanation
200
Command completed
successfully
Success response.
480
Renew capability is not Renewals are not yet supported for this TLD.
enabled for domain.tv
555
Domain already
renewed
541
400
System error.
497
Response
Code
Response Text
Explanation
400
Domain already
Domain is already in 'renewal applied' state.
renewed; another
renewal cannot be
applied until the first
request completes', at
the registry,
approximately six to
eight weeks after the
original expiration date
(2003-03-19 12:12:00)
498
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="registration expiration date">2009-01-08
15:35:00</item>
<item key="auto_renew">1</item>
<item key="admin_email">admin1@example.com</item>
<item key="id">3212624</item>
<item key="order_id">3511417</item>
</dt_assoc>
</item>
<item key="response_text">Command completed
successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
499
</body>
</OPS_envelope>
500
request_on_demand_scan
Description
Action & object
action = request_on_demand_scan
object = trust_service
Usage
If you have a Symantec or SiteLock seal, or the GeoTrust Web Site AntiMalware Scan product, and you have corrected a malware issue on your site,
you can ask the Trust Service provider to rescan your system immediately
and reinstate the Seal.
Note: You can only request a scan if the Trust Seal order is complete.
Attributes
Parameters within the attributes associative array are described below.
Note: You must specify at least one of these parameters.
Parameter name
Obligation
Definition/Value
order_id
Optional
product_id
Optional
501
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
product_id
Returned if
is_success =
true
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>request_on_demand_scan</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='product_id'>275</item>
</dt_assoc>
</item>
502
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='product_id'>275</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example requests a scan for a site by submitting the order ID.
503
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>request_on_demand_scan</item>
<item key='object'>trust_service</item>
<item key='action'>REQUEST_ON_DEMAND_SCAN</item>
<attributes>
<item key='order_id'>49841</item>
</attributes>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
504
505
resend_approve_email
Description
Action & object
action = resend_approve_email
object = trust_service
Usage
Resends the Approver email
Note: This command is not supported for SiteLock products, or for Comodo
EV SSL certificates or for Trustwave Premium EV, Premium SSL and Premium
SSL Wildcard certificates, or the GeoTrust Web Site Anti-Malware Scan
product. For TRUSTe products, this command resends the fulfillment email
after the order is submitted.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
order_id
Required
request
506
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
order_id
Returned if
is_success =
true
507
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>1859</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
508
resend_cert_email
Description
Action & object
action = resend_cert_email
object = trust_service
Usage
Resends the certificate email.
In order to request the SSL Certificate email, the order must be completed.
Note: This command is not supported for SiteLock or Comodo, or the
GeoTrust Web Site Anti-Malware Scan product. For TRUSTe products, this
command resends the fulfillment email after the order is completed.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
order_id
Required
request
509
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
order_id
Returned if
is_success =
true
510
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='order_id'>1799</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
511
revoke (domain)
Description
Action & object
action = revoke
object = domain
Usage
Removes the domain at the registry. Use this command to request a refund
for a domain purchase. This call can refund/revoke only one domain at the
time.
Note: A refund can be issued for only those domains which fall within the
specified grace period as defined by each registry.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
Domain to be revoked.
notes
Optional
512
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
charge
Optional
price
Optional
0No charge
1Indicates a charge
513
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="notes">this is a test</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
If successful
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="charge">0</item>
<item key="price">undef</item>
</dt_assoc>
</item>
<item key="response_text">Domain example.com revoked
successfully.</item>
514
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
If unsuccessful
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">0</item>
<item key="response_text">Domain not found.</item>
<item key="response_code">461</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
515
send_CIRA_approval_email
Description
Action & object
action = send_CIRA_approval_email
object = domain
Usage
When a .CA domain is registered, it goes into a waiting-approval state, and
the admin contact must confirm the registration by responding to an approval
email message, sent by CIRA. This command resends that CIRA registration
approval email message to the domain's contact.
Important: This command has been deprecated. If this command is part of
your current integration, it will continue to work; however, the results will be
ignored. The response will return 'is_success' => '1'.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
516
request
517
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">domain</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">CIRA registration confirmation
mail sent to user1@example.ca</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
518
send_registrant_verification_email
Description
Action & object
action =send_registrant_verification_email
object = domain
Usage
When a domain is registered or transferred, or when the registrant contact
information is changed, the registrant must reply to an email requesting
them to confirm that the submitted contact information is correct. This
command sends or resends the verification email to the registrant.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition / Value
domain
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
520
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Verification email has been resent
successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
521
set_domain_affiliate_id
Description
Action & object
action = set_domain_affiliate_id
object = domain
Usage
Assigns an affiliate id to a domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
affiliate_id
Required
domain
Required
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
523
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
524
Usage
Submits a new registration or transfer order that obeys the Reseller's
'process immediately' flag setting.
After the 30 days, if the order has not been cancelled, the customer is
automatically charged for the term that they selected when they placed the
order. The expiry date is calculated from the date that the paid term begins,
not the date that the free trial began. For GeoTrust and Symantec, once the
order has passed the free trial stage and become activated, you cannot order
another free trial for the same domain until the one year period has passed.
Note:The Symantec certs and the GeoTrust True BusinessID with EV
certificate can only be ordered for a one year term when taking advantage of
the 30 day free trial offer.
525
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
affiliate_id
Optional
auto_renew
Optional
change_contact
Optional
1Auto-renew
comments
Optional
contact_set
Required
526
Definition/Value
custom_
nameservers
Required for
domain
registrations
custom_transfer_
nameservers
Required for
domain
registrations
527
Definition/Value
dns_template
Optional
ns1.systemdns.com
ns2.systemdns.com
ns3.systemdns.com
Required for
domain
registrations
and domain
vetted
certificates
encoding_type
Optional
f_lock_domain
f_parkp
Optional
Optional
1Lock domain
528
Definition/Value
customized page containing contextual ads is
displayed. The ads generate revenue whenever
a visitor clicks on one of the links, and that
revenue is shared with you, the Reseller.
Important: Enabling Parked Pages changes
the nameservers of that domain, and any
existing website will not display.
Parked Pages functionality is available for new
and transferred domain registrations for these
TLDs: .COM, .NET, .ORG, .INFO, .BIZ,
.MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC,
.CO, .EU, .IN, .ME, .NL, .TV, .UK, .US, .WS and
.XXX .
If Parked Pages is enabled, DNS settings
entered at registration are saved for future use
and the Parked Pages nameservers are used
instead.
For transfers, the DNS settings that were
entered with the transfer request are used. If
DNS settings were not submitted at the time of
transfer, the pre-transfer DNS settings are
used. If the domain was using the Parked
Pages DNS at the time of transfer, and DNS
settings are not provided, the domain
continues to use the Parked Pages DNS.
f_whois_privacy
handle
link_domains
Optional
Required
Optional
0Disable
1Enable
529
Definition/Value
OpenSRS should have link_domains set to 1.
The return to this call contains an OpenSRS
order ID. This value is used as the
master_order_id in the subsequent calls to
sw_register for the remainder of the domain
list.
Required for
domain
registrations if
link_domains
=1
nameserver_list
ns1.systemdns.com
ns2.systemdns.com
ns3.systemdns.com
period
Required for
.DE, .BE, .EU,
and .IT
transfers
Required for
new domain
registrations
only
530
Definition/Value
reg_domain
Optional
reg_username
Required for
domain
registrations
Required for
domain
registrations
Required for
domain
registrations
reg_password
reg_type
tld_data
Required for
.AERO, .AR,
.ASIA, .AU,
.BR, .CL,
.COOP, .DE,
.DK, .FI,
.FR, .HK,
.HU, .IT, .JOBS,
.LV, .MX,
.MY, .NO,
.NU, .NYC, .PM,
.PRO, .PT,
.RE, .RO,
whois_privacyEnable WHOIS
Privacy for an existing domain.
DEPRECATED.
au_registrant_infoEligibility
requirements for.AU registrants.
ced_infoCharter Eligibility
Declaration (CED) information for
.ASIA domains.
ipr_dataSponsored Community
531
Definition/Value
.RU, .SE,
.SG, .TF,
.US. .WF, .YT,
and .ZA
domains.
Optional for
.XXX domains.
it_registrant_infoRegional
presence requirements for .IT
domains.
nexusAmerican presence
requirements for .US domains.
professional_dataThe professional
designation information that is
associated with the .PRO domain.
registrant_extra_infoRegional
presence requirements for various
ccTLDs such as .FR and .NYC, or
industry requirements for .JOBS
domains or .AERO domains.
Required for
Sunrise orders
of the new
gTLDs
Nameserver pair
Each element of the nameserver_list array contains the following pair,
expressed as an associative array:
Parameter
name
Obligation
Definition/Value
name
Required
sortorder
Required
532
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
owner_confirm_address
Required
Obligation
Definition/Value
lang
Required
enEnglish
frFrench
nlDutch
533
.CA registrations
Specific parameters and required values for .CA
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
legal_type
Required
ABOAboriginal
ASSAssociation
CCOCanadian Corporation
CCTCanadian Citizen
EDUEducational Institution
GOVGovernment
HOPHospital
INBIndian Band
LGRLegal Representative
PLTPolitical Party
PRTPartnership
RESPermanent Resident
TDMTrademark Owner
TRDTrade Union
TRSTrust
Deprecated
The following parameters have been deprecated. If these parameters are
used in your current integration, the command will continue to work;
however, the values will be ignored.
Parameter
name
Obligation
Definition/Value
ca_link_domain
Deprecated
534
Parameter
name
Obligation
Definition/Value
Registrant profile.
Allowed values are:
cwa
Deprecated
domain_description Deprecated
isa_trademark
rant_agrees
Deprecated
Deprecated
0No
1Yes
535
Parameter
name
Obligation
Definition/Value
confirmed.
Deprecated
Attributes
Parameters within the attributes associative array are described below.
536
Parameter name
Obligation
Definition/Value
owner_confirm_address
Required for
.EU transfers
Obligation
Definition/Value
country
BEBelgium
CYCyprus
CZCzech Republic
DEGermany
DKDenmark
EEEstonia
ESSpain
FIFinland
FRFrance
GIGibraltar
GFFrench Guyana
GPGuadeloupe
GRGreece
HUHungary
IEIreland
ITItaly
LTLithuania
LULuxembourg
LVLatvia
MQMartinique
MTMalta (including
Gozo and Comino)
NLNetherlands
PLPoland
PTPortugal
REReunion
SESweden
SISlovenia
SKSlovakia
lang
537
Parameter
name
Obligation
Definition/Value
csCzech
daDanish
deGerman
elGreek
enEnglish
esSpanish
etEstonian
fiFinnish
frFrench
huHungarian
itItalian
ltLithuanian
lvLatvian
mtMaltese
nlDutch
plPoland
ptPortuguese
skSlovak
slSlovenian
svSwedish
.IT transfers
Specific parameters and required values for .IT transfers
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
Used to change contact information during a transfer
or after transfer completion.
change_contact Optional
Required
.MOBI registrations
.MOBI applications use the sw_register command with the standard
parameters. Specific parameters and required values are described below.
Domain names can be registered for one to ten year terms.
538
Nameservers
You must submit the correct nameservers with your application. If you are
unsure which nameservers to submit with your application, submit the
OpenSRS nameservers ns1.systemdns.com and ns2.systemdns.com.
Obligati
on
Definition/Value
period
Required
reg_type
Required
.NAME registrations
Specific parameters and required values for .NAME
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
tld_data
forwarding-emailFor .NAME
domains
539
Obligation
Definition/Value
additional_
domains
TrueBusiness ID4 to 24
TrueBusiness ID EV4 to 24
Secure Site1 to 24
540
Parameter
name
Obligation
Definition/Value
Secure Site Pro, SSL Web Server, SGC
SuperCerts, True BusinessID.
approver_email
Required for
domain vetted
certificates.
base_order_id
Optional
contact_set
Required
csr
541
Parameter
name
Obligation
Definition/Value
domain
Required for
The domain or hostname for which the Trust
orders for domain Service is ordered.
vetted certificates
and for SiteLock
and TRUSTe
services; not
required when
requesting a
SiteLock upgrade
end_user_auth_
info
Optional used
only for SiteLock
and TRUSTe
Required
542
Parameter
name
order_id
period
Obligation
Definition/Value
certificates that
were migrated
from TPP.
Required for
renewals and for
SiteLock
upgrades if
product_id is
not submitted.
comodo_ev1 to 2
comodo_instantssl1 to 4
comodo_premiumssl1 to 4
comodo_premiumssl_wildcard1 to 4
comodo_ssl1 to 4
comodo_wildcard1 to 4
malwarescan1
quickssl1 to 4
quickssl_premium1 to 4
securesite1 to 4
securesite_ft1
securesite_ev1 to 2
securesite_ev_ft1
securesite_pro1 to 4
securesite_pro_ft1
securesite_pro_ev1 to 2
securesite_pro_ev_ft1
sgcsuper_certs1 to 4
sitelock_basic1
sitelock_premium1
sitelock_enterprise1
ssl1231 to 4
sslwebserver1 to 4
sslwebserver_ev1 to 2
543
Parameter
name
product_id
product_type
Obligation
Definition/Value
sslwebserver_wildcard1 to 2
truebizid1 to 4
truebizid_ev1 to 2
truebizid_ev_ft1
truebizid_wildcard1 to 4
truste_hpp1 to 3
truste_hpp_ft1 to 3
truste_tps1 to 3
truste_tps_ft1 to 3
trustwave_dv1 to 3
trustwave_ev1 to 2
trustwave_premiumssl1 to 3
trustwave_premiumssl_wildcard1 to
3
Required for
renewals and for
SiteLock
upgrades if
order_id is not
submitted.
Required
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
544
Parameter
name
reg_type
Obligation
Required
Definition/Value
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_ev
sslwebserver_wildcard
truebizid
truebizid_wildcard
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
545
Parameter
name
Obligation
Definition/Value
available only for SiteLock certificates.
search_in_seal
Optional
server_type
Optional
Comodo
apache2
apachessl
apacheapachessl
citrix
apacheopenssl
domino
apacheraven
ensim
apachessl
hsphere
apachessleay
iis4
c2net
iis6
cobaltseries
iis7
cobaltraq3
iplanet
cobaltraq2
javawebserver
546
Parameter
name
Obligation
Definition/Value
Symantec, thawte, and
GeoTrust
Comodo
cpanel
netscape
domino
ibmhttp
dominogo4626
novell
dominogo4625
oracle
ensim
other
hsphere
plesk
iis
redhat
iis4
sap
iis5
tomcat
iplanet
webstar
ipswitch
whmcpanel
netscape
ibmhttp
other
plesk
tomcat
weblogic
website
webstar
webstar4
zeusv3
Optional
trust_seal
Optional
547
End_user_auth_info
Parameters within the end_user_auth_info associative array are described
below.
Parameter
name
Obligation
Definition/Value
email_address
password
username
Standard parameters
action = reply
object = domain or trust_service
is_success = a Boolean is returned, indicating success or failure of the
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
548
Definition/Value
admin_email
Optional
async_reason
Returned for
Indicates the reason that the request
asynchronous requests was asynchronous. Allowed values
are:
generalOrder was
submitted to an asynchronous
registry.
has_claimRegistrant action
required before order can
complete.
cancelled_orders
Optional
error
Returned when an
order fails.
forced_pending
id
Returned if
is_success = true
queue_request_id
registration_code
Returned if
is_success = true
registration_text
transfer_id
Returned if
reg_type=transfer
whois_privacy_state
549
Definition/Value
domain
Returned for domain The domain with which the Trust Service
vetted certificates
is associated.
order_id
Always returned
state
Always returned
approver-confirmedOwner
has confirmed the domain vetted
certificate.
awaiting-approvalOrder
processed successfully; waiting
for supplier approval.
completedOrder is complete.
in-progressOrder is in
progress.
pendingOrder saved as
pending.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.10.19</item>
<item key="attributes">
<dt_assoc>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="reg_domain"/>
<item key="f_lock_domain">1</item>
<item key="f_whois_privacy">1</item>
<item key="f_parkp">Y</item>
<item key="domain">example.com</item>
<item key="affiliate_id"/>
<item key="period">1</item>
<item key="reg_type">new</item>
<item key="comments">Sample comment</item>
<item key="reg_username">daniel</item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="nameserver_list">
551
<dt_array>
<item key="0">
<dt_assoc>
<item key="sortorder">1</item>
<item key="name">ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="sortorder">2</item>
<item key="name">ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="reg_password">daniel</item>
<item key="encoding_type"/>
<item key="custom_nameservers">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
552
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">
Domain registration successfully completed. WHOIS
Privacy successfully enabled. Domain successfully locked.
</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">jsmith@example.com</item>
<item key="whois_privacy_state">enabled</item>
<item key="registration_text">Domain registration
successfully completed. WHOIS Privacy successfully enabled. Domain
successfully locked.</item>
<item key="registration_code">200</item>
<item key="id">3735281</item>
<item key="cancelled_orders">
<dt_array>
<item key="0">3764860</item>
<item key="1">3764861</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
About this example:
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.10.19</item>
<item key="attributes">
<dt_assoc>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="dns_template">newdnstemplate</item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="reg_domain">example.com</item>
<item key="f_lock_domain">0</item>
<item key="domain">example.net</item>
<item key="affiliate_id"/>
<item key="period">10</item>
<item key="reg_type">new</item>
<item key="reg_username">daniel</item>
<item key="reg_password">daniel</item>
<item key="custom_nameservers">0</item>
<item key="encoding_type"/>
</dt_assoc>
</item>
554
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Domain registration successfully
completed.</item>
<item key="attributes">
<dt_assoc>
<item key="registration_code">435</item>
<item key="id">3735283</item>
<item key="forced_pending">3735283</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
555
Example 3
About this example:
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.10.19</item>
<item key="attributes">
<dt_assoc>
<item key="dns_template">*blank*</item>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="reg_domain"/>
<item key="f_lock_domain">1</item>
<item key="f_whois_privacy">1</item>
<item key="f_parkp">Y</item>
<item key="domain">example.com</item>
<item key="affiliate_id"/>
<item key="period">1</item>
<item key="reg_type">new</item>
<item key="reg_username">daniel</item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
556
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Domain registration successfully completed
Domain successfully locked.
Whois Privacy successfully enabled.</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">email@example.com</item>
<item key="registration_text">Domain registration successfully
completed
Domain successfully locked.
Whois Privacy successfully enabled.</item>
<item key="registration_code">200</item>
557
<item key="id">177411</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
558
559
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">250</item>
<item key="is_success">1</item>
<item key="response_text">Domain registration successfully
submitted</item>
<item key="rr_id">13689</item>
<item key="transaction_id">2012-05-16 09:10:36 1250 101</item>
<item key="domain_id">707819</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration successfully
submitted</item>
<item key="admin_email">adler@example.com</item>
<item key="registration_code">300</item>
<item key="waiting_request">sw_register</item>
560
<item key="waiting_requests_no">1</item>
<item key="id">477659</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
561
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='custom_tech_contact'>0</item>
<item key='auto_renew'>0</item>
<item key='reg_type'>new</item>
<item key='reg_username'>sanford</item>
<item key='reg_password'>mypass</item>
<item key='domain'>example.asia</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
562
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='tld_data'>
<dt_assoc>
<item key='ced_info'>
<dt_assoc>
<item key='locality_country'>JP</item>
<item key='legal_entity_type'>naturalPerson</item>
<item key='id_type'>passport</item>
<item key='id_number'>12345</item>
<item key='contact_type'>admin</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='custom_nameservers'>0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
563
564
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>new</item>
<item key='domain'>example.com.au</item>
<item key='period'>2</item>
<item key='link_domains'>0</item>
<item key='f_lock_domain'>1</item>
<item key='auto_renew'>0</item>
<item key='reg_domain'/>
<item key='reg_username'>user123</item>
<item key='reg_password'>changeit</item>
<item key='tld_data'>
<dt_assoc>
<item key='au_registrant_info'>
<dt_assoc>
<item key='registrant_name'>Registered Company
Name Ltd</item>
<item key='registrant_id_type'>ABN</item>
<item key='policy_reason'>1</item>
<item key='registrant_id'>99 999 999 999</item>
<item key='eligibility_type'>Registered
Business</item>
CTO</item>
565
</item>
<item key='custom_tech_contact'>1</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='custom_nameservers'>1</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
566
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">OK</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">admin@example.com</item>
<item key="registration_text">Domain registration successfully
completed Domain successfully locked.</item>
<item key="registration_code">200</item>
<item key="id">417011</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
567
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="custom_tech_contact">0</item>
<item key="auto_renew">0</item>
<item key="reg_type">new</item>
<item key="reg_username">test</item>
<item key="domain">example.ca</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="domain_description">this is a domain
description</item>
<item key="link_domains">0</item>
<item key="period">1</item>
<item key="reg_password">passwd</item>
<item key="legal_type">CCT</item>
<item key="reg_domain"/>
<item key="custom_nameservers">0</item>
</dt_assoc>
</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="sortorder">1</item>
<item key="name">ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="sortorder">2</item>
568
<item key="name">ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>250</item>
<item key='response_text'>Domain registration successfully
submitted</item>
<item key='is_success'>1</item>
<item key='parameters'>
<dt_array>
<item key='0'>
<dt_assoc>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='attributes'>
569
<dt_assoc>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='rr_id'>839480</item>
<item key='domain_id'>14532389</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully submitted</item>
<item key='admin_email'>fraser@example.ca</item>
<item key='registration_code'>300</item>
<item key='waiting_requests_no'>1</item>
<item key='id'>56726064</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
or domain = .COM.BR
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
570
<item key="object">DOMAIN</item>
<item key="action">SW_REGISTER</item>
<item key="attributes">
<dt_assoc>
<item key="tld_data">
<dt_assoc>
<item key="br_register_number">114.113.111-11</item>
</dt_assoc>
</item>
<item key="reg_type">new</item>
<item key='handle'>process</item>
<item key="domain">mybraziliandomain.com.br</item>
<item key="period">1</item>
<item key='reg_domain'/>
<item key='reg_username'>username</item>
<item key='reg_password'>changeit123</item>
<item key="custom_tech_contact">1</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="custom_nameservers">1</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.livednsservice.com</item>
<item key="sortorder">1</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.livednsservice.com</item>
<item key="sortorder">2</item>
</dt_assoc>
</item>
571
<item key="2">
<dt_assoc>
<item key="name">ns3.livednsservice.com</item>
<item key="sortorder">3</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">250</item>
<item key="is_success">1</item>
<item key="rr_id">6466</item>
<item key="response_text">Domain registration successfully
submitted</item>
<item key="transaction_id">2011-04-14 18:12:39 25830 101</item>
<item key="domain_id">256808</item>
572
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration
successfully submitted</item>
<item key="admin_email">ajobim12345@somedomain.com.br</item>
<item key="registration_code">300</item>
<item key="waiting_requests_no">1</item>
<item key="waiting_request">sw_register</item>
<item key="id">296660</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='f_lock_domain'>0</item>
573
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='affiliate_id'>affiliatetest1</item>
<item key='reg_type'>new</item>
<item key='reg_username'>andrew</item>
<item key='domain'>example.de</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='sortorder'>3</item>
<item key='name'>ns3.systemdnssystemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
574
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>test</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
completed</item>
575
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>robson@example.com</item>
<item key='registration_code'>200</item>
<item key='id'>607737</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
576
<item key='domain'>example.dk</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_vat_id'>123456789</item>
<item key='registrant_type'>organization</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>test</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
577
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>250</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
submitted</item>
<item key='rr_id'>29910</item>
<item key='domain_id'>753996</item>
<item key='transaction_id'>2013-10-01 12:00:49 1402 101</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully submitted</item>
<item key='admin_email'>robson@example.com</item>
<item key='registration_code'>300</item>
<item key='waiting_request'>sw_register</item>
<item key='waiting_requests_no'>1</item>
578
<item key='id'>607640</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
579
</item>
<item key="custom_tech_contact">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Domain registration successfully
completed</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration
successfully completed</item>
<item key="registration_code">200</item>
<item key="id">16629</item>
<item key="admin_email">jsmith@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
580
</body>
</OPS_envelope>
581
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='date_of_birth'>1989-03-03</item>
<item key='place_of_birth'>Paris</item>
<item key='country_of_birth'>FR</item>
<item key='postal_code_of_birth'>75008</item>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>changeit</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
582
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>andre@example.com</item>
<item key='registration_code'>200</item>
<item key='id'>457700</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
583
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='f_lock_domain'>1</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='reg_type'>new</item>
<item key='reg_username'>zoltan</item>
<item key='domain'>example.hu</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Daniel</item>
<item key='last_name'>Nagy</item>
<item key='address1'>Bem rakpart 49</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Budapest</item>
<item key='state'/>
<item key='postal_code'>H-1037</item>
<item key='country'>HU</item>
<item key='org_name'>Varga Szoftver</item>
<item key='phone'>+1.3615550123</item>
<item key='fax'>+1.3615553653</item>
<item key='email'>dnagy@example.com</item>
584
</dt_assoc>
</item>
<item key='owner'>
<dt_assoc>
<item key='first_name'>Zoltan</item>
<item key='last_name'>Varga</item>
<item key='org_name'>Varga Szoftver</item>
<item key='address1'>Bem rakpart 49</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Budapest</item>
<item key='state'/>
<item key='postal_code'>H-1037</item>
<item key='country'>HU</item>
<item key='fax'>+1.3615553651</item>
<item key='phone'>+1.3615550124</item>
<item key='email'>zoltan@example.com</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Paul</item>
<item key='last_name'>Farkas</item>
<item key='org_name'>Varga Szoftver</item>
<item key='address1'>Bem rakpart 49</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Budapest</item>
<item key='state'/>
<item key='postal_code'>H-1037</item>
<item key='country'>HU</item>
<item key='fax'>+1.3615553652</item>
<item key='phone'>+1.3615550125</item>
<item key='email'>pfarkas@example.com</item>
</dt_assoc>
585
</item>
</dt_assoc>
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='sortorder'>3</item>
<item key='name'>ns3.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_vat_id'>12345678</item>
<item key='registrant_type'>organization</item>
</dt_assoc>
</item>
586
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>changeit</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>250</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
submitted</item>
<item key='domain_id'>709245</item>
<item key='transaction_id'>2012-06-19 13:49:57 1277 101</item>
<item key='attributes'>
<dt_assoc>
587
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.10.19</item>
588
<item key="attributes">
<dt_assoc>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="custom_tech_contact">1</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="reg_domain">example-nsi.com</item>
<item key="f_lock_domain">0</item>
<item key="domain">example.info</item>
<item key="affiliate_id"/>
<item key="period">2</item>
<item key="reg_type">new</item>
<item key="reg_username">daniel</item>
<item key="nameserver_list">
<dt_array/>
</item>
<item key="reg_password">daniel</item>
<item key="encoding_type"/>
<item key="custom_nameservers">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
589
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='registration_code'>200</item>
<item key='id'>23994</item>
<item key='admin_email'>admin@example.info</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
590
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="reg_username">aaaa</item>
<item key="tld_data">
<dt_assoc>
<item key="it_registrant_info">
<dt_assoc>
<item key="nationality_code">IT</item>
<item key="reg_code">SGLMRA80A01H501E</item>
<item key="entity_type">1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="custom_tech_contact">1</item>
<item key="reg_password">aaaa</item>
<item key="period">1</item>
<item key="f_whois_privacy">0</item>
<item key="link_domains">0</item>
<item key="custom_nameservers">1</item>
<item key="f_lock_domain">0</item>
<item key="domain">example031.it</item>
<item key="reg_type">new</item>
<item key="reg_domain"></item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
591
<dt_assoc>
<item key="first_name">Mario</item>
<item key="last_name">Segale</item>
<item key="org_name">Mario Segale</item>
<item key="address1">Via del Campidoglio, 1</item>
<item key="city">Rome</item>
<item key="state">RM</item>
<item key="country">IT</item>
<item key="postal_code">00123</item>
<item key="phone">+39.0612345678</item>
<item key="email">mario@mail.it</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="first_name">Frank</item>
<item key="last_name">Mosser</item>
<item key="org_name">Tech Orgname</item>
<item key="address1">Piazza dei Giudici 1</item>
<item key="city">Firenze</item>
<item key="state">FI</item>
<item key="country">IT</item>
<item key="postal_code">50123</item>
<item key="phone">+39.0551234567</item>
<item key="email">qafive@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="sortorder">1</item>
592
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="sortorder">2</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="name">ns3.systemdns.com</item>
<item key="sortorder">3</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
593
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Domain registration successfully
completed</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration successfully
completed</item>
<item key="admin_email">mario@mail.it</item>
<item key="registration_code">200</item>
<item key="id">214946</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>`
</OPS_envelope>
Example 2
This example registers a domain to an Italian company (entity_type = 2).
In this case, the admin contact is required.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
<item key="object">DOMAIN</item>
594
<item key="attributes">
<dt_assoc>
<item key="reg_username">aaaa</item>
<item key="tld_data">
<dt_assoc>
<item key="it_registrant_info">
<dt_assoc>
<item key="nationality_code">IT</item>
<item key="reg_code">06612345675</item>
<item key="entity_type">2</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="reg_password">aaaa</item>
<item key="period">1</item>
<item key="f_whois_privacy">0</item>
<item key="link_domains">0</item>
<item key="custom_nameservers">1</item>
<item key="f_lock_domain">0</item>
<item key="domain">example032.it</item>
<item key="reg_type">new</item>
<item key="reg_domain"></item>
<item key="custom_tech_contact">1</item>
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="first_name">Mario</item>
<item key="last_name">Segale</item>
<item key="org_name">Mario Segale</item>
<item key="address1">Via del Campidoglio, 1</item>
<item key="city">Rome</item>
<item key="state">RM</item>
<item key="country">IT</item>
595
<item key="postal_code">00123</item>
<item key="phone">+39.0612345678</item>
<item key="email">mario@mail.it</item>
</dt_assoc>
</item>
<item key="owner">
<dt_assoc>
<item key="first_name">Franco</item>
<item key="last_name">Pendenza</item>
<item key="org_name">Aumento Inc</item>
<item key="address1">Via del Inclinazione, 1</item>
<item key="city">Pisa</item>
<item key="state">PI</item>
<item key="country">IT</item>
<item key="postal_code">52123</item>
<item key="phone">+39.0501234567</item>
<item key="email">tilt@mail.it</item>
<item key="fax">+39.0501234568</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="first_name">Frank</item>
<item key="last_name">Mosser</item>
<item key="org_name">Tech Orgname</item>
<item key="address1">Piazza dei Giudici 1</item>
<item key="city">Firenze</item>
<item key="state">FI</item>
<item key="country">IT</item>
<item key="postal_code">50123</item>
<item key="phone">+39.0551234567</item>
<item key="email">qafive@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
596
</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="sortorder">1</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="sortorder">2</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="name">ns3.systemdns.com</item>
<item key="sortorder">3</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
597
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Domain registration successfully
completed</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration successfully
completed</item>
<item key="admin_email">mario@mail.it</item>
<item key="registration_code">200</item>
<item key="id">214947</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
598
599
<item key="country">US</item>
<item key="phone">+1.4165551212</item>
<item key="fax">+1.4165551234</item>
<item key="email">owen@example.com</item>
<item key="org_name">Example Inc.</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="domain">example.jobs</item>
<item key="affiliate_id"/>
<item key="period">1</item>
<item key="reg_type">new</item>
<item key="bulk_order">0</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="sortorder">1</item>
<item key="name">ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="sortorder">2</item>
<item key="name">ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="encoding_type"/>
<item key="action">register</item>
<item key="custom_nameservers">1</item>
<item key="tld_data">
<dt_assoc>
600
<item key="registrant_extra_info">
<dt_assoc>
<item key="jobs_admin_type">Yes</item>
<item key="jobs_industry_type">Supply Chain
Management</item>
<item key="jobs_title">HR Generalist</item>
<item key="jobs_association_member">Yes</item>
<item
key="jobs_website">http://www.example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">250</item>
<item key="is_success">1</item>
<item key="response_text">Domain registration successfully
601
submitted</item>
<item key="rr_id">13688</item>
<item key="transaction_id">2012-05-16 09:04:19 1249 101</item>
<item key="domain_id">707818</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Domain registration successfully
submitted</item>
<item key="admin_email">a@b.com</item>
<item key="registration_code">300</item>
<item key="waiting_request">sw_register</item>
<item key="waiting_requests_no">1</item>
<item key="id">477658</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER</item>
602
<item key="object">DOMAIN</item>
<item key="registrant_ip">10.0.10.19</item>
<item key="attributes">
<dt_assoc>
<item key="auto_renew"/>
<item key="link_domains">0</item>
<item key="custom_tech_contact">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="reg_domain">example-nsi.com</item>
<item key="f_lock_domain">0</item>
<item key="domain">jane.doe.name</item>
<item key="affiliate_id"/>
<item key="period">10</item>
<item key="reg_type">new</item>
<item key="reg_username">example</item>
<item key="nameserver_list">
<dt_array/>
</item>
<item key="tld_data">
<dt_assoc>
<item
key="forwarding_email">johndoe@netscape.net</item>
</dt_assoc>
</item>
<item key="reg_password">example</item>
<item key="encoding_type"/>
<item key="custom_nameservers">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
603
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='registration_code'>200</item>
<item key='id'>23995</item>
<item key='admin_email'>mail@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
604
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='f_lock_domain'>1</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='reg_type'>new</item>
<item key='reg_username'>lafleur</item>
<item key='domain'>example.pm</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Marie</item>
<item key='last_name'>LaFleur</item>
<item key='org_name'>French Impressions</item>
<item key='address1'>13 Rue Daze</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Paris</item>
<item key='state'/>
<item key='postal_code'>75002</item>
<item key='country'>FR</item>
<item key='fax'>+1.3365550125</item>
<item key='phone'>+1.3365551213</item>
<item key='email'>marie@example.com</item>
</dt_assoc>
605
</item>
<item key='owner'>
<dt_assoc>
<item key='first_name'>Henri</item>
<item key='last_name'>LaFleur</item>
<item key='org_name'>French Impressions</item>
<item key='address1'>13 Rue Daze</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Paris</item>
<item key='state'/>
<item key='postal_code'>75002</item>
<item key='country'>FR</item>
<item key='phone'>+1.3365551212</item>
<item key='fax'>+1.3365550124</item>
<item key='email'>lafleur@example.com</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Pierre</item>
<item key='last_name'>LaFleur</item>
<item key='org_name'>French Impressions</item>
<item key='address1'>13 Rue Daze</item>
<item key='address2'/>
<item key='address3'/>
<item key='city'>Paris</item>
<item key='state'/>
<item key='postal_code'>75002</item>
<item key='country'>FR</item>
<item key='phone'>+1.3365551214</item>
<item key='fax'>+1.3365550125</item>
<item key='email'>pierre@example.com</item>
</dt_assoc>
</item>
606
</dt_assoc>
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='sortorder'>3</item>
<item key='name'>ns3.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registration_number'/>
<item key='registrant_vat_id'>1X345678901</item>
<item key='registrant_type'>organization</item>
</dt_assoc>
</item>
</dt_assoc>
607
</item>
<item key='period'>1</item>
<item key='reg_password'>changeit</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>admin@example.com</item>
<item key='registration_code'>200</item>
608
<item key='id'>481007</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
609
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
<item key='2'>
<dt_assoc>
<item key='sortorder'>3</item>
<item key='name'>ns3.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
*<item key='professional_data'>
<dt_assoc>
<item
key='authority_website'>http://www.cda-adc.ca</item>
<item key='license_number'>123456789</item>
<item key='authority'>Canadian Dental
Association</item>
<item key='profession'>Dentist</item>
</dt_assoc>*
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
610
<item key='reg_password'>aaaa</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='action'>REPLY</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>qafive@example.com</item>
<item key='registration_code'>200</item>
<item key='id'>454197</item>
</dt_assoc>
611
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='custom_tech_contact'>0</item>
<item key='auto_renew'>0</item>
<item key='reg_type'>new</item>
<item key='reg_username'>aaaa</item>
<item key='domain'>example.us</item>
612
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='nexus'>
<dt_assoc>
<item key='category'>C11</item>
<item key='app_purpose'>P3</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>aaaa</item>
<item key='reg_domain'>corelogic0.info</item>
<item key='custom_nameservers'>0</item>
</dt_assoc>
</item>
</dt_assoc>
613
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>mail@example.us</item>
<item key='registration_code'>200</item>
<item key='id'>56726889</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
614
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>new</item>
<item key='f_lock_domain'>1</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='reg_username'>aaaa</item>
<item key='domain'>example.xxx</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
615
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='ipr_data'>
<dt_assoc>
<item key='icm_membership_id'>123456</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>aaaa</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
616
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>0</item>
<item key='response_text'>Domain registration successfully
completed. Domain successfully locked.</item>
<item key='attributes'>
<dt_assoc>
<item key='admin_email'>qafive@example.com</item>
<item key='id'>457626</item>
<item key='registration_code'>200</item>
<item key='registration_text'>Domain registration
successfully completed. Domain successfully locked.</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
617
Example 2
This example registers a domain to a registrant who wants to register the
domain name, but does not want it to resolve. This registrant is not currently
a member of the Sponsored Community.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>new</item>
<item key='f_lock_domain'>1</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='reg_username'>aaaa</item>
<item key='domain'>example.xxx</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
618
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='ipr_data'>
<dt_assoc>
<item key='ipr_non_resolver'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='period'>1</item>
<item key='reg_password'>aaaa</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'/>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
619
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>0</item>
<item key='response_text'>Domain registration successfully
completed. Domain successfully locked.</item>
<item key='attributes'>
<dt_assoc>
<item key='admin_email'>qafive@example.com</item>
<item key='id'>256841</item>
<item key='registration_code'>200</item>
<item key='registration_text'>Domain registration
successfully completed. Domain successfully locked.</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
620
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='f_lock_domain'>1</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>1</item>
<item key='reg_type'>sunrise</item>
<item key='handle'>save</item>
<item key='reg_username'>riggs</item>
<item key='domain'>example.guru</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='f_whois_privacy'>0</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
621
</item>
<item key='link_domains'>0</item>
<item key='tld_data'>
<dt_assoc>
<item key='trademark_smd'> Trademark SMD:Marks:
TEST
smdID: 00000096381377086406165-1
U-labels: sunrise-test
notBefore: 2013-08-21 14:00:06
notAfter: 2015-07-01 00:00:00
-----BEGIN ENCODED SMD----PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHNtZDpzaWduZWRNYXJ
rIHht
bG5zOnNtZD0idXJuOmlldGY6cGFyYW1zOnhtbDpuczpzaWduZWRNYXJrLTEuMCIgaWQ9Il8
0Yjk4
YzMzOC03ZjAxLTQyYWMtYjQyMS00MTQ5YWVkN2JhYjIiPgogIDxzbWQ6aWQ+MDAwMDAwOTYz
YzMzOC03ZjAxLTQyYWMtYjQyMS00MTQ5YWVkN2JhYjIiPgogIDxzbWQ6aWQ+ODEz
NzcwODY0MDYxNjUtMTwvc21kOmlkPgogIDxzbWQ6aXNzdWVySW5mbyBpc3N1ZXJJRD0iMSI
+CiAg
ICA8c21kOm9yZz5EZWxvaXR0ZTwvc21kOm9yZz4KICAgIDxzbWQ6ZW1haWw+YmV0bWNoc21k
ICA8c21kOm9yZz5EZWxvaXR0ZTwvc21kOm9yZz4KICAgIDxzbWQ6ZW1haWw+QGRl
bG9pdHRlLmJlPC9zbWQ6ZW1haWw+CiAgPC9zbWQ6aXNzdWVySW5mbz4KICA8c21kOm5vdEJl
bG9pdHRlLmJlPC9zbWQ6ZW1haWw+Zm9y
ZT4yMDEzLTA4LTIxVDEyOjAwOjA2LjE2NVo8L3NtZDpub3RCZWZvcmU+CiAgPHNtZDpub3RB
ZT4yMDEzLTA4LTIxVDEyOjAwOjA2LjE2NVo8L3NtZDpub3RCZWZvcmU+ZnRl
cj4yMDE1LTA2LTMwVDIyOjAwOjAwLjAwMFo8L3NtZDpub3RBZnRlcj4KICA8bWFyazptYXJ
rIHht
bG5zOm1hcms9InVybjppZXRmOnBhcmFtczp4bWw6bnM6bWFyay0xLjAiPgogICAgPG1hcms
6dHJh
ZGVtYXJrPgogICAgICA8bWFyazppZD4wMDA1MjUxMzc2NDA0OTY4MTM3NjQwNDk2OC0xPC9
tYXJr
OmlkPgogICAgICA8bWFyazptYXJrTmFtZT5UVUNPV1M8L21hcms6bWFya05hbWU+CiAgICAg
OmlkPgogICAgICA8bWFyazptYXJrTmFtZT5UVUNPV1M8L21hcms6bWFya05hbWU+IDxt
YXJrOmhvbGRlciBlbnRpdGxlbWVudD0ib3duZXIiPgogICAgICAgIDxtYXJrOm9yZz5UVUN
PV1Mg
KERFTEFXQVJFKSBJTkMuPC9tYXJrOm9yZz4KICAgICAgICA8bWFyazphZGRyPgogICAgICA
gICAg
PG1hcms6c3RyZWV0PjEyMDkgT1JBTkdFIFNUUkVFVCBDT1JQT1JBVElPTiBUUlVTVCBDRU5
URVI8
622
L21hcms6c3RyZWV0PgogICAgICAgICAgPG1hcms6Y2l0eT5XSUxNSU5HVE9OPC9tYXJrOmN
pdHk+
CiAgICAgICAgICA8bWFyazpzcD5ERUxBV0FSRTwvbWFyazpzcD4KICAgICAgICAgIDxtYXJ
rOnBj
PjE5ODAxPC9tYXJrOnBjPgogICAgICAgICAgPG1hcms6Y2M+VVM8L21hcms6Y2M+CiAgICAg
PjE5ODAxPC9tYXJrOnBjPgogICAgICAgICAgPG1hcms6Y2M+VVM8L21hcms6Y2M+ICAg
PC9tYXJrOmFkZHI+CiAgICAgIDwvbWFyazpob2xkZXI+CiAgICAgIDxtYXJrOmNvbnRhY3Qg
PC9tYXJrOmFkZHI+CiAgICAgIDwvbWFyazpob2xkZXI+dHlw
ZT0iYWdlbnQiPgogICAgICAgIDxtYXJrOm5hbWU+QWxleGFuZGVyIFNjaHdlcnRuZXI8L21h
ZT0iYWdlbnQiPgogICAgICAgIDxtYXJrOm5hbWU+cms6
bmFtZT4KICAgICAgICA8bWFyazpvcmc+RVBBRyBEb21haW5zZXJ2aWNlcyBHbWJIPC9tYXJr
bmFtZT4KICAgICAgICA8bWFyazpvcmc+Om9y
Zz4KICAgICAgICA8bWFyazphZGRyPgogICAgICAgICAgPG1hcms6c3RyZWV0PlJoZWluYWx
sZWUg
MzwvbWFyazpzdHJlZXQ+CiAgICAgICAgICA8bWFyazpjaXR5PkJvbm48L21hcms6Y2l0eT4K
MzwvbWFyazpzdHJlZXQ+ICAg
ICAgICAgIDxtYXJrOnNwPk5SVzwvbWFyazpzcD4KICAgICAgICAgIDxtYXJrOnBjPjUzMTc
zPC9t
YXJrOnBjPgogICAgICAgICAgPG1hcms6Y2M+REU8L21hcms6Y2M+CiAgICAgICAgPC9tYXJr
YXJrOnBjPgogICAgICAgICAgPG1hcms6Y2M+REU8L21hcms6Y2M+OmFk
ZHI+CiAgICAgICAgPG1hcms6dm9pY2U+KzQ5LjIyODMyOTY4NDA8L21hcms6dm9pY2U+CiAg
ZHI+CiAgICAgICAgPG1hcms6dm9pY2U+KzQ5LjIyODMyOTY4NDA8L21hcms6dm9pY2U+ICAg
ICAgPG1hcms6ZW1haWw+cmVnaXN0cnktcmVsYXRpb25zQGVwYWcuZGU8L21hcms6ZW1haWw
+CiAg
ICAgIDwvbWFyazpjb250YWN0PgogICAgICA8bWFyazpqdXJpc2RpY3Rpb24+VVM8L21hcms6
ICAgIDwvbWFyazpjb250YWN0PgogICAgICA8bWFyazpqdXJpc2RpY3Rpb24+anVy
aXNkaWN0aW9uPgogICAgICA8bWFyazpjbGFzcz40MjwvbWFyazpjbGFzcz4KICAgICAgPG1
hcms6
bGFiZWw+dHVjb3dzPC9tYXJrOmxhYmVsPgogICAgICA8bWFyazpnb29kc0FuZFNlcnZpY2Vz
bGFiZWw+PklD
IDA0Mi4gVVMgMTAwIDEwMS4gRyAmYW1wOyBTOiBjb21wdXRlciBzb2Z0d2FyZSBpbmZvcm1
hdGlv
biBzZXJ2aWNlcywgbmFtZWx5LCBpbmZvcm1hdGlvbiByZWdhcmRpbmcgY29tcHV0ZXIgc29
mdHdh
cmUgcmVsYXRlZCB0byBhIGdsb2JhbCBjb21wdXRlciBuZXR3b3JrLCBvZmZlcmVkIHZpYSB
hIGds
b2JhbCBjb21wdXRlciBuZXR3b3JrLiBGSVJTVCBVU0U6IDE5OTQwODAwLiBGSVJTVCBVU0U
gSU4g
Q09NTUVSQ0U6IDE5OTQwODAwPC9tYXJrOmdvb2RzQW5kU2VydmljZXM+CiAgICAgIDxtYXJr
623
Q09NTUVSQ0U6IDE5OTQwODAwPC9tYXJrOmdvb2RzQW5kU2VydmljZXM+OnJl
Z051bT4yMjQ3MTk2PC9tYXJrOnJlZ051bT4KICAgICAgPG1hcms6cmVnRGF0ZT4xOTk5LTA
1LTI0
VDIyOjAwOjAwLjAwMFo8L21hcms6cmVnRGF0ZT4KICAgIDwvbWFyazp0cmFkZW1hcms+CiAg
VDIyOjAwOjAwLjAwMFo8L21hcms6cmVnRGF0ZT4KICAgIDwvbWFyazp0cmFkZW1hcms+PC9t
YXJrOm1hcms+CjxkczpTaWduYXR1cmUgeG1sbnM6ZHM9Imh0dHA6Ly93d3cudzMub3JnLzIw
YXJrOm1hcms+MDAv
MDkveG1sZHNpZyMiIElkPSJfYTQwNWQ3OTAtMzJmYS00YjJiLTg2OTAtZTkyYmMzNjdiMDA
0Ij48
ZHM6U2lnbmVkSW5mbz48ZHM6Q2Fub25pY2FsaXphdGlvbk1ldGhvZCBBbGdvcml0aG09Imh
0dHA6
Ly93d3cudzMub3JnLzIwMDEvMTAveG1sLWV4Yy1jMTRuIyIvPjxkczpTaWduYXR1cmVNZXR
ob2Qg
QWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNyc2E
tc2hh
MjU2Ii8+PGRzOlJlZmVyZW5jZSBVUkk9IiNfNGI5OGMzMzgtN2YwMS00MmFjLWI0MjEtNDE0
MjU2Ii8+OWFl
ZDdiYWIyIj48ZHM6VHJhbnNmb3Jtcz48ZHM6VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDo
vL3d3
dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI2VudmVsb3BlZC1zaWduYXR1cmUiLz48ZHM6VHJ
hbnNm
b3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4
jIi8+
PC9kczpUcmFuc2Zvcm1zPjxkczpEaWdlc3RNZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d
3Lncz
Lm9yZy8yMDAxLzA0L3htbGVuYyNzaGEyNTYiLz48ZHM6RGlnZXN0VmFsdWU+Qk5Eb0IyS0VC
Lm9yZy8yMDAxLzA0L3htbGVuYyNzaGEyNTYiLz48ZHM6RGlnZXN0VmFsdWU+UC9D
UGZHYXpGZTZFZkptNmllSUF1VnhYM2NMMTBmdVhBOD08L2RzOkRpZ2VzdFZhbHVlPjwvZHM
6UmVm
ZXJlbmNlPjxkczpSZWZlcmVuY2UgVVJJPSIjXzFkOWQwMjNlLTNmYjUtNDAxMi1iYjExLTd
iYmNl
ZjAxZTdjZCI+PGRzOlRyYW5zZm9ybXM+PGRzOlRyYW5zZm9ybSBBbGdvcml0aG09Imh0dHA6
ZjAxZTdjZCI+PGRzOlRyYW5zZm9ybXM+Ly93
d3cudzMub3JnLzIwMDEvMTAveG1sLWV4Yy1jMTRuIyIvPjwvZHM6VHJhbnNmb3Jtcz48ZHM
6RGln
ZXN0TWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8wNC94bWxlbmM
jc2hh
MjU2Ii8+PGRzOkRpZ2VzdFZhbHVlPmx2Q2dCdFBkUlAydURZR05lQ0hqMXhaSmJhUlVwOW04
MjU2Ii8+em5K
S2hNOUtKakE9PC9kczpEaWdlc3RWYWx1ZT48L2RzOlJlZmVyZW5jZT48L2RzOlNpZ25lZEl
uZm8+
624
PGRzOlNpZ25hdHVyZVZhbHVlIElkPSJfNjJmNzA4Y2UtMmM5YS00ZjMwLTk4NTgtMDc0OTM
1ZmE1
YmE5Ij5pTDNpUmdCaVRNUTFmajNZT2F3VFZJQ3RpZmJETE9tL0x1NjF6UE9iOU5HYTZRT3N
ISTFZ
dnB6SDVYREJ6N1dRcVZmZDJ5V0VPdWFRClBOUjZjQUhHT3h0c0M2QytVRy94UmFoM2JnUUw
0Tmwv
cXI2SVBOd3dQdmNtVFlYYTBIUjV6MkRXNVJUbHZUY2dIQjA5Q1Z4eng5SkMKMFRnVjhpVE9
2bmpB
eFZ6OTF6dlJ5dUE0UFhvdi8waDBKcjg2a1F5WXhwanZJTXp4Y1pJb1ZhcVdZZWNrcGpUZDk
2Znhn
TGhBQ0ZhUAo5YkVQMkZKTDl4QnJ3SnU4Mjdsd1dkRlJGWmJhL2ZKSVFROVAyN0k4aWVUR29
FUzA4
NTFmSWNNUHRmcjhmQkZvRHNOV25QQkdZSkY2CnlOUC80NEozTXBmU3pKcDBvUXNEbnM0L2l
TY2U1
S2xsR0crdzNRPT08L2RzOlNpZ25hdHVyZVZhbHVlPjxkczpLZXlJbmZvIElkPSJfMWQ5ZDA
yM2Ut
M2ZiNS00MDEyLWJiMTEtN2JiY2VmMDFlN2NkIj48ZHM6WDUwOURhdGE+PGRzOlg1MDlDZXJ0
M2ZiNS00MDEyLWJiMTEtN2JiY2VmMDFlN2NkIj48ZHM6WDUwOURhdGE+aWZp
Y2F0ZT5NSUlGTlRDQ0JCMmdBd0lCQWdJaEFKTkNNcWhOanozY1hWSlBqN3l2Y1p2cm8xRkt
RUitk
VEM2dFhhemVtNWcvTUEwR0NTcUdTSWIzCkRRRUJDd1VBTUhZeEN6QUpCZ05WQkFZVEFsVlR
NVHd3
T2dZRFZRUUtFek5KYm5SbGNtNWxkQ0JEYjNKd2IzSmhkR2x2YmlCbWIzSWcKUVhOemFXZHV
aV1Fn
VG1GdFpYTWdZVzVrSUU1MWJXSmxjbk14S1RBbkJnTlZCQU1USUVsRFFVNU9JRlJ5WVdSbGJ
XRnlh
eUJEYkdWaApjbWx1WjJodmRYTmxJRU5CTUI0WERURXpNRGN5TkRBd01EQXdNRm9YRFRFNU1
EY3lN
ekl6TlRrMU9Wb3dnYUF4Q3pBSkJnTlZCQVlUCkFrSkZNUkV3RHdZRFZRUUlFd2hDY25WemM
yVnNj
ekVSTUE4R0ExVUVCeE1JVFdGamFHVnNaVzR4RVRBUEJnTlZCQW9UQ0VSbGJHOXAKZEhSbE1
USXdN
QVlEVlFRREV5bEpRMEZPVGlCVVRVTklJRUYxZEdodmNtbDZaV1FnVkhKaFpHVnRZWEpySUZ
aaGJH
bGtZWFJ2Y2pFawpNQ0lHQ1NxR1NJYjNEUUVKQVJZVlltVjBiV05vYzIxa1FHUmxiRzlwZEh
SbExt
SmxNSUlCSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DCkFROEFNSUlCQ2dLQ0FRRUF5VSs0a3d
xaHlE
QU13YlhINnhyZ3JKK0NzTzVPN2JMZGtEMk1vTmFKajFLUlcxY2ZTUVVNUUM0ZHpJd1QKM0d
nZksw
M1lPSk9wTTFUSjQvM2xZMWFTcmFMSnRtRy9LYlVrZDFub0RNWmlja3FqQWtISDhtTGliYlF
1Zjl2
625
dFpWV0ZOUW5td0h4VwoyWWFxRlVzUUFGQVNjRjNURmE0dG1rZDFZbU1Zb2IzYUdUaFZUMkl
maktt
OXpUNkhNT1JqNCtYd0gvamRkOGxKeHIwSmJCc0dCSzloClBab3o1NXdvVWJNTFhLcWVvVFl
OTE5V
R0VNRlpYWktKSllIQzdFcFl4d3hKaDNtN2NWK2x0UVZzWG5NMlZndVZWak5EUjVYNEY2NCs
KcG54
ZGp2SzFPUEVxWDBRWVJhMzYrYW9QTlQ5cGdtM3RJVE5PSUQ4ZnFIeFh5TGRsbTRnTzZ3SUR
BUUFC
bzRJQmdUQ0NBWDB3REFZRApWUjBUQVFIL0JBSXdBREFkQmdOVkhRNEVGZ1FVc21rQjl0SDI
5cURR
N204TUdyWDhxdXdJVFp3d2djQUdBMVVkSXdTQnVEQ0J0WUFVClhNRHhsaXpLVEZzcDhVQjA
weHMy
UGtmVWJnU2hlcVI0TUhZeEN6QUpCZ05WQkFZVEFsVlRNVHd3T2dZRFZRUUtFek5KYm5SbGN
tNWwK
ZENCRGIzSndiM0poZEdsdmJpQm1iM0lnUVhOemFXZHVaV1FnVG1GdFpYTWdZVzVrSUU1MWJ
XSmxj
bk14S1RBbkJnTlZCQU1USUVsRApRVTVPSUZSeVlXUmxiV0Z5YXlCRGJHVmhjbWx1WjJodmR
YTmxJ
RU5CZ2lFQWswSXlxRTJQUGR4ZFVrK1B2Szl4bSt1alVVcEJINTFNCkxxMWRyTjZibUQ0d0R
nWURW
UjBQQVFIL0JBUURBZ2VBTUM0R0ExVWRId1FuTUNVd0k2QWhvQitHSFdoMGRIQTZMeTlqY21
3dWFX
TmgKYm00dWIzSm5MM1J0WTJndVkzSnNNRXNHQTFVZElBUkVNRUl3RUFZT0t3WUJCQUdDeVJ
zQkJZ
TTdDQW93TGdZSUt3WUJCUVVIQWdFdwpJakFnQmdnckJnRUZCUWNDQVJZVWFIUjBjSE02THk
5allT
NXBZMkZ1Ymk1dmNtY3dEUVlKS29aSWh2Y05BUUVMQlFBRGdnRUJBQTdKCmhXZHZpdUtkeXN
ZM2pl
T3pic1gyRFRtN1RxdmN0Y0V0am1hTy80VW1OMDlDc01USUUzcGptNUtxdzQ5cmxoR0VLM2V
uRGFU
S1hWRXUKMG5iYkRxZUJENjA2WithbFlNNjN3dzRRbjRUYVNiTmNlaDZubGhDYzcrWEI5VGR
LUHJw
SFVwUmhsSDdOM1dXWUsvUGQyMEVmUVR5bwo4UStIMVppbXV3VGdTU2dzN2JvVUlDSWFadFJ
YTG5J
YXZoL2ZNaWYySkpPbDZpUXhsNEp6d2ErUHQwdkd2Q1IrYUx1RVNnWkZuMDR2CmpGVWFUbHF
3YVhv
YUVkOUs2SmxQa2NGTHFIcmN4MlpKSzE5eHBjWTBSR3FreXloc3A1S0RsS0I5RGZraWxhK3l
GcGRQ
R2JjN05rNTgKUkxGSHYvaUlqZTZiZUxwY1FZcS9mQnMzSGRaT2dTQXBiVkE9PC9kczpYNTA
5Q2Vy
dGlmaWNhdGU+PC9kczpYNTA5RGF0YT48L2RzOktleUluZm8+PC9kczpTaWduYXR1cmU+PC9z
dGlmaWNhdGU+PC9kczpYNTA5RGF0YT48L2RzOktleUluZm8+PC9kczpTaWduYXR1cmU+bWQ6
c2lnbmVkTWFyaz4=
626
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Order created</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">qafive@example.com</item>
627
<item key="id">422013</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
628
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</item>
<item key='period'>1</item>
<item key='reg_password'>aaaa</item>
<item key='custom_nameservers'>1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
629
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>260</item>
<item key='is_success'>1</item>
<item key='response_text'>Registration is pending registrant
review before completing due to claim/trademark.</item>
<item key='transaction_id'>2014-03-06 16:30:17 1701 101</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Registration is pending
registrant review before completing due to claim/trademark.</item>
<item key='admin_email'>qafive@example.com</item>
<item key='registration_code'>300</item>
<item key='id'>654276</item>
<item key='async_reason'>has_claim</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 1
This example is an order for a Symantec SecureSite certificate with seal-insearch and trust seal.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
630
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='trust_seal'>1</item>
<item key='reg_type'>NEW</item>
<item key='seal_in_search'>1</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='special_instructions'>Test ABC</item>
<item key='handle'>process</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC4TCCAckCAQAwgZsxKTAnBgNVBAMTIHNlY3VyZXNpdGUudGVzdDEyODU4NzYw
MzY2MDgub3JnMQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rv
cm9udG8xDzANBgNVBAoTBm5ld29yZzEPMA0GA1UECxMGUUFEZXB0MSAwHgYJKoZI
hvcNAQkBFhFxYWZpdmVAdHVjb3dzLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEP
ADCCAQoCggEBAJ0FDLurKaddUzayM5FgICBhy8DkOaBuYzCiHSFw6xRUf9CjAHpC
/MiUM5TnegMiU02COAPmfeHZAERv21CoB/HPDcshewHJywzs8nwcbGncz37eFhNG
FQNIif5ExoGAcLS9+d1EAmR1CupTBCCq86lGBa/RdwgUNlvLF5IgZZeKphd/FKaY
B2KZmRBxM51WvV6AYmRKb6IsuUZCfHO2FCelThDE0EF99GbfSapVj7woSIu0/PTJ
cEX4sHURq6pY3ELfNG0BOzrTsT3Af8T3N5xwD0FMatkDrCPCgVx7sRZ05UqenxBO
VWBJQcr5QRZSykxBosGjbqO3QSyGsElIKgkCAwEAAaAAMA0GCSqGSIb3DQEBBAUA
A4IBAQCEUGNk45qCJiR4Yuce4relbP22EwK7pyX0+0VZ+F3eUxhpZ6S5WN1Juuru
8w48RchQBjGK1jjUfXJIqn/DgX+yAfMj4aW/ohBmovN2ViuNILvNaj0volwoqyMl
NrTmBze69qHMfnMGUUUehMr/Nq4QdQTqxy7EYQkNOqx21gfZcUi6zWCeFTRkasD+
SYAKsOUIKdrt/Jq5lWFXxhkJHuyA+q1yr/w6zh18JmFAT4y/0q/odFGyIr9yKhQ9
usW1sQ8CT3e3AnU4jq7sBrYFxN0f+92W8gX7WADortA7+6PcSFPrZEoQlr5Brki7
631
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.com</item>
<item key='order_id'>1860</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
632
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example is for a domain vetted certificate, which requires approval.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='approver_email'>qafive@example.com</item>
<item key='reg_type'>NEW</item>
<item key='contact_set'>
... see "Contact Set"
</item>
</dt_assoc>
</item>
<item key='special_instructions'>Test ABC</item>
<item key='handle'>process</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC2TCCAcECAQAwgZMxIDAeBgNVBAMTF3NzbDEyMy5xYXJlZ3Jlc3Npb24ub3Jn
MQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8xDzAN
633
BgNVBAoTBlR1Y293czEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJARYR
cWFmaXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
AQDpKz48gJG4ImyJi76kH3AdDZoGNZCC8xgWBUDk4yNXPqe3NxJvZooZIoctP2o8
CX6+xoK8p6jMb9iIz7ZVC9LuoUmoYZZWdoatMUwaz3xIa4Fq7HeLtCE3misKMcZq
+QomhLFv2yMSgyzWWitHdW5oVDuT83Xs8FTZG33rI8gut1J9+5fhJV4WKuncfLwM
xMrj+5iWm+KwoE86dTarGAPwYhC2FepcblszVbz87Dp1clTJLaN4potMES83RHo1
teHHmJAilNzy2PfRoylbzlQ38x1n10wbhqjMcoDYk6CSB40PlduqbsMjpkOClwu4
H92c2Hmo3bqRGWM2K5SXkj29AgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEAKUh6
WH4WtC/LtlJhj+p5i3sLEG/L//8DQh30eOxwMxrSGGZUGTfLBT4RaeDA5JEIF5pK
v4MxvDw1+NExMQW3h/9eVWXpGGjvC2EoLgya3ri3OJlQNOyqSzOvNunk0EPaWoO+
v9o2yKdH88e7NQZp8Pw5jhE9RV9u3+mNw2sztqpzcXYDXW3kKI2UiIP3eur2/iiH
nSAIRl5NfUPgAzCem/zpM1lc3s+EVKysn2wF4bwOkNyYPo4DmgHCb7ggSQyhh5vN
UAoDkyqu2ZScDZTyDG7YOdobMqwbsCT5er5Bq+NWOZyUE+3zO/1VQpznJehaGLrQ
N7UAJliUAO+SFFGdxQ== -----END CERTIFICATE REQUEST-----</item>
<item key='period'>1</item>
<item key='server_type'>apachessl</item>
<item key='server_count'>1</item>
<item key='product_type'>ssl123</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
634
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.com</item>
<item key='order_id'>577</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
This example shows a request that failed because the required title field was
missing from the contact_set.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
635
<item key='trust_seal'>1</item>
<item key='reg_type'>NEW</item>
<item key='seal_in_search'>1</item>
<item key='contact_set'>
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="first_name">Adler</item>
<item key="last_name">Adams</item>
<item key="phone">+1.4165550123x1812</item>
<item key="fax">+1.4165550125</item>
<item key="email">adams@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 100</item>
<item key="address3">Admin</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
<item key="country">US</item>
<item key="postal_code">90210</item>
</dt_assoc>
</item>
<item key="billing">
<dt_assoc>
<item key="first_name">Bill</item>
<item key="last_name">Burton</item>
<item key="phone">+1.4165550123x1248</item>
<item key="fax">+1.4165550136</item>
<item key="email">burton@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 200</item>
<item key="address3">Billing</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
636
<item key="country">US</item>
<item key="postal_code">90210</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="first_name">Tim</item>
<item key="last_name">Tucker</item>
<item key="phone">+1.4165550123x1243</item>
<item key="fax">+1.4165550125</item>
<item key="email">tucker@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 100</item>
<item key="address3">Tech</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
<item key="country">US</item>
<item key="postal_code">90210</item>
</dt_assoc>
</item>
<item key="organization">
<dt_assoc>
<item key="first_name">Jim</item>
<item key="last_name">Johnson</item>
<item key="phone">+1.4165550123x1224</item>
<item key="fax">+1.4165550126</item>
<item key="email">jjohnson@example.com</item>
<item key="org_name">Example Inc.</item>
<item key="address1">32 Oak Street</item>
<item key="address2">Suite 100</item>
<item key="address3">Tech</item>
<item key="city">Santa Clara</item>
<item key="state">CA</item>
<item key="country">US</item>
637
<item key="postal_code">90210</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='special_instructions'>Test ABC</item>
<item key='handle'>process</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC4TCCAckCAQAwgZsxKTAnBgNVBAMTIHNlY3VyZXNpdGUudGVzdDEyODU4NzYw
MzY2MDgub3JnMQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rv
cm9udG8xDzANBgNVBAoTBm5ld29yZzEPMA0GA1UECxMGUUFEZXB0MSAwHgYJKoZI
hvcNAQkBFhFxYWZpdmVAdHVjb3dzLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEP
ADCCAQoCggEBAJ0FDLurKaddUzayM5FgICBhy8DkOaBuYzCiHSFw6xRUf9CjAHpC
/MiUM5TnegMiU02COAPmfeHZAERv21CoB/HPDcshewHJywzs8nwcbGncz37eFhNG
FQNIif5ExoGAcLS9+d1EAmR1CupTBCCq86lGBa/RdwgUNlvLF5IgZZeKphd/FKaY
B2KZmRBxM51WvV6AYmRKb6IsuUZCfHO2FCelThDE0EF99GbfSapVj7woSIu0/PTJ
cEX4sHURq6pY3ELfNG0BOzrTsT3Af8T3N5xwD0FMatkDrCPCgVx7sRZ05UqenxBO
VWBJQcr5QRZSykxBosGjbqO3QSyGsElIKgkCAwEAAaAAMA0GCSqGSIb3DQEBBAUA
A4IBAQCEUGNk45qCJiR4Yuce4relbP22EwK7pyX0+0VZ+F3eUxhpZ6S5WN1Juuru
8w48RchQBjGK1jjUfXJIqn/DgX+yAfMj4aW/ohBmovN2ViuNILvNaj0volwoqyMl
NrTmBze69qHMfnMGUUUehMr/Nq4QdQTqxy7EYQkNOqx21gfZcUi6zWCeFTRkasD+
SYAKsOUIKdrt/Jq5lWFXxhkJHuyA+q1yr/w6zh18JmFAT4y/0q/odFGyIr9yKhQ9
usW1sQ8CT3e3AnU4jq7sBrYFxN0f+92W8gX7WADortA7+6PcSFPrZEoQlr5Brki7
GSwIuTTSlKFRyZ53DbEGjp2ELnnl -----END CERTIFICATE REQUEST----- </item>
<item key='period'>1</item>
<item key='server_type'>apachessl</item>
<item key='server_count'>1</item>
<item key='product_type'>securesite</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
638
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Supplier validation error</item>
<item key="error_details">
<dt_array>
<item key="0">
<dt_assoc>
<item key="error_detail">Title for admin contact object is
missing</item>
<item key="field_name">admin-title</item>
<item key="error_code">3010</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="response_code">3000</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.org</item>
<item key="order_id">12345</item>
<item key="state">pending</item>
</dt_assoc>
</item>
<item key="is_success">0</item>
639
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 4
This example shows an order for a TRUSTe Privacy Service certificate.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">TRUST_SERVICE</item>
<item key="action">SW_REGISTER</item>
<item key="attributes">
<dt_assoc>
<item key="product_type">truste_tps</item>
<item key="special_instructions">none</item>
<item key="domain">example.com</item>
<item key="handle">process</item>
<item key="period">1</item>
<item key="reg_type">NEW</item>
<item key="end_user_auth_info">
<dt_assoc>
<item key="username">rsanford</item>
<item key="password">mypa55w0rd</item>
<item key="email_address">rsanford@example.com</item>
</dt_assoc>
640
</item>
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="country">US</item>
<item key="address3"/>
<item key="org_name">Example Inc.</item>
<item key="phone">+1.4165550123x1812</item>
<item key="last_name">Adams</item>
<item key="address2">Suite 100</item>
<item key="state">CA</item>
<item key="email">adams@example.com</item>
<item key="city">Santa Clara</item>
<item key="postal_code">90210</item>
<item key="fax">+1.4165550125</item>
<item key="address1">32 Oak Street</item>
<item key="first_name">Adler</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
641
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER:REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">6792</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 5
This example shows a renewal order for a QuickSSL certificate.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
642
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>renew</item>
<item key='handle'>process</item>
<item key='product_id'>372</item>
<item key='domain'>www.example.com</item>
<item key='period'>1</item>
<item key='product_type'>quickssl</item>
<item key='server_type'>apacheopenssl</item>
<item key='approver_email'>admin@example.com</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='csr'>
-----BEGIN CERTIFICATE REQUEST----MIICwTCCAakCAQAwfDELMAkGA1UEBhMCQ0ExEDAOBgNVBAgMB09udGFyaW8xEDAO
BgNVBAcMB1Rvcm9udG8xEzARBgNVBAoMClR1Y293cyBJbmMxDjAMBgNVBAsMBVNh
bGVzMSQwIgYDVQQDDBt3d3cub3BlbnNyc2VtYWlsc2VydmljZS5jb20wggEiMA0G
CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCa8HMJsATmwVoqE4sKNFrxA9FLb9rP
F6E/VgL/zYRjmxJgy7ap7Rh6fXLHHNal/pD/TT0FDe11vcocR/A32Ypbyx9CPvvV
040Ik4k+9XCs7jZm1+vKe9RK/MVQcIVaHCL7apbb0TPNGLRfhav5m/pQ7tBz+uXb
fMSchwQ0CjT10gSoNxmC0lFSfR9iCTwxETxeJTKD3xAghSmDFB252EFo9lVWp72u
G/ofSyH0QA0fREmMeYvxE3L6+CjnAn91QxT4/Oq9b353GMXOHyEdM7Zn2Ei9aGzt
bb7iFpVAEPH96a5fVruDI881KmUzncjhIPhiPATGJxThN/Cv2nWlSfrzAgMBAAGg
ADANBgkqhkiG9w0BAQUFAAOCAQEAajJJ5SGFyTO/tnqcAEpcBs+e3Q61zokmRXPb
Zo/LbuseQYXBcgLvEMQwTlzZBbP4JHHOfKXq2iHyMyaj/OX2MilCspjY+Ds6MJsb
kF9tD/R885OS3KP+/umBOz1Q97qx16oKOiuz+KZEh90k141PI2tLbaQlWt9cHtTm
IHVg0319JCKbjieq4AqdaHzQO7NLJYXBzU/uAYe0kggGRV4OtYuFLuKZb46SuFAW
pzY42a72PJ2a/IzF/azGRRD1JU98DKGY1RnzK2ZXuRG3v7G6j2CZLBGLEKG18lSY
qD9+gEzYoTKe4fTNK8yGQ8E2jsW2bE3SG4oq5ghqHZ5vUNzEjw==
-----END CERTIFICATE REQUEST----</item>
643
<item key='special_instructions'></item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SW_REGISTER:REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">8321</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
644
Example 6
This example shows an order to upgrade a SiteLock SSL certificate to
SiteLock Premium.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>upgrade</item>
<item key='product_type'>sitelock_premium</item>
<item key='period'>1</item>
<item key='product_id'>47811</item>
<item key='handle'>process</item>
<item key='special_instructions'>none</item>
<item key='contact_set'>
...see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
645
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">5597</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 7
This example shows an order for a GeoTrust Web Site Anti-Malware Scan
certificate.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
646
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.com</item>
<item key='product_type'>malwarescan</item>
<item key='reg_type'>new</item>
<item key='period'>1</item>
<item key='handle'>process</item>
<item key='contact_set'>
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
647
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">6854</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 8
This example shows an order for a 30 day free trial of a Symantec SecureSite
certificate.
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
648
<item key="action">sw_register</item>
<item key="object">trust_service</item>
<item key="attributes">
<dt_assoc>
<item key="special_instructions">none</item>
<item key="csr">
-----BEGIN CERTIFICATE REQUEST----MIIC1zCCAb8CAQAwgZExHjAcBgNVBAMTFTEzMjA3MDU2NzN0ZXN0aW5nLmNvbTEL
MAkGA1UEBhMCQ0ExEDAOBgNVBAgTB09udGFyaW8xEDAOBgNVBAcTB1Rvcm9udG8x
DzANBgNVBAoTBlR1Y293czELMAkGA1UECxMCUUExIDAeBgkqhkiG9w0BCQEWEXFh
Zml2ZUB0dWNvd3MuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
vfz5BS7X70AFyqvk05RSe5dsxB8e0aTVkj8YixqPULcMxcNSos/hF9CkWKyYD2iP
g8O511Gzw3VA+TWDp+Een1HCyW1uRnnQ/Yepq0J0H4a0kPXh5Mb01WxGVwD5zorm
1QM0gqIW8KTPgUCfi0P+CQkw5TZ2yqJWjcyNwakv/seg2opqUra06jkcdCDliGkW
RJfGgJPM1B2fonduruveWDvIiga3+sbfAoBKajX71NgHZtQXZgHZLU2obPU1lvms
ZUZGavARcUVt043sJvgZG9xMX8hf0LoT4BLrJ1TK7JWf5Be5ZAkq0Y42Lf1V198/
JKNeMJHPeTvpxkrT0W/R4wIDAQABoAAwDQYJKoZIhvcNAQEEBQADggEBAIqzgz3z
5JzscIq6XszzrJw79ampGPSz7JE35pjoPAjk7vsjbxnRTAVfLHeSMyjXTFBZB60h
lyFO0Ft4KQ8Fj7eKtCoMR2mvhx1UtaoRqJ9y9RJmTJfHmdfHrNa4hLIQqDreE5Tj
U4ngidNTTc91qaRrPhAC471BAn7/Ob+ltleIiUuk/ySkh29lR5qQqSTX0FXjsVrN
G9gIHn4KAra3W+SgWGJHpVQrCWqqyPDQ7/dj6x1pEli8izkZv33Xw6386nFhSkB0
EH2LCtmzTJNgUicXzbRu4/UXgMJgaFU77fCzCtOBwMTz+ALWIo0NTPwNp5JE/dw0
/GOjMZgid2nuuMY=
-----END CERTIFICATE REQUEST----</item>
<item key="reg_type">new</item>
<item key="period">1</item>
<item key="product_type">securesite_ft</item>
<item key="server_type">apachessl</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key="handle">process</item>
<item key="server_count">1</item>
<item key="approver_email">admin@example.org</item>
649
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRUST_SERVICE</item>
<item key="response_text">Command completed successfully.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="order_id">7737</item>
<item key="state">awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
650
Example 9
This example shows a new order for a QuickSSL certificate based on an
existing order.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>NEW</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC2zCCAcMCAQAwgZUxIzAhBgNVBAMTGnJlbmV3dGVzdC5xYXJlZ3Jlc3Npb24u
b3JnMQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8x
DzANBgNVBAoTBm5ld29yZzEPMA0GA1UECxMGUUFEZXB0MSAwHgYJKoZIhvcNAQkB
FhFxYWZpdmVAdHVjb3dzLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBAKEUMvmJTbZlIM7aBU3vPYJTsJqPFo45fzzgcrrCUMzsnYV8l/9PRELAfvGK
eFMI27uGUbeXO3EoklMXd1YZwJickfEBG3dSmR8hGBRHrzhKazqos0UmgS4xIyPl
5Rs/WzRRCdhnV7yqSYmC4SLui/8WTEaYsWy5xgbwI7q4ojZurJ65kjeL3e2q7ftr
R/YLvP9Fx6mMTECBFbQxlrlXUQCn/goCfI98zFDQJ/cuPuYuU6Ret4IFU4T8Jn87
jiDa17hqgo/D2rEUfPe1xuk8LgyCcKT0Nemg1uNLihBwwt+nzo7LfyM16BdEFVkG
DOVsasYYFRKQDH7dGTUeZ2hhd5MCAwEAAaAAMA0GCSqGSIb3DQEBBAUAA4IBAQCY
+zsCNQ+vtEocKDg+8eAA4hKUhOTbuT2TsfxtQflmihKa0WB5IvKjgVb3MENWwwAi
3+XpYEBlsaI2NYpLjgRGvoQMUiAXC3JeoxxXXfcdmEpLevD0VZfGtm04RRlFPwEx
jZESqMjBGROUsjnC3pOjUcb9Y6vFeRWtatCmdbDMKnumrKB1G1G6uA01yQR1vsx0
fjK8bhWxwbCoXCQ8LnlQwb9wQECXJ+vguFdB0u97+XHKZXhxpij12frnYPRyJfec
hA6ODlhvJv2k2P19ZjGthGrfW5z7F/mev59a5LX6n4TO1Wp4FZFw4pOJr79umR/K
L/tZauY8EjcOfSHZ76vn -----END CERTIFICATE REQUEST-----</item>
<item key='base_order_id'>8245</item>
<item key='handle'>process</item>
<item key='product_type'>quickssl</item>
<item key='contact_set'>
<dt_assoc>
651
<item key='admin'>
<dt_assoc>
<item key='first_name'>Adler</item>
<item key='last_name'>Adams</item>
<item key='title'>Admin</item>
<item key='org_name'>Example Inc.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='fax'>+1.4165350155</item>
<item key='phone'>+1.4165550123x1812</item>
<item key='email'>adams@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
652
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.com</item>
<item key='order_id'>8279</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 10
This example shows a renewal order for a QuickSSL certificate that was
submitted by using the order ID.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
653
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>RENEW</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC2zCCAcMCAQAwgZUxIzAhBgNVBAMTGnJlbmV3dGVzdC5xYXJlZ3Jlc3Npb24u
b3JnMQswCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8x
DzANBgNVBAoTBm5ld29yZzEPMA0GA1UECxMGUUFEZXB0MSAwHgYJKoZIhvcNAQkB
FhFxYWZpdmVAdHVjb3dzLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBAKEUMvmJTbZlIM7aBU3vPYJTsJqPFo45fzzgcrrCUMzsnYV8l/9PRELAfvGK
eFMI27uGUbeXO3EoklMXd1YZwJickfEBG3dSmR8hGBRHrzhKazqos0UmgS4xIyPl
5Rs/WzRRCdhnV7yqSYmC4SLui/8WTEaYsWy5xgbwI7q4ojZurJ65kjeL3e2q7ftr
R/YLvP9Fx6mMTECBFbQxlrlXUQCn/goCfI98zFDQJ/cuPuYuU6Ret4IFU4T8Jn87
jiDa17hqgo/D2rEUfPe1xuk8LgyCcKT0Nemg1uNLihBwwt+nzo7LfyM16BdEFVkG
DOVsasYYFRKQDH7dGTUeZ2hhd5MCAwEAAaAAMA0GCSqGSIb3DQEBBAUAA4IBAQCY
+zsCNQ+vtEocKDg+8eAA4hKUhOTbuT2TsfxtQflmihKa0WB5IvKjgVb3MENWwwAi
3+XpYEBlsaI2NYpLjgRGvoQMUiAXC3JeoxxXXfcdmEpLevD0VZfGtm04RRlFPwEx
jZESqMjBGROUsjnC3pOjUcb9Y6vFeRWtatCmdbDMKnumrKB1G1G6uA01yQR1vsx0
fjK8bhWxwbCoXCQ8LnlQwb9wQECXJ+vguFdB0u97+XHKZXhxpij12frnYPRyJfec
hA6ODlhvJv2k2P19ZjGthGrfW5z7F/mev59a5LX6n4TO1Wp4FZFw4pOJr79umR/K
L/tZauY8EjcOfSHZ76vn -----END CERTIFICATE REQUEST-----</item>
<item key='handle'>process</item>
<item key='product_type'>quickssl</item>
<item key='order_id'>8274</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
654
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.com</item>
<item key='order_id'>8278</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 11
This example shows a renewal order for a QuickSSL certificate that was
submitted by using the product ID.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
655
<dt_assoc>
<item key='inventory_item_id'>8887502</item>
<item key='reg_type'>RENEW</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC1zCCAb8CAQAwgZExHzAdBgNVBAMTFnJhcGlkLnFhcmVncmVzc2lvbi5vcmcxCzAJBgN
VBAYTAkNBMQswCQYDVQQIEwJPTjEQMA4GA1UEBxMHVG9yb250bzEPMA0G
A1UEChMGbmV3b3JnMQ8wDQYDVQQLEwZRQURlcHQxIDAeBgkqhkiG9w0BCQEWEXFhZml2ZUB
0dWNvd3MuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
3FI2z0xXFk5/0iy3Sw6JiXuN1LJmL61NdvuXH+6WLdWDxsheSzmGLtnELmKuKZAVgby1+13
KuvuxOtutM/EfrnWagrn2cOpR7WDkogRFlYQ14jx8CadjCIviyIsdL+SC
ix9HeFYLT/kMcB/i7oWUlroyvOZ6aHFnThvZxl7Yk9su3UNfn9ZL/bj7GjmxMn8lBH9AJvm
EvM8Qa9vLUT4AQR+p7TrdcTeXyBJSt4q1rqKXhq4Q4ChG6rielRu3VN2g
x60cCWOl/b04w/psWCBmgUvzFzwmgIfP0a7H+sxsAOFTyCwKBfOBALtKsQWkW4DCM4KpZLQ
20W+IfPXvvrJSUwIDAQABoAAwDQYJKoZIhvcNAQEEBQADggEBAGTZD3sk
qLoNK2tx+ciIUBvBXrVNzUm5PSc7LQLfDqKms0zcvQM1nE8Yz+LkbjFZyWIc2njrt8H7AGi
s/sdeKKK9Vi1VU9cOwp+QOgtuLxa/97rBudrLdoUiWYWj2MiR2T9aSf0k
vxSRdio3UrJNrygkf1z2I5sEn5HjbiavaSAE/c7yo9EtsTSfp2P/siT2D6a3FOrAwPPyw0R
N01YslYBgzV+RsTRPdewpIPe85RnCET76R+/cGMsvoe3ayl/lzZS5irkL
ilRltNDFa5NHlxtgJuyvrOtfyqVuro+2nznZYkxZsJun/D+CzA6oamgF/q13Mk60d8dsqH1
Ya/8rX0g= -----END CERTIFICATE REQUEST-----</item>
<item key='handle'>process</item>
<item key='product_type'>quickssl</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='first_name'>Adler</item>
<item key='last_name'>Adams</item>
<item key='title'>Administrator</item>
<item key='org_name'>Example Co.</item>
<item key='address1'>32 Oak Street</item>
<item key='address2'>Suite 100</item>
<item key='address3'/>
<item key='city'>Santa Clara</item>
<item key='state'>CA</item>
<item key='country'>US</item>
<item key='postal_code'>90210</item>
<item key='fax'>+1.4165550125</item>
<item key='phone'>+1.4165550123x1812</item>
<item key='email'>adams@example.com</item>
</dt_assoc>
656
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>certtest.example.org</item>
<item key='order_id'>8310</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
657
</body>
</OPS_envelope>
Example 12
This example shows a registration for an SSL WebServer with EV SAN
certificate.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>sw_register</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='reg_type'>NEW</item>
<item key='additional_domains'>
<dt_array>
<item key='0'>additional1.example.org</item>
<item key='1'>example.net</item>
<item key='2'>example2.org</item>
</dt_array>
</item>
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='special_instructions'>Test ABC</item>
<item key='handle'>process</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC2jCCAcICAQAwgZQxIjAgBgNVBAMTGXNzbHdlYmV2MTM0NzQ3NjI5Mzg1My5v
658
cmcxCzAJBgNVBAYTAkNBMQswCQYDVQQIEwJPTjEQMA4GA1UEBxMHVG9yb250bzEP
MA0GA1UEChMGbmV3b3JnMQ8wDQYDVQQLEwZRQURlcHQxIDAeBgkqhkiG9w0BCQEW
EXFhZml2ZUB0dWNvd3MuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC
AQEApc+zO2kbORX06H6jLjmoesh/VQOVcZpGUNy5ZbGILDj/wWiPxurylaYh1aAo
aeq2f/UAzb+2YtgEBmQoTNteVz02VlUeIYpzkr2Tr9lGiJfTuVsQgsyMWofadW7r
w8U9SM6BKOmqCWkvGyTWBFDugJQGJmy4mOfcau0YKolGc1YzYDfSPTqkfwqh9Rl3
ZLWLQv3kmF0cDPHSyFxEjilCeqkZ5gF8tkhpcPEKDw1y7f3a3Bjw7sDyrMmD7bBI
H9JYqi6sEGbMFutKUvjWdcgQvQ42qOOO+w+HkAJ6bQxMIHr5cnj3vJ+peIfTjAQl
+T+WcRcv15Utw72emN7YNTmtkwIDAQABoAAwDQYJKoZIhvcNAQEEBQADggEBAJVl
wme99Uo/z8LdOaJsKKPww2etWmBP9SXzW7edClkd2sXoRPKYjj60DDwODvJhZGR4
9u4dnz6HqfpFi4ldvX9Uz9zUYUSkKPNN2Q5gelLwbG5MjBNG+lxsfuAtvak9yxxt
g24agYFlBlAoLOqCkLVCULCQIdZ6WOH4DLOaCgEeP3thh5ig+pn0lyXB3U3ACHxN
NIpYjwMNogyXNcEefHAjTZQIm+fcHKfEbvSTrlzXMY6/MSK0nsWCHN4CD2bmwXeq
J5JmIEZ+Q0mZGefhNUvn3bxiNYlpVU5KiFFX1L42Ed0I16cmQt8k7yC+WtghCT0d
KNDYOT15336r+A1KCfc= -----END CERTIFICATE REQUEST----- </item>
<item key='period'>1</item>
<item key='server_type'>apachessl</item>
<item key='server_count'>1</item>
<item key='product_type'>sslwebserver_ev</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='is_success'>1</item>
<item key='action'>REPLY</item>
659
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.org</item>
<item key='order_id'>8506</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
660
<item key="custom_tech_contact">0</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="reg_domain">example-nsi.com</item>
<item key="domain">transfer-example-nsi.com</item>
<item key="period">1</item>
<item key="reg_type">transfer</item>
<item key="reg_username">example</item>
<item key="reg_password">example</item>
<item key="encoding_type"/>
<item key="custom_transfer_nameservers">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
This response shows the result of a successful response to a transfer order.
The transfer is not complete at this point rather, it has only been started. If
the domain's current whois information is accurate, then the current domain
owner receives an email from OpenSRS requesting that they approve or
reject the transfer request.
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
661
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="response_text">Transfer request has been
successfully sent</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Transfer request has
been successfully sent</item>
<item key="registration_code">200</item>
<item key="id">3735288</item>
<item key="transfer_id">1234</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
662
<item key='reg_type'>transfer</item>
<item key='handle'>process</item>
<item key='domain'>mytransferdomain.au</item>
<item key='f_lock_domain'>1</item>
<item key='auto_renew'>0</item>
<item key='reg_domain'>existingdomain.com</item>
<item key='reg_username'>username</item>
<item key='reg_password'>password</item>
<item key='custom_tech_contact'>1</item>
<item key='contact_set'>
<dt_assoc>
<item key='owner'>
<dt_assoc>
<item key='first_name'>Chris</item>
<item key='last_name'>Christopherson</item>
<item key='phone'>+1.4165550123</item>
<item key='fax'></item>
<item
key='email'>chris@christopherson.com</item>
<item key='org_name'>Christopherson Kitchens
(Australia) Pty Limited</item>
<item key='address1'>4 York Street</item>
<item key='address2'></item>
<item key='address3'></item>
<item key='city'>Sydney</item>
<item key='state'>NSW</item>
<item key='country'>AU</item>
<item key='postal_code'>2022</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='first_name'>Johnny</item>
<item key='last_name'>Jameson</item>
<item key='phone'>+1.4165550123</item>
<item key='fax'></item>
663
<item
key='email'>johnny@techfixers.com</item>
<item key='org_name'>Tech Fixers Inc.</item>
<item key='address1'>66 Mowat Avenue</item>
<item key='address2'></item>
<item key='address3'></item>
<item key='city'>Sydney</item>
<item key='state'>NSW</item>
<item key='country'>AU</item>
<item key='postal_code'>2023</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='custom_transfer_nameservers'>0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
664
<item key="is_success">1</item>
<item key="response_text">Transfer request has been successfully
sent. Admin contact email: chris@christopherson.com</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Transfer request has been
successfully sent. Admin contact email: chris@christopherson.com</item>
<item key="transfer_id">5851957</item>
<item key="admin_email">chris@christopherson.com</item>
<item key="registration_code">200</item>
<item key="id">101184590</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
665
<item key="domain">example.ca</item>
<item key="reg_type">transfer</item>
<item key="reg_domain"/>
<item key="reg_username">srs_registrant_username</item>
<item key="reg_password">srs_registrant_password</item>
<item key="encoding_type"/>
<item key="custom_transfer_nameservers">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Registration successful</item>
<item key="attributes">
<dt_assoc>
<item key="admin_email">admin@email.com</item>
<item key="id">85550904</item>
</dt_assoc>
</item>
666
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
667
<item key='reg_domain'/>
<item key='custom_nameservers'>0</item>
</dt_assoc>
</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.domaindirect.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.domaindirect.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
668
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Transfer request has been
successfully sent. Admin contact email: robson@example.com</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">Transfer request has
been successfully sent. Admin contact email: robson@example.com</item>
<item key="admin_email">robson@example.com</item>
<item key="registration_code">200</item>
<item key="id">101550</item>
<item key="transfer_id">1234</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
669
<item key="attributes">
<dt_assoc>
<item key="affiliate_id"/>
<item key="reg_type">transfer</item>
<item key="period">1</item>
<item key="reg_username">unittest</item>
<item key="auto_renew"/>
<item key="domain">example.eu</item>
<item key="reg_password">password</item>
<item key="custom_tech_contact">0</item>
<item
key="owner_confirm_address">owner@example.eu</item>
<item key="link_domains">0</item>
<item key="custom_transfer_nameservers">1</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="sortorder">1</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="sortorder">2</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
670
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">
Transfer request has been successfully sent.
Admin contact email: admin@example.eu
</item>
<item key="attributes">
<dt_assoc>
<item key="registration_text">
Transfer request has been successfully sent.
Admin contact email: admin@example.eu
</item>
<item key="registration_code">200</item>
<item key="id">3751913</item>
<item key="transfer_id">1234</item>
<item key="admin_email">admin@example.eum</item>
</dt_assoc>
</item>
</dt_assoc>
671
</data_block>
</body>
</OPS_envelope>
672
</item>
<item key="reg_password">aaaa</item>
<item key="domain">example037.it</item>
<item
key="owner_confirm_address">transferapprover@example.com</item>
<item key="contact_set">
<dt_assoc>
<item key="owner">
<dt_assoc>
<item key="first_name">Mario</item>
<item key="last_name">Segale</item>
<item key="org_name">Mario Segale</item>
<item key="address1">Via del Campidoglio, 20</item>
<item key="city">Rome</item>
<item key="state">RM</item>
<item key="country">IT</item>
<item key="postal_code">00123</item>
<item key="phone">+39.0612345678</item>
<item key="email">mario@mail.it</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="first_name">Frank</item>
<item key="last_name">Mosser</item>
<item key="org_name">Tech Orgname</item>
<item key="address1">Piazza dei Giudici 20</item>
<item key="city">Firenze</item>
<item key="state">FI</item>
<item key="country">IT</item>
<item key="postal_code">50123</item>
<item key="phone">+39.0551234567</item>
<item key="email">qafive@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
673
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Transfer request has been successfully
sent. Admin contact email: transferapprover@example.com</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="transfer_id">41334</item>
<item key="registration_text">Transfer request has been
successfully sent. Admin contact email:
transferapprover@example.com</item>
<item key="admin_email">transferapprover@example.com</item>
<item key="registration_code">200</item>
<item key="id">214998</item>
</dt_assoc>
</item>
674
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
675
676
update_all_info
Description
Action & object
action = update_all_info
object = domain
Usage
Submits a domain-information update for .DK TLDs to the OpenSRS system.
Each contact object is submitted as a whole to OpenSRS, and changes are
parsed against the existing information.
Note: This command does not support .BE.
Important: This command will overwrite the existing nameserver entries. If
a nameserver has two IPs, one for IPv4 and one for IPv6, and you specify
only one of these in the request, the other one will be removed from the
registry.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
contact_set
Required
domain
Required if
cookie is not
submitted
nameserver_list
Required
677
678
Nameserver_List
Parameters within the nameserver_list associative array are described below.
Parameter
name
Obligation
Definition/Value
fqdn
Required
ipaddress
Required if
ipv6 is not
submitted
Required if
ipaddress is
not submitted
ipv6
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
679
<item key="action">UPDATE_ALL_INFO</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.dk</item>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="fqdn">ns1.systemdns.dk</item>
<item key="ipaddress">216.40.33.21</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="fqdn">ns2.systemdns.dk</item>
<item key="ipaddress">216.40.33.22</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
If successful
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
680
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Update request submitted
successfully.</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
If unsuccessful
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">0</item>
<item key="response_text">A request is currently waiting on
this domain.</item>
<item key="response_code">437</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
681
update_contacts
Description
Action & object
action = update_contacts
object = domain
Usage
Submits a domain-contact information update to the OpenSRS system. Each
contact object is submitted as a whole to OpenSRS, and changes are parsed
against the existing information.
Note: This command cannot be used for .DK TLDs.
Important: For .UK domains, if you use this command to submit a change to
the Organization field, it is recognized by OpenSRS, but not by the registry.
To change the .UK Organization information, you must contact the Nominet
Registry.
For .ES domains, if you use this command to submit any changes to the
owner contact information, the changes are recognized by OpenSRS, but not
by the registry. To change the .ES Owner contact information, you must
contact the Esnic Registry.
For .IT domains, the owner contact requires three additional parameters:
entity_type, nationality_code, and reg_code. For more information about
contact_set values, see .IT contact requirements.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
affect_domains
Optional
682
Parameter
name
Obligation
Definition/Value
domain. This is the default.
contact_set
Required
domain
Required if
cookie is not
submitted
report_email
Optional
types
Required
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
details
Returned if
is_success = true
683
Parameter name
Obligation
Definition/Value
Because the modification may succeed
or fail on a case-by-case basis, you
get a response code for each domain
that is affected.
The key that is used to access this
domain success information is the
name of the domain itself, for
example, 'mydomain.com' or
'mydomain.co.uk'.
Each key contains a hash (described
below) that provides details on the
action performed on that domain.
encoding_type
Optional
response_code
Returned if
is_success = true
response_text
Returned if
is_success = true
waiting_requests_no
Returned if
is_success = true
684
<dt_assoc>
<item key="domain">example.com</item>
<item key="types">
<dt_array>
<item key="0">admin</item>
<item key="1">billing</item>
</dt_array>
</item>
<item key="contact_set">
... see "Contact Set"
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object"></item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully.</item>
<item key="response_code">200</item>
<item key="waiting_requests_no">0</item>
685
<item key="attributes">
<dt_assoc>
<item key="details">
<dt_assoc>
<item key="example.com">
<dt_assoc>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
686
update_order
Description
Action & object
action = update_order
object = trust_service
Usage
Submits a Trust Service order update to the OpenSRS system.
When updating existing trust service orders, the general rules are:
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
additional_
domains
Optional. May be
used for SAN
certificates.
687
Sub-Reseller Commands
Parameter
name
Obligation
Definition/Value
Request parameters for sw_register
(trust_service)
approver_email
Optional
contact_set
Optional
csr
Optional
end_user_auth_
info
688
Sub-Reseller Commands
Parameter
name
Obligation
Definition/Value
password, and the user does not
already exist, the user credentials
cannot be created and the
command will fail.
Required
period
Optional
comodo_ev1 to 2
comodo_instantssl1 to 4
comodo_premiumssl1 to 4
comodo_premiumssl_wildcard1 to
4
comodo_ssl1 to 4
comodo_wildcard1 to 4
malwarescan1
quickssl1 to 4
quickssl_premium1 to 4
sgcsuper_certs1 to 4
sitelock_basic1
sitelock_premium1
sitelock_enterprise1
ssl1231 to 4
sslwebserver1 to 4
sslwebserver_wildcard1 to 2
sslwebserver_ev1 to 2
securesite1 to 4
securesite_ev1 to 2
securesite_pro1 to 4
689
Sub-Reseller Commands
Parameter
name
product_type
Obligation
Optional
Definition/Value
securesite_pro_ev1 to 2
truebizid1 to 4
truebizid_wildcard1 to 4
truebizid_ev1 to 2
truste_hpp1 to 3
truste_tps1 to 3
trustwave_dv 1 to 3
trustwave_ev 1 to 2
trustwave_premiumssl 1 to 3
trustwave_premiumssl_wildcard 1
to 3
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
truebizid
truebizid_wildcard
690
Sub-Reseller Commands
Parameter
name
reg_type
Obligation
Optional
Definition/Value
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
upgradeUpgrade a SiteLock
Basic or Premium SSL certificate to
a higher level certificate.
When you upgrade, the
product_type changes, you are
charged the price for a one year
term at the new level, and the new
expiry date is one year from the
date of the upgrade.
Note: This feature is currently
available only for SiteLock
certificates.
server_count
Required when
The number of servers on which the Trust
product_type =
Service product will be installed.
securesite*,
ssl123,
sgcsuper_certs,
sslwebserver,
sslwebserver_
wildcard,
sslwebserver_ev,
comodo_
premiumssl_
wildcard,
comodo_wildcard
server_type
Optional
691
Sub-Reseller Commands
Parameter
name
Obligation
Definition/Value
Symantec, thawte, and Comodo
GeoTrust
apache2
apachessl
apacheapaches
sl
citrix
apacheopenssl
domino
ensim
apacheraven
apachessl
hsphere
iis4
apachessleay
c2net
iis6
iis7
cobaltseries
cobaltraq3
iplanet
javawebserver
cobaltraq2
cpanel
netscape
ibmhttp
domino
novell
dominogo4626
oracle
dominogo4625
other
ensim
plesk
hsphere
redhat
iis
sap
iis4
tomcat
iis5
webstar
iplanet
whmcpanel
ipswitch
netscape
ibmhttp
other
plesk
tomcat
weblogic
website
webstar
webstar4
zeusv3
692
Sub-Reseller Commands
Parameter
name
Obligation
special_instructions Optional
Definition/Value
Any special instructions regarding the Trust
Service purchase.
693
Sub-Reseller Commands
End_user_auth_info
Parameters within the end_user_auth_info associative array are described
below.
Parameter Obligation
name
Definition/Value
password
username
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name Obligation
Definition/Value
domain
Returned if
is_success =
true
694
Sub-Reseller Commands
Parameter name Obligation
Definition/Value
order_id
Returned if
is_success =
true
state
Returned if
is_success =
true
approver-confirmedOwner has
confirmed the domain vetted
certificate.
awaiting-approvalOrder
processed successfully; waiting for
supplier approval.
completedOrder is complete.
in-progressOrder is in progress.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>update_order</item>
<item key='object'>trust_service</item>
695
Sub-Reseller Commands
<item key='attributes'>
<dt_assoc>
<item key='server_type'>apachessl</item>
<item key='special_instructions'></item>
<item key='approver_email'>admin@example.com</item>
<item key='csr'>-----BEGIN CERTIFICATE REQUEST----MIIC3DCCAcQCAQAwgZYxJTAjBgNVBAMTHHVwZGF0ZW9yZGVyLnFhcmVncmVzc2lv
bi5vcmcxCzAJBgNVBAYTAkNBMQswCQYDVQQIEwJPTjEQMA4GA1UEBxMHVG9yb250
bzENMAsGA1UEChMEVGVzdDEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJ
ARYRcWFmaXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK
AoIBAQDkMouJLDenKrVS9FdcmdY3BHrJ9iS5o8TbNSAKf2loYF1afa6tJyxO6bCj
Mk6WegE+Yugb42ONAgz0zhJq5bNTuWb9FvBZLEuN/jUBR/iVdTlf//W/BPoE2CmK
lbgskzFooQ7v3SSAoYl3TjwfN8iPWwni/yLDMJYJekxcZtsro7vugtl2HZDRhxLy
B0WB0y8Kx3lh1c7xC9CbXfqjJf+j1sKiGEh+cy1H71VdcakleoG+Tll8qvtWreEf
pZYczmeyn1pPZfbDzVw9AR9x1Yohrwaah1KNZoMIp0taVTkMe/NNEdMP2Rm7Y8ak
Eof49VBrRfDGkW135EYYJCHxBvXJAgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEA
nQHOcqylM/b7NUqFuoWRG9R1GP6/gjixHqyyV4fe2c66HlBHcKR1Tm88cpT8mfu2
oE2Hw55DVUtkrBfNdVZqVXEK8yfiuF2EKuVk+34anCwwIQOg4o6Oy3xBU1oIKpqX
1x0Z7HZJ097DK6uwUqFsviEWyxrNCfJ3DYU5TfrZtnzIdOB6ztI3wBv1IYZyYzk/
zU65N4MDv64yUazmqjZKgxvl4THhWeFVPPy+4dk8k8dkuPkcqhdxeJVwntG7tQIw
utv8IShy2ckHVC0URV1RHbr660ygD/fAE3hGjzPbdgwu1DLlC5ANlpSfgeJc3feK
sqC2b/EfPHfdbtu6+eJgGw== -----END CERTIFICATE REQUEST-----</item>
<item key='server_count'>2</item>
<item key='period'>2</item>
<item key='order_id'>2326</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
696
Sub-Reseller Commands
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>updateorder.example.com</item>
<item key='order_id'>2326</item>
<item key='state'>pending</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example creates login credentials for Domain Admin and changes the
processing instruction for the order from save to process.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
697
Sub-Reseller Commands
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>update_order</item>
<item key='object'>trust_service</item>
<item key='attributes'>
<dt_assoc>
<item key='handle'>process</item>
<item key='order_id'>7419</item>
<item key='product_type'>sitelock_premium</item>
<item key='end_user_auth_info'>
<dt_assoc>
<item key='email_address'>qafive@example.com</item>
<item key='username'>customer111</item>
<item key='password'>changeit</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
698
Sub-Reseller Commands
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>example.ca</item>
<item key='order_id'>7419</item>
<item key='state'>awaiting-approval</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 3
This example updates the list of domains that are secured by the Trust
Service product.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>update_order</item>
<item key='object'>trust_service</item>
699
Sub-Reseller Commands
<item key='attributes'>
<dt_assoc>
<item key='additional_domains'>
<dt_array>
<item key='0'>upadditional1.example.org</item>
<item key='1'>upadditional2.example.org</item>
<item key='2'>upadditional3.example.org</item>
<item key='3'>upadditional4.example.org</item>
<item key='4'>upadditional5.example.org</item>
</dt_array>
</item>
<item key='handle'>save</item>
<item key='order_id'>186332</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='response_text'>Command completed successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
700
Sub-Reseller Commands
<dt_assoc>
<item key='domain'>example.org</item>
<item key='order_id'>186332</item>
<item key='state'>pending</item>
</dt_assoc>
</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
701
Sub-Reseller Commands
update_product
Description
Action & object
action = update_product
object = trust_service
Usage
Updates the Trust Service product and enables or disables the Symantec
Trust Seal and/or the Symantec Search-in-Seal.
Note: In order to enable the Symantec Search-in-Seal, Trust Seal must be
enabled.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
contact_email
Optional
let_expire
Optional
product_id
Required
seal_in_search
Optional
702
Sub-Reseller Commands
Parameter
name
Obligation
Definition/Value
in-Search which displays the Symantec seal next
to the link for your web site in online search
results. Allowed values are:
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
contact_email
Optional
let_expire
Optional
703
Sub-Reseller Commands
Parameter
name
Obligation
Definition/Value
the certificate is approaching its expiry
date. This is the default.
product_id
Returned if
The ID number for the Trust Service.
is_success =
true
seal_in_search
Optional
trust_seal
Optional
0Not enabled.
1Enabled.
0Not enabled.
1Enabled.
704
Sub-Reseller Commands
<item key='seal_in_search'>1</item>
<item key='let_expire'>1</item>
<item key='product_id'>279</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>TRUST_SERVICE</item>
<item key='is_success'>1</item>
<item key='response_text'>Command completed
successfully.</item>
<item key='response_code'>200</item>
<item key='attributes'>
<dt_assoc>
<item key='trust_seal'>1</item>
<item key='product_id'>279</item>
<item key='contact_email'>newqafive@example.com</item>
<item key='let_expire'>1</item>
<item key='seal_in_search'>1</item>
</dt_assoc>
</item>
705
Sub-Reseller Commands
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
706
Sub-Reseller Commands
The Sub-Reseller API commands allow you to create and operate your own
network of domain name Resellers. Sub-Resellers operate very much like any
other OpenSRS Reseller; however, you are considered to be the parent
Reseller for your Sub-Resellers. You set the pricing plans for them, and you
earn commissions on the domains that they sell.
This section contains the following commands:
707
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
as_subreseller
Optional
Example
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>SW_REGISTER</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='as_subreseller'>subrsp</item>
<item key='domain'>belongstosubreseller.com</item>
<item key='custom_tech_contact'>1</item>
<item key='auto_renew'>0</item>
<item key='reg_type'>new</item>
<item key='reg_username'>jefferson</item>
708
<item key='contact_set'>
... see "Contact Set"
</item>
<item key='link_domains'>1</item>
<item key='period'>1</item>
<item key='reg_password'>password</item>
<item key='bulk_order'>0</item>
<item key='reg_domain'></item>
<item key='custom_nameservers'>0</item>
</dt_assoc>
</item>
<item key='nameserver_list'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='sortorder'>1</item>
<item key='name'>ns1.systemdns.com</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='sortorder'>2</item>
<item key='name'>ns2.systemdns.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
709
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Domain registration successfully
completed</item>
<item key='attributes'>
<dt_assoc>
<item key='registration_text'>Domain registration
successfully completed</item>
<item key='admin_email'>aaron@example.com</item>
<item key='registration_code'>200</item>
<item key='id'>281405</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
710
create subreseller
Description
Action & object
action = create
object = subreseller
Usage
Creates a new Sub-Reseller account.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
ccp_enabled
Required
contact_set
Required
NNo
YYes
711
Parameter name
Obligation
Definition/Value
low_balance_email
Required
nameservers
Optional
password
Required
payment_email
Optional
pricing_plan
Required
status
Required
system_status_email
Required
url
Optional
username
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
reseller_id
Returned if is_success
=1
712
713
<item key="phone2"></item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="org_name">Sub Reseller Company
Inc.</item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
<item key="title">CEO</item>
<item key="phone">+1.4165551122x333</item>
<item key="fax"></item>
<item key="email">jdoe@example.com</item>
<item key="address1">55 Reseller Ave</item>
<item key="address2">Suite 99</item>
<item key="address3"></item>
<item key="city">New York</item>
<item key="state">NY</item>
<item key="postal_code">70218</item>
<item key="country">US</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='ccp_enabled'>n</item>
<item key='low_balance_email'>mbrown@example.com</item>
<item key='password'>changeit</item>
<item key='system_status_email'>rory@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
714
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SUBRESELLER</item>
<item key='response_text'>Sub-Reseller sub1240929148892
successfully created</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='reseller_id'>9782</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
715
modify subreseller
Description
Action & object
action = modify
object = subreseller
Usage
Modify a Sub-Reseller account.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
allowed_tld_list
Optional
ccp_enabled
Required
contact_set
Required
NNo
YYes
716
Parameter name
Obligation
Definition/Value
low_balance_email
Required
nameservers
Optional
password
Required
payment_email
Optional
pricing_plan
Required
status
Required
storefront_rwi
Optional
system_status_email
Required
url
Optional
username
Required
request
717
718
<item key="phone2"></item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="org_name">Sub Reseller Company
Inc.</item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
<item key="title">CEO</item>
<item key="phone">+1.4165551122x333</item>
<item key="fax"></item>
<item key="email">jdoe@example.com</item>
<item key="address1">55 Reseller Ave</item>
<item key="address2">Suite 99</item>
<item key="address3"></item>
<item key="city">New York</item>
<item key="state">NY</item>
<item key="postal_code">70218</item>
<item key="country">US</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key='storefront_rwi'>Y</item>
<item key='ccp_enabled'>Y</item>
<item key='low_balance_email'>wilkison@example.com</item>
<item key='password'>test123</item>
<item key='system_status_email'>robson@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
719
</OPS_envelope>
720
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='object'>SUBRESELLER</item>
<item key='response_text'>Reseller sub1240929148892
successfully modified</item>
<item key='action'>REPLY</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
721
get subreseller
Description
Action & object
action = get
object = subreseller
Usage
Returns information about a Sub-Reseller account.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
username
Required
request
722
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
allowed_tld_list
Returned if
List of TLDs that the Sub-Reseller is allowed
is_success = to sell.
true
ccp_enabled
Returned if
Indicates whether credit card payments are
is_success = allowed for the Sub-Reseller.
true
NNo
cert_permission
Returned if
Indicates whether the Sub-Reseller is
is_success = allowed to sell SSL Certificates.
true
0No
contact_set
YYes
1Yes
Returned if
Sub-Resellers contact information.
is_success = The admin contact for a Sub-Reseller is the
true
Emergency Contact, which is not the same
as a domain admin contact. The following
values are required for the Sub-Reseller
admin contact: first_name, last_name,
org_name, phone, and email.
The tech contact, can include any of the
fields explained in the contact_set section;
however, it must include first_name,
last_name, org_name, address1, city,
phone, and email. If country is Canada or
U.S, it also includes the state and postal
code parameters.
low_balance_email
Returned if
The email address to which notices are sent
is_success = when the Sub-Reseller's account balance
true
falls to a predefined level.
nameservers
Optional
payment_email
Optional
pricing_plan
Returned if
The pricing plan assigned to the Subis_success = Reseller.
true
reseller_id
Returned if
The ID of the Reseller who created and
is_success = manages the Sub-Reseller.
true
723
Parameter name
Obligation
Definition/Value
status
Returned if
Set the status of the account.
is_success = Allowed values are active, onhold, locked,
true
canceled, and paid_only.
storefront_rwi
Optional
system_status_email
Returned if
The email address that will receive system
is_success = status messages.
true
url
Optional
username
Returned if
Username for the new Sub-Reseller.
is_success =
true
724
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SUBRESELLER</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Query Successful</item>
<item key='pricing_plan_id'>84</item>
<item key='pricing_plan'>silver</item>
<item key='attributes'>
<dt_assoc>
<item key='system_status_email'>robson@example.com</item>
<item key='low_balance_email'>wilkison@example.com</item>
<item key='status'>cancelled</item>
<item key='cert_permission'>0</item>
<item key='nameservers'>
<dt_assoc>
<item key='fqdn4'/>
<item key='fqdn2'>ns2.systemdns.com</item>
<item key='fqdn5'/>
725
<item key='fqdn1'>ns1.systemdns.com</item>
<item key='fqdn6'/>
<item key='fqdn3'/>
</dt_assoc>
</item>
<item key='payment_email'>jdoe@example.com</item>
<item key='username'>sub1240929148892</item>
<item key='allowed_tld_list'>
<dt_array>
<item key='0'>.cc</item>
<item key='1'>.com.vc</item>
<item key='2'>.net</item>
<item key='3'>.com</item>
<item key='4'>.nl</item>
<item key='5'>.mobi</item>
<item key='6'>.fr</item>
<item key='7'>.tv</item>
<item key='8'>.ltd.uk</item>
<item key='9'>.co.uk</item>
<item key='10'>.me.uk</item>
<item key='11'>.vc</item>
<item key='12'>.at</item>
<item key='13'>.info</item>
<item key='14'>.it</item>
<item key='15'>.ch</item>
<item key='16'>.net.uk</item>
<item key='17'>.mx</item>
<item key='18'>.us</item>
<item key='19'>.es</item>
<item key='20'>.org.vc</item>
<item key='21'>.asia</item>
<item key='22'>.org</item>
<item key='23'>.be</item>
<item key='24'>.tel</item>
<item key='25'>.eu</item>
726
<item key='26'>.net.vc</item>
<item key='27'>.plc.uk</item>
<item key='28'>.biz</item>
<item key='29'>.ca</item>
<item key='30'>.name</item>
<item key='31'>.de</item>
<item key='32'>.dk</item>
<item key='33'>.org.uk</item>
<item key='34'>.li</item>
<item key='35'>.me</item>
</dt_array>
</item>
<item key='wsb_permission'>0</item>
<item key='contact_set'>
<dt_assoc>
<item key='admin'>
<dt_assoc>
<item key='email'>jdoe@example.com</item>
<item key='org_name'/>
<item key='phone'>+1.4165551234</item>
<item key='phone2'>+1.4165551123</item>
<item key='first_name'>John</item>
<item key='last_name'>Doe</item>
</dt_assoc>
</item>
<item key='tech'>
<dt_assoc>
<item key='org_name'>Sub Reseller Company
Inc.</item>
<item key='first_name'>John</item>
<item key='last_name'>Doe</item>
<item key='title'>CEO</item>
<item key='phone'>+1.4165551122 x333</item>
<item key='fax'>+1.4165551221</item>
<item key='email'>jdoe@example.com</item>
<item key='address1'>55 Reseller Ave</item>
727
728
pay subreseller
Description
Action & object
action = pay
object = subreseller
Usage
Transfers funds from the Reseller account into a Sub-Reseller account.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
amount
Required
The amount that you want to transfer to the SubReseller account; this value must be a positive
number.
username
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
729
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
id
Returned if
is_success =
true
730
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SUBRESELLER</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Funds Transferred</item>
<item key='attributes'>
<dt_assoc>
<item key='id'>6715</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
731
732
name_suggest (surname)
Description
Action & object
action = name_suggest
object = surname
Usage
Checks whether a specified Personal Name, (firstname lastname) is available
for registration in various gTLDs and ccTLDs, suggests other similar domain
names, and checks whether they are available.
Important: This command has been deprecated. To check whether a
specified Personal Names domain, is available for registration, use the
name_suggest (domain) command and specify personal_names.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
searchstring
Required
733
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
suggestion
Returned if
The results returned.
is_success = For more information, see the Suggestion table
true
below.
Suggestion
Parameters within the suggestion associative array are described below.
Parameter
name
Obligation
Definition/Value
count
Always
returned
items
Always
returned
Items
Parameters within the items associative array are described below.
734
Parameter
name
Obligation
Definition/Value
domain
Always
returned
status
Always
returned
Response
<?xml version=1.0 encoding=UTF-8 standalone=no ?>
<!DOCTYPE OPS_envelope SYSTEM ops.dtd>
735
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="response_text">Command completed
successfully</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="suggestion">
<dt_assoc>
<item key="count">11</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="items">
<dt_array>
<item key="0">
<dt_assoc>
<item
key="domain">steven.smith.net</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item
key="domain">steven.smithemail.com</item>
<item key="status">available</item>
736
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item
key="domain">steven.smithhome.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item
key="domain">steven.smithmail.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="4">
<dt_assoc>
<item
key="domain">steven.smithnet.net</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="5">
<dt_assoc>
<item
key="domain">steven.smithnet.org</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="6">
<dt_assoc>
<item
key="domain">steven.smithpage.net</item>
<item key="status">available</item>
</dt_assoc>
</item>
737
<item key="7">
<dt_assoc>
<item
key="domain">steven.smithpost.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="8">
<dt_assoc>
<item
key="domain">steven.smithweb.org</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="9">
<dt_assoc>
<item
key="domain">steven.thesmith.org</item>
<item key="status">available</item>
</dt_assoc>
</item>
<item key="10">
<dt_assoc>
<item
key="domain">steven.nesmith.com</item>
<item key="status">available</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
738
</OPS_envelope>
739
su_register
Description
Action & object
action = su_register
object = surname
Usage
Submits a new registration order for an available Personal Names domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
dnsRecords
Optional
domain
Required
mailbox
Required
740
DNS Records
Parameters within the dnsRecords associative array are described below.
Parameter
name
Obligation Definition/Value
content
Optional
name
Optional
type
Optional
Mailbox
Parameters within the mailbox associative array are described below.
Parameter
name
Obligation Definition/Value
forward_email
Optional
mailbox_type
password
Required
Required
741
742
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
Register a domain with a regular mailbox and email forwarding
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SU_REGISTER</item>
743
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="password">changeit</item>
<item key="forward_email">steve@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
744
</data_block>
</body>
</OPS_envelope>
Request
Register a domain with webmail only
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SU_REGISTER</item>
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">WEBMAIL_ONLY</item>
<item key="password">changeit</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
745
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
Register a domain with webmail only and email forwarding
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SU_REGISTER</item>
746
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">WEBMAIL_ONLY</item>
<item key="password">changeit</item>
<item key="forward_email">steve@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
747
</data_block>
</body>
</OPS_envelope>
748
Request
Register a domain with email forwarding and set the A record
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SU_REGISTER</item>
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="password">changeit</item>
<item key="forward_email">steve@example.com</item>
</dt_assoc>
</item>
<item key="dnsRecords">
<dt_array>
<item key="0">
<dt_assoc>
<item key="type">A</item>
<item key="name">@</item>
<item key="content">127.0.0.2</item>
</dt_assoc>
</item>
</dt_array>
749
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Request
Register a domain with a regular mailbox and set the Cname record
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
750
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">SU_REGISTER</item>
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="password">changeit</item>
</dt_assoc>
</item>
<item key="dnsRecords">
<dt_array>
<item key="0">
<dt_assoc>
<item key="type">CNAME</item>
<item key="name">@</item>
<item key="content">steven.smith.net.</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
751
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>SURNAME</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
<item key='response_text'>Command completed successfully</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
752
query (surname)
Description
Action & object
action = query
object = surname
Usage
Queries the properties of the domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
query_dns
Optional
query_email
Optional
account.
753
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
created_on
Returned if
Date the domain was created.
is_success =
true
domain
Returned if
The Personal Names domain to which the returned
is_success = values apply.
true
mailbox
Optional
state
Optional
zone
Optional
Mailbox
Parameters within the mailbox associative array are described below.
Parameter
name
Obligation
Definition/Value
forward_email
Optional
mailbox_type
Optional
754
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
content
Optional
name
Optional
type
Optional
Zone
Parameters within the zone associative array are described below.
Parameter
name
Obligation
Definition/Value
records
Optional
zone_id
Optional
755
<item key="domain">steven.smith.net</item>
<item key="query_email">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="is_success">1</item>
<item key="response_text">Command completed successfully</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="state">active</item>
<item key="created_on">2008-01-03T14:25:45.000-05:00</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="response_text">OK</item>
<item key="is_success">1</item>
</dt_assoc>
756
</item>
<item key="zone">
<dt_assoc>
<item key="state">active</item>
<item key="response_text">OK</item>
<item key="is_success">1</item>
<item key="zone_id">3186929</item>
<item key="name">steven.smith.net</item>
<item key="records">
<dt_array>
<item key="0">
<dt_assoc>
<item key="content">steven.smith.net</item>
<item key="type">CNAME</item>
<item key="name">www</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
757
update (surname)
Description
Action & object
action = update
object = surname
Usage
Changes properties of the domain. You can use this command to change the
DNS records, enable or disable email forwarding, or to change the service
type, for example, to switch from Webmail (no IMAP/POP/SMTP) to a regular
mailbox.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
dnsRecords
Optional
domain
Required
mailbox
Optional
758
DnsRecords
Parameters within the dnsRecords associative array are described below.
Parameter
name
Obligation
Definition/Value
content
Optional
name
Optional
type
Optional
Warning: If you update dnsRecords, you must supply a full list of records.
Any committed records will be deleted.
Mailbox
Parameters within the mailbox associative array are described below.
Parameter name
Obligation
Definition/Value
disable_forward_
email
Optional
forward_email
Optional
mailbox_type
Optional
password
Optional
WEBMAIL_ONLYChange to
Webmail only account (no
IMAP/POP/SMTP).
FORWARD_ONLYTHIS VALUE
HAS BEEN DEPRECATED.
759
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
760
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
761
Request
Change a webmail only account to a regular mailbox, change the
password, and set the A record
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">UPDATE</item>
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="password">changeit</item>
</dt_assoc>
</item>
<item key="dnsRecords">
<dt_array>
<item key="0">
<dt_assoc>
<item key="type">A</item>
<item key="name">@</item>
<item key="content">127.0.0.2</item>
</dt_assoc>
</item>
</dt_array>
</item>
762
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
763
Request
Change a webmail only account to a regular mailbox and disable
email forwarding
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">UPDATE</item>
<item key="object">SURNAME</item>
<item key="attributes">
<dt_assoc>
<item key="domain">steven.smith.net</item>
<item key="mailbox">
<dt_assoc>
<item key="mailbox_type">MAILBOX</item>
<item key="disable_forward_email">1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
764
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
<OPS_envelope>
765
delete (surname)
Description
Action & object
action = delete
object = surname
Usage
Deletes the Personal Names domain. This call can delete only one domain at
a time.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required
request
766
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
767
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SURNAME</item>
<item key="is_success">1</item>
<item key="response_text">Command completed
successfully</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
768
Transfer Commands
This section contains the following commands:
rsp2rsp_push_transferTransfer a domain
from one Reseller to another Reseller.
769
cancel_transfer
Description
Action & object
action = cancel_transfer
object = transfer
Usage
Cancels transfers that are pending owner approval.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
order_id
reseller
Required
Reseller username.
request
770
Response
If successful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
771
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRANSFER</item>
<item key="response_text">Transfer with order id: 3533098
has been cancelled.</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
If unsuccessful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRANSFER</item>
<item key="response_text">Command Failed: Transfer State
Prohibits Cancellation</item>
<item key="is_success">0</item>
<item key="response_code">400</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
772
check_transfer
Description
Action & object
action = check_transfer
object = domain
Usage
Checks to see if the specified domain can be transferred in to OpenSRS, or
from one OpenSRS Reseller to another. This call can also be used to check
the status of the last transfer request on a given domain name.
When you use the check_transfer action prior to initiating a transfer, the
transferable response parameter is most relevant, and if transferable = 0,
the reason field is also important.
When you use the check_transfer action to determine the progress of a
transfer, the status parameter is most important. If the response indicates
that the transfer is in progress and the status is pending_registry, the
transfer will be scheduled to complete within 5 minutes of the query; running
the query expedites the process and causes the transfer to complete within 5
minutes.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
check_status
Optional
domain
Required
773
Parameter name
Obligation
Definition/Value
transfer order.
get_request_address
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
noservice
Returned if
is_success = true
0Supplier is available
1Supplier is unavailable.
Returned if
Reason for transfer status.
is_success = true
and transferrable =
0
request_address
Optional
status
Returned if
Status of the latest transfer on the
is_success = true. If domain initiated by the Reseller.
no transfer is
Note: Resellers can only request status
774
Parameter
name
Obligation
Definition/Value
pending_adminWaiting for
approval by OpenSRS support
staff.
pending_registryAwaiting
registry approval (the transfer
completes after 7 days unless it is
declined by the current registrar).
If the Registry shows OpenSRS as
the Registrar of record, OpenSRS
schedules the completion of gTLD
transfers. The transfer will be
scheduled to complete within 5
minutes of the query.
completedThe transfer
completed successfully.
cancelledThe Reseller or
OpenSRS stopped the transfer.
domain.
timestamp
Returned if
The date and time of the most recent
is_success = true. If update to the state of the transfer (which
no transfer is currently could be placement of an order, an owner
underway, timestamp request, an owner confirmation, a
is retrieved from the registry request, or
previous transfer
completion/cancellation of an order).
order.
Date format is DD MMM YYYY 00:00:00
GMT
transferrable
type
Returned if
Type of transfer initiated:
is_success = true
reg2regTransfer from one
and transferrable =
registrar to another.
1
rsp2rspTransfer between two
Resellers of the same registrar.
775
Parameter
name
Obligation
Definition/Value
unixtime
Returned if
Conversion of timestamp, in seconds
is_success = true. If since Epoch (1 Jan 1970 00:00:00 GMT).
no transfer is currently
underway, unixtime is
retrieved from the
previous transfer
order.
776
Response 1
This response indicates that the transfer is awaiting approval by domain's admin
contact .
4 09:36:06 2005</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
777
Response 2
This response indicates that the transfer was successful. The status shows
pending_registry because a cronjob needs to run to complete the transfer
process; however, running the check transfer command causes the transfer
to complete within 5 minutes.
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Query successful. Transfer scheduled in 5
minutes.</item>
<item key="attributes">
<dt_assoc>
<item key="transferrable">0</item>
<item key="noservice">0</item>
<item key="timestamp">Thu Jun 14 11:05:34 2012</item>
<item key="status">pending_registry</item>
<item key="reason">Transfer in progress</item>
<item key="unixtime">1339686334</item>
<item key="request_address">requester@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
778
Response 3
This response indicates that the transfer request completed and the domain
is now with OpenSRS.
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Query successful</item>
<item key="action">REPLY</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="transferrable">0</item>
<item
key="reason_code">domain_already_belongs_to_current_reseller</item>
<item key="noservice">0</item>
<item key="timestamp">Mon Jun 18 15:15:25 2012</item>
<item key="status">completed</item>
<item key="reason">Domain already exists in RESELLER_NAME's
account</item>
<item key="unixtime">1340046925</item>
<item key="request_address">requester@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
779
get_transfers_away
Description
Action & object
action = get_transfers_away
object = domain
Usage
Lists domains that have been transferred away. This command applies to all
domains in a Reseller's profile.
All attributes are optional, but can be used to narrow the search criteria. If
no attributes are specified, all domains that were ever transferred-away from
your profile are returned.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Optional
gaining_registrar
Optional
limit
Optional
owner_confirm_from
Optional
780
Parameter name
Obligation
Definition/Value
owner_confirm_to
Optional
owner_request_from
Optional
owner_request_to
Optional
page
Optional
req_from
Optional
req_to
Optional
781
Parameter name
Obligation
Definition/Value
returned. The year specified cannot exceed
2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
request_address
Optional
status
Optional
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
page
page_size
total
Returned if is_success =
true
transfers
782
Transfers
Parameters within the transfers associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Returned if a
transferred-away
domain exists and
meets the specified
search criteria.
gaining_registrar
owner_choice
IIgnored
YApproved
NDeclined
owner_confirm_date
owner_confirm_date_epoch
owner_request_date
owner_request_date_epoch
registry_request_date
registry_request_date_epoch
request_address
request_date
783
Parameter name
Obligation
Definition/Value
request_date_epoch
status
pending_admin
pending_owner
pending_registry
completed
cancelled.
784
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="page">1</item>
<item key="page_size">2</item>
<item key="total">1</item>
<item key="transfers">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain">example.com</item>
<item key="status">completed</item>
<item key="gaining_registrar">Tucows
Inc.</item>
<item key="owner_choice">Y</item>
785
<item
key="owner_confirm_ip">10.0.12.165</item>
<item key="owner_request_date">20-JUL-
2006 16:14:41</item>
<item
key="owner_request_date_epoch">1153426481</item>
<item key="owner_confirm_date">20-JUL-
2006 16:18:08</item>
<item
key="owner_confirm_date_epoch">1153426688</item>
<item
key="request_address">girl@example.com</item>
<item key="request_date">20-JUL-2006
16:14:36</item>
<item
key="request_date_epoch">1153426476</item>
<item key="registry_request_date">20-JUL-
2006 16:18:09</item>
<item
key="registry_request_date_epoch">1153426689</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
786
get_transfers_in
Description
Action & object
action = get_transfers_in
object = domain
Usage
Lists domains that have been transferred in. This command applies to all
domains in a Reseller's profile.
All attributes are optional, but can be used to narrow the search criteria. If
no attributes are specified, all domains that were ever transferred into your
profile are returned.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
completed_from
Optional
completed_to
Optional
domain
Optional
limit
Optional
losing_registrar
Optional
787
Parameter name
Obligation
Definition/Value
registrar. String and wildcards (*) accepted.
order_id
Optional
order_from
Optional
Specify a starting date, in the format YYYYMM-DD from which to return orders. Can be
used with the order_to parameter to specify
a range within which to search. If not used
with order_to, all orders from the
order_from date onward are returned.
order_to
Optional
Specify an end date, in the format YYYYMM-DD, before which to return orders. Can
be used with the attribute order_from
parameter to specify a range within which to
search. If not used with order_from, all
orders from the order_to date and earlier
are returned.
owner_confirm_from
Optional
owner_confirm_ip
Optional
owner_confirm_to
Optional
owner_request_from
Optional
788
Parameter name
Obligation
Definition/Value
owner_request_to
Optional
page
Optional
request_address
Optional
status
Optional
transfer_id
Optional
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
page
page_size
789
Parameter
name
Obligation
Definition/Value
total
transfers
Returned if a transferred-in
domain exists and meets the
specified search criteria and
is_success = true
Transfers
Parameters within the transfers associative array are described below.
Parameter name
Obligation
Definition/Value
affiliate_id
Returned if specified in
the transfer order.
completed_date
domain
gaining_registrar
losing_registrar
order_date
order_date_epoch
790
Parameter name
Obligation
Definition/Value
owner_choice
owner_confirm_date
IIgnored
YApproved
NDeclined
owner_confirm_ip
owner_request_date
registry_request_date
request_address
request_date
request_date_epoch
status
791
Parameter name
Obligation
Definition/Value
transfer_id
Always returned.
792
<item key="owner_confirm_to">2006-10-06</item>
<item key="owner_request_from">2006-10-04</item>
<item key="owner_confirm_from">2006-10-04</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
<item key="attributes">
<dt_assoc>
<item key="page_size">20</item>
<item key="page">1</item>
<item key="total">1</item>
<item key="transfers">
<dt_array>
<item key="0">
<dt_assoc>
793
<item key="owner_request_date">06-OCT-
2006 14:23:54</item>
<item key="status">cancelled</item>
<item
key='affiliate_id'>NUAffiliate123</item>
<item key="registry_request_date"/>
<item key="owner_confirm_date"/>
<item key="registry_request_date_epoch"/>
<item key="owner_confirm_ip"/>
<item key="completed_date">06-OCT-2006
14:59:01</item>
<item
key="order_date_epoch">1159729141</item>
<item key="owner_confirm_date_epoch"/>
<item
key="request_address">agnes@example.com</item>
<item key="losing_registrar">Tucows</item>
<item key="domain">kaka.cc</item>
<item key="order_date">06-OCT-2006
14:23:52</item>
<item
key="completed_date_epoch">1160159032</item>
<item
key="owner_request_date_epoch">1160159034</item>
<item key="transfer_id">1234</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
794
process_transfer
Description
Action & object
action = process_transfer
object = transfer
Usage
Creates a new order with the same data as a cancelled order; the existing
cancelled order is not modified. This command is only available for failed
transfers with the status of 'cancelled'.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
order_id
Required
reseller
Required
Reseller username.
request
795
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name Obligation
Definition/Value
order_id
Returned if is_success =
true
796
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">TRANSFER</item>
<item key="is_success">1</item>
<item key="response_text">Transfer request has been
successfully sent. Admin contact email: admin@example.com'</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">1111111</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
797
rsp2rsp_push_transfer
Description
Action & object
action = rsp2rsp_push_transfer
object = domain
Usage
Transfer a domain from one Reseller to another Reseller. The domain is not
renewed when it is transferred and so no charges are incurred.
Important: Before you can push a domain to another Reseller account, that
Reseller has to add you to their allow list by entering your username on the
Push Domain Settings page of the RWI. For more information, see the
Reseller's Guide to Domain Name Registration and Management guide.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
grsp
Required
password
Optional
username
Optional
798
request
799
Response
If successful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object"></item>
<item key="is_success">1</item>
<item key="response_text">'Domain successfully
transferred'</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
If unsuccessful
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
800
<item key="object"></item>
<item key="is_success">0</item>
<item key="response_text">'grsp must be another
reseller'</item>
<item key="response_code">465</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
801
send_password (transfer)
Description
Action & object
action = send_password
object = transfer
Usage
Resends an email message for a transfer that is in 'pending owner approval'
state, to the admin contact listed for the domain at the time that the transfer
request was submitted. If a transfer is currently in progress, but in a
different state, an error is returned.
Note: This does not handle bulk transfers as such if the password is
requested for a domain that is part of a bulk-transfer order, the password
returned in the email is only usable for the single domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain_name
Required
802
request
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
803
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">transfer</item>
<item key="response_text">Message sent.</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
804
trade_domain
Description
Action & object
action = trade_domain
object = domain
Usage
Transfers ownership of a domain name from one registrant to another. This
command may be used for the following domains: .CL, .COM.AR, .DK, FI,
.FR, .HK, .HU, .MY, .NO, .NU, .PM, .RE, .RO, .RU, .SE, .SG, .TF, .WF, and .YT.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
address1
city
country
domain
Required
domain_auth_info
Required for
.BE
Required
first_name
Required
last_name
Required
805
Definition/Value
org_name
Required
phone
postal_code
state
tld_data
request
806
Request
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">TRADE_DOMAIN</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="first_name">Simon</item>
<item key="last_name">Dubois</item>
<item key="domain">js4.be</item>
<item key="email">dubois@example.be</item>
<item key="org_name">Example Co.</item>
<item keyi="domain_auth_info">ewgnRwnH</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
807
Example 2
Transfers ownership of a .DK domain
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> <OPS_envelope>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
808
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>TRADE_DOMAIN</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
<dt_assoc>
<item key='org_name'>Example Co.</item>
<item key='domain'>example.dk</item>
<item key='first_name'>Daniel</item>
<item key='last_name'>Jensen</item>
<item key='address1'>Gammel Kongevej 1</item>
<item key='city'>Copenhagen V</item>
<item key='state'/>
<item key='country'>DK</item>
<item key='postal_code'>1610</item>
<item key='phone'>+1.33257400</item>
<item key='email'>djensen@example.dk</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
809
Example 3
Transfers ownership of a .FR domain.
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>TRADE_DOMAIN</item>
<item key='object'>DOMAIN</item>
<item key='attributes'>
810
<dt_assoc>
<item key='domain'>example.fr</item>
<item key='first_name'>Henri</item>
<item key='last_name'>LeFluer</item>
<item key='address1'>13 Rue Daze</item>
<item key='city'>Paris</item>
<item key='state'/>
<item key='country'>FR</item>
<item key='postal_code'>75002</item>
<item key='org_name'>French Impressions</item>
<item key='phone'>+1.3365551212</item>
<item key='email'>lefluer@example.com</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='date_of_birth'>1979-03-03</item>
<item key='place_of_birth'>Paris</item>
<item key='country_of_birth'>FR</item>
<item key='postal_code_of_birth'>75008</item>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
811
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Trade for example.fr has been
successfully issued.</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 4
Transfers ownership of a .COM.AR domain
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>TRADE_DOMAIN</item>
<item key='object'>DOMAIN</item>
812
<item key='attributes'>
<dt_assoc>
<item key='first_name'>Daniela</item>
<item key='last_name'>Sosa</item>
<item key='address1'>Piedras No 623</item>
<item key='city'>San Sebastian</item>
<item key='state'/>
<item key='postal_code'>B1000TBU</item>
<item key='country'>AR</item>
<item key='org_name'>Sosa Informatica S.A.</item>
<item key='domain'>example.com.ar</item>
<item key='phone'>+1.4165350123</item>
<item key='email'>sosa@example.com</item>
<item key='tld_data'>
<dt_assoc>
<item key='registrant_extra_info'>
<dt_assoc>
<item key='tax_number'>27-10563145-8</item>
<item key='id_card_number'>10563145</item>
<item key='registrant_type'>individual</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
813
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='response_text'>Trade for example.com.ar has been
successfully issued.</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
814
once.
submit_bulk_changeEnable or disable
WHOIS Privacy for multiple domains.
815
bulk_transfer
Description
Action & object
action = bulk_transfer
object = domain
Usage
Submits a request to transfer several domains at once. The list is grouped by
the admin contact email address and only one email message (containing a
list of the domains) is sent to each admin contact.
Note: Bulk transfers only work for .COM and .NET domains.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
affiliate_id
Optional
custom_tech_contact Required
domain_list
Required
handle
Optional
processProcess order
816
Parameter name
Obligation
Definition/Value
immediately.
reg_domain
Required if
The registrant's domain name
link_domains =
1. If so, the
registered
domain is linked
to the profile
indicated by
reg_username
and
reg_password.
Otherwise, the
reg_username
and
reg_password
fields are used to
create a new
profile.
reg_password
Required
reg_username
Required
request
817
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
bulk_transfer_id
Returned if
A system-generated order ID.
is_success =
true
successful_domains
Returned if
List of domains for which transfers were
is_success = successfully initiated. Each item in the list is
true
represented as a hash, which contains a pair
consisting of the domain name and order_id
for the domain transfer.
For more information, see the
Successful_Domains table below.
Successful_Domains
Parameters within the successful_domains associative array are described
below.
Parameter name
Obligation
Definition/Value
domain
Always
returned
order_id
Always
returned
818
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">bulk_transfer</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain_list">
<dt_array>
<item key="0">aug26-1.com</item>
<item key="1">aug26-2.com</item>
<item key="2">aug26-3.com</item>
<item key="3">aug26-4.com</item>
<item key="4">aug26-5.com</item>
</dt_array>
</item>
<item key="reg_password">secret</item>
<item key="custom_tech_contact">0</item>
<item key="reg_domain">example.com</item>
<item key="contact_set">
... see "Contact Set"
</item>
<item key="reg_username">jdoe</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
819
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Batch transfer successfully
submitted. Please review our orders in 15 minutes to verify that they
were successfully processed.</item>
<item key="attributes">
<dt_assoc>
<item key="bulk_transfer_id">74488</item>
<item key="successful_domains">
<dt_array>
<item key="0">
<dt_assoc>
<item key="order_id">3507635</item>
<item key="domain">aug26-4.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="order_id">3507632</item>
<item key="domain">aug26-1.com</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="order_id">3507634</item>
<item key="domain">aug26-3.com</item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="order_id">3507636</item>
820
<item key="domain">aug26-5.com</item>
</dt_assoc>
</item>
<item key="4">
<dt_assoc>
<item key="order_id">3507633</item>
<item key="domain">aug26-2.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
821
submit (bulk_change)
Description
Action & object
action = submit
object = bulk_change
Usage
Submits a request to change information associated with a large set of
domains. Can also be used to check the availability of a list of domains,
renew multiple domains, or to push multiple domains to another Reseller
account.
You can submit the following bulk change requests with this API call: check
availability, domain lock/unlock, renewals, nameserver modification, contact
changes, enable/disable Parked Pages, enable WHOIS Privacy, and push
domains to another Reseller account. The following restrictions apply to the
submit bulk_change API:
Up to 10,000 domains can be affected in a single request.
When submitting a large number of domains for a bulk change, there
may be a delay of several minutes between when the request is
submitted and when the request is visible in the RWI.
If the Reseller has not signed the end user access contract, owner and
admin contacts sets are not updated as part of bulk change request.
Up to 13 nameservers can be specified in the assign list when updating
nameservers.
Before you can push domains to another Reseller account, you must
add that Reseller to your allow list through the RWI. Duplicate entries
are eliminated from the change_items list.
add_ns adds the nameserver to the current list while assign_ns
replaces the current list with whatever nameservers are listed in the
bulk change request.
Note: This command must be submitted to batch.opensrs.net; submissions
to the live production pool (rr-n1-tor.opensrs.net) will fail.
822
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
apply_to_all_
reseller_items
apply_to_locked_
domains
Optional
change_items
change_type
Required
Note: If
apply_to_all_reseller_items =1,
do not include this parameter.
Allowed values are:
availability_checkCheck
the registry, Premium
Domains, and Personal Names
for the availability of a list of
domains and email a CSV file
containing the results to the
specified email address. The
file indicates whether each
823
Parameter name
Obligation
Definition/Value
name is available, and for
Premium Names, it also
specified the price of the
domain name.
Note: when this value is
specified, contact_email is
required.
dns_zoneAdd, remove or
reset the DNS service for
multiple domains.
Changes can be applied to all
specified domains, to only
domains with DNS service
nameservers, or to domains
that are not using DNS
service nameservers. You can
also change your
nameservers to use the DNS
service nameservers.
If a DNS template is not
specified, a blank zone is
applied.
dns_zone_recordAdd,
modify, or remove DNS
records (A, CNAME, etc) from
zones for multiple domains.
domain_contactsChange
contact information for
multiple domains
domain_forwardingAdd
or remove the domain
forwarding service for
multiple domains.
domain_lockLock or
unlock multiple domains
domain_nameservers
Add, remove, or assign
nameservers
domain_parked_pages
Enable or disable Parked
Pages for multiple domains
domain_renewRenew
multiple domains in one
request
push_domainsMove or
'push' domains from one
Reseller account to another.
824
Parameter name
Obligation
Definition/Value
Note: Before you can push
domains to another Reseller,
you need to add that Reseller
to your allow list in OpenSRS.
storefront_managedMove
domains from OpenSRS to
Storefront or from Storefront
to OpenSRS.
Important: When you move
contact_email
Optional
whois_privacyEnable or
disable WHOIS Privacy
Obligation
Definition/Value
apply_to_domains
Required
dns_action
Required
using_dns_nameservers
not_using_dns_nameservers
all_selected_domains
dns_template
Optional
825
Parameter name
Obligation
Definition/Value
only_if
Optional
force_dns_nameservers
Optional
Obligation
Definition/Value
dns_action
Required
dns_record_type
Required
dns_record_data
Required only if
dns_action =
add or modify.
ip_address, subdomain
AAAA
ipv6_address,
subdomain
CNAME
hostname, subdomain
MX
priority, hostname,
subdomain
SRV
priority, weight,
subdomain, hostname,
port
TXT
subdomain, text
826
Parameter
name
Obligation
Definition/Value
For an explanation of each of these record
types and allowed values, see Request
parameters for set_dns_zone.
only_if
Optional. Can
only be used if
dns_action =
modify or
remove.
Obligation
Definition/Value
contacts
Required
set
Required
type
Required
Type of contact.
Allowed values are billing and tech.
Obligation
Definition/Value
change_items
Required
op_type
Required
827
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
op_type
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
add_ns
assign_ns
op_type
Required
remove_ns
828
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
op_type
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
affiliate_id
Optional
auto_renew
Optional
let_expire
period
Optional
Optional
0Disable auto-renew
1Enable auto-renew
829
Obligation
Definition/Value
change_items
Required
gaining_reseller_username
Required
contact_email
Optional
Obligation
Definition/Value
op_type
Required
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
op_type
Required
830
831
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
bulk_change_req_id
Returned if
is_success =
true
832
<dt_assoc>
<item key='change_type'>availability_check</item>
<item key='change_items'>
<dt_array>
<item key='0'>bulkrenewtest3.com</item>
<item key='1'>bulkrenewtest4.com</item>
</dt_array>
</item>
<item key='contact_email'>jdoe@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
833
<item key="change_items">
<dt_array>
<item key="0">dnstestingthing1.com</item>
<item key="1">dnstestingthing2.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
834
</item>
<item key="dns_record_data">
<dt_assoc>
<item key="subdomain">www</item>
<item key="hostname">example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
835
<item key="0">dnstestingthing1.com</item>
<item key="1">dnstestingthing2.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
836
<dt_assoc>
<item key="hostname">mydomain.com</item>
</dt_assoc>
</item>
<item key="only_if">
<dt_assoc>
<item key="subdomain">www</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
837
<dt_array>
<item key="0">dnstestingthing1.com</item>
<item key="1">dnstestingthing2.com</item>
</dt_array>
</item>
<item key="only_if">
<dt_assoc>
<item key="dns_template">my_name</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
838
<dt_array>
<item key="0">dnstestingthing1.com</item>
<item key="1">dnstestingthing2.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
839
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
840
841
</data_block>
</body>
</OPS_envelope>
842
<item key="address3"/>
<item key="fax"/>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="type">tech</item>
<item key="set">
<dt_assoc>
<item key="first_name">Mark</item>
<item key="last_name">Doe</item>
<item key="address1">123 Main
St.</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
843
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>submit</item>
<item key='object'>bulk_change</item>
<item key='attributes'>
<dt_assoc>
<item key='change_items'>
<dt_array>
<item key='0'>example.com</item>
<item key='1'>example.info</item>
</dt_array>
</item>
<item key='contact_email'>jdoe@example.com</item>
<item key='change_type'>domain_parked_pages</item>
<item key='op_type'>enable</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
844
<item key='attributes'>
<dt_assoc>
<item key='change_type'>domain_renew</item>
<item key='change_items'>
<dt_array>
<item key='0'>example1.com</item>
<item key='1'>example2.com</item>
</dt_array>
</item>
<item key='affiliate_id'>myaffiliate</item>
<item key='let_expire'>0</item>
<item key='period'>2</item>
<item key='auto_renew'>0</item>
<item key='contact_email'>jdoe@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
845
<item key='change_items'>
<dt_array>
<item key='0'>example.com</item>
<item key='1'>example.info</item>
</dt_array>
</item>
<item key='contact_email'>jdoe@example.com</item>
<item key='change_type'>whois_privacy</item>
<item key='op_type'>enable</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
846
</dt_array>
</item>
<item key='gaining_reseller_username'>orange</item>
<item key='contact_email'>jdoe@example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
847
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">bulk_change</item>
<item key="response_text">Command successfully submitted
for processing</item>
<item key="is_success">1</item>
<item key="bulk_change_req_id">168</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
848
Usage
This command allows you to enable or disable WHOIS Privacy for multiple
domains. WHOIS Privacy can be enabled or disabled for .COM, .NET, .ORG,
.INFO, .BIZ, .ME, .MOBI, .NAME, .CC, .CO, and .TV TLDs.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
apply_to_locked_
domains
Optional
change_items
Required
change_type
Required
whois_privacy
whois_privacy_purchase - DEPRECATED.
If this value is part of your current
integration, it continues to work; however,
we recommend that you use
whois_privacy instead
849
Parameter name
Obligation
Definition/Value
contact_email
Optional
op_type
Required
request
850
<item key="contact_email">jdoe@example.com</item>
<item key="change_type">whois_privacy</item>
<item key="op_type">enable</item>
<item key="change_items">
<dt_array>
<item key="0">example1.com</item>
<item key="1">example2.com</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">BULK_CHANGE</item>
<item key="response_text">Command successfully submitted
for processing</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
851
Nameserver Commands
This section contains the following commands:
advanced_update_nameserverAdds or
removes nameservers for a domain.
registry_check_nameserverVerifies whether a
nameserver exists at a particular registry.
852
advanced_update_nameservers
Description
Action & object
action = advanced_update_nameservers
object = domain
Usage
Adds nameservers to a domain, or adds or removes nameservers for a
domain that already has nameservers assigned to it. This command does not
create a nameserver; the nameserver must already exist (see "create
(nameserver).
This command is not supported for .DK. Use the update_all_info command to
change the nameservers for .DK domains.
Note: When you use this command to add or change nameservers for .IT
domains, even though the response says the command was successful, the
new nameservers are not activated immediately. The registry runs a series of
tests against the nameservers before activating them. During the time that
the tests are being run, any query about the domain, such as get
nameservers or get domain all_info, will return the old nameservers. If the
nameservers do not pass the registry tests within 30 days, the registry
ignores the request. If you issue another advanced_update_nameservers
command before the registry has completed their tests, the new command is
assumed to refer to the old, currently active nameservers.
853
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
add_ns
Optional
assign_ns
Optional
domain
Required if
The relevant domain.
cookie is not
submitted
op_type
Required
remove_ns
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
854
855
856
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">domain</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command completed
successfully</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
857
create (nameserver)
Description
Action & object
action = create
object = nameserver
Usage
Creates a nameserver in the same domain space as the cookie's domain.
Note: This action is not the same as modify domain nameserver_list add,
which actually assigns a nameserver created with create nameserver to
serve the cookie's domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
add_to_all_registry
Optional
Required if
cookie is not
submitted
ipaddress
Required if
ipv6 is not
submitted
858
Definition/Value
ipv6
Required if
The IPv6 address of the nameserver.
ipaddress is You can specify ipaddress or ipv6, or both.
not submitted
Note: This parameter is not supported for .CN.
name
Required
request
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">create</item>
<item key="object">nameserver</item>
<item key="cookie">366828736:3210384</item>
859
<item key="attributes">
<dt_assoc>
<item key="name">ns1.example.com</item>
<item key="ipaddress">212.112.123.11</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Nameserver Created</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example creates an IPv4 nameserver and adds it to any foreign
registries.
860
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_array>
<item key="0">
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">create</item>
<item key="object">nameserver</item>
<item key="attributes">
<dt_assoc>
<item key="add_to_all_registry">
<dt_array>
<item key="0">.info</item>
<item key="1">.name</item>
<item key="2">.org</item>
<item key="3">.biz</item>
<item key="4">.de</item>
<item key="5">.cc</item>
<item key="6">.us</item>
</dt_array>
</item>
<item key="ipaddress">207.136.65.24</item>
<item key="name">ns6.example.com</item>
</dt_assoc>
</item>
<item key="cookie">591236085:3210384</item>
<item key="registrant_ip">111.222.333.444</item>
</dt_assoc>
861
</item>
</dt_array>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_array>
<item key="0">
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="add_to_all_registry">
<dt_assoc>
<item key=".biz">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command
successful</item>
</dt_assoc>
</item>
<item key=".cc">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
862
successful</item>
<item key="response_text">Command
</dt_assoc>
</item>
<item key=".info">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
successful</item>
<item key="response_text">Command
</dt_assoc>
</item>
<item key=".name">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
successful</item>
<item key="response_text">Command
</dt_assoc>
</item>
<item key=".org">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
successful</item>
<item key="response_text">Command
</dt_assoc>
</item>
<item key=".us">
<dt_assoc>
<item key="is_success">1</item>
<item key="response_code">200</item>
successful</item>
<item key="response_text">Command
</dt_assoc>
</item>
</dt_assoc>
863
</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Nameserver Created</item>
</dt_assoc>
</item>
</dt_array>
</data_block>
</body>
</OPS_envelope>
Example 3
This example submits the create nameserver command without end-user
credentials and creates an IPv4 nameserver without adding it to any foreign
registries.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">create</item>
<item key="object">nameserver</item>
<item key="attributes">
<dt_assoc>
<item key="ipaddress">212.112.123.11</item>
<item key="name">ns5.example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
864
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">NAMESERVER</item>
<item key="is_success">1</item>
<item key="response_text">Nameserver Created</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 4
This example creates an IPv6 nameserver without adding to any foreign
registries.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
865
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">create</item>
<item key="object">nameserver</item>
<item key="cookie">366828736:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="name">ns1.example.com</item>
<item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Nameserver Created</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
866
</data_block>
</body>
</OPS_envelope>
867
delete (nameserver)
Description
Action & object
action = delete
object = nameserver
Usage
Deletes a nameserver, provided it is not currently serving a domain.
Note: If the registry in which the nameserver object resides is serving a
domain outside of OpenSRS, delete nameserver returns an error and the
nameserver is not deleted.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
ipaddress
Required if
ipv6 is not
submitted
ipv6
Required if
The IPv6 address of the nameserver.
ipaddress is You can specify ipaddress or ipv6, or both.
not submitted
Note: This parameter is not supported for .CN.
868
Parameter
name
Obligation
Definition/Value
name
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">delete</item>
<item key="object">nameserver</item>
<item key="registrant_ip">216.40.46.115</item>
<item key="cookie">435686610:3185178</item>
<item key="attributes">
<dt_assoc>
869
<item key="ipaddress">24.22.112.11</item>
<item key="name">ns1.example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Nameserver deleted</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example deletes an IPv6 nameserver.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
870
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
871
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Nameserver deleted</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
872
get (nameserver)
Description
Action & object
action = get
object = nameserver
Usage
Queries nameservers that exist in the current user profile (current cookie).
These nameservers may or may not be currently assigned to a domain.
To see a list of nameservers serving the cookie's domain, use the command
get domain nameservers.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain
Required if cookie is
not submitted
name
Required
Specify all.
request
873
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
nameserver_list
Returned if
A list (array) of nameservers, each of which can
is_success = contain any of the attributes listed in the
true
Nameserver_List table below.
Nameserver_List
Parameters within the nameserver_list associative array are described below.
Parameter
name
Obligation
Definition/Value
can_delete
Always
returned
ipaddress
ipv6
name
Always
returned
874
Deprecated
Parameter
name
Obligation
Definition/Value
encoding_type
Deprecated
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">nameserver</item>
<item key="cookie">121321321:12341242424</item>
<item key="registrant_ip">111.121.121.121</item>
<item key="attributes">
<dt_assoc>
<item key="name">all</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
875
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns1.systemdns.com</item>
<item key="can_delete">1</item>
<item
key="ipaddress">191.11.121.111</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns2.systemdns.com</item>
<item key="can_delete">0</item>
<item
key="ipaddress">11.111.121.111</item>
</dt_assoc>
</item>
876
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
This example returns information about an IPv6 nameserver.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get</item>
<item key="object">nameserver</item>
<item key="cookie">121321321:12341242424</item>
<item key="registrant_ip">111.121.121.121</item>
<item key="attributes">
<dt_assoc>
<item key="name">all</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
877
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_code">200</item>
<item key="response_text">Query Successful</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="nameserver_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="name">ns3.systemdns.com</item>
<item key="can_delete">1</item>
<item
key="ipv6">2a00:1450:4008:c00:0:0:0:1</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="name">ns4.systemdns.com</item>
<item key="can_delete">0</item>
<item
key="ipv6">2001:0db8:85a3:0000:0000:8a2e:0370:7334</item>
878
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
879
modify (nameserver)
Description
Action & object
action = modify
object = nameserver
Usage
Modifies a nameserver. This command is not supported for .TEL domains.
Important: This command will overwrite the existing nameserver entries. If
a nameserver has two IPs, one for IPv4 and one for IPv6, and you specify
only one of these in the request, the other one will be removed from the
registry.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
ipaddress
ipv6
880
Parameter
name
Obligation
Definition/Value
for .CN.
name
Required
new_name
Deprecated
Parameter name
Obligation
Definition/Value
new_encoding_type
Deprecated
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
881
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">nameserver</item>
<item key="cookie">892036263:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="name">ns1.example.com</item>
<item key="new_name">ns.boo.example.com</item>
<item key="ipaddress">212.112.123.11</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Command successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
882
</OPS_envelope>
Example 2
This example changes the name of an IPv6 nameserver.
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">modify</item>
<item key="object">nameserver</item>
<item key="cookie">892036263:3210384</item>
<item key="attributes">
<dt_assoc>
<item key="name">ns1.example.com</item>
<item key="new_name">ns.test.example.com</item>
<item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
883
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">nameserver</item>
<item key="response_text">Command successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
884
registry_add_ns
Description
Action & object
action = registry_add_ns
object = nameserver
Usage
Adds a nameserver to one or all registries to which a Reseller has access.
This command does not create a nameserver; a nameserver must already be
created (see "create (nameserver)").
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
all
Required
fqdn
Required
tld
Required
885
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
attributes
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
registry_name
Returned if
Registry Names:
is_success = true
NSI
DENIC
NeuLevel
TV
NSI .cc
CIRA
ISOC/PIR
UK
VC
dotName
NeuStar
Afilias
'Successfully added.'
'Couldn't add nameserver: Registry doesn't support nameserver as a
separate object.'
'Couldn't add nameserver: Our system is experiencing technical
difficulties; please try again later. If problem persists, please contact
886
support and state error message: REM server: -702, no RAs to service
the domain 'example.cc'.
Response
For "all" = "1"
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
887
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>reply</item>
<item key='object'>nameserver</item>
<item key='attributes'>
<dt_assoc>
<item key='DENIC'>Successfully added</item>
<item key='VC'>Couldn't add nameserver: Unexpected response
from registry: 705: No RAs to service your domain.
</item>
<item key='TV'>Couldn't add nameserver: Registry doesn't
support nameserver as a separate object.
</item>
<item key='Neulevel'>Successfully added</item>
<item key='CIRA'>Couldn't add nameserver: Registry doesn't
support nameserver as a separate object.
</item>
<item key='ISOC/PIR'>Successfully added</item>
<item key='GNR'>Successfully added</item>
<item key='UK'>Couldn't add nameserver: Registry doesn't
support nameserver as a separate object.
</item>
<item key='NSI_CC'>Successfully added</item>
<item key='Neustar'>Successfully added</item>
<item key='Afilias'>Successfully added</item>
</dt_assoc>
</item>
<item key='response_text'>Command verified</item>
<item key='is_success'>1</item>
<item key='response_code'>200</item>
</dt_assoc>
</data_block>
</body>
888
</OPS_envelope>
889
registry_check_nameserver
Description
Action & object
action = registry_check_nameserver
object = nameserver
Usage
Verifies whether a nameserver exists at a particular registry.
Note: This command is not required for registries that do not have a
nameserver object, that is, .CA, .UK, .DE, .FR, and CH.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
fqdn
Required
tld
Required
890
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
status
Returned if
Indicates whether the nameserver exists at
is_success = true the registry.
891
<dt_assoc>
<item key="tld">.com</item>
<item key="fqdn">ns1.livedns.co.uk</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
Nameserver found
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_array>
<item key="0">
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">NAMESERVER</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command successful</item>
</dt_assoc>
</item>
</dt_array>
</data_block>
</body>
</OPS_envelope>
892
893
</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
894
895
create_dns_zone
Description
Action & object
action = create_dns_zone
object = domain
Usage
Enables the DNS service for a domain. If you have created a DNS template,
you can specify the template in the command to assign initial DNS records.
The template is then associated with the domain, so if you later issue the
reset_dns_zone command, the records are set back to what is defined in the
template.
If you specify *blank* instead of a DNS template when you issue this
command, you can submit the values for the DNS records in this command
or you can use the set_dns_zone command to define the DNS records.
For information on creating a DNS zone template, see Managing DNS Zone
Information in the Resellers Guide to Domain Name Registration and
Management.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
dns_template
Optional
896
Parameter
name
Obligation
Definition/Value
records
Required
A
AAAA
CNAME
MX
SRV
TXT
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address
that computers recognize, for example,
123.45.54.123.
subdomainThe
third level of the domain name, such as www or
ftp.
AAAA
Optional
ipv6_address
The next generation Internet Protocol designed
as the successor to version 4. It is normally
written as eight groups of four hexadecimal
digits (i.e. 2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
subdomainThe
third level of the domain name, such as www or
ftp.
CNAME
Optional
hostnameThe
897
Parameter
name
Obligation
Definition/Value
FQDN of the domain that you want to access.
subdomainThe
third level of the domain name, such as www or
ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
SRV
Optional
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA relative
weight for records with the same priority.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP or
UDP port on which the service is to be found.
request
898
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
nameservers_ok
Returned if
Indicates whether the domain is set up to use the
is_success = OpenSRS nameservers.
true
0Nameservers
are not set to the DNS service nameservers
1Nameservers
are set to the DNS service nameservers
records
Returned if
A list of the record types defined for the domain;
is_success = each record includes the settings for that record.
true
Record types may be
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table
below.
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address
that computers recognize, for example,
123.45.54.123.
subdomainThe
third level of the domain name, such as www or
ftp.
899
Parameter
name
Obligation
Definition/Value
AAAA
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
ipv6_address
The next generation Internet Protocol designed
as the successor to version 4. It is normally
written as eight groups of four hexadecimal
digits (i.e. 2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
CNAME
Optional
hostnameThe
FQDN of the domain that you want to access.
subdomainThe
third level of the domain name, such as www or
ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
900
Parameter
name
Obligation
Definition/Value
SRV
Optional
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA relative
weight for records with the same priority.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP or
UDP port on which the service is to be found.
TXT
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
textThe
comments that you want to include.
901
<item key="protocol">XCP</item>
<item key="action">create_dns_zone</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="dns_template">business_domains</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
902
Response
If template is specified
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item key="ip_address">17.16.156.5</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="MX">
<dt_array>
<item key="0">
903
<dt_assoc>
<item key="priority">10</item>
<item key="subdomain">www</item>
<item key="hostname">example.org</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="priority">1</item>
<item key="subdomain"></item>
<item
key="hostname">mx.cust.aug18dnstest1.com.hostedemail.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">1</item>
<item key="weight">3</item>
<item key="subdomain">w3</item>
<item key="hostname">yummynames.com</item>
<item key="port">81</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="nameservers_ok">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
904
</body>
</OPS_envelope>
905
delete_dns_zone
Description
Action & object
action = delete_dns_zone
object = domain
Usage
Deletes the DNS zones defined for the specified domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
906
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
907
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
908
force_dns_nameservers
Description
Action & object
action = force_dns_nameservers
object = domain
Usage
Changes the nameservers on your domain to use the DNS nameservers:
ns1.systemdns.com, ns2.systemdns.com, and ns3.systemdns.com.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
909
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
910
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="action">REPLY</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
911
get_dns_zone
Description
Action & object
action = get_dns_zone
object = domain
Usage
View the DNS records for a specified domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
912
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
nameservers_ok
Returned if
Indicates whether the domain is set up to use the
is_success = OpenSRS nameservers.
true
0Nameservers
are not set to the DNS service nameservers
1Nameservers
are set to the DNS service nameservers
records
Returned if
A list of the record types defined for the domain;
is_success = each record includes the settings for that record.
true
Record types may be
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table
below.
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address
that computers recognize, for example,
123.45.54.123.
subdomainThe
third level of the domain name, such as www or
ftp.
AAAA
Optional
913
Parameter
name
Obligation
Definition/Value
subdomainThe
third level of the domain name, such as www or
ftp.
ipv6_addressThe
next generation Internet Protocol designed as the
successor to version 4. It is normally written as
eight groups of four hexadecimal digits (i.e.
2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
CNAME
Optional
hostnameThe
FQDN of the domain that you want to access.
subdomainThe
third level of the domain name, such as www or
ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
914
Parameter
name
Obligation
Definition/Value
SRV
Optional
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA relative
weight for records with the same priority.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP or
UDP port on which the service is to be found.
TXT
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
textThe
comments that you want to include.
915
<item key="action">get_dns_zone</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
916
<dt_assoc>
<item key="subdomain"></item>
<item key="ip_address">17.16.156.5</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="MX">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">10</item>
<item key="subdomain">www</item>
<item key="hostname">example.org</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="priority">1</item>
<item key="subdomain"></item>
<item
key="hostname">mx.cust.aug17dnstest1.com.hostedemail.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">1</item>
<item key="weight">3</item>
<item key="subdomain">w3</item>
<item key="hostname">yummynames.com</item>
<item key="port">81</item>
</dt_assoc>
917
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="nameservers_ok">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
918
reset_dns_zone
Description
Action & object
action = reset_dns_zone
object = domain
Usage
Sets the DNS zone to the values in the specified template. If a template is
not specified in the command, the records are set to what was in the
template that was used to enable the DNS service.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
dns_template
Optional
domain
Required
request
919
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
nameservers_ok
Returned if
Indicates whether the domain is set up to use the
is_success = OpenSRS nameservers.
true
0Nameservers
are not set to the DNS service nameservers
1Nameservers
are set to the DNS service nameservers
records
Returned if
A list of the record types defined for the domain;
is_success = each record includes the settings for that record.
true
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address that
computers recognize, for example,
123.45.54.123.
subdomainThe
third level of the domain name, such as www or
ftp.
AAAA
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
ipv6_addressThe
920
Parameter
name
Obligation Definition/Value
next generation Internet Protocol designed as the
successor to version 4. It is normally written as
eight groups of four hexadecimal digits (i.e.
2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
CNAME
Optional
hostnameThe
FQDN of the domain that you want to access.
subdomainThe
third level of the domain name, such as www or
ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
SRV
Optional
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA relative
weight for records with the same priority.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP or
UDP port on which the service is to be found.
TXT
Optional
921
Parameter
name
Obligation Definition/Value
email is being sent from the IP address of the
domain's mail server.
The TXT record consists of the following:
subdomainThe
third level of the domain name, such as www or
ftp.
textThe comments
922
</OPS_envelope>
Response
If template is specified
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
923
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item key="ip_address">17.16.156.5</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="MX">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">10</item>
<item key="subdomain">www</item>
<item key="hostname">example.com</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="priority">1</item>
<item key="subdomain"></item>
<item
key="hostname">mx.cust.aug18dnstest1.com.hostedemail.com</item>
924
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">1</item>
<item key="weight">3</item>
<item key="subdomain">w3</item>
<item key="hostname">yummynames.com</item>
<item key="port">81</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="nameservers_ok">0</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
925
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="nameservers_ok">0</item>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item key="ip_address">17.16.156.5</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="MX">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">10</item>
<item key="subdomain">www</item>
<item key="hostname">example.org</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="priority">1</item>
<item key="subdomain"></item>
926
<item
key="hostname">mx.cust.aug18dnstest1.com.hostedemail.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">1</item>
<item key="weight">3</item>
<item key="subdomain">w3</item>
<item key="hostname">yummynames.com</item>
<item key="port">81</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
927
set_dns_zone
Description
Action & object
action = set_dns_zone
object = domain
Usage
Set the records for a domain's DNS zone.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
records
Required
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table
below.
928
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address
that computers recognize, for example,
123.45.54.123.
subdomain
The third level of the domain name, such as
www or ftp.
AAAA
Optional
ipv6_address
The next generation Internet Protocol
designed as the successor to version 4. It is
normally written as eight groups of four
hexadecimal digits (i.e. 2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
subdomain
The third level of the domain name, such as
www or ftp.
CNAME
Optional
hostnameThe
FQDN of the domain that you want to access.
subdomain
The third level of the domain name, such as
www or ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomain
The third level of the domain name, such as
929
Parameter
name
Obligation
Definition/Value
www or ftp.
hostnameThe
FQDN of the domain that you want to access.
nameservers_ok
Required
0Domain is
not set up to use the OpenSRS nameservers
1Domain is
set up to use the OpenSRS nameservers
records
Required
SRV
Optional
A
AAAA
CNAME
MX
SRV
TXT
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA
relative weight for records with the same
priority.
subdomain
The third level of the domain name, such as
www or ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP
or UDP port on which the service is to be
found.
TXT
Optional
subdomain
The third level of the domain name, such as
www or ftp.
textThe
930
Parameter
name
Obligation
Definition/Value
comments that you want to include.
931
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
nameservers_ok
Returned if
Indicates whether the domain is set up to use the
is_success = OpenSRS nameservers.
true
0Domain is
not set up to use the OpenSRS nameservers
1Domain is
set up to use the OpenSRS nameservers
records
Returned if
A list of the record types defined for the domain;
is_success = each record includes the settings for that record.
true
Record types may be
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table
below.
932
Records
Parameters within the records associative array are described below.
Parameter
name
Obligation
Definition/Value
Optional
ip_address
Internet Protocol Address. A numeric address
that computers recognize, for example,
123.45.54.123.
subdomainThe
third level of the domain name, such as www or
ftp.
AAAA
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
ipv6_addressThe
next generation Internet Protocol designed as the
successor to version 4. It is normally written as
eight groups of four hexadecimal digits (i.e.
2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
CNAME
Optional
hostnameThe
FQDN of the domain that you want to access.
subdomainThe
third level of the domain name, such as www or
ftp.
MX
Optional
priorityThe
priority of the target host, lower value means
more preferred.
subdomainThe
third level of the domain name, such as www or
ftp.
933
Parameter
name
Obligation
Definition/Value
hostnameThe
FQDN of the domain that you want to access.
SRV
Optional
Service Record.
The SRV record consists of the following:
priorityThe
priority of the target host, lower value means
more preferred.
weightA relative
weight for records with the same priority.
subdomainThe
third level of the domain name, such as www or
ftp.
hostnameThe
FQDN of the domain that you want to access.
portThe TCP or
UDP port on which the service is to be found.
TXT
Optional
subdomainThe
third level of the domain name, such as www or
ftp.
textThe
comments that you want to include.
934
<item key="protocol">XCP</item>
<item key="action">SET_DNS_ZONE</item>
<item key="object">DOMAIN</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item
key="ip_address">123.123.123.2</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="subdomain">*</item>
<item
key="ip_address">123.123.123.3</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="subdomain">www</item>
<item
key="ip_address">123.123.123.4</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="CNAME">
<dt_array>
<item key="0">
935
<dt_assoc>
<item key="subdomain">portal</item>
<item
key="hostname">www.example.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="MX">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item
key="hostname">mx.example.com.cust.test.hostedemail.com</item>
<item key="priority">10</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="TXT">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain">mail</item>
<item key="text">v=spf1
exists:example.com -all</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="AAAA">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain">itportal</item>
936
<item
key="ipv6_address">2001:00ab:0000:00a1:0001:000b:00cc:00de</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain">itcontrol</item>
<item
key="hostname">control.example.com</item>
<item key="port">443</item>
<item key="priority">10</item>
<item key="weight">1</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
937
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="records">
<dt_assoc>
<item key="A">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain"></item>
<item key="ip_address">123.123.123.2</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="subdomain">*</item>
<item key="ip_address">123.123.123.3</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="subdomain">www</item>
<item key="ip_address">123.123.123.4</item>
</dt_assoc>
</item>
</dt_array>
</item>
938
<item key="MX">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">10</item>
<item key="subdomain"></item>
<item
key="hostname">mx.example.com.cust.test.hostedemail.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="TXT">
<dt_array>
<item key="0">
<dt_assoc>
<item key="text">v=spf1 exists:example.com -all</item>
<item key="subdomain">mail</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="SRV">
<dt_array>
<item key="0">
<dt_assoc>
<item key="priority">10</item>
<item key="weight">1</item>
<item key="subdomain">itcontrol</item>
<item key="hostname">control.example.com</item>
<item key="port">443</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="CNAME">
939
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain">portal</item>
<item key="hostname">www.example.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="AAAA">
<dt_array>
<item key="0">
<dt_assoc>
<item key="subdomain">itportal</item>
<item
key="ipv6_address">2001:00ab:0000:00a1:0001:000b:00cc:00de</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="nameservers_ok">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
940
delete_domain_forwardingDeletes domain
forwarding service.
set_domain_forwardingConfigures the
domain forwarding settings for a domain.
941
create_domain_forwarding
Description
Action & object
action = create_domain_forwarding
object = domain
Usage
Create domain forwarding service that is used to redirect visitors from one
web address to another. Once you create domain forwarding, you need to use
the set_domain_forwarding command to configure the settings.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Optional
request
response_code = response code indicating outcome of the request
942
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
943
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
944
delete_domain_forwarding
Description
Action & object
action = delete_domain_forwarding
object = domain
Usage
Delete the domain forwarding service for the specified domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
945
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
946
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
947
get_domain_forwarding
Description
Action & object
action = get_domain_forwarding
object = domain
Usage
Queries the domain forwarding settings for a specified domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
948
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
forwarding
Returned if
A list of the subdomains that are forwarded; can
is_success = be empty.
true
For more information, see the Forwarding table
below.
Forwarding
Parameters within the forwarding associative array are described below.
Parameter
name
Obligation
Definition/Value
description
Optional
destination_url
Optional
enabled
Optional
1Domain forwarding is on
keywords
Optional
masked
Optional
subdomain
Always
returned
title
Optional
949
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
950
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='forwarding'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='keywords'/>
<item key='masked'>0</item>
<item key='subdomain'>mail</item>
<item
key='destination_url'>http://mail.example.org/webmail</item>
<item key='title'>Main Web Mail Access 1</item>
<item key='description'>Default Web Mail
Access</item>
<item key='enabled'>1</item>
</dt_assoc>
</item>
<item key='1'>
<dt_assoc>
<item key='keywords'/>
<item key='masked'>1</item>
<item key='subdomain'>www</item>
<item
key='destination_url'>http://www.example.org</item>
<item key='title'>Main Web Access 1</item>
Forward</item>
951
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_domain_forwarding</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key='domain'>example.com</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
952
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>REPLY</item>
<item key='object'>DOMAIN</item>
<item key='response_text'>Command Successful</item>
<item key='response_code'>200</item>
<item key='is_success'>1</item>
<item key='attributes'>
<dt_assoc>
<item key='forwarding'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='keywords'/>
<item key='masked'>1</item>
<item key='subdomain'>mail</item>
<item
key='destination_url'>http://mail.example.org/webmail</item>
<item key='title'>Main Web Mail Access 1</item>
Access</item>
953
<dt_assoc>
<item key='keywords'/>
<item key='masked'>1</item>
<item key='subdomain'>www</item>
<item
key='destination_url'>http://www.example.org</item>
<item key='title'>Main Web Access 1</item>
<item key='description'>Default Site Access
Forward</item>
<item key='enabled'>1</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
954
set_domain_forwarding
Description
Action & object
action = set_domain_forwarding
object = domain
Usage
Configures the domain forwarding settings for a domain.
Note: Domain forwarding must already have been created for the domain.
See create_domain_forwarding.
The way in which the domain forwarding behaves depends on the format of
the domain name to which it applies:
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
955
Parameter
name
Obligation
Definition/Value
forwarding
Optional
Forwarding
Parameters within the forwarding associative array are described below.
Parameter
name
Obligation
Definition/Value
description
Optional
destination_url Optional
enabled
keywords
Optional
Optional
masked
Optional
Required
956
Parameter
name
Obligation
Definition/Value
title
Optional
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
957
<item key='forwarding'>
<dt_array>
<item key='0'>
<dt_assoc>
<item key='masked'>1</item>
<item key='keywords'>Example2.com</item>
<item
key='destination_url'>http://www.example2.com</item>
<item key='enabled'>1</item>
<item key='description'>Example2.com</item>
<item key='subdomain'>mail</item>
<item key='title'>Example2.com</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
958
Example 2
Without end-user credentials
Request
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key='protocol'>XCP</item>
<item key='action'>set_domain_forwarding</item>
<item key='object'>domain</item>
<item key='attributes'>
<dt_assoc>
<item key='domain'>mydomain.com</item>
<item key='forwarding'>
<dt_array>
<item key="0">
<dt_assoc>
checkout</item>
<item
key="destination_url">http://payment.gateway.biz</item>
959
Gateway</item>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Command Successful</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
960
User Commands
This section contains the following commands:
account.
data.
information.
user data.
961
add (subuser)
Description
Action & object
action = add
object = subuser
Usage
Creates a subuser for a user's account. Only one subuser can exist per
account.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
sub_password
Required
sub_permission
Required
1Owner
2Admin
4Billing
8Tech
16Nameservers
962
Parameter
name
Obligation
Definition/Value
sub_username
Required
32Rsp_whois_info
request
963
<item key="sub_username">subludak</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SUBUSER</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
964
delete (subuser)
Description
Action & object
action = delete
object = subuser
Usage
Deletes a subuser.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
sub_id
Required
request
response_code = response code indicating outcome of the request
965
966
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
967
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SUBUSER</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
968
get (subuser)
Description
Action & object
action = get
object = subuser
Usage
Queries a domain's sub-user data.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
request
969
Attributes
If the request is successful, the attributes associative array may include the
following. (If there is no sub-user on the domain, the attributes are empty.)
Parameter
name
Obligation
id
Returned if
The sub-user's ID.
is_success = true
permission
Returned if
The sub-user's permission level. The permission
is_success = true value is a bit mask indicating which parts of the
domain information the sub-user can change.
username
Definition/Value
1Owner
2Admin
4Billing
8Tech
16Nameservers
32Rsp_whois_info
Returned if
The sub-user's username.
is_success = true
970
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SUBUSER</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="permission">2</item>
<item key="username">subludak</item>
<item key="id">2532880</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
971
get (userinfo)
Description
Action & object
action = get
object = userinfo
Usage
Retrieves a user's general information.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
request
972
The Reseller Agent (RSA) could respond with a 250 response_code, which
indicates that the action was submitted for processing in an asynchronous
registry. OpenSRS processes the request when the registry's reply is
received.
Performing a set cookie or get userinfo command indicates if there is an
action currently waiting on a domain. This information can be used to alert
the user that there is a waiting request.
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
capabilities
dns_errors
domain
domain_count
encoding_type
Optional
expiredate
f_owner
973
Parameter name
Obligation
Definition/Value
permission
1Owner
2Admin
4Billing
8Tech
16Nameservers
32Rsp_whois_info
username
waiting_requests_no
Capabilities
Parameters within the capabilities associative array are described below.
Parameter name Obligation
Definition/Value
change_ips_tag
domain_auth_info
Optional
Always
returned
1True
0False
Always
returned
1True
0False
974
Definition/Value
uk_whois_opt
Optional
Deprecated
Parameter name
Obligation
Definition/Value
waiting_request
Deprecated
Replaced by waiting_requests_no.
975
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">USERINFO</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="waiting_requests_no">8</item>
<item key="domain">example.org.uk</item>
<item key="encoding_type"/>
<item key="expiredate">2007-11-25 00:00:00</item>
<item key="permission"/>
<item key="domain_count">131</item>
<item key="f_owner">1</item>
<item key="username">aaaa</item>
<item key="capabilities">
<dt_assoc>
<item key="forwarding_email">0</item>
<item key="domain_auth_info">0</item>
<item key="uk_whois_opt">1</item>
<item key="change_ips_tag">1</item>
</dt_assoc>
</item>
</dt_assoc>
976
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
977
modify (subuser)
Description
Action & object
action = modify
object = subuser
Usage
Modifies a domain's sub-user data.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
sub_id
Required
sub_password
Required
sub_permission
Required
1Owner
2Admin
4Billing
8Tech
16Nameservers
978
Parameter
name
Obligation
Definition/Value
sub_username
Required
32Rsp_whois_info
request
979
<item key="sub_id">2532880</item>
<item key="sub_username">subludak</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SUBUSER</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
980
Authentication Commands
This section contains the following commands:
change (ownership)Changes the username
and password of the profile that owns the cookie's domain.
981
change (ownership)
Description
Action & object
action = change
object = ownership
Usage
Changes the username and password of the profile that owns the cookie's
domain.
Note: After issuing this command, in order to continue issuing further
commands for the domain, you must delete the current cookie and set
another.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
move_all
Optional
982
Parameter
name
Obligation
Definition/Value
password
Required
reg_domain
Optional
username
Required
request
983
<item key="protocol">XCP</item>
<item key="action">CHANGE</item>
<item key="object">OWNERSHIP</item>
<item key="cookie">992336212:3228913</item>
<item key="registrant_ip">10.0.10.138</item>
<item key="attributes">
<dt_assoc>
<item key="move_all">1</item>
<item key="password">newprofile</item>
<item key="username">newprofile</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">OWNERSHIP</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
984
change (password)
Description
Action & object
action = change
object = password
Usage
Changes the password of the profile associated with the cookie.
Note: After issuing this action, you should delete the current cookie and set
another in order to keep the profile information current.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
reg_password
Required
985
request
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
986
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PASSWORD</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
987
send_authcode
Description
Action & object
action = send_authcode
object = domain
Usage
Sends the Authcode for an EPP domain to the admin contact. If the domain
for which the request is made does not use the EPP protocol, an error is
returned.
Note: A cookie does not need to be set to use this command.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain_name
Required
request
988
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
989
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">domain</item>
<item key="response_text">Message sent</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
990
send_password (domain)
Description
Action & object
action = send_password
object = domain
Usage
Sends an email containing the domain password to the domain's admin
contact.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain_name
Required
send_to
Required
sub_user
Required
1Send to sub-user
991
request
992
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">domain</item>
<item key="response_text">Message sent</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
993
Cookie/Session Commands
This section contains the following commands:
connection.
set (cookie)Creates a cookie.
994
delete (cookie)
Description
Action & object
action = delete
object = cookie
Usage
Deletes a cookie.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
cookie
Required
domain
Required if
cookie is not
submitted as
credentials
995
request
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
996
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">COOKIE</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
997
quit (session)
Description
Action & object
action = quit
object = session
Usage
Cleanly terminates the connection. This command is required only if your
connection method is CBC (crypt type can be Blowfish or DES).
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
998
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">quit</item>
<item key="object">session</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SESSION</item>
<item key="response_text">Closing connection</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
999
set (cookie)
Description
Action & object
action = set
object = cookie
Usage
Creates a cookie for use in commands where a cookie is required to access
OpenSRS.
The cookie lasts for one hour.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
reg_password
Required
reg_username
Required
1000
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
attributes
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
cookie
Returned if
The current user's cookie.
is_success = Note: The format of the cookie is subject to
true
change, and should be treated as a simple
string.
domain_count
Returned if
The number of domains in the registrant
is_success = profile.
true
Note: The domain_count for a sub-user is
always 0, because a sub-user cannot be
linked with more than one domain.
expiredate
Returned if
The expiry date of the domain, in the format
is_success = YYYY-MM-DD hh:mm:ss.
true
f_owner
Returned if
A flag indicating whether the current user is
is_success = the owner of the domain(s):
true
0User is not owner
1User is owner
last_access_time
Returned if
When the account was last accessed,
is_success = expressed in seconds since Epoch.
true
last_ip
Returned if
The last IP address used.
is_success =
true
permission
Returned if
An indication of the permission level of the
is_success = domain's sub-user. The permission value is a
true
bit mask that indicates which portions of the
domain information are changeable by the
sub-user.
1001
Parameter name
redirect_url
Obligation
Optional
Definition/Value
1Owner
2Admin
4Billing
8Tech
16Nameservers
32Rsp_whois_info
waiting_requests_no
Returned if
The number of registry requests in the
is_success = waiting state.
true
Deprecated
Parameter name
Obligation
Definition/Value
waiting_request
Deprecated
Replaced by "waiting_requests_no"
1002
<item key="registrant_ip">216.40.46.115</item>
<item key="attributes">
<dt_assoc>
<item key="reg_username">robson</item>
<item key="reg_password">changeit</item>
<item key="domain">example.co.uk</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">reply</item>
<item key="object">cookie</item>
<item key="response_text">Command Successful</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="attributes">
<dt_assoc>
<item key="waiting_requests_no">0</item>
<item key="permission"/>
<item key="cookie">920954818:3214550:7453745</item>
<item key="domain_count">131</item>
<item key="f_owner">1</item>
1003
<item key="last_access_time">1082751795</item>
<item key="encoding_type"/>
<item key="last_ip">10.0.11.215</item>
<item key="expiredate">2007-11-25 00:00:00</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1004
update (cookie)
Description
Action & object
action = update
object = cookie
Usage
Allows the client to change the domain associated with the current cookie.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required if
cookie is not
submitted
domain_new
Required
reg_username
Required
reg_password
Required
request
1005
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter name
Obligation
Definition/Value
cookie
Returned if
The current user's cookie.
is_success = Note: The format of the cookie is subject to
true
change, and should be treated as a simple
string.
domain_count
Returned if
The number of domains in this profile.
is_success = Note: The domain_count for a sub-user is
true
always 0, as a sub-user cannot be linked with
more than one domain.
expiredate
Returned if
The domain's expiry date in the format YYYYis_success = MM-DD hh:mm:ss.
true
f_owner
Returned if
A flag indicating whether the current user is
is_success = the owner of the domain(s):
true
0User is not owner
waiting_requests_no
1User is owner
Returned if
The number of registry requests in the
is_success = waiting state.
true
Deprecated
Parameter name
Obligation
Definition/Value
waiting_request
Deprecated
Replaced by "waiting_requests_no"
1006
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">update</item>
<item key="object">cookie</item>
<item key="registrant_ip">10.0.11.121</item>
<item key="attributes">
<dt_assoc>
<item key="domain_new">example.me.uk</item>
<item key="reg_username">robson</item>
<item key="domain">example.co.uk</item>
<item key="reg_password"/>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">COOKIE</item>
1007
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command Successful</item>
<item key="attributes">
<dt_assoc>
<item key="waiting_requests_no">2</item>
<item key="f_owner">1</item>
<item key="cookie">880117898:3214551:7453745</item>
<item key="domain_count">172</item>
<item key="expiredate">2007-11-25 00:00:00</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1008
1009
change_wp_expiry_date
Description
Action & object
action = change_wp_expiry_date
object = domain
Usage
Changes the expiry date for the WHOIS Privacy service for a domain.
Important: This command has been deprecated.
WHOIS Privacy is now a free service and does not have an expiry date. If this
command is part of your current integration, it continues to work; however,
the resulting expiry date is ignored.
To disable the WHOIS Privacy service, use the modify (domain) command
with the whois_privacy_state parameter.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
expiry_day
Required
1010
Parameter
name
Obligation
Definition/Value
expiry_month
Required
expiry_year
Required
request
1011
<item key="object">domain</item>
<item key="cookie">199316337:3893</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="expiry_month">12</item>
<item key="expiry_day">05</item>
<item key="expiry_year">2009</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_text">Expiry date successfully
updated</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1012
1013
create_alias
Description
Action & object
action = create_alias
object = publishing
Usage
Creates an alias for a mobile domain. You can create up to five aliases per
subscription so that multiple hostnames can point to the same goMobi page;
however, each alias must be created separately.
Important: Ensure that the DNS for each of the alias hostnames points to
lb.goMobi.info.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
hostname
Required
service_type
Required
1014
object = publishing
is_success = a Boolean is returned, indicating success or failure of the
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
1015
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Created alias 'example.net'
for 'example.com'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1016
create (publishing)
Description
Action & object
action = create
object = publishing
Usage
Creates a new goMobi domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required
end_user_auth_info
Optional
service_type
Required
source_domain
Optional
Note: If you do not specify a username and password, the service will work;
however, the domain owner will not be able to access the end user control
panel at domainadmin.com. In that case, you can either provision the
domain for your customer or you can provide your own end user interface.
Parameter
name
Obligation
Definition/Value
email_address
Required if
The domain owner's email address.
end_user_auth_info is
specified and this is a
new account
password
Required if
The password associated with the
end_user_auth_info is Publishing service. The password must be
specified and this is a
at least 8 characters long.
new account
username
Required if
The username associated with the
end_user_auth_info is Publishing service. The username must be
specified
at least 6 characters long.
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
1018
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">CREATE</item>
<item key="object">PUBLISHING</item>
<item key="attributes">
<dt_assoc>
<item key="service_type">gomobi</item>
<item key="domain">example.net</item>
<item key="source_domain">example.com</item>
<item key="end_user_auth_info">
<dt_assoc>
<item key="email_address">danny@example.com</item>
<item key="password">BigPWTest</item>
<item key="username">danny1234</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
1019
<item key="object">PUBLISHING</item>
<item key="response_text">Publishing service created</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1020
delete_alias
Description
Action & object
action = delete_alias
object = publishing
Usage
Deletes a goMobi domain alias.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation Definition/Value
domain
Required
hostname
Required
service_type
Required
request
1021
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
1022
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Deleted alias
'example.net' for
'example.com'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1023
delete (publishing)
Description
Action & object
action = delete
object = publishing
Usage
Deletes a goMobi domain.
Warning: This command deletes the account immediately.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
service_type
Required
request
1024
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
1025
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Deleted 'gomobi' service for
'example.net'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1026
disable (publishing)
Description
Action & object
action = disable
object = publishing
Usage
Disables a goMobi domain. This command causes the mobile domain to be
inaccessible; however, you are still charged for the service, and you can reenable the domain by using the enable (publishing) command. If you want to
stop billing, you need to delete the account by using the delete (publishing)
command.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
service_type
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Disabled 'gomobi' service for
'example.net'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
enable (publishing)
Description
Action & object
action = enable
object = publishing
Usage
Re-enables a goMobi domain that has been disabled or set to let-expire.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
service_type
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
1030
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
1031
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Enabled 'gomobi' service for
'example.net'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1032
Usage
Generate code that redirects visitors to either the source domain or the
mobile domain, depending on the device theyre using.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required
programming_language
Required
service_type
Required
asp
htaccess
javascript
jsp
php
1033
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
redirection_code
Returned if
The code that you insert in your source website
is_success = that redirects visitors to the source or the mobile
true
site depending on the device they're using to
access it.
1034
Sub-Reseller Commands
<dt_assoc>
<item key="programming_language">javascript</item>
<item key="service_type">gomobi</item>
<item key="domain">example.net</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Got GoMobi redirection code (javascript)
for 'example.net'</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="attributes">
<dt_assoc>
<item key="redirection_code"><script type="text/javascript"
src="http://detect.deviceatlas.com/redirect.js?
d=http://example.com&m=http://example.net"></script></item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
1035
Sub-Reseller Commands
</OPS_envelope>
1036
get_alias_list
Description
Action & object
action = get_alias_list
object = publishing
Usage
Returns a list of the aliases associated with the specified mobile domain.
Attributes
Parameters within the attributes associative array are described below.
Parameter name
Obligation
Definition/Value
domain
Required
service_type
Required
request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
attributes
1037
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
aliases
Returned if
is_success = true
domain
Returned if
is_success = true
1038
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Service information retrieved.</item>
<item key="attributes">
<dt_assoc>
<item key="domain">example.com</item>
<item key="aliases">
<dt_array>
<item key="0">example.net</item>
<item key="1">example.org</item>
<item key="2">example.info</item>
<item key="3">example.biz</item>
<item key="4">example.us</item>
</dt_array>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1039
get_control_panel_url
Description
Action & object
action = get_control_panel_url
object = publishing
Usage
Returns the URL for the goMobi control panel that you use to define the
appearance of the mobile site.
Important: This link is only available for 5 minutes.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
language
Optional
deGerman
enEnglish (US)
en-GBEnglish (UK)
esSpanish
frFrench
itItalian
jaJapanese
nlDutch
1040
service_type
Obligation
Required
Definition/Value
ptPortuguese
ruRussian
slSlovenian
zh-CNChinese
request
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
control_panel_url
Returned if
The URL for the goMobi control panel that you
is_success = use to define the appearance of the mobile site.
true
1041
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Got GoMobi control-panel URL for
'example.net'.</item>
1042
1043
Usage
Gets information about the goMobi service.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
service_type
Required
request
1044
Transfer Commands
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter
name
Obligation
Definition/Value
aliases
Returned if
The list of aliases associated with the domain.
aliases exist
and
is_success =
true
billing_date
Returned if
The next billing date for the goMobi service.
is_success =
true
creation_date
Returned if
The date the goMobi service was purchased.
is_success =
true
domain
Returned if
The name of the mobile domain.
is_success =
true
gomobi
Returned if
Lists information about the goMobi service.
is_success = For more information, see the gomobi table below.
true
status
Returned if
The current status of the goMobi service.
is_success = Allowed values are:
true
activeThe service is active.
1045
Transfer Commands
gomobi
Parameters within the gomobi associative array are described below.
Parameter
name
Obligation
Definition/Value
source_domain
Always
returned
1046
Transfer Commands
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Service information retrieved.</item>
<item key="attributes">
<dt_assoc>
<item key="service_type">gomobi</item>
<item key="gomobi">
<dt_assoc>
<item key="source_domain">example.com</item>
</dt_assoc>
</item>
<item key="domain">example.net</item>
<item key="creation_date">2010-11-26 12:33:03 UTC</item>
<item key="status">active</item>
<item key="aliases">
<dt_array>
<item key="0">example.net</item>
<item key="1">example.org</item>
<item key="2">example.info</item>
<item key="3">example.biz</item>
<item key="4">example.us</item>
</dt_array>
1047
Transfer Commands
</item>
<item key="billing_date">2010-12-26 12:33:03 UTC</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1048
Usage
Sets a goMobi domain to expire at the end of the billing period. Until that
time, you can re-enable the domain by using the enable (publishing)
command.
Attributes
Parameters within the attributes associative array are described below.
Parameter
name
Obligation
Definition/Value
domain
Required
service_type
Required
request
response_code = response code indicating outcome of the request
1049
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
1050
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Let 'gomobi' service for 'example.net'
expire.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1051
update publishing
Description
Action & object
action = update
object = publishing
Usage
Changes the name of the mobile domain, and, optionally, changes the
domain from which the mobile domain gets its content.
Attributes
Parameters within the attributes associative array are described below.
Parameter name Obligation
Definition/Value
domain
Required
new_domain
Optional
service_type
Required
source_domain
Required
request
1052
Response
<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
1053
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">PUBLISHING</item>
<item key="response_text">Updated 'gomobi' service for
'example.net' with source-domain 'example303.com' and new domain
'example123.net'.</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
1054
1055
Regular transfers
Key
Value
action
Confirm
domain
<domain_name>
id
<transfer_request_id>
action
whois_transfer
domain
<domain_name>
unique_id
<transfer_request_id>
action
do_confirm
domain
<domain_name>
unique_id
<transfer_request_id>
phone
phone_number
action
cancel_transfer
domain
<domain_name>
unique_id
<transfer_request_id>
Page flow
Notes:
Bulk transfers
Key
Value
action
confirm_bulk_transfer
bt
bulk_transfer_id
id
<transfer_request_id>
action
do_confirm_bulk_transfer
bulk_transfer_id
unique_id
<transfer_request_id>
phone
phone_number
action
cancel_bulk_transfer
domain
<domain_name>
unique_id
<transfer_request_id>
Page flow
Notes:
The Confirm page must contain the string 'Listed below are the
domains that will be transferred:' (List of domains located between
<menu> </menu>).
The Success page must contain the string 'Thank you for confirming
batch transfer'.
The Cancel page must contain the string 'has been cancelled'.
Transfers away
Key
Value
action
confirm_transfer_away
away
domain
<domain_name>
id
<transfer_request_id>
action
do_confirm_away
domain
<domain_name>
1057
unique_id
<transfer_request_id>
phone
phone_number
action
do_cancel_away
domain
<domain_name>
unique_id
<transfer_request_id>
Page flow
Notes:
The Confirm page must contain the string 'away from' (To include time
and registrar name, the page must also contain the string 'this request
was entered at <date> by <registrar>').
The Success page must contain the string 'Thank you. Your domain will
be transferred to'.
The Cancel page must contain the string 'Thank you. Your domain will
NOT be transferred to'.
1058
Language code
Afrikaans
AFR
Albanian-ALB
ALB
Arabic
ARA
Aragonese
ARG
Armenian-ARM
ARM
ASCII
Assamese
ASM
Asturian; Bable
AST
Avestan
AVE
Awadhi
AWA
Azerbaijani
AZE
Balinese
BAN
Baluchi
BAL
Basa
BAS
Bashkir
BAK
Basque-BAQ
BAQ
Belarusian
BEL
Bengali
BEN
Bhojpuri
BHO
Bosnian
BOS
Bulgarian
BUL
Burmese-BUR
BUR
Carib
CAR
Catalan
CAT
Chechen
CHE
1059
Language
Language code
Chinese-CHI
CHI
Chuvash
CHV
Coptic
COP
Corsican
COS
Croatian-SCR
SCR
Czech-CZE
CZE
Danish
DAN
Divehi
DIV
Dogri
DOI
Dutch-DUT; Flemish
DUT
English
ENG
Estonian
EST
Faroese
FAO
Fijian
FIJ
Finnish
FIN
French-FRE
FRE
Frisian
FRY
GLA
Georgian-GEO
GEO
German-GER
GER
GRE
Gondi
GON
Gujarati
GUJ
Hebrew
HEB
Hindi
HIN
Hungarian
HUN
Icelandic-ICE
ICE
Indic (Other)
INC
1060
Language
Language code
Indonesian
IND
Ingush
INH
Irish
GLE
Italian
ITA
Japanese
JPN
Javanese
JAV
Kashmiri
KAS
Kazakh
KAZ
Khmer
KHM
Kirghiz
KIR
Korean
KOR
Kurdish
KUR
Lao
LAO
Latvian
LAV
Lithuanian
LIT
Luxembourgish; Letzeburgesch
LTZ
Macedonian-MAC
MAC
Malayalam
MAL
Malay-MAY
MAY
Maltese
MLT
Maori-MAO
MAO
Mixed (English) *
ENG
Moldavian
MOL
Mongolian
MON
Nepali
NEP
None specified
NO
Norwegian
NOR
Oriya
ORI
1061
Language
Language code
Ossetian; Ossetic
OSS
Panjabi
PAN
Persian-PER
PER
Polish
POL
Portuguese
POR
Pushto
PUS
Rajasthani
RAJ
Romanian-RUM
RUM
Russian
RUS
Samoan
SMO
Sanskrit
SAN
Sardinian
SRD
Serbian-SCC
SCC
Seychelles
SCR
Simplified Chinese
ZH-CN
Sindhi
SND
Sinhalese
SIN
Slovak-SLO
SLO
Slovenian
SLV
Somali
SOM
Spanish; Castilian
SPA
Swahili
SWA
Swedish
SWE
Syriac
SYR
Tajik
TGK
Tamil
TAM
Telugu
TEL
Thai
THA
1062
Language
Language code
Tibetan-TIB
TIB
Traditional Chinese
ZH-TW
Turkish
TUR
Ukrainian
UKR
Urdu
URD
Uzbek
UZB
Vietnamese
VIE
Welsh-WEL
WEL
Yiddish
YID
1063
May 5, 2014
1064
January 7, 2014
December 3, 2013
When submitting sunrise orders for the new gTLDs, you must submit
the following parameters and values with the sw_register command:
trademark_smd, reg_type = sunrise, and handle = save.
October 8, 2013
Added information about the tld_data requirements for .DE and .DK
domains.
1065
Added a table listing the contacts required for each gTLD and ccTLD.
You can now generate coupon codes for Fotolia that are worth 10 free
Fotolia credits, and MightyCall codes that are worth 30 minutes of
MightyCall ClickConnect service.
November 1, 2012
You can now secure more than one domain under a single SSL
certicate for these products:
GeoTrust QuickSSL Premium (subdomains only), TrueBusiness ID
EV, and TrueBusiness ID
SymantecSecure Site EV, Secure Site Pro EV, Secure Site Pro, and
Secure Site
ThawteSGC Super Certs, SSL Web Server EV, and SSL Web
Server Certificate
You can now use the update_product command to specify whether or
not renewal reminder emails are sent when a Trust Service product is
approaching its expiry date.
You can now use the update_order command to add or change the
additional domains in a Trust Service order.
1066
July 5, 2012
1067
May 8, 2012
In the Offers Manager, you can now generate a Ting coupon code
worth $50 USD that your customers can use toward the purchase of a
Ting mobile device. You receive a share of the net revenue that is
generated by the fees that the customer pays during their first 24
months of service.
May 1, 2012
As of April 17, 2012, you can use the OpenSRS API to renew and
manage SSL certificates that were ordered through the TPP API. All
SSL orders that were placed through the TPP system will be migrated
to the OpenSRS API by April 20, after which all purchasing and
management of OpenSRS Trust products must be done through the
OpenSRS API or the OpenSRS Control Panel as the TPP API and the
RWI2 are decommissioned.
The get_product_info command now includes two additional request
parameters all_info and inventory_item_id - that facilitate searches
of products that were migrated from TPP. For products that were
migrated from TPP, the command result includes the following
parameters: tpp_order_id and inventory_item_id.
The sw_register command now includes the new parameter
base_order_id, which allows you to create a new order based on a
previous order.
The maximum registration period for Trust Service products is now
four years.
Incremented version to 4.0.4.
You can now generate Offer codes that your customers can use toward
payment processing services with Host Merchant Services (HMS). Each
1068
coupon is worth $75 USD and you benefit by earning a percent of the
net revenue that is generated by the customer's processing fees to
HMS.
Incremented version to 4.0.3.
December 8, 2011
December 6, 2011
Free 30 day trials are available for the following Trust Service
products:
GeoTrustTrue BusinessID with EV
TRUSTeHosted Privacy Policy (HPP) and Privacy Policy with Seal
(TPS)
VeriSignSecureSite, Secure Site Pro, Secure Site with EV, and
Secure Site Pro with EV
Incremented version to 3.9.5.
1069
November 8, 2011
November 1, 2011
In addition to Google AdWords, you can now generate Offer codes for
Google AdWords Express.
Added the following Trust Service product: GeoTrust Web Site AntiMalware Scan.
You can now specify the email address to which the Domain Admin
credentials are sent for SiteLock and TRUSTe products.
Incremented version to 3.9.4.
You can now use the redeem domain command to redeem .COM, .NET,
.IT, and .NL domains that have expired but are within the redemption
grace period (previously this command could only be used for .CA)
The create, modify, delete and get nameserver commands now accept
IPv6 addresses.
Incremented version to 3.9.3.
October 6, 2011
1070
SiteLock Premium
SiteLock SMB Enterprise Secure
TRUSTe HPP (Hosted Privacy Policy)
TRUSTe TPS (TRUSTe Privacy Policy with seal)
Incremented version to 3.9.
September 7, 2011
Added information to sw_register and get_order_info sections about
the additional parameters required for .XXX Sunrise applications.
The .XXX Sunrise period begins September 7, 2011.
1071
December 9, 2010
Added a new parameter to the get domain command called
clean_ca_subset, which determines the type of contact_set values
that are returned for .CA domains when type = admin or tech.
November 30, 2010
Added the following new commands for Publishing Service:
create (publishing)Creates a new goMobi domain.
delete (publishing)Deletes a goMobi domain.
disable (publishing)Disables a goMobi domain.
enable (publishing)Re-enables a goMobi domain that has been
disabled or set to let-expire.
let expire (publishing)Sets a goMobi domain to expire at the
end of the billing period.
generate_redirection_codeGenerate code that redirects
visitors to either the source domain or the mobile domain,
depending on the device theyre using.
get_control_panel_urlReturns the URL for the goMobi control
panel that you use to define the appearance of the mobile site.
get_service_infoGets information about the goMobi service.
1072
October 5, 2010
Added information to the sw_register and get_order_info commands
for Trust Services.
Added the following new commands for Trust Services:
cancel_orderCancels a Trust Service order.
get_product_infoQueries the properties of the specified Trust
Service product.
parse_csrParses the CSR and identifies its data elements.
1073
1074
March 5, 2010
The name_suggest domain command has been enhanced to allow you
to:
Search for personal names.
Specify the language (English, German, Italian, and Spanish) in
which to return suggestions for other similar names
Specify the number of seconds that the command can run, and
return as many results as can be found in that time period.
Resubmit a previously run name_suggest command if the
command did not return complete results during the specified
max_wait_time.
Deprecated the name_suggest (surname) command.
There is a new command called create_reseller which creates a new
Reseller account; however, this command is disabled by default. To be
enabled for this command, contact reseller.support@tucows.com.
Incremented the version to 3.4.
January 23, 2010
As of January 23, 2010, .ORG supports IDNs for Simplified Chinese
and Traditional Chinese.
December 3, 2009
As of December 10, 2009, .EU supports IDNs
November 7, 2009
Internationalized Domain Name (IDN) are now supported for .NAME
domains.
November 3, 2009
Added the following parameters to sw_register:
cwaindicates where the Registrar can change the Organization or
Admin Contact information for the domain without submitting the
request to the registry (CIRA) for processing.
rant_agreesindicates whether the registrant has read and
agrees with the CIRA Registrant Agreement. If rant_agrees = 1,
registration is processed immediately, and the confirmation email is
not sent.
October 8, 2009
Added six new commands for enabling and configuring the DNS
service:
create_dns_zone enables the DNS service for a domain
delete_dns_zone deletes the DNS zones defined for the specified
domain
1075
August 6, 2009
OpenSRS allows you to operate your own network of domain name
Resellers. Sub-Resellers operate very much like any other OpenSRS
Reseller; however, you are considered to be the parent Reseller for
your Sub-Resellers. You set the pricing plans for them, and you earn
commissions on the domains that they sell. See the Sub-Reseller
Commands section for the related API commands.
March 17, 2009
Added two new search parameters for the get_transfer_in command:
order_id and transfer_id. Also, transfer_id is now included in the
response.
For the sw_register command when reg_type=transfer, transfer_id is
now included in the response.
February 27, 2009
For Personal Names, the forward_only email account type has been
deprecated and replaced by the webmail_only account type (no
IMAP/POP/SMTP). This change affects the su_register surname and
update surname commands.
February 10, 2009
Added skip_registry_lookup parameter to name_suggest (domain)
API. This parameter specifies whether to query the applicable
1076
registries to find out if the lookup domain names are available for
registration.
Added transfer_away_in_progress attribute to response for get
domain API when type = status. This attribute indicates that the
domain is in the process of being transferred away.
1077
1078
1079
The sunrise period for the .MOBI TLD is open from 22 May 2006 to 29
May 2006 for members of specific mobile associations. Trademark
holders who are not members of the designated mobile associations
may submit sunrise applications from 12 June 2006 - 21 August 2006.
The SW Register command has been updated to support .MOBI
Sunrise applications.
May 2, 2006
The 'change_contact' parameter in the SW Register command can now
be used to change contact information for .UK/.US/.BIZ/.INFO/.ORG
domains during a transfer or after transfer completion.
1080
To remove the expiration date for WHOIS Privacy, submit the Change
WHOIS Privacy Expiry Date command leaving the day, month, and
year parameters blank.
Updated the Get Domain command when 'type' = 'status' to return
parameter 'parkp_status', indicating whether the domain is enabled
for Parked Pages service.
Individual .EU domain registrants can keep their name private in the
WHOIS record by leaving the 'owner' 'org_name' field blank when
submitting the SW Register command.
Added parameters 'registry_updatedate', 'registry_expiredate',
'registry_createdate', and 'registry_transferdate' to the Get Domain
command.
1081
1082
November 4, 2005
Revised tld_data description to indicate that it is only used for .NAME
and .US domains.
September 12, 2005
Incremented document version to 2.9.3.
Pending orders older than 30 days, and with 30 days of inactivity, will
be cancelled automatically.
The Renew Domain command now returns the admin_email
parameter, which contains the email address of the domains
administrative contact.
German IDNs for .INFO now supported.
July 23, 2005
Incremented document version to 2.9.2.
IDN conversion for .ORG, for nine languages is now supported. See
Encoding Types for IDNs for more information.
June 20, 2005
Incremented document version to 2.9.1.
Added the "Bulk Purchase WHOIS Privacy" command, which enables
the purchase of WHOIS Privacy for multiple domains.
May 12, 2005
Updated the "SW Register Domain" command to include the
"custom_transfer_nameservers" attribute, which allows you to specify
whether to use the nameservers provided in the request or keep the
domain's existing nameservers when transferring a domain.
May 5, 2005
All changes posted for this date have been promoted to the Horizon
environment, and will be promoted to live on May 12, 2005.
Incremented document version to 2.9.0.
Added new command "Advanced Update Nameservers" which allows
you to assign, add, or remove nameservers for a domain.
Added new command "CIRA Send Approval Email", which resends the
CIRA registration approval email message to the domain's contact.
Added new command "Cancel Pending or Declined order".
Updated the "Check Domain Transfer" command to include the
"check_status" attribute in the request. When "status" is submitted,
and the transfer state is returned as 'pending_registry' and the
Registry shows Tucows as the Registrar of record, OpenSRS will initiate
the completion of .UK transfers, or schedule the completion of gTLD
transfers.
1083
1084
1085
1086
1087
October 8, 2003
Added optional command=>cancel attribute to the Process Pending
Order command.
Added command Process Transfer which allows the client to
resubmit failed transfers.
Added command Cancel Transfer which allows the client to cancel
transfers that are pending owner approval.
September 15, 2003
Reorganized Get Domain section.
September 12, 2003
Reorganized Modify Domain section.
Removed Buy Web Cert command as it's no longer functional and
has been replaced with TPP Certs functionality.
September 10, 2003
Added several XML examples throughout document.
Changed 'Revoke Domain' to 'Refund Domain'.
August 28, 2003
Added Revoke Domain.
August 12, 2003
Corrected CIRA E-mail Password.
July 22, 2003
Added CIRA E-mail Password.
Updated 'timestamp' description for Check Domain Transfer.
Updated 'currentexpirationyear' description for Renew Domain.
July , 2003
Updated description of 'custom_nameservers' attribute for
SW_Register Domain
July 3, 2003
Removed 'bulk_order' from sw_register examples
Updated info re: the 'remainder' attribute for Get Domain
May 26, 2003
Added response value 'request_address' in Check Domain Transfer
Updated Modify Domain with information regarding the modification of
owner contacts for dot.de domains.
1088
April 9, 2003
Updated information for the following commands:
Activate Domain - NEW
Belongs_to_RSP Domain - NEW
Get Domain
Get User Info
1089
1090
1091