Method

rxc-session-login

Description

This method uses the passed authentication information to initialize a session (log on) with privilege higher than an anonymous user. At least one user_name or email field is required.

Parameters

Name Input Value Type Description
user_name String (Optional) Employee or member user name.
password String Password associated with user_name or email.
login_type Integer (Optional) This is the type of login we are trying to make. 0 = Unknown, 1 = Member, 2 = Employee, 3 = RezRobot
business_code Integer (Optional) Business to use as default selection in subsequent calls for this session. Is applied when a business identifier is not passed to a method. The business_id and business_code parameters have the same effect, but identify the business with a different field.
application_version_major Integer (Optional) Major version number of application that is connecting. Used for logging and compatibility checks.
application_version_minor Integer (Optional) Minor version number of application that is connecting. Used for logging and compatibility checks.
application_version_revision Integer (Optional) Minor version number of application that is connecting. Used for logging and compatibility checks.
format enumeration (optional) 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

XML Encoded Request

URL Encoded Request





Result