API Web Service

API

Click here for a complete list of operations.

GetCommentsOfUsers

Gets comments of users

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

<?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>
    <GetCommentsOfUsers xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UTCStartDate>dateTime</UTCStartDate>
      <UTCEndDate>dateTime</UTCEndDate>
      <userIds>
        <int>int</int>
        <int>int</int>
      </userIds>
    </GetCommentsOfUsers>
  </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>
    <GetCommentsOfUsersResponse xmlns="http://jobctrl.com/">
      <GetCommentsOfUsersResult>OK or UnknownError or AuthCodeNotValid</GetCommentsOfUsersResult>
      <comments>
        <UsersComment>
          <UserId>int</UserId>
          <WorkId>int</WorkId>
          <ReasonItemId>int</ReasonItemId>
          <ReasonItemNames>
            <string>string</string>
            <string>string</string>
          </ReasonItemNames>
          <Text>string</Text>
          <UTCDate>dateTime</UTCDate>
        </UsersComment>
        <UsersComment>
          <UserId>int</UserId>
          <WorkId>int</WorkId>
          <ReasonItemId>int</ReasonItemId>
          <ReasonItemNames>
            <string>string</string>
            <string>string</string>
          </ReasonItemNames>
          <Text>string</Text>
          <UTCDate>dateTime</UTCDate>
        </UsersComment>
      </comments>
    </GetCommentsOfUsersResponse>
  </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>
    <GetCommentsOfUsers xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UTCStartDate>dateTime</UTCStartDate>
      <UTCEndDate>dateTime</UTCEndDate>
      <userIds>
        <int>int</int>
        <int>int</int>
      </userIds>
    </GetCommentsOfUsers>
  </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>
    <GetCommentsOfUsersResponse xmlns="http://jobctrl.com/">
      <GetCommentsOfUsersResult>OK or UnknownError or AuthCodeNotValid</GetCommentsOfUsersResult>
      <comments>
        <UsersComment>
          <UserId>int</UserId>
          <WorkId>int</WorkId>
          <ReasonItemId>int</ReasonItemId>
          <ReasonItemNames>
            <string>string</string>
            <string>string</string>
          </ReasonItemNames>
          <Text>string</Text>
          <UTCDate>dateTime</UTCDate>
        </UsersComment>
        <UsersComment>
          <UserId>int</UserId>
          <WorkId>int</WorkId>
          <ReasonItemId>int</ReasonItemId>
          <ReasonItemNames>
            <string>string</string>
            <string>string</string>
          </ReasonItemNames>
          <Text>string</Text>
          <UTCDate>dateTime</UTCDate>
        </UsersComment>
      </comments>
    </GetCommentsOfUsersResponse>
  </soap12:Body>
</soap12:Envelope>