POST api/StandardWorkTemplate/List

Get template list based on project base

Request Information

URI Parameters

None.

Body Parameters

StandardWorkTemplateQueryBinder
NameDescriptionTypeAdditional information
ProjectId

Project base family id

 integer

None.
PageIndex

integer

None.
PageSize

integer

None.
WorkTypes

Collection of WorkObjectiveTypeIdObject

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "PageIndex": 2,
  "PageSize": 3,
  "WorkTypes": [
    {
      "SystemType": 1,
      "Id": 2
    },
    {
      "SystemType": 1,
      "Id": 2
    }
  ]
}

application/xml, text/xml

Sample: 
<StandardWorkTemplateQueryBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <PageIndex>2</PageIndex>
  <PageSize>3</PageSize>
  <ProjectId>1</ProjectId>
  <WorkTypes>
    <WorkObjectiveTypeIdObject>
      <Id>2</Id>
      <SystemType>1</SystemType>
    </WorkObjectiveTypeIdObject>
    <WorkObjectiveTypeIdObject>
      <Id>2</Id>
      <SystemType>1</SystemType>
    </WorkObjectiveTypeIdObject>
  </WorkTypes>
</StandardWorkTemplateQueryBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get template list based on project base

API_Data_StandardWorkTemplateList
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

StandardWorkTemplateList

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "Total": 1,
    "Items": [
      {
        "ProjectId": 1,
        "TemplateId": 2,
        "Title": "sample string 3",
        "Points": 1,
        "SystemWorkType": 1,
        "WorkType": 1,
        "WorkTypeName": "sample string 4"
      },
      {
        "ProjectId": 1,
        "TemplateId": 2,
        "Title": "sample string 3",
        "Points": 1,
        "SystemWorkType": 1,
        "WorkType": 1,
        "WorkTypeName": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<API_Data_StandardWorkTemplateList 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:Items>
      <d2p1:StandardWorkTemplateListItem>
        <d2p1:Points>1</d2p1:Points>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:SystemWorkType>1</d2p1:SystemWorkType>
        <d2p1:TemplateId>2</d2p1:TemplateId>
        <d2p1:Title>sample string 3</d2p1:Title>
        <d2p1:WorkType>1</d2p1:WorkType>
        <d2p1:WorkTypeName>sample string 4</d2p1:WorkTypeName>
      </d2p1:StandardWorkTemplateListItem>
      <d2p1:StandardWorkTemplateListItem>
        <d2p1:Points>1</d2p1:Points>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:SystemWorkType>1</d2p1:SystemWorkType>
        <d2p1:TemplateId>2</d2p1:TemplateId>
        <d2p1:Title>sample string 3</d2p1:Title>
        <d2p1:WorkType>1</d2p1:WorkType>
        <d2p1:WorkTypeName>sample string 4</d2p1:WorkTypeName>
      </d2p1:StandardWorkTemplateListItem>
    </d2p1:Items>
    <d2p1:Total>1</d2p1:Total>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_StandardWorkTemplateList>