API12 Web Service

API12

Click here for a complete list of operations.

EEIDSubmit

Submit updated information for one or more employees via the EEID API. This web method is fully supported for TimeWorksPlus and TimeWorks clients. Please see and/or request the EEID API documentation for full details on what we expect to see in the Employees parameter, part of which has specific requirements and part of which is free-form. Briefly, the XmlDocument's root should contain at least one Employee node which is somewhat of a free-form document, its actual interpretation governed by a script entered into the client account. Employees will be updated or added as necessary, using the EmployeeCode attribute of the Employee node as the record identifier. Please note there is a 4 megabyte upload limit enforced for each individual call to EEIDSubmit.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /pg/api12.asmx HTTP/1.1
Host: www.swipeclock.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mc2cs.com/EEIDSubmit"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EEIDSubmit xmlns="http://mc2cs.com/">
      <sessionID>string</sessionID>
      <SiteNumber>int</SiteNumber>
      <ApplicationID>string</ApplicationID>
      <Employees>xml</Employees>
    </EEIDSubmit>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EEIDSubmitResponse xmlns="http://mc2cs.com/">
      <EEIDSubmitResult>
        <SubmissionResults>xml</SubmissionResults>
      </EEIDSubmitResult>
    </EEIDSubmitResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /pg/api12.asmx HTTP/1.1
Host: www.swipeclock.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EEIDSubmit xmlns="http://mc2cs.com/">
      <sessionID>string</sessionID>
      <SiteNumber>int</SiteNumber>
      <ApplicationID>string</ApplicationID>
      <Employees>xml</Employees>
    </EEIDSubmit>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EEIDSubmitResponse xmlns="http://mc2cs.com/">
      <EEIDSubmitResult>
        <SubmissionResults>xml</SubmissionResults>
      </EEIDSubmitResult>
    </EEIDSubmitResponse>
  </soap12:Body>
</soap12:Envelope>