Updated session doc

This commit is contained in:
Priit Tark 2015-01-22 12:54:49 +02:00
parent ac2cf33f40
commit c532282598

View file

@ -3,36 +3,37 @@ Here are functions like login, logout, hello, poll
### Login request
| 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 |
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
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-session-when-connected-with-valid-user-logs-in-epp-user)
### Logout request
| Field name | Min-max | Field description |
| ----------------------- |---------|------------------ |
| `<logout>` | 1 | |
| `<clTRID>` | 0-1 | Client transaction id |
Field name Min-max Field description
----------------------- ------- -----------------
<logout> 1
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-session-when-connected-with-valid-user-logs-out-epp-user)
### Poll request
| 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 |
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-examples.md#epp-poll-with-valid-user-queues-and-dequeues-messages)