From 0721bc519e8cddbf7afa7182f1eade41c26cc93d Mon Sep 17 00:00:00 2001 From: Martin Lensment Date: Thu, 15 Jan 2015 13:15:39 +0200 Subject: [PATCH] Contact doc --- doc/epp/contact.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++ doc/epp/domain.md | 4 ++-- 2 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 doc/epp/contact.md diff --git a/doc/epp/contact.md b/doc/epp/contact.md new file mode 100644 index 000000000..90b432cf5 --- /dev/null +++ b/doc/epp/contact.md @@ -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 | + +##### 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) diff --git a/doc/epp/domain.md b/doc/epp/domain.md index 179a359fc..68a0682c7 100644 --- a/doc/epp/domain.md +++ b/doc/epp/domain.md @@ -66,11 +66,11 @@ | Field name | Required | Attributes | Field description | | ----------------- |----------| -----|----------------- | -| [update](#top-domain-update) | true | | | +| [update](#update) | true | | | | [extension](#top-domain-update-extension) | true if registrant is changing | | | | clTRID | false | | Client transaction id | -##### update +##### update | Field name | Required | Attributes | Field description | | ----------------- |----------| -----|----------------- | | [domain:update](#domainupdate) | true | xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) | |