ZA EPP Contact Extensions

 

Contact Info Including Linked Domains

 
Notes

1. Domain Listing is a custom extension to the standard Contact Info EPP command.

2. The listing will provide up to a maximum of 100 domain names that are linked to the specified contact ID.

3. The 100 domains are the most recent 100 domains associated with the contact.

4. A domain listing cannot be obtained for contact objects taht do not belong to the requesting registrar.

5. To successfully obtain the listing, the <cozacontact:domainListing> element must be used in the extension declaration, with an element value of "true".

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
xmlns:cozacontact="http://co.za/epp/extensions/cozacontact-1-0">
  <epp:command>
    <epp:info>
      <contact:info>
        <contact:id>contactID</contact:id>
      </contact:info>
    </epp:info>
    <epp:extension>
      <cozacontact:info>
        <cozacontact:domainListing>true</cozacontact:domainListing>
      </cozacontact:info>
    </epp:extension>
  </epp:command>
</epp:epp>

 

Possible Responses

 
1000: Info Command Completed Successfully


Notes


A response code of 1000 means taht the server has processed the command. A listing of the most recent 100 domains linked to the contact will be displayed at the end of the request, in the extension section. The rest of the information for the contact will also be provided.

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
xmlns:cozacontact="http://co.za/epp/extensions/cozacontact-1-0">
  <epp:response>
    <epp:result code="1000">
      <epp:msg>Contact Info Command completed successfully</epp:msg>
    </epp:result>
    <epp:resData>
      <contact:infData>
        <contact:id>contactID</contact:id>
        <contact:roid>CTC_2-COZA</contact:roid>
        <contact:status s="ok"/>
        <contact:status s="linked"/>
        <contact:postalInfo type="loc">
          <contact:name>Test Contact</contact:name>
          <contact:org/>
          <contact:addr>
            <contact:street>Street 1</contact:street>
            <contact:street>Stree 2</contact:street>
            <contact:city>Contact City</contact:city>
            <contact:sp>Contact Province</contact:sp>
            <contact:pc>12345</contact:pc>
            <contact:cc>AB</contact:cc>
          </contact:addr>
        </contact:postalInfo>
        <contact:voice>+27.115551234</contact:voice>
        <contact:fax>+86.5551234</contact:fax>
        <contact:email>test@example.zoneza</contact:email>
        <contact:clID>currentRegistrar</contact:clID>
        <contact:crID>createRegistrar</contact:crID>
        <contact:crDate>2011-02-07T12:39:43Z</contact:crDate>
        <contact:upID>currentRegistrar</contact:upID>
        <contact:upDate>2011-02-07T12:39:43Z</contact:upDate>
      </contact:infData>
    </epp:resData>
    <epp:extension>
      <cozacontact:infData>
        <cozacontact:domain level="Contact">exampledomain1.zoneza</cozacontact:domain>
        <cozacontact:domain level="Contact">exampledomain2.zoneza</cozacontact:domain>
      </cozacontact:infData>
    </epp:extension>
    <epp:trID>
      <epp:svTRID>ZARC-12E4C3796FC-1562C</epp:svTRID>
    </epp:trID>
  </epp:response>
</epp:epp>




Checking Registrar Balance

 

Notes


1. The Balance Check is a custom extension to the standard Contact Info EPP command.

2. The response will contain a figure that represents the current real-time balance of a registrar.

3. If a balance amount is a negative number, it means that the registrar is currently in overdraft and should consider topping up their account.

4. The currency of the number in the response is in ZAR (South African Rands).

5. To successfully obtain the balance, the <cozacontact:balance> element must be used in the extension declaration, with an element value of "true".

 

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
xmlns:cozacontact="http://co.za/epp/extensions/cozacontact-1-0">
  <epp:command>
    <epp:info>
      <contact:info>
        <contact:id>RegistrarID</contact:id>
      </contact:info>
    </epp:info>
    <epp:extension>
      <cozacontact:info>
      <cozacontact:balance>true</cozacontact:balance></cozacontact:info>
    </epp:extension>
  </epp:command>
</epp:epp>

 


Possible Responses

 
1000: Command Completed Sucessfully

