DeviceInterface Web Service

DeviceInterface

Click here for a complete list of operations.

GetDeviceConfig

Used by VoiceClock product and by API clients. Gets configuration information for a timekeeping device or service in XML format. This method gives list of client codes that are configured to use the device plus any device-specific configuration that has been entered into our website, for example, any custom prompts or restrictions that should be applied to clients. This call is only for acquiring information from our site to your device or service. Use the SendMessages call to submit employee punch data back to us. DeviceID and DeviceSecret are credentials that identify your device to our system (like a login and password). Many of the items you get back in the response are specific to the VoiceClock and you can ignore them if you don't recognize them, but you will want to be aware of SiteNumber (you'll need to include this in all punches you send back to us so we know which client they belong to). TimeZone for North American clients will typically be a string such as "-0700,D" which means UTC minus 7 hours, the ",D" meaning add 1 hour during North American daylight (summertime) hours. So "-0700,D" stands for Mountain Time, but "-0700" stands for Arizona Mountain Time which uses standard time year round and doesn't observe DST.

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 /scci/xml/DeviceInterface.asmx HTTP/1.1
Host: www.payrollservers.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mc2cs.com/sc/GetDeviceConfig"

<?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>
    <GetDeviceConfig xmlns="http://mc2cs.com/sc">
      <DeviceID>int</DeviceID>
      <DeviceSecret>string</DeviceSecret>
    </GetDeviceConfig>
  </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>
    <GetDeviceConfigResponse xmlns="http://mc2cs.com/sc">
      <GetDeviceConfigResult>
        <ConsoleSoftwareVersion>string</ConsoleSoftwareVersion>
        <ConsoleTimeZone>string</ConsoleTimeZone>
        <LastMessageReceived>int</LastMessageReceived>
        <Sites>
          <DeviceSite>
            <AllowComboPunch>int</AllowComboPunch>
            <AllowMultipleTransactions>int</AllowMultipleTransactions>
            <AllowedCallerIDs>string</AllowedCallerIDs>
            <CallerIDVariable>string</CallerIDVariable>
            <Employees xsi:nil="true" />
            <Prompts xsi:nil="true" />
            <RequireCallerID>int</RequireCallerID>
            <SiteName>string</SiteName>
            <SiteNumber>int</SiteNumber>
            <TimeZone>string</TimeZone>
          </DeviceSite>
          <DeviceSite>
            <AllowComboPunch>int</AllowComboPunch>
            <AllowMultipleTransactions>int</AllowMultipleTransactions>
            <AllowedCallerIDs>string</AllowedCallerIDs>
            <CallerIDVariable>string</CallerIDVariable>
            <Employees xsi:nil="true" />
            <Prompts xsi:nil="true" />
            <RequireCallerID>int</RequireCallerID>
            <SiteName>string</SiteName>
            <SiteNumber>int</SiteNumber>
            <TimeZone>string</TimeZone>
          </DeviceSite>
        </Sites>
        <StatusCode>string</StatusCode>
      </GetDeviceConfigResult>
    </GetDeviceConfigResponse>
  </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 /scci/xml/DeviceInterface.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>
    <GetDeviceConfig xmlns="http://mc2cs.com/sc">
      <DeviceID>int</DeviceID>
      <DeviceSecret>string</DeviceSecret>
    </GetDeviceConfig>
  </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>
    <GetDeviceConfigResponse xmlns="http://mc2cs.com/sc">
      <GetDeviceConfigResult>
        <ConsoleSoftwareVersion>string</ConsoleSoftwareVersion>
        <ConsoleTimeZone>string</ConsoleTimeZone>
        <LastMessageReceived>int</LastMessageReceived>
        <Sites>
          <DeviceSite>
            <AllowComboPunch>int</AllowComboPunch>
            <AllowMultipleTransactions>int</AllowMultipleTransactions>
            <AllowedCallerIDs>string</AllowedCallerIDs>
            <CallerIDVariable>string</CallerIDVariable>
            <Employees xsi:nil="true" />
            <Prompts xsi:nil="true" />
            <RequireCallerID>int</RequireCallerID>
            <SiteName>string</SiteName>
            <SiteNumber>int</SiteNumber>
            <TimeZone>string</TimeZone>
          </DeviceSite>
          <DeviceSite>
            <AllowComboPunch>int</AllowComboPunch>
            <AllowMultipleTransactions>int</AllowMultipleTransactions>
            <AllowedCallerIDs>string</AllowedCallerIDs>
            <CallerIDVariable>string</CallerIDVariable>
            <Employees xsi:nil="true" />
            <Prompts xsi:nil="true" />
            <RequireCallerID>int</RequireCallerID>
            <SiteName>string</SiteName>
            <SiteNumber>int</SiteNumber>
            <TimeZone>string</TimeZone>
          </DeviceSite>
        </Sites>
        <StatusCode>string</StatusCode>
      </GetDeviceConfigResult>
    </GetDeviceConfigResponse>
  </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 /scci/xml/DeviceInterface.asmx/GetDeviceConfig?DeviceID=string&DeviceSecret=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"?>
