diff --git a/doc/epp/domain.md b/doc/epp/domain.md index 50b68a32f..be6fa5547 100644 --- a/doc/epp/domain.md +++ b/doc/epp/domain.md @@ -2,142 +2,142 @@ ### Domain create -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. | -| `--` | 0-1 | Registration period for domain. Must add up to 1 / 2 / 3 years. Attribute: unit="y/m/d"| -| `--` | 1 | Contact reference to the registrant | -| `--` | 0-n | Contact reference. Admin contact is required if registrant is a juridical person. Attribute: type="admin / tech" | -| `--` | 1 | | -| `---` | 2-11 | | -| `----` | 1 | Hostname of the nameserver | -| `----` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6" | -| `` | 1 | | -| `-` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1" | -| `--` | 1-n | | -| `---` | 1 | Allowed values: 0, 256, 257 | -| `---` | 1 | Allowed values: 3 | -| `---` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 | -| `---` | 1 | Public key | -| `-` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters. +`--` | 0-1 | Registration period for domain. Must add up to 1 / 2 / 3 years.
Attribute: unit="y/m/d" +`--` | 1 | Contact reference to the registrant +`--` | 0-n | Contact reference. Admin contact is required if registrant is a
juridical person. Attribute: type="admin / tech" +`--` | 1 | +`---` | 2-11 | +`----` | 1 | Hostname of the nameserver +`----` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6" +`` | 1 | +`-` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1" +`--` | 1-n | +`---` | 1 | Allowed values: 0, 256, 257 +`---` | 1 | Allowed values: 3 +`---` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 +`---` | 1 | Public key +`-` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-citizen-as-an-owner-creates-a-domain) ### Domain update -| Field name | Min-max | Field description | -| ------------------------ |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. | -| `--` | 0-1 | Attributes to change | -| `---` | 0-1 | Contact reference to the registrant | -| `--` | 0-1 | Objects to add | -| `---` | 0-n | Contact reference. Attribute: type="admin / tech" | -| `---` | 0-n | Status description. Attribute: s="clientDeleteProhibited / clientHold / clientRenewProhibited / clientTransferProhibited / clientUpdateProhibited" | -| `---` | 0-1 | | -| `----` | 1 | | -| `-----` | 1 | Hostname of the nameserver | -| `-----` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6" | -| `--` | 0-1 | Objects to remove | -| `---` | 0-n | Contact reference. Attribute: type="admin / tech" | -| `---` | 0-n | Attribute: s="clientDeleteProhibited / clientHold / clientRenewProhibited / clientTransferProhibited / clientUpdateProhibited" | -| `---` | 0-1 | | -| `----` | 1 | | -| `-----` | 1 | Hostname of the nameserver | -| `` | 0-1 | Required if registrant is changing | -| `-` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1" | -| `--` | 0-1 | | -| `---` | 1-n | | -| `----` | 1 | Allowed values: 0, 256, 257 | -| `----` | 1 | Allowed values: 3 | -| `----` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 | -| `----` | 1 | Public key | -| `--` | 0-1 | | -| `---` | 1-n | | -| `----` | 1 | Public key | -| `-` | 0-1 | Required if registrant is changing. Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +------------------------ | -------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters. +`--` | 0-1 | Attributes to change +`---` | 0-1 | Contact reference to the registrant +`--` | 0-1 | Objects to add +`---` | 0-n | Contact reference. Attribute: type="admin / tech" +`---` | 0-n | Status description. Attribute: s="clientDeleteProhibited / clientHold /
clientRenewProhibited / clientTransferProhibited / clientUpdateProhibited" +`---` | 0-1 | +`----` | 1 | +`-----` | 1 | Hostname of the nameserver +`-----` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6" +`--` | 0-1 | Objects to remove +`---` | 0-n | Contact reference. Attribute: type="admin / tech" +`---` | 0-n | Attribute: s="clientDeleteProhibited / clientHold / clientRenewProhibited /
clientTransferProhibited / clientUpdateProhibited" +`---` | 0-1 | +`----` | 1 | +`-----` | 1 | Hostname of the nameserver +`` | 0-1 | Required if registrant is changing +`-` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1" +`--` | 0-1 | +`---` | 1-n | +`----` | 1 | Allowed values: 0, 256, 257 +`----` | 1 | Allowed values: 3 +`----` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 +`----` | 1 | Public key +`--` | 0-1 | +`---` | 1-n | +`----` | 1 | Public key +`-` | 0-1 | Required if registrant is changing.
Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-updates-domain-and-adds-objects) ### Domain delete -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters. +`` | 1 | +`-` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-deletes-domain) ### Domain info -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. Attribute: hosts="all / TODO" | -| `--` | 0-1 | Required if registrar is not the owner of the domain. | -| `---` | 1 | Domain password. Attribute: roid="String" | -| `` | 0-1 | | -| `-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO" +`--` | 0-1 | Required if registrar is not the owner of the domain. +`---` | 1 | Domain password. Attribute: roid="String" +`` | 0-1 | +`-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-returns-domain-info) ### Domain renew -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. Attribute: hosts="all / TODO" | -| `--` | 1 | Current expiry date (ISO8601 format) | -| `--` | 1 | Registration period for domain. Must add up to 1 / 2 / 3 years. Attribute: unit="y/m/d" | -| `` | 0-1 | | -| `-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO" +`--` | 1 | Current expiry date (ISO8601 format) +`--` | 1 | Registration period for domain. Must add up to 1 / 2 / 3 years.
Attribute: unit="y/m/d" +`` | 0-1 | +`-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-renews-a-domain) ### Domain transfer -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. Attribute: hosts="all / TODO" | -| `--` | 1 | | -| `---` | 1 | Domain password. Attribute: roid="String" | -| `` | 0-1 | | -| `-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO" +`--` | 1 | +`---` | 1 | Domain password. Attribute: roid="String" +`` | 0-1 | +`-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-two-epp-users-transfers-a-domain) ### Domain check -| Field name | Min-max | Field description | -| ----------------------- |---------|------------------ | -| `` | 1 | | -| `-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" | -| `--` | 1 | Domain name. Can contain unicode characters. Attribute: hosts="all / TODO" | -| `` | 0-1 | | -| `-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" | -| `--` | 1 | Base64 encoded document. Attribute: type="pdf" | -| `` | 0-1 | Client transaction id | +Field name | Min-max | Field description +----------------------- | ------- | ----------------- +`` | 1 | +`-` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" +`--` | 1 | Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO" +`` | 0-1 | +`-` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" +`--` | 1 | Base64 encoded document. Attribute: type="pdf" +`` | 0-1 | Client transaction id [EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-checks-a-domain)