POST api/projectone/P1ProjectsEx

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

Request Information

URI Parameters

None.

Body Parameters

P1ProjectsExBinder
NameDescriptionTypeAdditional information
ProjectBaseId

integer

None.
QueryOption

P1ProjectsQueryOption

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": {
    "StatusOption": 1,
    "ModuleOption": 1
  },
  "ProjectCategory": 2
}

application/xml, text/xml

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

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_ListOfProjectModel
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

Collection of ProjectModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "ProjectID": 1,
      "IsActive": true,
      "ProjectName": "sample string 3",
      "ProjectType": 4,
      "IsSampleProject": 5
    },
    {
      "ProjectID": 1,
      "IsActive": true,
      "ProjectName": "sample string 3",
      "ProjectType": 4,
      "IsSampleProject": 5
    }
  ]
}

application/xml, text/xml

Sample: 
<API_Data_ArrayOfProjectModel 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.Entities">
    <d2p1:ProjectModel>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsSampleProject>5</d2p1:IsSampleProject>
      <d2p1:ProjectID>1</d2p1:ProjectID>
      <d2p1:ProjectName>sample string 3</d2p1:ProjectName>
      <d2p1:ProjectType>4</d2p1:ProjectType>
    </d2p1:ProjectModel>
    <d2p1:ProjectModel>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsSampleProject>5</d2p1:IsSampleProject>
      <d2p1:ProjectID>1</d2p1:ProjectID>
      <d2p1:ProjectName>sample string 3</d2p1:ProjectName>
      <d2p1:ProjectType>4</d2p1:ProjectType>
    </d2p1:ProjectModel>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfProjectModel>