Post Sessions Activities Message (postSessionsActivitiesMessage) API

The Post Sessions Activities Message (postSessionsActivitiesMessage) API adds a new message to a logbook session.

Required Parameter Group:

Pos	Name	I/O	Type
1	API token	Input	char(256)
2	Session ID	Input	decimal(7 0)
3	Severity	Input	decimal(4)
4	Message	Input	char(136)
5	Long message	Input	char(1026)
6	Error code	I/O	Char(*)

Service Program

To use this API, bind the following service program to your program module

Service Program	Library	Thread safe
SERVICEAPI	IEFFECT	yes

The job using this API has to be set to the correct country specific CCSID. A job CCSID of 65535 is not supported.

Authorities and Locks

Public API Authority *USE

Parameter details

API token

INPUT; CHAR(256)

API token for authentification on the server. The authorised user can generate this token with i-effect WebControl. See Generate API token

Session ID

INPUT; DECIMAL(7 0)

i-effect logbook session number to add a message to.

Severity

INPUT; DECIMAL(4)

The new logbook message severity.

Message

INPUT; CHAR(136)

User defined message, that should be added to this session. This message will appear in the first level message text with the following message ID.

Message ID	Description
IEF9600	<user defined message text>

Long message

INPUT; CHAR(256)

User defined message, that should be added to this session. This message will appear in the second level message text with the following message ID.

Message ID	Description
IEF9600	<user defined message text>

Error code

I/O; CHAR(*)

The structure in which to return error information:

Offset	I/O	Type	Description
0	Output	CHAR(1024)	Message ID
1025	Output	CHAR(1024)	Message description
2049	Output	CHAR(1024)	Stack trace

Messages

All call to this API returns the following status and error messages

Message ID	Description	Sample Message description	Sample Callstack
200	The API call was successful
400	The API Call returned an error	Could not find the specified session '99999' in the database!	com.menten.ieffect.rest.exceptions.SessionNotFoundException: Could not find the specified session '99999' in the database! at com.menten.ieffect.rest.controller.LogbookController.getSession(LogbookController.java:110)
401	The API Authentification was unsuccessful	Authentication failed.

Sample

In this sample API call in RPG-FREE, a messages for session 28130 will be added.

Java

       returnCode = postSessionactivitiesMessage(token:
                                                 28130:
                                                 30:
                                                 'User defined short message text':
                                                 'Long eplanatory message text to be added to the seesion logbook':
                                                 errorDS);

See Sample programs