<DeviceConfig xmlns="http://mc2cs.com/sc">
  <ConsoleSoftwareVersion>string</ConsoleSoftwareVersion>
  <ConsoleTimeZone>string</ConsoleTimeZone>
  <LastMessageReceived>int</LastMessageReceived>
  <Sites>
    <DeviceSite>
      <AllowComboPunch>int</AllowComboPunch>
      <AllowMultipleTransactions>int</AllowMultipleTransactions>
      <AllowedCallerIDs>string</AllowedCallerIDs>
      <CallerIDVariable>string</CallerIDVariable>
      <Employees>
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Employees>
      <Prompts>
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Prompts>
      <RequireCallerID>int</RequireCallerID>
      <SiteName>string</SiteName>
      <SiteNumber>int</SiteNumber>
      <TimeZone>string</TimeZone>
    </DeviceSite>
    <DeviceSite>
      <AllowComboPunch>int</AllowComboPunch>
      <AllowMultipleTransactions>int</AllowMultipleTransactions>
      <AllowedCallerIDs>string</AllowedCallerIDs>
      <CallerIDVariable>string</CallerIDVariable>
      <Employees>
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Employees>
      <Prompts>
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Prompts>
      <RequireCallerID>int</RequireCallerID>
      <SiteName>string</SiteName>
      <SiteNumber>int</SiteNumber>
      <TimeZone>string</TimeZone>
    </DeviceSite>
  </Sites>
  <StatusCode>string</StatusCode>
</DeviceConfig>

HTTP POST

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

POST /scci/xml/DeviceInterface.asmx/GetDeviceConfig HTTP/1.1
Host: www.payrollservers.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

DeviceID=string&DeviceSecret=string

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

<?xml version="1.0" encoding="utf-8"?>
<DeviceConfig xmlns="http://mc2cs.com/sc">
  <ConsoleSoftwareVersion>string</ConsoleSoftwareVersion>
  <ConsoleTimeZone>string</ConsoleTimeZone>
  <LastMessageReceived>int</LastMessageReceived>
  <Sites>
    <DeviceSite>
      <AllowComboPunch>int</AllowComboPunch>
      <AllowMultipleTransactions>int</AllowMultipleTransactions>
      <AllowedCallerIDs>string</AllowedCallerIDs>
      <CallerIDVariable>string</CallerIDVariable>
      <Employees>
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Employees>
      <Prompts>
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Prompts>
      <RequireCallerID>int</RequireCallerID>
      <SiteName>string</SiteName>
      <SiteNumber>int</SiteNumber>
      <TimeZone>string</TimeZone>
    </DeviceSite>
    <DeviceSite>
      <AllowComboPunch>int</AllowComboPunch>
      <AllowMultipleTransactions>int</AllowMultipleTransactions>
      <AllowedCallerIDs>string</AllowedCallerIDs>
      <CallerIDVariable>string</CallerIDVariable>
      <Employees>
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceEmployee d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Employees>
      <Prompts>
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DevicePrompt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Prompts>
      <RequireCallerID>int</RequireCallerID>
      <SiteName>string</SiteName>
      <SiteNumber>int</SiteNumber>
      <TimeZone>string</TimeZone>
    </DeviceSite>
  </Sites>
  <StatusCode>string</StatusCode>
</DeviceConfig>

Parameter	Value
DeviceID:
DeviceSecret: