API


Click here for a complete list of operations.

GetAllUsers

Gets all non-deleted users of the company.

Test

The test form is only available for requests from the local machine.

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 /api/api.asmx HTTP/1.1
Host: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/GetAllUsers"

<?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>
    <GetAllUsers xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <includeDeleted>boolean</includeDeleted>
    </GetAllUsers>
  </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>
    <GetAllUsersResponse xmlns="http://jobctrl.com/">
      <GetAllUsersResult>OK or UnknownError or AuthCodeNotValid</GetAllUsersResult>
      <users>
        <Worker_v2>
          <UserId>int</UserId>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CultureId>string</CultureId>
          <AccessLevel>NoChange or Worker or Supervisor or Administrator</AccessLevel>
          <ActiveDirectoryUserPrincipalName>string</ActiveDirectoryUserPrincipalName>
          <FirstWorkTime>dateTime</FirstWorkTime>
          <LastWorkTime>dateTime</LastWorkTime>
          <UserExtendedProperties>
            <UserExtendedProperty xsi:nil="true" />
            <UserExtendedProperty xsi:nil="true" />
          </UserExtendedProperties>
        </Worker_v2>
        <Worker_v2>
          <UserId>int</UserId>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CultureId>string</CultureId>
          <AccessLevel>NoChange or Worker or Supervisor or Administrator</AccessLevel>
          <ActiveDirectoryUserPrincipalName>string</ActiveDirectoryUserPrincipalName>
          <FirstWorkTime>dateTime</FirstWorkTime>
          <LastWorkTime>dateTime</LastWorkTime>
          <UserExtendedProperties>
            <UserExtendedProperty xsi:nil="true" />
            <UserExtendedProperty xsi:nil="true" />
          </UserExtendedProperties>
        </Worker_v2>
      </users>
    </GetAllUsersResponse>
  </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 /api/api.asmx HTTP/1.1
Host: jobctrl.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>
    <GetAllUsers xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <includeDeleted>boolean</includeDeleted>
    </GetAllUsers>
  </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>
    <GetAllUsersResponse xmlns="http://jobctrl.com/">
      <GetAllUsersResult>OK or UnknownError or AuthCodeNotValid</GetAllUsersResult>
      <users>
        <Worker_v2>
          <UserId>int</UserId>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CultureId>string</CultureId>
          <AccessLevel>NoChange or Worker or Supervisor or Administrator</AccessLevel>
          <ActiveDirectoryUserPrincipalName>string</ActiveDirectoryUserPrincipalName>
          <FirstWorkTime>dateTime</FirstWorkTime>
          <LastWorkTime>dateTime</LastWorkTime>
          <UserExtendedProperties>
            <UserExtendedProperty xsi:nil="true" />
            <UserExtendedProperty xsi:nil="true" />
          </UserExtendedProperties>
        </Worker_v2>
        <Worker_v2>
          <UserId>int</UserId>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CultureId>string</CultureId>
          <AccessLevel>NoChange or Worker or Supervisor or Administrator</AccessLevel>
          <ActiveDirectoryUserPrincipalName>string</ActiveDirectoryUserPrincipalName>
          <FirstWorkTime>dateTime</FirstWorkTime>
          <LastWorkTime>dateTime</LastWorkTime>
          <UserExtendedProperties>
            <UserExtendedProperty xsi:nil="true" />
            <UserExtendedProperty xsi:nil="true" />
          </UserExtendedProperties>
        </Worker_v2>
      </users>
    </GetAllUsersResponse>
  </soap12:Body>
</soap12:Envelope>