API12 Web Service

API12

Click here for a complete list of operations.

CreateSessionSelectClient

Creates a new session for future calls to this API and selects a specific client. Mainly useful for accounts that can access data from more than one client. The returned SessionID can be passed into subsequent API calls, and, except if the server is reset, typically is valid for at least several hours.

The same IP-address limitation as described in CreateSession also applies here.
Parameter "matchfield" determines how to parse clientID, and can be either "EmployerID" (client tag entered on website), "MC2ID" (numeric identifier assigned by MC2), or "ClientName" (directly match on client name).
Returns "true" in Success, and a unique SessionID string. if successful.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
login:
password:
secondFactor:
matchfield:
clientID:

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/CreateSessionSelectClient"

<?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>
    <CreateSessionSelectClient xmlns="http://mc2cs.com/">
      <login>string</login>
      <password>string</password>
      <secondFactor>string</secondFactor>
      <matchfield>string</matchfield>
      <clientID>string</clientID>
    </CreateSessionSelectClient>
  </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>
    <CreateSessionSelectClientResponse xmlns="http://mc2cs.com/">
      <CreateSessionSelectClientResult>
        <SessionID>string</SessionID>
      </CreateSessionSelectClientResult>
    </CreateSessionSelectClientResponse>
  </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>
    <CreateSessionSelectClient xmlns="http://mc2cs.com/">
      <login>string</login>
      <password>string</password>
      <secondFactor>string</secondFactor>
      <matchfield>string</matchfield>
      <clientID>string</clientID>
    </CreateSessionSelectClient>
  </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>
    <CreateSessionSelectClientResponse xmlns="http://mc2cs.com/">
      <CreateSessionSelectClientResult>
        <SessionID>string</SessionID>
      </CreateSessionSelectClientResult>
    </CreateSessionSelectClientResponse>
  </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/CreateSessionSelectClient?login=string&password=string&secondFactor=string&matchfield=string&clientID=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"?>
<CreateSessionResult xmlns="http://mc2cs.com/">
  <SessionID>string</SessionID>
</CreateSessionResult>

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/CreateSessionSelectClient HTTP/1.1
Host: www.swipeclock.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

login=string&password=string&secondFactor=string&matchfield=string&clientID=string

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

<?xml version="1.0" encoding="utf-8"?>
<CreateSessionResult xmlns="http://mc2cs.com/">
  <SessionID>string</SessionID>
</CreateSessionResult>