API Web Service

API

Click here for a complete list of operations.

GetProjectReport

Get the company's project report 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: kr.jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/GetProjectReport"

<?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>
    <GetProjectReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <taskIdList>
        <int>int</int>
        <int>int</int>
      </taskIdList>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
      <includeProjectsWithoutWorktime>boolean</includeProjectsWithoutWorktime>
      <showClosedProjects>boolean</showClosedProjects>
    </GetProjectReport>
  </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>
    <GetProjectReportResponse xmlns="http://jobctrl.com/">
      <GetProjectReportResult>OK or UnknownError or AuthCodeNotValid</GetProjectReportResult>
      <Report>
        <Root>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <UserId>int</UserId>
          <Name>string</Name>
          <TaskId>int</TaskId>
          <TaskCategoryId>int</TaskCategoryId>
          <ProjectId>int</ProjectId>
          <TotalTime>long</TotalTime>
          <InnerTotalCost>decimal</InnerTotalCost>
          <Priority>short</Priority>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <HoursPlanned>int</HoursPlanned>
          <SumTotalTime>long</SumTotalTime>
          <DeletedAt>dateTime</DeletedAt>
          <Children>
            <ProjectReportItem xsi:nil="true" />
            <ProjectReportItem xsi:nil="true" />
          </Children>
          <ParentTaskNames>
            <string>string</string>
            <string>string</string>
          </ParentTaskNames>
          <ParentWorkerGroupNames>
            <string>string</string>
            <string>string</string>
          </ParentWorkerGroupNames>
          <Type>Project or Work or AssignedWork</Type>
        </Root>
        <TaskCategories>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
        </TaskCategories>
      </Report>
    </GetProjectReportResponse>
  </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: kr.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>
    <GetProjectReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <taskIdList>
        <int>int</int>
        <int>int</int>
      </taskIdList>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
      <includeProjectsWithoutWorktime>boolean</includeProjectsWithoutWorktime>
      <showClosedProjects>boolean</showClosedProjects>
    </GetProjectReport>
  </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>
    <GetProjectReportResponse xmlns="http://jobctrl.com/">
      <GetProjectReportResult>OK or UnknownError or AuthCodeNotValid</GetProjectReportResult>
      <Report>
        <Root>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <UserId>int</UserId>
          <Name>string</Name>
          <TaskId>int</TaskId>
          <TaskCategoryId>int</TaskCategoryId>
          <ProjectId>int</ProjectId>
          <TotalTime>long</TotalTime>
          <InnerTotalCost>decimal</InnerTotalCost>
          <Priority>short</Priority>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <HoursPlanned>int</HoursPlanned>
          <SumTotalTime>long</SumTotalTime>
          <DeletedAt>dateTime</DeletedAt>
          <Children>
            <ProjectReportItem xsi:nil="true" />
            <ProjectReportItem xsi:nil="true" />
          </Children>
          <ParentTaskNames>
            <string>string</string>
            <string>string</string>
          </ParentTaskNames>
          <ParentWorkerGroupNames>
            <string>string</string>
            <string>string</string>
          </ParentWorkerGroupNames>
          <Type>Project or Work or AssignedWork</Type>
        </Root>
        <TaskCategories>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
        </TaskCategories>
      </Report>
    </GetProjectReportResponse>
  </soap12:Body>
</soap12:Envelope>