Celayix REST API - Get valid SessionID for Schedule Xpress
Log in to the system via API and receive a valid Session ID
The assumption is that we already received all needed parameters via SOAP API or WEBX API + we have
client’s end point for API - path to Celayix etime API that correspond to the client’s configuration. For example, for prodv3vaqa client: https://prodv3-va-etime-api.celayix.com Note: we have no documentation how to get it from initial https://etime-api.celayix.com , for now, we will provide it to CS by request.
POST <client’s end point for API>/CheckETXLogin
Sample Post JSON request payload:
{
"pcClientID": "clientid",
"pcUserID": "user1",
"pcPassword": "mypassword",
"pcLanguage": "eng"
}
The provided example includes minimum data we need to send to the server as it is with changes to a few parameters:
pcClientID - valid Client ID ( provided by CS)
pcUserID - valid User ID
pcUserID - valid password
pcLanguage - valid language for a new session. Supported languages: eng - English; fra - French; spa - Spanish
Response will return standard execution status via pcResult / pcResultCode / pcResultDescription
Note: Once credentials are correct, the server returns specific details related to this session, including valid pcSessionID - session we need to use for all others requests
{
"pcResult": "OK",
"pcResultCode": null,
"pcResultDescription": null,
"pcContextString": {
"dsContext": {
"ttContext": [
{
"contextName": "pcCustomerCode",
"contextValue": "DEVDB"
},
{
"contextName": "pcETXLastCommit",
"contextValue": ""
},
{
"contextName": "pcETXVersion",
"contextValue": "9.3.2104052055"
},
{
"contextName": "pcETXverUI",
"contextValue": "9.3.0"
},
{
"contextName": "pcEventObjectAPI",
"contextValue": "https://prodv3-va-event-object-api.celayix.com"
},
{
"contextName": "pcLanguage",
"contextValue": "eng"
},
{
"contextName": "pcNetAPIEndpoint",
"contextValue": "https://prodv3vadb3a.celayix.com/WEBXPAPI802T/api/Common/"
},
{
"contextName": "pcSessionID",
"contextValue": "121@user1.9c7a1bba-6ecf-0da7-7d14-edc7149d2254.kajickiluclldjlc"
},
{
"contextName": "pcSocketAPI",
"contextValue": "wss://prodv3-va-socket-api.celayix.com"
},
{
"contextName": "pcStatisticsSeqS",
"contextValue": "1"
},
{
"contextName": "pcUserType",
"contextValue": ""
},
{
"contextName": "piBranchID",
"contextValue": "1"
},
{
"contextName": "piCompanyID",
"contextValue": "1"
},
{
"contextName": "piServerVersion",
"contextValue": "20201124001"
},
{
"contextName": "plDebugServiceMode",
"contextValue": "no"
}
]
}
}
}