The set_session API method is called by a client-hosted server side process upon successful authentication of the customer via the client-hosted web site.
set_session(client_no, auth_key, user_id)
The set_session API method is called by a client-hosted server side process upon successful authentication of the customer via the client-hosted web site.
set_session(client_no, auth_key, user_id)
Field Name | Field Type | Length | Nullable | Comments |
---|---|---|---|---|
<client_no> | long | 8 | No | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
<auth_key> | string | 32 | No | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
<user_id> | string | 32 | No | Mandatory unique and case-insensitive alphanumeric identifier for this account within the client name space. Allowable characters include:
Additional special characters may be accepted but require explicit allowance prior to submission. This value is used for any end-user services provided by Aria Systems’ clients requiring user ID and password authentication. Must adhere to client-defined rules for minimum and maximum length. May not equal any string determined as reserved or unallowable by either Aria Systems or its client. |
Field Name | Field Type | Length | Nullable |
---|---|---|---|
<session_id> | string | 32 |
|
<error_code> | long | 32 | No |
<error_msg> | string | 32 |
|