<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!-- One method to get references from the online citation libraries.
     There has to be one entity for each item to be referenced. 
     An alternate method (rfc include) is described in the references. -->
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC5730 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5730.xml">
<!ENTITY I-D.narten-iana-considerations-rfc2434bis SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.narten-iana-considerations-rfc2434bis.xml">
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<!-- used by XSLT processors -->
<!-- For a complete list and description of processing instructions (PIs), 
     please see http://xml.resource.org/authoring/README.html. -->
<!-- Below are generally applicable Processing Instructions (PIs) that most I-Ds might want to use.
     (Here they are set differently than their defaults in xml2rfc v1.32) -->
<?rfc private="VeriSign Inc. Proprietary Information" ?>
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>
<!-- generate a ToC -->
<?rfc tocdepth="4"?>
<!-- the number of levels of subsections in ToC. default: 3 -->
<!-- control references -->
<?rfc symrefs="yes"?>
<!-- use symbolic references tags, i.e, [RFC2119] instead of [1] -->
<?rfc sortrefs="yes" ?>
<!-- sort the reference entries alphabetically -->
<!-- control vertical white space 
     (using these PIs as follows is recommended by the RFC Editor) -->
<?rfc compact="yes" ?>
<!-- do not start each main section on a new page -->
<?rfc subcompact="yes"?>
<!-- keep one blank line between list items -->
<?rfc comments="yes" ?>
<!-- show cref output -->
<?rfc inline="yes" ?>
<!-- inline cref output -->
<!-- end of list of popular I-D processing instructions -->
<rfc category="info" docName="verisign_epp-extension_low-balance_v01" ipr="none">
  <!-- category values: std, bcp, info, exp, and historic
     ipr values: full3667, noModification3667, noDerivatives3667
     you can add the attributes updates="NNNN" and obsoletes="NNNN" 
     they will automatically be output with "(if approved)" -->

  <!-- ***** FRONT MATTER ***** -->

  <front>
    <title abbrev="low-balance">Low Balance Mapping for the Extensible Provisioning Protocol (EPP)</title>

    <author fullname="James Gould" initials="J.G" surname="Gould">
      <organization>VeriSign, Inc.</organization>

      <address>
        <postal>
          <street>12061 Bluemont Way</street>

          <city>Reston</city>

          <region>VA</region>

          <code>20190</code>

          <country>US</country>
        </postal>

        <email>jgould@verisign.com</email>

        <uri>http://www.verisigninc.com</uri>
      </address>
    </author>

    <author fullname="Mahendra Jain" 
      initials="M.J" surname="Jain">
      <organization>VeriSign, Inc.</organization>

      <address>
        <postal>
          <street>12061 Bluemont Way</street>

          <city>Reston</city>

          <region>VA</region>

          <code>20190</code>

          <country>US</country>
        </postal>

        <email>majain@verisign.com</email>

        <uri>http://www.verisigninc.com</uri>
      </address>
    </author>

    <date day="1" month="May" year="2014"/>

    <abstract>
      <t>This document describes an Extensible Provisioning Protocol (EPP)
      mapping for the Low Balance Poll Notification used when 
      an account reaches or goes below the credit threshold.</t>
    </abstract>
    
    <note title="Legal Disclaimer">
      <t>COPYRIGHT NOTIFICATION</t>
      <t>Copyright 2013 VeriSign, Inc. All rights reserved. VERISIGN; 
      the Verisign logo; and other trademarks, service marks and Verisign designs are registered or 
      unregistered trademarks of VeriSign Inc. and its subsidiaries in the United States and foreign countries. 
      Copyright laws and international treaties protect this document, and any Verisign product to which it relates.</t>
      
      <t>VERISIGN PROPRIETARY INFORMATION</t>
      <t>This document is the property of VeriSign, Inc. and its subsidiaries (together "Verisign") It may be used by 
      recipient only for the purpose for which it was transmitted and must be returned upon request or when no longer 
      needed by recipient. It may not be copied or communicated without the prior written consent of Verisign.</t>

      <t>NOTICE AND CAUTION</t>
      <t>Concerning U.S. Patent or Trademark Rights</t>
      <t>Verisign and other trademarks, service marks and logos are registered or unregistered trademarks of 
      Verisign and its subsidiaries in the United States and in foreign countries. The inclusion in this 
      document, the associated on-line file or the associated software of any information covered by any 
      other patent, trademark or service mark rights does not constitute nor imply a grant of or authority 
      to exercise, any right or privilege protected by such patent, trademark or service mark. All such 
      rights and privileges are vested in the patent, trademark or service mark owner and no other person 
      may exercise such rights without express permission, authority or license secured from the patent, 
      trademark or service mark owner.</t>    
    </note>
    
  </front>

  <middle>
    <section title="Introduction">
      <t>This document describes an extension mapping for version 1.0 of the
      <xref target="RFC5730">Extensible Provisioning Protocol (EPP)</xref>.
      This EPP extension supports the poll message created by the server 
      when an account reaches or goes below the credit threshold.</t>

      <section title="Conventions Used in This Document">
        <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
        "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
        document are to be interpreted as described in <xref
        target="RFC2119">RFC 2119</xref>.</t>

        <t>XML is case sensitive. Unless stated otherwise, XML specifications
        and examples provided in this document MUST be interpreted in the
        character case presented in order to develop a conforming
        implementation.</t>
        
        <t>In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server.  
        Indentation and white space in examples are provided only to illustrate element relationships 
        and are not a REQUIRED feature of this protocol.        
        </t>

        <t>"lowbalance-poll-1.0" is used as an abbreviation for
        "http://www.verisign.com/epp/lowbalance-poll-1.0". The XML namespace prefix "lowbalance-poll"
        is used, but implementations MUST NOT depend on it and instead employ
        a proper namespace-aware XML parser and serializer to interpret and
        output the XML documents.</t>
      </section>
    </section>

    <section anchor="attrs" title="Object Attributes">
    
      <t>The EPP Low Balance Poll has attributes and associated values that may be viewed by the 
      sponsoring client or server.  This section describes each attribute type in detail.</t>
              
       <section anchor="currency" title="Currency Attribute Values">
        <t>All of the currency attributes including the creditLimit, 
        creditThreshold (FIXED), and availableCredit use the XML normalizedString data type 
        to represent the currency value in the currency of the server.</t>
      </section>
      
    </section>

    <section anchor="commands" title="EPP Command Mapping">
      <t>A detailed description of the EPP syntax and semantics can be found
      in the EPP core protocol specification <xref target="RFC5730"/>.  The command 
      mapping described here is specifically for use to notify of low balance 
      situations.</t>
      
      <section anchor="pollCommand" title="EPP &lt;poll&gt; Command">
      
       <t>The EPP &lt;poll&gt; command and response is defined in section 2.9.2.3 of <xref target="RFC5730"/>.  The Low  
        Balance Notification is included in the EPP &lt;poll&gt; response of <xref target="RFC5730"/>.</t>
        
       <t>For the Low Balance Notification, poll messages apply whenever the available credit for   
       an account reaches or goes below the credit threshold.  In the case of a Low Balance   
       specific message, a &lt;lowbalance-poll:pollData&gt; element will be included within the   
       &lt;resData&gt; element of the standard &lt;poll&gt; response. The &lt;lowbalance-poll:pollData&gt; element 
       will include a reference to the Low Balance namespace. EPP data 
       contained within the &lt;lowbalance-poll:pollData&gt; element is formatted according to the 
       lowbalance-poll schema.</t>
                 
       <figure>
            <preamble>Example &lt;poll&gt; command:</preamble>

            <artwork><![CDATA[
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:  <poll op="req"/>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>]]></artwork>
       </figure>
       
       <t>An Low Balance Poll Message consists of the &lt;lowbalance-poll:pollData&gt; element with the following 
       child elements:</t>

       <t><list hangIndent="4" style="hanging">
          <t hangText="&lt;lowbalance-poll:registrarName&gt;">The registrar / account full name.</t>
          <t hangText="&lt;lowbalance-poll:creditLimit&gt;">The credit limit for the account.</t>
          <t hangText="&lt;lowbalance-poll:creditThreshold&gt;">The lower limit credit threshold for the account.  
          The "type" attribute defines the type of threshold.  A "type" value of FIXED indicates that the threshold is a fixed currency amount.  
          A "type" value of PERCENT indicates that the threshold is calculated as the threshold value times the credit limit, 
          represented by the value of &lt;lowbalance-poll:creditLimit&gt;.</t>
          <t hangText="&lt;lowbalance-poll:availableCredit&gt;">The account available credit that is compared against the credit threshold value.</t>
       </list></t>

       <figure>
            <preamble>Example &lt;poll&gt; response with the Low Balance Poll Message:</preamble>

            <artwork><![CDATA[
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S:  <response>
S:    <result code="1301">
S:      <msg>Command completed successfully; ack to dequeue</msg>
S:    </result>
S:  <msgQ count="1" id="12345">
S:    <qDate>2013-03-25T18:20:07.0078Z</qDate>
S:    <msg>Low Account Balance</msg>
S:  </msgQ>
S:  <resData>
S:    <lowbalance-poll:pollData   
S:      xmlns:lowbalance-poll=
S:      "http://www.verisign.com/epp/lowbalance-poll-1.0">
S:      <lowbalance-poll:registrarName>Test Registar
S:      </lowbalance-poll:registrarName>
S:      <lowbalance-poll:creditLimit>1000
S:      </lowbalance-poll:creditLimit>
S:      <lowbalance-poll:creditThreshold type="PERCENT">10
S:      </lowbalance-poll:creditThreshold>
S:      <lowbalance-poll:availableCredit>80
S:      </lowbalance-poll:availableCredit>
S:      </lowbalance-poll:pollData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>]]></artwork>
       </figure>

      </section>
      <!-- end INFO command -->
            
    </section>

    <!-- EPP command mapping -->

    <section anchor="syntax" title="Formal Syntax">
    
      <t>One schema is presented here that is the Low Balance Poll Mapping
      schema.</t>
      
      <t>The formal
      syntax presented here is a complete schema representation of the object
      mapping suitable for automated validation of EPP XML instances. The
      BEGIN and END tags are not part of the schema; they are used to note the
      beginning and ending of the schema for URI registration purposes.</t>

    <section title="Low Balance Poll Mapping Schema">

      <figure>
        <artwork><![CDATA[
BEGIN
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace=
  "http://www.verisign.com/epp/lowbalance-poll-1.0"
  xmlns:lowbalance-poll=
  "http://www.verisign.com/epp/lowbalance-poll-1.0"
  xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
  xmlns="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified">
  
  <!-- Import common element types.-->
  <import namespace="urn:ietf:params:xml:ns:eppcom-1.0"
    schemaLocation="eppcom-1.0.xsd"/>
    
  <annotation>
    <documentation>
      Extensible Provisioning Protocol v1.0
      VeriSign poll notification specification 
      for low balance notifications.
    </documentation>
  </annotation>

  <!--Child elements found in EPP commands.-->
  <element name="pollData" 
    type="lowbalance-poll:pollDataType"/>

  <!--Child elements of the <notifyData> 
  element for the low balance.-->
  <complexType name="pollDataType">
    <sequence>
      <element name="registrarName" 
        type="eppcom:labelType"/>
      <element name="creditLimit" 
        type="normalizedString"/>
      <element name="creditThreshold" 
        type="lowbalance-poll:thresholdType"/>      
      <element name="availableCredit" 
        type="normalizedString"/>
    </sequence>
  </complexType>
    
  <complexType name="thresholdType">
    <simpleContent>
      <extension base="normalizedString">
        <attribute name="type" 
          type="lowbalance-poll:thresholdValueType"
          use="required"/>
      </extension>
    </simpleContent>
  </complexType>
               
  <simpleType name="thresholdValueType">
    <restriction base="token">
      <enumeration value="FIXED"/>
      <enumeration value="PERCENT"/>
    </restriction>
  </simpleType>
   
<!-- End of schema.-->   
</schema>
END]]></artwork>
      </figure>
      </section>
    </section>
   
   <section title="Change History">
    <section title="Version 01" anchor="version-01">
      <t><list style="numbers">
        <t>Initial version of Internet-Draft format of the 
        Low Balance Poll Mapping, version 1.2.</t>
      </list></t>
    </section>
   </section>
    

    <section anchor="Security" title="Security Considerations">
      <t>The mapping extensions described in this document do not provide any
      security services beyond those described by <xref
      target="RFC5730">EPP</xref> and protocol layers used by EPP. The security
      considerations described in these other specifications apply to this
      specification as well.</t>
    </section>

  </middle>

  <!--  *****BACK MATTER ***** -->

  <back>
    <!-- References split into informative and normative -->

    <!-- There are 2 ways to insert reference entries from the citation libraries:
     1. define an ENTITY at the top, and use "ampersand character"RFC2629; here (as shown)
     2. simply use a PI "less than character"?rfc include="reference.RFC.2119.xml"?> here
        (for I-Ds: include="reference.I-D.narten-iana-considerations-rfc2434bis.xml")

     Both are cited textually in the same manner: by using xref elements.
     If you use the PI option, xml2rfc will, by default, try to find included files in the same
     directory as the including file. You can also define the XML_LIBRARY environment variable
     with a value containing a set of directories to search.  These can be either in the local
     filing system or remote ones accessed by http (http://domain/dir/... ).-->

    <references title="Normative References">
       
      &RFC2119;
      
      &RFC5730;

    </references>
  </back>

  <!-- vim: set ts=2 sw=2 expandtab: -->
</rfc>
