API Web Service

API

Click here for a complete list of operations.

GetFavoriteCustomReport

Get the company's custom report saved as favorite for the specified time interval

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

<?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>
    <GetFavoriteCustomReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <favoriteReportId>int</favoriteReportId>
    </GetFavoriteCustomReport>
  </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>
    <GetFavoriteCustomReportResponse xmlns="http://jobctrl.com/">
      <GetFavoriteCustomReportResult>OK or ErrorInReportExecution or FavoriteReportTypeIsNotCustom or UnknownError or AuthCodeNotValid</GetFavoriteCustomReportResult>
      <Report>
        <ResultSet>
          <Tables>
            <DataTable xsi:nil="true" />
            <DataTable xsi:nil="true" />
          </Tables>
        </ResultSet>
        <ShowReport>boolean</ShowReport>
      </Report>
    </GetFavoriteCustomReportResponse>
  </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>
    <GetFavoriteCustomReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <favoriteReportId>int</favoriteReportId>
    </GetFavoriteCustomReport>
  </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>
    <GetFavoriteCustomReportResponse xmlns="http://jobctrl.com/">
      <GetFavoriteCustomReportResult>OK or ErrorInReportExecution or FavoriteReportTypeIsNotCustom or UnknownError or AuthCodeNotValid</GetFavoriteCustomReportResult>
      <Report>
        <ResultSet>
          <Tables>
            <DataTable xsi:nil="true" />
            <DataTable xsi:nil="true" />
          </Tables>
        </ResultSet>
        <ShowReport>boolean</ShowReport>
      </Report>
    </GetFavoriteCustomReportResponse>
  </soap12:Body>
</soap12:Envelope>