EmployeeWebInterface
Click here for a complete list of operations.
GetTerminalBatches
Get details on recent TimeClock/FlexClock transmissions. IgnoreThru can be 0 to get twenty most recent transmissions, or a previously retrieved RecordNumber to get up to 20 batches newer than that. Please note that the schema for the return value is subject to change without notice.
- Compatibility with TimeWorks: Fully compatible
- Compatibility with TimeWorksPlus: Fully compatible
- Applies to: TimeClock, FlexClock (including Z Series, Vx Series, L1/LA2000, and HandPunch)
- Does not apply to: WebClock, VoiceClock, Punch submission WebMethods
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/xml/EmployeeWebInterface.asmx HTTP/1.1
Host: www.swipeclock.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://mc2cs.com/scci/GetTerminalBatches"
<?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:Header>
<AuthHeader xmlns="https://mc2cs.com/scci">
<password>string</password>
<site>string</site>
<userName>string</userName>
</AuthHeader>
</soap:Header>
<soap:Body>
<GetTerminalBatches xmlns="https://mc2cs.com/scci">
<IgnoreThru>long</IgnoreThru>
</GetTerminalBatches>
</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>
<GetTerminalBatchesResponse xmlns="https://mc2cs.com/scci">
<GetTerminalBatchesResult>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch xsi:nil="true" />
<Punch xsi:nil="true" />
</PunchRecords>
</TerminalBatch>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch xsi:nil="true" />
<Punch xsi:nil="true" />
</PunchRecords>
</TerminalBatch>
</GetTerminalBatchesResult>
</GetTerminalBatchesResponse>
</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/xml/EmployeeWebInterface.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:Header>
<AuthHeader xmlns="https://mc2cs.com/scci">
<password>string</password>
<site>string</site>
<userName>string</userName>
</AuthHeader>
</soap12:Header>
<soap12:Body>
<GetTerminalBatches xmlns="https://mc2cs.com/scci">
<IgnoreThru>long</IgnoreThru>
</GetTerminalBatches>
</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>
<GetTerminalBatchesResponse xmlns="https://mc2cs.com/scci">
<GetTerminalBatchesResult>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch xsi:nil="true" />
<Punch xsi:nil="true" />
</PunchRecords>
</TerminalBatch>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch xsi:nil="true" />
<Punch xsi:nil="true" />
</PunchRecords>
</TerminalBatch>
</GetTerminalBatchesResult>
</GetTerminalBatchesResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /pg/xml/EmployeeWebInterface.asmx/GetTerminalBatches?IgnoreThru=string HTTP/1.1 Host: www.swipeclock.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTerminalBatch xmlns="https://mc2cs.com/scci">
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch ee="string" recnum="string" dupe="string" />
<Punch ee="string" recnum="string" dupe="string" />
</PunchRecords>
</TerminalBatch>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch ee="string" recnum="string" dupe="string" />
<Punch ee="string" recnum="string" dupe="string" />
</PunchRecords>
</TerminalBatch>
</ArrayOfTerminalBatch>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /pg/xml/EmployeeWebInterface.asmx/GetTerminalBatches HTTP/1.1 Host: www.swipeclock.com Content-Type: application/x-www-form-urlencoded Content-Length: length IgnoreThru=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTerminalBatch xmlns="https://mc2cs.com/scci">
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch ee="string" recnum="string" dupe="string" />
<Punch ee="string" recnum="string" dupe="string" />
</PunchRecords>
</TerminalBatch>
<TerminalBatch BatchNumber="string" BatchRecordNumber="long" BatchRevision="int" ConnectionMethod="string" DialNumber1="string" DialNumber2="string" DialPrefix="string" EpromVersion="string" FingerFirmwareVersion="string" PlatformName="string" RecordsExpected="int" SiteName="string" SiteNumber="string" SoftwareVersion="string" LastUpdateUTC="string" UsingTcpModem="string" Abbreviated="string">
<PunchRecords xmlns="http://mc2cs.com/sc">
<Punch ee="string" recnum="string" dupe="string" />
<Punch ee="string" recnum="string" dupe="string" />
</PunchRecords>
</TerminalBatch>
</ArrayOfTerminalBatch>