ProjectAndTaskService Web Service

ProjectAndTaskService

Click here for a complete list of operations.

SearchProjects

Gets projects by supplied Guid id from Project Insight. The flag include tasks will cause the tasks to be returned in a recursive tree on the project object.

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 /projectandtaskservice.asmx HTTP/1.1
Host: webservices.projectinsight.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.projectinsight.net/SearchProjects"

<?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>
    <SearchProjects xmlns="http://webservices.projectinsight.net">
      <sessionKey>string</sessionKey>
      <startDateTimeUTC_RFC1123>string</startDateTimeUTC_RFC1123>
      <endDateTimeUTC_RFC1123>string</endDateTimeUTC_RFC1123>
      <companyListIds>string</companyListIds>
      <companyContractListIds>string</companyContractListIds>
      <isCompaniesMustBeAssociatedToProjectAsDefault>boolean</isCompaniesMustBeAssociatedToProjectAsDefault>
      <isCompanyContractsMustBeAssociatedToProjectAsDefault>boolean</isCompanyContractsMustBeAssociatedToProjectAsDefault>
      <projectStatusListIds>string</projectStatusListIds>
      <projectStatusReportListIds>string</projectStatusReportListIds>
      <projectTypeListIds>string</projectTypeListIds>
      <isActive>boolean</isActive>
      <isArchive>boolean</isArchive>
      <isPlanning>boolean</isPlanning>
      <isTemplate>boolean</isTemplate>
      <isToBeDeleted>boolean</isToBeDeleted>
      <departmentListIds>string</departmentListIds>
      <groupListIds>string</groupListIds>
      <userListIds>string</userListIds>
      <projectManagerListIds>string</projectManagerListIds>
      <primaryProjectManagerListIds>string</primaryProjectManagerListIds>
      <projectSponsorListIds>string</projectSponsorListIds>
      <poNumber>string</poNumber>
      <customerName>string</customerName>
      <clientJobNumber>string</clientJobNumber>
      <statusDescription>string</statusDescription>
      <projectNumber>string</projectNumber>
      <projectListIds>string</projectListIds>
      <planningProjectListIds>string</planningProjectListIds>
      <masterFolderListIds>string</masterFolderListIds>
      <projectCustomFieldReportInputValues>
        <CustomFieldReportInputValue>
          <CustomFieldDefinitionId>guid</CustomFieldDefinitionId>
          <StringValue>string</StringValue>
          <TextValue>string</TextValue>
          <DecimalValue>decimal</DecimalValue>
          <Int32Value>int</Int32Value>
          <DateValue>dateTime</DateValue>
          <RangeStartDateValue>dateTime</RangeStartDateValue>
          <RangeEndDateValue>dateTime</RangeEndDateValue>
          <BoolValue>boolean</BoolValue>
          <GuidValue>guid</GuidValue>
          <GuidValueIds>
            <guid>guid</guid>
            <guid>guid</guid>
          </GuidValueIds>
        </CustomFieldReportInputValue>
        <CustomFieldReportInputValue>
          <CustomFieldDefinitionId>guid</CustomFieldDefinitionId>
          <StringValue>string</StringValue>
          <TextValue>string</TextValue>
          <DecimalValue>decimal</DecimalValue>
          <Int32Value>int</Int32Value>
          <DateValue>dateTime</DateValue>
          <RangeStartDateValue>dateTime</RangeStartDateValue>
          <RangeEndDateValue>dateTime</RangeEndDateValue>
          <BoolValue>boolean</BoolValue>
          <GuidValue>guid</GuidValue>
          <GuidValueIds>
            <guid>guid</guid>
            <guid>guid</guid>
          </GuidValueIds>
        </CustomFieldReportInputValue>
      </projectCustomFieldReportInputValues>
      <includeAdvancedInformation>boolean</includeAdvancedInformation>
      <includeProjectResources>boolean</includeProjectResources>
      <includeTasks>boolean</includeTasks>
      <includeTaskResourceAssignments>boolean</includeTaskResourceAssignments>
      <includeTaskPredecessors>boolean</includeTaskPredecessors>
      <includeProjectBaselines>boolean</includeProjectBaselines>
    </SearchProjects>
  </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>
    <SearchProjectsResponse xmlns="http://webservices.projectinsight.net">
      <SearchProjectsResult>
        <Project>
          <ProjectNumber>int</ProjectNumber>
          <ScheduleStartDate>string</ScheduleStartDate>
          <ProjectType_Id>guid</ProjectType_Id>
          <ProjectType_Name>string</ProjectType_Name>
          <ProjectStatus_Id>guid</ProjectStatus_Id>
          <ProjectStatus_Name>string</ProjectStatus_Name>
          <StatusDescription>string</StatusDescription>
          <ProjectState>int</ProjectState>
          <ProjectStateDescription>string</ProjectStateDescription>
          <CompanyDefault_Id>guid</CompanyDefault_Id>
          <CompanyDefault_Name>string</CompanyDefault_Name>
          <Companies>
            <guid>guid</guid>
            <guid>guid</guid>
          </Companies>
          <CompanyContractDefault_Id>guid</CompanyContractDefault_Id>
          <CompanyContractDefault_Number>string</CompanyContractDefault_Number>
          <CompanyContracts>
            <guid>guid</guid>
            <guid>guid</guid>
          </CompanyContracts>
          <Groups>
            <guid>guid</guid>
            <guid>guid</guid>
          </Groups>
          <Department_Id>guid</Department_Id>
          <ProjectResources>
            <ProjectResource xsi:nil="true" />
            <ProjectResource xsi:nil="true" />
          </ProjectResources>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <ProjectBaseline_Id>guid</ProjectBaseline_Id>
          <ProjectBaselines>
            <ProjectBaseline xsi:nil="true" />
            <ProjectBaseline xsi:nil="true" />
          </ProjectBaselines>
          <IsAtRisk>boolean</IsAtRisk>
          <CustomerName>string</CustomerName>
          <PurchaseOrder>string</PurchaseOrder>
          <ClientJobNumber>string</ClientJobNumber>
          <TargetWorkTotalHours>decimal</TargetWorkTotalHours>
          <TargetWorkTotalRate>decimal</TargetWorkTotalRate>
          <TargetWorkTotalTime>decimal</TargetWorkTotalTime>
          <TargetWorkTotalExpense>decimal</TargetWorkTotalExpense>
          <TargetWorkTotalCost>decimal</TargetWorkTotalCost>
          <TargetWorkTotalHoursBillable>decimal</TargetWorkTotalHoursBillable>
          <TargetWorkTotalRateBillable>decimal</TargetWorkTotalRateBillable>
          <TargetWorkTotalTimeBillable>decimal</TargetWorkTotalTimeBillable>
          <TargetWorkTotalExpenseBillable>decimal</TargetWorkTotalExpenseBillable>
          <TargetWorkTotalCostBillable>decimal</TargetWorkTotalCostBillable>
        </Project>
        <Project>
          <ProjectNumber>int</ProjectNumber>
          <ScheduleStartDate>string</ScheduleStartDate>
          <ProjectType_Id>guid</ProjectType_Id>
          <ProjectType_Name>string</ProjectType_Name>
          <ProjectStatus_Id>guid</ProjectStatus_Id>
          <ProjectStatus_Name>string</ProjectStatus_Name>
          <StatusDescription>string</StatusDescription>
          <ProjectState>int</ProjectState>
          <ProjectStateDescription>string</ProjectStateDescription>
          <CompanyDefault_Id>guid</CompanyDefault_Id>
          <CompanyDefault_Name>string</CompanyDefault_Name>
          <Companies>
            <guid>guid</guid>
            <guid>guid</guid>
          </Companies>
          <CompanyContractDefault_Id>guid</CompanyContractDefault_Id>
          <CompanyContractDefault_Number>string</CompanyContractDefault_Number>
          <CompanyContracts>
            <guid>guid</guid>
            <guid>guid</guid>
          </CompanyContracts>
          <Groups>
            <guid>guid</guid>
            <guid>guid</guid>
          </Groups>
          <Department_Id>guid</Department_Id>
          <ProjectResources>
            <ProjectResource xsi:nil="true" />
            <ProjectResource xsi:nil="true" />
          </ProjectResources>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <ProjectBaseline_Id>guid</ProjectBaseline_Id>
          <ProjectBaselines>
            <ProjectBaseline xsi:nil="true" />
            <ProjectBaseline xsi:nil="true" />
          </ProjectBaselines>
          <IsAtRisk>boolean</IsAtRisk>
          <CustomerName>string</CustomerName>
          <PurchaseOrder>string</PurchaseOrder>
          <ClientJobNumber>string</ClientJobNumber>
          <TargetWorkTotalHours>decimal</TargetWorkTotalHours>
          <TargetWorkTotalRate>decimal</TargetWorkTotalRate>
          <TargetWorkTotalTime>decimal</TargetWorkTotalTime>
          <TargetWorkTotalExpense>decimal</TargetWorkTotalExpense>
          <TargetWorkTotalCost>decimal</TargetWorkTotalCost>
          <TargetWorkTotalHoursBillable>decimal</TargetWorkTotalHoursBillable>
          <TargetWorkTotalRateBillable>decimal</TargetWorkTotalRateBillable>
          <TargetWorkTotalTimeBillable>decimal</TargetWorkTotalTimeBillable>
          <TargetWorkTotalExpenseBillable>decimal</TargetWorkTotalExpenseBillable>
          <TargetWorkTotalCostBillable>decimal</TargetWorkTotalCostBillable>
        </Project>
      </SearchProjectsResult>
    </SearchProjectsResponse>
  </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 /projectandtaskservice.asmx HTTP/1.1
