GET api/Project/PageFields?projectId={projectId}&pageId={pageId}

Get fields for a page/project

Request Information

URI Parameters

NameDescriptionTypeAdditional information
projectId

project id

integer

Required

pageId

page id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Get fields for a page/project

API_Data_ListOfTUIPageFieldDef
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

Collection of TUIPageFieldDef

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "ProjectID": 1,
      "PageID": 2,
      "FieldID": 3,
      "IfReadonly": 1,
      "Ctrl_Pos_Left": 1,
      "Ctrl_Pos_Right": 1,
      "Ctrl_Pos_Top": 1,
      "Ctrl_Pos_Bottom": 1,
      "Label_Pos_Left": 1,
      "Label_Pos_Right": 1,
      "Label_Pos_Top": 1,
      "Label_Pos_Bottom": 1,
      "LabelAlignment": 1
    },
    {
      "ProjectID": 1,
      "PageID": 2,
      "FieldID": 3,
      "IfReadonly": 1,
      "Ctrl_Pos_Left": 1,
      "Ctrl_Pos_Right": 1,
      "Ctrl_Pos_Top": 1,
      "Ctrl_Pos_Bottom": 1,
      "Label_Pos_Left": 1,
      "Label_Pos_Right": 1,
      "Label_Pos_Top": 1,
      "Label_Pos_Bottom": 1,
      "LabelAlignment": 1
    }
  ]
}

application/xml, text/xml

Sample:
<API_Data_ArrayOfTUIPageFieldDef 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.Project">
    <d2p1:TUIPageFieldDef>
      <d2p1:Ctrl_Pos_Bottom>1</d2p1:Ctrl_Pos_Bottom>
      <d2p1:Ctrl_Pos_Left>1</d2p1:Ctrl_Pos_Left>
      <d2p1:Ctrl_Pos_Right>1</d2p1:Ctrl_Pos_Right>
      <d2p1:Ctrl_Pos_Top>1</d2p1:Ctrl_Pos_Top>
      <d2p1:FieldID>3</d2p1:FieldID>
      <d2p1:IfReadonly>1</d2p1:IfReadonly>
      <d2p1:LabelAlignment>1</d2p1:LabelAlignment>
      <d2p1:Label_Pos_Bottom>1</d2p1:Label_Pos_Bottom>
      <d2p1:Label_Pos_Left>1</d2p1:Label_Pos_Left>
      <d2p1:Label_Pos_Right>1</d2p1:Label_Pos_Right>
      <d2p1:Label_Pos_Top>1</d2p1:Label_Pos_Top>
      <d2p1:PageID>2</d2p1:PageID>
      <d2p1:ProjectID>1</d2p1:ProjectID>
    </d2p1:TUIPageFieldDef>
    <d2p1:TUIPageFieldDef>
      <d2p1:Ctrl_Pos_Bottom>1</d2p1:Ctrl_Pos_Bottom>
      <d2p1:Ctrl_Pos_Left>1</d2p1:Ctrl_Pos_Left>
      <d2p1:Ctrl_Pos_Right>1</d2p1:Ctrl_Pos_Right>
      <d2p1:Ctrl_Pos_Top>1</d2p1:Ctrl_Pos_Top>
      <d2p1:FieldID>3</d2p1:FieldID>
      <d2p1:IfReadonly>1</d2p1:IfReadonly>
      <d2p1:LabelAlignment>1</d2p1:LabelAlignment>
      <d2p1:Label_Pos_Bottom>1</d2p1:Label_Pos_Bottom>
      <d2p1:Label_Pos_Left>1</d2p1:Label_Pos_Left>
      <d2p1:Label_Pos_Right>1</d2p1:Label_Pos_Right>
      <d2p1:Label_Pos_Top>1</d2p1:Label_Pos_Top>
      <d2p1:PageID>2</d2p1:PageID>
      <d2p1:ProjectID>1</d2p1:ProjectID>
    </d2p1:TUIPageFieldDef>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfTUIPageFieldDef>