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

Session doc

Browse source
This commit is contained in:
Martin Lensment 2015-01-19 18:04:46 +02:00
parent faf46ec561
commit be5f329a6c
1 changed files with 26 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

69
doc/epp/session.md
View file

@ -3,59 +3,42 @@ Here are functions like login, logout, hello, poll
### Login request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [login](#login) | true | | |
| clTRID | false | | Client transaction id |
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<login>` | 1 | |
| `-<clID>` | 1 | Username |
| `-<pw>` | 1 | Password |
| `-<options>` | 0-1 | |
| `--<version>` | 0-1 | 1.0 |
| `--<lang>` | 0-1 | en |
| `-<svcs>` | 0-1 | |
| `--<objURI>` | 0-n | Object URI that is going to be used in current connection. |
| `--<svcExtension>` | 0-1 | |
| `---<extURI>` | 0-n | Extension URI that is going to be used in current connection. |
| `<clTRID>` | 0-1 | Client transaction id |
##### login
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| clID | true | Username |
| pw | true | Password |
| [options](#options) | false | |
| [svcs](#svcs) | false | |
##### options
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| version | false | 1.0 |
| lang | false | en |
##### svcs
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| objURI | false | Object URI that is going to be used in current connection. (0-n) |
| [svcExtension](#svcextension) | false | |
##### svcExtension
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| extURI | false | Extension URI that is going to be used in current connection. (0-n) |
| `--<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 |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-in-epp-user)
### Logout request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| logout | true | | |
| clTRID | false | | Client transaction id |
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<logout>` | 1 | |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-out-epp-user)
### Poll request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [poll](#poll) | true | | |
| clTRID | false | | Client transaction id |
##### poll
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| poll | true | op (req, ack) | Rec for receiving messages, ack for dequeuing |
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<poll>` | 1 | Rec for receiving messages, ack for dequeuing Attribute: op="req / ack" |
| `<clTRID>` | 0-1 | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-doc.md#epp-poll-with-valid-user-queues-and-dequeues-messages)