Host: webservices.projectinsight.net
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>
    <SearchProjects xmlns="http://webservices.projectinsight.net">
      <sessionKey>string</sessionKey>
      <startDateTimeUTC_RFC1123>string</startDateTimeUTC_RFC1123>
      <endDateTimeUTC_RFC1123>string</endDateTimeUTC_RFC1123>
      <companyListIds>string</companyListIds>
      <companyContractListIds>string</companyContractListIds>
      <isCompaniesMustBeAssociatedToProjectAsDefault>boolean</isCompaniesMustBeAssociatedToProjectAsDefault>
      <isCompanyContractsMustBeAssociatedToProjectAsDefault>boolean</isCompanyContractsMustBeAssociatedToProjectAsDefault>
      <projectStatusListIds>string</projectStatusListIds>
      <projectStatusReportListIds>string</projectStatusReportListIds>
      <projectTypeListIds>string</projectTypeListIds>
      <isActive>boolean</isActive>
      <isArchive>boolean</isArchive>
      <isPlanning>boolean</isPlanning>
      <isTemplate>boolean</isTemplate>
      <isToBeDeleted>boolean</isToBeDeleted>
      <departmentListIds>string</departmentListIds>
      <groupListIds>string</groupListIds>
      <userListIds>string</userListIds>
      <projectManagerListIds>string</projectManagerListIds>
      <primaryProjectManagerListIds>string</primaryProjectManagerListIds>
      <projectSponsorListIds>string</projectSponsorListIds>
      <poNumber>string</poNumber>
      <customerName>string</customerName>
      <clientJobNumber>string</clientJobNumber>
      <statusDescription>string</statusDescription>
      <projectNumber>string</projectNumber>
      <projectListIds>string</projectListIds>
      <planningProjectListIds>string</planningProjectListIds>
      <masterFolderListIds>string</masterFolderListIds>
      <projectCustomFieldReportInputValues>
        <CustomFieldReportInputValue>
          <CustomFieldDefinitionId>guid</CustomFieldDefinitionId>
          <StringValue>string</StringValue>
          <TextValue>string</TextValue>
          <DecimalValue>decimal</DecimalValue>
          <Int32Value>int</Int32Value>
          <DateValue>dateTime</DateValue>
          <RangeStartDateValue>dateTime</RangeStartDateValue>
          <RangeEndDateValue>dateTime</RangeEndDateValue>
          <BoolValue>boolean</BoolValue>
          <GuidValue>guid</GuidValue>
          <GuidValueIds>
            <guid>guid</guid>
            <guid>guid</guid>
          </GuidValueIds>
        </CustomFieldReportInputValue>
        <CustomFieldReportInputValue>
          <CustomFieldDefinitionId>guid</CustomFieldDefinitionId>
          <StringValue>string</StringValue>
          <TextValue>string</TextValue>
          <DecimalValue>decimal</DecimalValue>
          <Int32Value>int</Int32Value>
          <DateValue>dateTime</DateValue>
          <RangeStartDateValue>dateTime</RangeStartDateValue>
          <RangeEndDateValue>dateTime</RangeEndDateValue>
          <BoolValue>boolean</BoolValue>
          <GuidValue>guid</GuidValue>
          <GuidValueIds>
            <guid>guid</guid>
            <guid>guid</guid>
          </GuidValueIds>
        </CustomFieldReportInputValue>
      </projectCustomFieldReportInputValues>
      <includeAdvancedInformation>boolean</includeAdvancedInformation>
      <includeProjectResources>boolean</includeProjectResources>
      <includeTasks>boolean</includeTasks>
      <includeTaskResourceAssignments>boolean</includeTaskResourceAssignments>
      <includeTaskPredecessors>boolean</includeTaskPredecessors>
      <includeProjectBaselines>boolean</includeProjectBaselines>
    </SearchProjects>
  </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>
    <SearchProjectsResponse xmlns="http://webservices.projectinsight.net">
      <SearchProjectsResult>
        <Project>
          <ProjectNumber>int</ProjectNumber>
          <ScheduleStartDate>string</ScheduleStartDate>
          <ProjectType_Id>guid</ProjectType_Id>
          <ProjectType_Name>string</ProjectType_Name>
          <ProjectStatus_Id>guid</ProjectStatus_Id>
          <ProjectStatus_Name>string</ProjectStatus_Name>
          <StatusDescription>string</StatusDescription>
          <ProjectState>int</ProjectState>
          <ProjectStateDescription>string</ProjectStateDescription>
          <CompanyDefault_Id>guid</CompanyDefault_Id>
          <CompanyDefault_Name>string</CompanyDefault_Name>
          <Companies>
            <guid>guid</guid>
            <guid>guid</guid>
          </Companies>
          <CompanyContractDefault_Id>guid</CompanyContractDefault_Id>
          <CompanyContractDefault_Number>string</CompanyContractDefault_Number>
          <CompanyContracts>
            <guid>guid</guid>
            <guid>guid</guid>
          </CompanyContracts>
          <Groups>
            <guid>guid</guid>
            <guid>guid</guid>
          </Groups>
          <Department_Id>guid</Department_Id>
          <ProjectResources>
            <ProjectResource xsi:nil="true" />
            <ProjectResource xsi:nil="true" />
          </ProjectResources>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <ProjectBaseline_Id>guid</ProjectBaseline_Id>
          <ProjectBaselines>
            <ProjectBaseline xsi:nil="true" />
            <ProjectBaseline xsi:nil="true" />
          </ProjectBaselines>
          <IsAtRisk>boolean</IsAtRisk>
          <CustomerName>string</CustomerName>
          <PurchaseOrder>string</PurchaseOrder>
          <ClientJobNumber>string</ClientJobNumber>
          <TargetWorkTotalHours>decimal</TargetWorkTotalHours>
          <TargetWorkTotalRate>decimal</TargetWorkTotalRate>
          <TargetWorkTotalTime>decimal</TargetWorkTotalTime>
          <TargetWorkTotalExpense>decimal</TargetWorkTotalExpense>
          <TargetWorkTotalCost>decimal</TargetWorkTotalCost>
          <TargetWorkTotalHoursBillable>decimal</TargetWorkTotalHoursBillable>
          <TargetWorkTotalRateBillable>decimal</TargetWorkTotalRateBillable>
          <TargetWorkTotalTimeBillable>decimal</TargetWorkTotalTimeBillable>
          <TargetWorkTotalExpenseBillable>decimal</TargetWorkTotalExpenseBillable>
          <TargetWorkTotalCostBillable>decimal</TargetWorkTotalCostBillable>
        </Project>
        <Project>
          <ProjectNumber>int</ProjectNumber>
          <ScheduleStartDate>string</ScheduleStartDate>
          <ProjectType_Id>guid</ProjectType_Id>
          <ProjectType_Name>string</ProjectType_Name>
          <ProjectStatus_Id>guid</ProjectStatus_Id>
          <ProjectStatus_Name>string</ProjectStatus_Name>
          <StatusDescription>string</StatusDescription>
          <ProjectState>int</ProjectState>
          <ProjectStateDescription>string</ProjectStateDescription>
          <CompanyDefault_Id>guid</CompanyDefault_Id>
          <CompanyDefault_Name>string</CompanyDefault_Name>
          <Companies>
            <guid>guid</guid>
            <guid>guid</guid>
          </Companies>
          <CompanyContractDefault_Id>guid</CompanyContractDefault_Id>
          <CompanyContractDefault_Number>string</CompanyContractDefault_Number>
          <CompanyContracts>
            <guid>guid</guid>
            <guid>guid</guid>
          </CompanyContracts>
          <Groups>
            <guid>guid</guid>
            <guid>guid</guid>
          </Groups>
          <Department_Id>guid</Department_Id>
          <ProjectResources>
            <ProjectResource xsi:nil="true" />
            <ProjectResource xsi:nil="true" />
          </ProjectResources>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <ProjectBaseline_Id>guid</ProjectBaseline_Id>
          <ProjectBaselines>
            <ProjectBaseline xsi:nil="true" />
            <ProjectBaseline xsi:nil="true" />
          </ProjectBaselines>
          <IsAtRisk>boolean</IsAtRisk>
          <CustomerName>string</CustomerName>
          <PurchaseOrder>string</PurchaseOrder>
          <ClientJobNumber>string</ClientJobNumber>
          <TargetWorkTotalHours>decimal</TargetWorkTotalHours>
          <TargetWorkTotalRate>decimal</TargetWorkTotalRate>
          <TargetWorkTotalTime>decimal</TargetWorkTotalTime>
          <TargetWorkTotalExpense>decimal</TargetWorkTotalExpense>
          <TargetWorkTotalCost>decimal</TargetWorkTotalCost>
          <TargetWorkTotalHoursBillable>decimal</TargetWorkTotalHoursBillable>
          <TargetWorkTotalRateBillable>decimal</TargetWorkTotalRateBillable>
          <TargetWorkTotalTimeBillable>decimal</TargetWorkTotalTimeBillable>
          <TargetWorkTotalExpenseBillable>decimal</TargetWorkTotalExpenseBillable>
          <TargetWorkTotalCostBillable>decimal</TargetWorkTotalCostBillable>
        </Project>
      </SearchProjectsResult>
    </SearchProjectsResponse>
  </soap12:Body>
</soap12:Envelope>