zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-07-23 19:20:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

Refactor contact doc

Browse source
This commit is contained in:
Martin Lensment 2015-01-19 18:32:07 +02:00
parent 6b2a63ed7a
commit b527221baf
2 changed files with 25 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

65
doc/epp/contact.md
View file

@ -2,53 +2,24 @@
### Contact create
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [create](#create) | true | | |
| [extension](#ext-0) | true | | |
| clTRID | false | | Client transaction id |
##### create
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [contact:create](#contactcreate) | true | xmlns:contact (urn:ietf:params:xml:ns:contact-1.0) | |
##### contact:create
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [contact:postalInfo](#contactpostalinfo) | true | | Address information |
| contact:voice | true | | Phone |
| contact:email | true | | E-mail |
| contact:ident | true | type (ico, op, passport, birthday) | Ident |
##### contact:postalInfo
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| contact:name | true | | Full name |
| [contact:addr](#contactaddr) | true | | Address |
##### contact:addr
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| contact:street | false | | Street name |
| contact:city | true | | City name |
| contact:cc | true | | Country code |
##### <a name="ext-0"></a>extension !!! NOT IMPLEMENTED YET
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [eis:extdata](#eisextdata) | false | xmlns:eis (urn:ee:eis:xml:epp:eis-1.0) | Legal document |
##### eis:extdata
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| eis:legalDocument | true | type (pdf) | Base64 encoded document |
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<create>` | 1 | |
| `-<contact:create>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:contact-1.0" |
| `-<contact:voice>` | 1 | Phone |
| `-<contact:email>` | 1 | E-mail |
| `-<contact:Ident>` | 1 | Contact identificator. Attribute: type="ico / op / passport / birthday" |
| `-<contact:postalInfo>` | 1 | Contact information |
| `--<contact:name>` | 1 | Full name |
| `--<contact:addr>` | 1 | Address |
| `---<contact:street>` | 0-1 | Street name |
| `---<contact:city>` | 1 | City name |
| `---<contact:cc>` | 1 | Country code |
| `<extension>` | 0-1 | |
| `-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 0-1 | Client transaction id |
NB! Extension is not implemented yet!
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-contact-with-valid-user-create-command-successfully-creates-a-contact)

14
doc/epp/domain.md
View file

@ -22,7 +22,7 @@
| `---<secDNS:alg>` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 |
| `---<secDNS:pubKey>` | 1 | Public key |
| `-<eis:extdata>` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 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)
@ -61,7 +61,7 @@
| `---<secDNS:keyData>` | 1-n | |
| `----<secDNS:pubKey>` | 1 | Public key |
| `-<eis:extdata>` | 0-1 | Required if registrant is changing. Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 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)
@ -75,7 +75,7 @@
| `--<domain:name>` | 1 | Domain name. Can contain unicode characters. |
| `<extension>` | 1 | |
| `-<eis:extdata>` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-deletes-domain)
@ -91,7 +91,7 @@
| `---<domain:pw>` | 1 | Domain password. Attribute: roid="String" |
| `<extension>` | 0-1 | |
| `-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-returns-domain-info)
@ -107,7 +107,7 @@
| `--<domain:period>` | 1 | Registration period for domain. Must add up to 1 / 2 / 3 years. Attribute: unit="y/m/d" |
| `<extension>` | 0-1 | |
| `-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-with-valid-domain-renews-a-domain)
@ -123,7 +123,7 @@
| `---<domain:pw>` | 1 | Domain password. Attribute: roid="String" |
| `<extension>` | 0-1 | |
| `-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 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)
@ -137,7 +137,7 @@
| `--<domain:name>` | 1 | Domain name. Can contain unicode characters. Attribute: hosts="all / TODO" |
| `<extension>` | 0-1 | |
| `-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0" |
| `--<eis:legalDocument>` | 1 | Base64 encoded document |
| `--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf" |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-domain-with-valid-user-checks-a-domain)