A response code of 1000 means that the command has been successfully processed. The available balance may be viewed in the value of the <cozacontact:balance> element. Additional information related to the registrar acount will also be displayed as part of the Contact Info command.

 

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
xmlns:cozacontact="http://co.za/epp/extensions/cozacontact-1-0">
  <epp:response>
    <epp:result code="1000">
      <epp:msg>Contact Info Command completed successfully</epp:msg>
    </epp:result>
    <epp:resData>
      <contact:infData>
        <contact:id>RegistrarID</contact:id>
        <contact:roid>ABC-123</contact:roid>
        <contact:status s="ok"/>
        <contact:voice/>
        <contact:fax/>
        <contact:email>registraremail@example.com</contact:email>
        <contact:clID/>
        <contact:crID/>
        <contact:crDate>2011-02-07T11:02:55Z</contact:crDate>
      </contact:infData>
    </epp:resData>
    <epp:extension>
      <cozacontact:infData>
          <cozacontact:balance>1111.11</cozacontact:balance>
      </cozacontact:infData>
    </epp:extension>
    <epp:trID>
      <epp:svTRID>ZARC-12E75BD4F95-948A5</epp:svTRID>
    </epp:trID>
  </epp:response>
</epp:epp>

2201: Requester Is Not Owner

A response code of 2201 means that the registrar ID provided does not match the ID of the requesting registrar. Please review the registrar ID element to ensure that the correct ID is specified.

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0">
  <epp:response>
    <epp:result code="2201">
      <epp:msg>Balance requester != contact owner</epp:msg>
    </epp:result>
    <epp:trID>
      <epp:svTRID>ZARC-12E75CFFC79-8E05A</epp:svTRID>
    </epp:trID>
  </epp:response>
</epp:epp>

 

Cancel Pending Actions

 
Notes


1. A Cancel Pending Action command will cancel a pending event that is currently in progress.

2. Succesfully cancelling a pending action will result in a poll message being queued for the registrar indicating that the pending action was cancelled.

3. Once a pending action is cancelled the contact object will revert back to its initial state prior to the initiation of the update.

4. To successfully execute the cancellation of a pending action, the <cozacontact:update cancelPendingAction="pending action"> element must be used in the extension, and the pending action to be cancelled must be specified as the value for the "cancelPendingAction" attribute. A complete list of available pending actions is available further down.

<epp:epp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
xmlns:cozacontact="http://co.za/epp/extensions/cozacontact-1-0">
  <epp:command>
    <epp:update>
      <contact:update>
        <contact:id>ContactID</contact:id>
      </contact:update>
    </epp:update>
    <epp:extension>
      <cozacontact:update xsi:schemaLocation="http://co.za/epp/extensions/cozacontact-1-0 coza-contact-1.0.xsd"
cancelPendingAction="PendingUpdate"/>
    </epp:extension>
  </epp:command>
</epp:epp>

Possible Responses


1000: Contact Action Cancelled

A response code of 1000 means that the command was successfully processed and the pending update will be cancelled shortly. Please reference the Poll Message queue for the eventual successful result message.

<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0">
  <epp:response>
    <epp:result code="1000">
      <epp:msg>Contact Action Cancelled</epp:msg>
    </epp:result>
    <epp:trID>
      <epp:svTRID>ZARC-12E763D3E09-B813D</epp:svTRID>
    </epp:trID>
  </epp:response>
</epp:epp>

2306: Event Not Found

A response code of 2306 means that the specified action to be cancelled is not currently pending on the contact. Please review the specified action in accordance to the available actions further below.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<epp:epp xmlns:epp="urn:ietf:params:xml:ns:epp-1.0">
  <epp:response>
    <epp:result code="2306">
      <epp:msg>CancelPendingAction event not found 'EVET NAME'</epp:msg>
    </epp:result>
    <epp:trID>
      <epp:svTRID>ZARC-EPP-13F9E5C469F-6A70A</epp:svTRID>
    </epp:trID>
  </epp:response>
</epp:epp>


Available Pending Actions

 

Canceling a pending action requires the action name to be specified. The following contact pending actions can be canceled after being performed:

  • - PendingUpdate

 

Last update: 23-02-2023 08:07:42

Technical Support

All issues and questions relating to the ZA EPP Registry Registrar System must be raised in the Contact/Support pages through the Registrar Portal. This is to ensure that our support department tracks and addresses all issues. If you have an account, please log on to the Registrar Portal and submit a support request online.

 

Registrar Noticeboard

Click here for the latest status updates.

 

Office Closure

Dear Registrar,

 

As Wednesday, 1 May approaches - a South African public holiday marking Workers' Day, we extend warm wishes for a safe and restful celebration to you and your family. Please be informed that our office will be closed on Wednesday, 1 May and will resume operations on Thursday, 2 May 2024. Support services will remain accessible during this period. Feel free to reach out to us via phone at +27 11 314 0077 or email us at support@zarc.net.za, and we will be happy to assist. We sincerely appreciate your ongoing support.

 

Warmest Regards,

The ZARC Team.