s3rxc-sessionlogin-get
This method uses the passed authentication information to initialize a session (log on) with privileges higher than an anonymous user. Most people find it easier to include this call at the beggining of every communication so they don't have to worry if their session is still valid.
| Name | Input Value | Type | Description |
|---|---|---|---|
| format | enumeration | (Optional) The format you want the response data to be in. Set this value to "xml" for XML raw formatted output, "xml-clean" for XML tidy formatted output or "json" for JSON formatted output. If not passed, "xml" is used as a default | |
| user_name | String | (Required) User name. | |
| password | String | (Required) Password associated with user_name. |
| Name | Type | Description |
|---|---|---|
| s3rxc-sessionlogin-get | Object (1..1) | This is the call that was made and the container for the response. |
| s3rxc-sessionlogin-get\@faultcode | String | This should be used to indicate if this call was made successfully. If this value is anything other than "success" then the call was not made successfully and this field should give an indication as to why. |
| s3rxc-sessionlogin-get\session | Object (0..1) | Contains details of a session. If the login was successful this node should be present. |