API12 Web Service

API12

Click here for a complete list of operations.

CreateSession

Creates a new session for future calls to this API, given a login and password. This login and password needs to have access to only one client, otherwise please use CreateSessionSelectClient. Returns "true" in Success, and a unique SessionID string in ApiReturn.StringReturnValue if successful. SessionID can be passed into subsequent API calls, and, except if the server is reset, typically is valid for at least several hours.

Note: Your session is only valid with the individual server you're connected to, which is chosen from a load balancing pool. You'll get the same server whenever you connect from the same public IP address (or any public IP address that matches on the first three numbers, also known as the same class-C block), but your session most likely cannot be used from another IP address elsewhere on the internet, such as if you were to give your Session ID to another party. If you want to delegate access, use GetOneTimeCredential, which is persisted in our database and can be accessed from any IP address.
Security Warning: Your Session ID is a credential, and anyone who has it can take actions on your account. Keep it secure as though it were a password.

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

<?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>
    <CreateSession xmlns="http://mc2cs.com/">
      <login>string</login>
      <password>string</password>
      <secondFactor>string</secondFactor>
    </CreateSession>
  </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>
    <CreateSessionResponse xmlns="http://mc2cs.com/">
      <CreateSessionResult>
        <SessionID>string</SessionID>
      </CreateSessionResult>
    </CreateSessionResponse>
  </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>
    <CreateSession xmlns="http://mc2cs.com/">
      <login>string</login>
      <password>string</password>
      <secondFactor>string</secondFactor>
    </CreateSession>
  </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>
    <CreateSessionResponse xmlns="http://mc2cs.com/">
      <CreateSessionResult>
        <SessionID>string</SessionID>
      </CreateSessionResult>
    </CreateSessionResponse>
  </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/CreateSession?login=string&password=string&secondFactor=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"?>
<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/CreateSession HTTP/1.1
Host: www.payrollservers.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

login=string&password=string&secondFactor=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>

Parameter	Value
login:
password:
secondFactor: