Released to public

PDF generating source code is placed under SOAP sub directory in https://celayixakit@bitbucket.org/celayix/doc.git

ProxiGeneratior files (SOAP wsdl) are placed under webservices-proxy-files sub directory in https://celayixakit@bitbucket.org/celayix/doc.git project and includes following files:

<SOAPVersion>\NoBeforeImage\eTimeWS.wsdl

<SOAPVersion>\NoBeforeImage\eTimeWS.wsm

<SOAPVersion>\WithBeforeImage\eTimeWS.wsdl

<SOAPVersion>\WithBeforeImage\eTimeWS.wsm

DEF\eTime<SOAPVersion>.xpxg

ETX 814:

The latest version of SOAP wsdl file we use in 814 PRODUCTION is based on SOAP Version 8.0.9 (i/e corresponds to all datasets/functions interface defined in ETX code 8.0.9) and it is OK for ETX 8.0.9→ ETX 8.14:

Simple video on how to test and run SOAP services using free SOAP UI tool Run_Login_SOAP_Service.mp4

The latest version of SOAP API documentation is for ETX 8.0.10 → ETX 8.14 :

8_0_10_eTimeXpressWebServicesAPI.pdf

8_0_10_eTimeXpressWebServicesAPI_Datasets.pdf

8_0_10_eTimeXpressWebServicesAPI_Examples.pdf

ETX900:

CURRENT STATUS: SOAP wsdl is generated and will be used in 900 PRODUCTION for Andy Frain client test only. It is based on SOAP Version 9.0.0 (current production code) and it is ok for ETX900. It Includes following files;

900\NoBeforeImage\eTimeWS.wsdl

900\NoBeforeImage\eTimeWS.wsm

900\WithBeforeImage\eTimeWS.wsdl

900\WithBeforeImage\eTimeWS.wsm

DEF\eTime900.xpxg

Note: These files are put in the current SOAP API deployment directory and are used by admins: \\celamas01-117\Celdevel\DeployEtime\webservices\900

SOAP API documentation (9.0.0): none High level chages described here: https://celayix.myjetbrains.com/youtrack/issue/ET-1446

Older versions are available here.

REST WEB API version is available here

Example Requests

Login request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Body xmlns:s0="urn:L1340384D62:eTimeWS" 
                 xmlns:s1="http://www.w3.org/2001/XMLSchema">
    <s0:apSrv>
      <dsContext>
        <ttContext>
         <contextGroup>PARAM</contextGroup>
         <contextName>pcUserID</contextName>
         <contextValue>wsdl</contextValue>
         <contextOperator />
         <contextType />
        </ttContext>

        <ttContext>
         <contextGroup>PARAM</contextGroup>
         <contextName>pcPassword</contextName>
         <contextValue>_____PUT_THE_CORRECT_PASSWORD_HERE_____</contextValue>
         <contextOperator />
         <contextType />
        </ttContext>
      </dsContext>
    </s0:apSrv>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

To receive pcSessionID

Create New Employee Record Request

In order to create new employee record, the minimum fields that need to be passed to service are set in the pcUpdateRequestFieldsList context parameter are cid,bid,eid,emnamel,emnamef,emshort,rstat,emnerev + add at record level <cChkNew>A</cChkNew>:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:s0="urn:L1340384D62:eTimeWS" 
                  xmlns:s1="http://www.w3.org/2001/XMLSchema">
      <s0:apSrvEmpSave>
         <dsContext>
            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcAction</contextName>
               <contextValue>ADD_UPDATE</contextValue>
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcSessionID</contextName>
               <contextValue>_____SUBSTITUTE_pcSessionID_received_here_____</contextValue>
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcUserID</contextName>
               <contextValue>wsdl</contextValue>
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piCompanyID</contextName>
               <contextValue>2</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piBranchID</contextName>
               <contextValue>1</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcUpdateRequestFieldsList</contextName>
               <contextValue>cid,bid,eid,emnamel,emnamef,emshort,rstat,emnerev</contextValue> <!-- ADD ADDITIONAL NAMES OF FIELDS TO BE UPDATED HERE; See documentation for name of fields -->
               <contextOperator />
               <contextType />
            </ttContext>            
         </dsContext>

         <dsEmployee>
            <ttEmployee>
               <!-- Add values for each additional field here --> 
               <cid>2</cid>
               <bid>1</bid>
               <eid>999</eid>
               <cChkNew>A</cChkNew> <!-- TO ADD RECORD -->
               <emnamel>Last</emnamel>
               <emnamef>First</emnamef>
               <emshort>Celayix</emshort>
               <rstat>A</rstat>
               <emnerev>0101</emnerev>
            </ttEmployee>
         </dsEmployee>
      </s0:apSrvEmpSave>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Update employee record

If we want to update the following field:

In this case we use registration panel that supports a custom label

So, the TAM fields corresponds to Reg.2 field:

So, the minimum fields that need to be pass to service are set in the pcUpdateRequestFieldsList context parameter includes key fields + required field, i.e. cid,bid,eid,emstateid:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:s0="urn:L1340384D62:eTimeWS" 
                  xmlns:s1="http://www.w3.org/2001/XMLSchema">
      <s0:apSrvEmpSave>
         <dsContext>
            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcAction</contextName>
               <contextValue>ADD_UPDATE</contextValue>
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcSessionID</contextName>
               <contextValue>_____SUBSTITUTE_pcSessionID_received_here_____</contextValue>
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcUserID</contextName>
               <contextValue>wsdl</contextValue>
              <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piCompanyID</contextName>
               <contextValue>2</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>            

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piBranchID</contextName>
               <contextValue>1</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>

            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pcUpdateRequestFieldsList</contextName>
               <contextValue>cid,bid,eid,emstateid</contextValue> <!-- ADD ADDITIONAL NAMES OF FIELDS TO BE UPDATED HERE; See documentation for name of fields -->
               <contextOperator />
               <contextType />
            </ttContext>            
         </dsContext>

         <dsEmployee>
            <ttEmployee>
               <!-- Add values for each additional field here --> 
               <cid>2</cid>
               <bid>1</bid>
               <eid>999</eid>               
               <emstateid>TAM TEST VALUE</emstateid>
            </ttEmployee>
         </dsEmployee>
      </s0:apSrvEmpSave>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

to get