createSession (DSO882A Anonymous, DSO881X registered). For JSON interface the programs are (DSO882AJ Anonymous, DSO884A registered).
Allows a user to establish a session with IP1 as an anonymous or a registered user. The web service will create a session for an anonymous/registered user and return the session ID if successful or return the appropriate error message(s). Anonymous user is only allowed if its pre-configured in control file TMSWWW/ANON-USE (See Anonymous vs registered users). The generated session ID is then used by all other operations with the exception of the following:
Input parameters:
| Field ID | Description | Type | Constraints |
| sessionId | Previous session ID. Applicable when creating a session as a registered user from an anonymous user session. | String | Optional |
| userName | Login ID of the user. Required for loginType = L only. | String | Optional |
| password | Password of the registered user. Required for loginType = L only. | String | Optional |
| emailAddress | Email address of the user. Required for loginType = L only. | String | Optional |
| loginType | Type of session to create.
A = for an anonymous user L = for a registered user Defaults to ‘A’. |
String | Optional |
| ipAddress | Trusted IP address can be specified in IP1. A trusted IP address makes some validation simpler. | String | Optional |
| moveCart | Set to ‘True’ or ‘False’ depending upon the requirement for a registered user to be allowed to transfer items in their cart from an anonymous session to their registered session. | Boolean | Optional |
| anonymousTemplate | An anonymous sign on creates a temporary contact. The defaults for this contact come from the template. Template is required for an anonymous user but will default to the template defined on TMSWWW/ANON-USE for the site code. Templates are maintained in CRM via CRW045 Work with Contact Template and setup in TMSWWW/ANON-VT. |
String | Optional |
| siteCode | The code of the website being used to communicate with IP1. Site codes are maintained in control file TMSWWW/SITECODE. Where multiple web sites exist, relevant siteCode field setting must be passed so that IP1 uses appropriate configurations/defaults for that specific web site. | String | Optional |
| useTemporaryPassword | Use temporary password. Defaults to ‘False’. | Boolean | Optional |
| contactLinkSummary | This is additional optional input element to support Author Services. It allows for additional information to be included in the response. i.e. information about type Author/Customer and multiple accounts linked to the user. Default is ‘False’. | Boolean | Optional |
Response:
| Field | Description | Type | Occurrence |
| sessionId | ID for the successfully created new session. | String | 1..1 |
| contactLinkSummary | If contactLinkSummary is set to ‘True’ in the input of the createSession call, then the following contactLinkSummary output will be returned when the session is created successfully. | contactLinkSummary | 0..1 |
| messageSet | messageSetDataType structure is part of the output that holds the messages particularly error messages returned from the service call. This is the last element in the output of most services. | messageSetDataType | 0..1 |
