Versions Compared

Version Old Version 19 New Version Current
Changes made by

Dinesh Adithan

Dinesh Adithan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

For release to public

Table of Contents

Table of Contents

SOAP API Documentation:

ETX 901 (latest)

View file
name9_0_1_eTimeXpressWebServicesAPI.pdf
View file
name9_0_1_eTimeXpressWebServicesAPI_Examples.pdf
View file
name9_0_1_eTimeXpressWebServicesAPI_Datasets.pdf

ETX 814 (sunset and supported)

8_0_10_eTimeXpressWebServicesAPI.pdf

...

Field name

Label

Description

readOnly

Read Only

Read Only

dsLocation Dataset (ttLocation)

Field name

Label

Description

addr[1]

Address

Address

addr[2]

Address

Address

addr[3]

Address

Address

addr[4]

Address

Address

city

City

City

cycd

Country code

Country code

latitude

Latitude

Latitude

longitude

Longitude

Longitude

stcd

State/Prov

State/Prov

VenueSpaceName

Venue Name

Venue Name

zip

Zip or Postal Code

Zip or Postal Code

...

Code Block
...
   <dsContext>
      <ttContext>
         <contextGroup>PARAM</contextGroup>
         <contextName>ExecuteStatus</contextName>
         <contextValue>RUN_ERROR,1965,alertemailid,faxno,phone[2],teltype[2]</contextValue>
         <contextOperator/>
         <contextType/>
      </ttContext>
...

Examples

Login request

Code Block
languagexml
<?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>:

Code Block
languagexml
<?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:

...

Code Block
languagexml
<?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.

Read shifts

This method retrieves retrieves information about existing shifts from the system.

pdFromDate and pdToDate (Shift’s scheduled from and to date) are additional required parameters along with pcSessionID, pcUserID, piCompanyID, piBranchID.

Code Block
languagexml
<?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:TestClient:eTimeWS" xmlns:s1="http://www.w3.org/2001/XMLSchema">
      <s0:apSrvShiftGet>
         <dsContext xmlns="urn:eTimeWS:eTimeWS">
            <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>pdFromDate</contextName>
               <contextValue>01/01/2021</contextValue> <!-- PUT FROM DATE HERE -->
               <contextOperator />
               <contextType />
            </ttContext>
            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>pdToDate</contextName>
               <contextValue>03/01/2021</contextValue> <!-- PUT TO DATE HERE; not more than 90 days difference -->
               <contextOperator />
               <contextType />
            </ttContext>
            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piBranchID</contextName>
               <contextValue>2</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>
            <ttContext>
               <contextGroup>PARAM</contextGroup>
               <contextName>piCompanyID</contextName>
               <contextValue>2</contextValue> <!-- PUT CORRECT IDs HERE -->
               <contextOperator />
               <contextType />
            </ttContext>
         </dsContext>
      </s0:apSrvShiftGet>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You can add a where clause parameter to search for shifts meeting additional criteria. For e.g.

Code Block
languagexml
<ttContext>
    <contextGroup>PARAM</contextGroup>
    <contextName>pcWhere</contextName>
    <contextValue>crdate >= today - 1 </contextValue> <!-- to get shifts changed since yesterday -->
    <contextOperator />
    <contextType />
</ttContext>