Celayix REST API - Team XP onboarding - Sending Invite
Sending Invite for few employees
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>/UpdateEmployeesExt
Sample Post JSON request payload:
{"pcSessionID":"2@admin.d60d7bb7-7cc3-109c-7a14-1d687c8d4a3e.BebPdkfdafaClSjd",
"pcServiceName":"",
"pcContextString":"{\"ttContext\":[{\"contextName\":\"piCompanyID\",\"contextValue\":\"4\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"piBranchID\",\"contextValue\":\"1\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcUserID\",\"contextValue\":\"admin\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcStatus\",\"contextValue\":\"\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcAction\",\"contextValue\":\"UPDATE\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcRecAccGroupsAction\",\"contextValue\":\"U\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcEid\",\"contextValue\":\"571,572\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcCustomerCode\",\"contextValue\":\"prodv3vaqa\",\"contextGroup\":\"PARAM\"},{\"contextName\":\"pcUpdateRequestFieldsListEmployee\",\"contextValue\":\"sendSms,sendEmail\",\"contextGroup\":\"PARAM\"}]}",
"pcIODataSetString":"{\"dsEmployee\":{\"prods:before\":{},\"prods:hasChanges\":true,\"ttEmployee\":[{\"sendSms\":true,\"sendEmail\":true}]}}"}The provided example includes minimum data we need to send to the server as it is with changes to a few parameters:
pcSessionID - the system needs pass a valid pcSessionID session parameter.
Context parameters:
piCompanyID - valid Company ID
piBranchID - valid Branch ID
pcUserID - valid User ID
pcEid - comma-separated list of employee IDs that we what to send invite. In the example above you can see {"contextName":"pcEid","contextValue":"571,572","contextGroup":"PARAM"}. Note: limitation is to send invite within one branch per one request.
pcCustomerCode - client Customer Code. In the example above you can see {"contextName":"pcCustomerCode","contextValue":"prodv3vaqa","contextGroup":"PARAM"}
Note: Request will analyze employee record and if it satisfy rules to send SMS or Email - corresponded action will be taken. Service do not provide any info how many sms or emails are send to employee.
Response will return standard execution status via pcResult / pcResultCode / pcResultDescription
Example is also available in postman via our Etime API Collection:
Please see this link for more details on how to get Session ID: https://celayix.atlassian.net/wiki/spaces/CX/pages/2098757654