API12


Click here for a complete list of operations.

GetActivityFile

Pulls the activity file for the date range. We auto detect whether the client is using the TimeWorksPlus or the TimeWorks system based on the client's Upgrade Status. Note - only client level accounts can pull TimeWorks formats. For information on pulling an activity file using http post, click here.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sessionID:
BeginDate:
EndDate:
FormatName:
OptionalLaborMapping:

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.payrollservers.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mc2cs.com/GetActivityFile"

<?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>
    <GetActivityFile xmlns="http://mc2cs.com/">
      <sessionID>string</sessionID>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
      <FormatName>string</FormatName>
      <OptionalLaborMapping>string</OptionalLaborMapping>
    </GetActivityFile>
  </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>
    <GetActivityFileResponse xmlns="http://mc2cs.com/">
      <GetActivityFileResult>
        <FormatBinaryFile>base64Binary</FormatBinaryFile>
        <FormatText>string</FormatText>
        <MimeType>string</MimeType>
        <SiteName>string</SiteName>
        <SiteNumber>int</SiteNumber>
      </GetActivityFileResult>
    </GetActivityFileResponse>
  </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.payrollservers.us
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>
    <GetActivityFile xmlns="http://mc2cs.com/">
      <sessionID>string</sessionID>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
      <FormatName>string</FormatName>
      <OptionalLaborMapping>string</OptionalLaborMapping>
    </GetActivityFile>
  </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>
    <GetActivityFileResponse xmlns="http://mc2cs.com/">
      <GetActivityFileResult>
        <FormatBinaryFile>base64Binary</FormatBinaryFile>
        <FormatText>string</FormatText>
        <MimeType>string</MimeType>
        <SiteName>string</SiteName>
        <SiteNumber>int</SiteNumber>
      </GetActivityFileResult>
    </GetActivityFileResponse>
  </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/api12.asmx/GetActivityFile?sessionID=string&BeginDate=string&EndDate=string&FormatName=string&OptionalLaborMapping=string HTTP/1.1
Host: www.payrollservers.us

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

<?xml version="1.0" encoding="utf-8"?>
<GetActivityFileApiResult xmlns="http://mc2cs.com/">
  <FormatBinaryFile>base64Binary</FormatBinaryFile>
  <FormatText>string</FormatText>
  <MimeType>string</MimeType>
  <SiteName>string</SiteName>
  <SiteNumber>int</SiteNumber>
</GetActivityFileApiResult>

HTTP POST

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

POST /pg/api12.asmx/GetActivityFile HTTP/1.1
Host: www.payrollservers.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sessionID=string&BeginDate=string&EndDate=string&FormatName=string&OptionalLaborMapping=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetActivityFileApiResult xmlns="http://mc2cs.com/">
  <FormatBinaryFile>base64Binary</FormatBinaryFile>
  <FormatText>string</FormatText>
  <MimeType>string</MimeType>
  <SiteName>string</SiteName>
  <SiteNumber>int</SiteNumber>
</GetActivityFileApiResult>