POST api/projectone/P1Projects

Get all p1 projects in a ProjectBase Family based on query option

Request Information

URI Parameters

None.

Body Parameters

P1ProjectsBinder
NameDescriptionTypeAdditional information
ProjectBaseId

integer

None.

QueryOption

If Option equals 1, indicate only opened projects are included, If Option equals 2, indicate only archived projects are included, If Option equals 3, indicate both opened and archived projects are included.

integer

None.

ProjectCategory

If ProjectCategory equals 0, indicate only normal projects are included If ProjectCategory equals 1, indicate only project templates are included If ProjectCategory equals 2, indicate only project rquests are included

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectBaseId": 1,
  "QueryOption": 2,
  "ProjectCategory": 3
}

application/xml, text/xml

Sample:
<P1ProjectsBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.ProjectOne">
  <ProjectBaseId>1</ProjectBaseId>
  <ProjectCategory>3</ProjectCategory>
  <QueryOption>2</QueryOption>
</P1ProjectsBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get all p1 projects in a ProjectBase Family based on query option

API_Data_IEnumerableOfP1ProjectBasicInfo
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

Collection of P1ProjectBasicInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "PrimaryManagerId": 1,
      "PrimaryManagerName": "sample string 1",
      "StatusId": 1,
      "StatusName": "sample string 2",
      "PlanStartDate": "2020-11-29 11:48:43",
      "PlanFinishDate": "2020-11-29 11:48:43",
      "ProjectId": 3,
      "ProjectTypeId": 4,
      "SpaceId": 5,
      "SpaceName": "sample string 6",
      "P1ProjectType": 7
    },
    {
      "PrimaryManagerId": 1,
      "PrimaryManagerName": "sample string 1",
      "StatusId": 1,
      "StatusName": "sample string 2",
      "PlanStartDate": "2020-11-29 11:48:43",
      "PlanFinishDate": "2020-11-29 11:48:43",
      "ProjectId": 3,
      "ProjectTypeId": 4,
      "SpaceId": 5,
      "SpaceName": "sample string 6",
      "P1ProjectType": 7
    }
  ]
}

application/xml, text/xml

Sample:
<API_Data_ArrayOfP1ProjectBasicInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.ProjectOne">
    <d2p1:P1ProjectBasicInfo>
      <d2p1:P1ProjectType>7</d2p1:P1ProjectType>
      <d2p1:ProjectId>3</d2p1:ProjectId>
      <d2p1:ProjectTypeId>4</d2p1:ProjectTypeId>
      <d2p1:SpaceId>5</d2p1:SpaceId>
      <d2p1:SpaceName>sample string 6</d2p1:SpaceName>
      <d2p1:PlanFinishDate>2020-11-29T11:48:43.2963414-08:00</d2p1:PlanFinishDate>
      <d2p1:PlanStartDate>2020-11-29T11:48:43.2963414-08:00</d2p1:PlanStartDate>
      <d2p1:PrimaryManagerId>1</d2p1:PrimaryManagerId>
      <d2p1:PrimaryManagerName>sample string 1</d2p1:PrimaryManagerName>
      <d2p1:StatusId>1</d2p1:StatusId>
      <d2p1:StatusName>sample string 2</d2p1:StatusName>
    </d2p1:P1ProjectBasicInfo>
    <d2p1:P1ProjectBasicInfo>
      <d2p1:P1ProjectType>7</d2p1:P1ProjectType>
      <d2p1:ProjectId>3</d2p1:ProjectId>
      <d2p1:ProjectTypeId>4</d2p1:ProjectTypeId>
      <d2p1:SpaceId>5</d2p1:SpaceId>
      <d2p1:SpaceName>sample string 6</d2p1:SpaceName>
      <d2p1:PlanFinishDate>2020-11-29T11:48:43.2963414-08:00</d2p1:PlanFinishDate>
      <d2p1:PlanStartDate>2020-11-29T11:48:43.2963414-08:00</d2p1:PlanStartDate>
      <d2p1:PrimaryManagerId>1</d2p1:PrimaryManagerId>
      <d2p1:PrimaryManagerName>sample string 1</d2p1:PrimaryManagerName>
      <d2p1:StatusId>1</d2p1:StatusId>
      <d2p1:StatusName>sample string 2</d2p1:StatusName>
    </d2p1:P1ProjectBasicInfo>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfP1ProjectBasicInfo>