Request and Response Format

The client and the server exchange SOAP messages via HTTP::POST.

REQUEST

<?xml version="1.0"?> <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"
SOAP:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

The header of the request message contains the userid and password of the partner who sent the request.
This is the same userid and password used to login to the Registrar Console.
T:UserID - partner userid, T:Password - partner password
T:Source - For tracking purposes. This can be used to identify the site that sent the request.


<SOAP:Header>
<T:Tran>
<T:ID></T:ID>
<T:UserID>i-register</T:UserID>
<T:Password>i-register1</T:Password>
<T:Source/>
</T:Tran>
</SOAP:Header>

<SOAP:Body>




 Valid REQUESTS are:
 
  • Job
        Requests that would result to an update to the MySRS Database or NZ Registry (RegisterDomain, EditDomainInfo, EditNameServers, RenewDomain)
     
  • GetDomainInfo
        Returns Domain Information stored in the MySRS Database
     
  • CheckDomain
        Determines availability of domains
     
  • GetJobs
        Returns the Jobs executed by the partner
     
  • GetJobDetails
        Returns details of a specific Job
     
  • GetWhoisRequest
        Returns the domain WHOIS



    • <[REQUEST]>
    <[REQUEST PARAMETERS]/>
    </[REQUEST]>

    </SOAP:Body>
    </SOAP:Envelope>

    RESPONSE

    Server response varies per transaction. The server either returns a fault message, an invoice, or the information requested (i.e., availability of domains for the CheckDomain request)

    Fault
    a component of a SOAP message that contains error information

    Example: Fault 502, registering a domain that already exists

    <?xml version="1.0"?>
    <SOAP:Envelope
    xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" SOAP:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP:Header>
    <T:Tran xmlns:T="http://dotph.com">
    <T:ID></T:ID>
    </T:Tran>
    </SOAP:Header>
    <SOAP:Body>
    <SOAP:Fault>
    <faultcode>502</faultcode>
    <faultstring>Domain name not available</faultstring>
    <faultactor>serverURI</faultactor>
    <detail>RegisterDomain-The online search showed that the domain name specified was still available at the time. Unfortunately, the domain has since been paid and registered by another user.</detail>
    </SOAP:Fault>
    </SOAP:Body>
    </SOAP:Envelope>

    Invoice
    An invoice is returned by successful Job requests.
    It contains a list of operations performed (JD), the total charges (Total attribute of Invoice), and the transaction tracking number (id attribute of Invoice).

    Example: Invoice 38038 generated for the registration of mysrs.co.nz for 2 years at $50

    <?xml version="1.0"?>
    <SOAP:Envelope
    xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" SOAP:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP:Header>
    <T:Tran>
    <T:ID></T:ID>
    </T:Tran>
    </SOAP:Header>
    <SOAP:Body>
    <JobResponse>
    <return><![CDATA[
    <Invoice Total="50" id="38038" currency="nzd">
    <Domain name="mysrs.co.nz">
    <JD type="RegisterDomain" duration="2" cost="50.00" currency="nzd"></JD>
    <Charges total="50" currency="nzd"/></Domain>
    </Invoice>
    ]]>
    </return>
    </JobResponse>
    </SOAP:Body>
    </SOAP:Envelope>

    Response to Requests other than Job

    Example: CheckDomain Request for mysrs.co.nz

    <?xml version="1.0"?>
    <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"
    SOAP:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP:Header>
    <T:Tran xmlns:T="http://dotph.com">
    <T:UserID>i-register</T:UserID>
    <T:Password>i-register1</T:Password>
    </T:Tran>
    </SOAP:Header>
    <SOAP:Body>

    <CheckDomain>
    <domain>mysrs</domain>
    </CheckDomain>

    </SOAP:Body>
    </SOAP:Envelope>

    Example: Response to the CheckDomain Request

    <?xml version="1.0"?>
    <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" SOAP:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP:Header>
    <T:Tran xmlns:T="http://dotph.com">
    <T:ID/>
    </T:Tran>
    </SOAP:Header>
    <SOAP:Body>


    <CheckDomainResponse><return><![CDATA[<Domains>
    <Dom name="mysrs">
    <Ext xt=".co.nz" st="NA" />
    <Ext xt=".net.nz" st="AV" />
    <Ext xt=".org.nz" st="AV" />
    <Ext xt=".ac.nz" st="AV" />
    <Ext xt=".gen.nz" st="AV" />
    <Ext xt=".geek.nz" st="AV" />
    <Ext xt=".maori.nz" st="AV" />
    <Ext xt=".school.nz" st="AV" />
    </Dom>
    ...
    </Domains>
    ]]></return>
    </CheckDomainResponse>

    </SOAP:Body>
    </SOAP:Envelope>


    July 28, 2004


    [ Back ]