For release to public

SOAP API Documentation:

ETX 901 (latest)

9_0_1_eTimeXpressWebServicesAPI.pdf

9_0_1_eTimeXpressWebServicesAPI_Datasets.pdf

9_0_1_eTimeXpressWebServicesAPI_Examples.pdf

ETX 814 (sunset but is supported)

8_0_10_eTimeXpressWebServicesAPI.pdf

8_0_10_eTimeXpressWebServicesAPI_Datasets.pdf

8_0_10_eTimeXpressWebServicesAPI_Examples.pdf

Setup

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

Run_Login_SOAP_Service.mp4

Examples

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

Custom labels used reference fields

Custom labels:

are defined here:

and correspond to ref1 & ref2 fields in request.

Celayix SOAP API - For Public Distribution