API Web Service

API

Click here for a complete list of operations.

GetProjectReport_v2

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: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/GetProjectReport_v2"

<?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_v2 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_v2>
  </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>
    <GetProjectReport_v2Response xmlns="http://jobctrl.com/">
      <GetProjectReport_v2Result>OK or UnknownError or AuthCodeNotValid</GetProjectReport_v2Result>
      <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>
          <PlannedWorktimeInMinutes>int</PlannedWorktimeInMinutes>
          <SumTotalTime>long</SumTotalTime>
          <DeletedAt>dateTime</DeletedAt>
          <Children>
            <ProjectReportItem_v2 xsi:nil="true" />
            <ProjectReportItem_v2 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>
          <TaskPlannedWorkTimeInMinutes>int</TaskPlannedWorkTimeInMinutes>
          <TaskPlannedCost>decimal</TaskPlannedCost>
          <PeriodData>
            <ProjectPeriodData xsi:nil="true" />
            <ProjectPeriodData xsi:nil="true" />
          </PeriodData>
          <Description>string</Description>
        </Root>
        <TaskCategories>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
        </TaskCategories>
      </Report>
    </GetProjectReport_v2Response>
  </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>
    <GetProjectReport_v2 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_v2>
  </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>
    <GetProjectReport_v2Response xmlns="http://jobctrl.com/">
      <GetProjectReport_v2Result>OK or UnknownError or AuthCodeNotValid</GetProjectReport_v2Result>
      <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>
          <PlannedWorktimeInMinutes>int</PlannedWorktimeInMinutes>
          <SumTotalTime>long</SumTotalTime>
          <DeletedAt>dateTime</DeletedAt>
          <Children>
            <ProjectReportItem_v2 xsi:nil="true" />
            <ProjectReportItem_v2 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>
          <TaskPlannedWorkTimeInMinutes>int</TaskPlannedWorkTimeInMinutes>
          <TaskPlannedCost>decimal</TaskPlannedCost>
          <PeriodData>
            <ProjectPeriodData xsi:nil="true" />
            <ProjectPeriodData xsi:nil="true" />
          </PeriodData>
          <Description>string</Description>
        </Root>
        <TaskCategories>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
          <TaskCategoryData>
            <Name>string</Name>
            <Id>int</Id>
          </TaskCategoryData>
        </TaskCategories>
      </Report>
    </GetProjectReport_v2Response>
  </soap12:Body>
</soap12:Envelope>