Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisLogin

int ctMemphisLogin( pRCESJson connRequest, ppRCESJson retError )

Description:

Receives in the JSON input parameter the login name and password. If it already has an existing connection pool for this login, just return its token to be used in the subsequent API calls and increment the usage counter for this pool. In case it still does not have an initialized pool, starts a connection pool for this login, and return its token. This token is expected in the header of all the API calls. It means that all the Replication Manager web functions listed below must have custom property named "token" with this returned content.

URL: <baseURL>/ctMemphisLogin/

HTTP Verb: POST

Parameters:

  • connRequest [IN] - Connection request parameter list in JSON format. It will have the user name and password:

{

"user": "ADMIN",

"password": "ADMIN"

}

  • retError [OUT] - Token for the connection pool and error in JSON format. For example:

{

"token": "ASDNL342SLKFS8FSN9SSFDG856",

"success": true,

"inactiveTimeout" : 60,

"error":

{

"errorCode": 0,

"message": "success"

}

}

Return:

Error code

Note: The connection is automatically cleaned up by inactive time out. In order to setup this information add the following entry key: INACTIVE_TIMEOUT <elapsed time in seconds> at the SUBSYSTEM REPLICATION AGENT section in the Replication Manager Database ctsrvr.cfg.

TOCIndex