API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

get (userinfo)

Retrieves a user's general information.

Request parameters for get (userinfo)

Standard parameters

  • action = get
  • object = user_info

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The relevant domain.

Response parameters for get (userinfo)

Standard parameters

  • action = reply
  • object = userinfo
  • 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

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 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

Returned if is_success = true

An associative array containing parameters specific to the action.

dns_errors

Returned for .DE if is_success = true

This contains the DNS errors if any, in text format .DE only

domain

Returned if is_success = true

Fully qualified domain name. IDN names are returned in Punycode for .COM/.NET and in RACE for .ORG.

domain_count

Returned if is_success = true

Total number of domains in the current user profile. A domain count > 1 indicates that the get domain list action is possible.

encoding_type

Optional

Encoding type for the domain. For a list of languages and codes, see
Appendix C: Encoding Types for IDNs”.

expiredate

Returned if is_success= true

Expiration date for the domain as specified in the 'domain' field.

f_owner

Returned if is_success= true

A flag indicating whether the current user is the owner of the domain(s).

If set to 1 then the current user is the owner of the domain, if set to 0, then the user is a subuser of the domain and may only be authorized to do certain actions.

permission

Returned if is_success = true

An associative array containing parameters specific to the action.

  • 1—Owner
  • 2—Admin
  • 4—Billing
  • 8—Tech
  • 16—Nameservers
  • 32—Rsp_whois_info

username

Returned if is_success = true

The sub-user's username

waiting_requests_no

Returned if is_success = true

The number of registry requests in the waiting state.

Capabilities

Parameters within the capabilities associative array are described below.

Parameter name
Obligation
Definition/Value

change_ips_tag

Optional

Indicates if option is available for end user to change the Domain Tag; applicable to .UK domains only.

  • 1—Option available for end user to change Domain Tag

  • 0—Option not available for end user to change Domain Tag

domain_auth_info

Always returned

Secret pass phrase stored at the registry, which is used to authorize transfers of domains.

  • 1—True

  • 0—False

The absence of a key also signifies false.

dnssec

Always returned

Indicates whether DNSSEC is supported for domain.

  • 1—True

  • 0—False

forwarding_email

Always returned

Some TLDs offer an email forwarding service. Often the end user must explicitly purchase this service.

  • 1—True

  • 0—False

The absence of a key also signifies false.

uk_whois_opt

Optional

Indicates if option is available for end user to opt out of display of personal information in WHOIS for .UK. The WHOIS opt-out is available for .UK domains only, and only to individuals (i.e. not corporations).

  • 1—End user is eligible to use the opt-out feature for .UK WHOIS

  • 0—End user is not eligible to use the opt- out feature for .UK WHOIS

Examples for get (userinfo)

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">USERINFO</item>
                <item key="registrant_ip">216.40.46.115</item>
                <item key="domain">yourdomain.com</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">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="dnssec">1</item>
                                <item key="uk_whois_opt">1</item>
                                <item key="change_ips_tag">1</item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

get (userinfo)

Retrieves a user's general information.