Contact doc

This commit is contained in:
Martin Lensment 2015-01-15 13:15:39 +02:00
parent 303a9470f2
commit 0721bc519e
2 changed files with 56 additions and 2 deletions

54
doc/epp/contact.md Normal file
View file

@ -0,0 +1,54 @@
## Contact related functions
### 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
| 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 |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-contact-with-valid-user-create-command-successfully-creates-a-contact)

View file

@ -66,11 +66,11 @@
| Field name | Required | Attributes | Field description | | Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- | | ----------------- |----------| -----|----------------- |
| [update](#top-domain-update) | true | | | | [update](#update) | true | | |
| [extension](#top-domain-update-extension) | true if registrant is changing | | | | [extension](#top-domain-update-extension) | true if registrant is changing | | |
| clTRID | false | | Client transaction id | | clTRID | false | | Client transaction id |
##### <a name="top-domain-update"></a>update ##### update
| Field name | Required | Attributes | Field description | | Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- | | ----------------- |----------| -----|----------------- |
| [domain:update](#domainupdate) | true | xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) | | | [domain:update](#domainupdate) | true | xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) | |