POST api/Admin/SetFieldsOnPage?projectId={projectId}&pageId={pageId}
SetFieldsOnPage
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| projectId | integer |
Required |
|
| pageId | integer |
Required |
Body Parameters
Collection of WebUIPageFieldDef| Name | Description | Type | Additional information |
|---|---|---|---|
| ProjectID | integer |
None. |
|
| PageID | integer |
None. |
|
| FieldID | integer |
None. |
|
| FieldName | string |
None. |
|
| FieldNote | string |
None. |
|
| FieldType | integer |
None. |
|
| IfReadonly | integer |
None. |
|
| Ctrl_Pos_Left | integer |
None. |
|
| Ctrl_Pos_Right | integer |
None. |
|
| Ctrl_Pos_Top | integer |
None. |
|
| Ctrl_Pos_Bottom | integer |
None. |
|
| Label_Pos_Left | integer |
None. |
|
| Label_Pos_Right | integer |
None. |
|
| Label_Pos_Top | integer |
None. |
|
| Label_Pos_Bottom | integer |
None. |
|
| LabelAlignment | integer |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"ProjectID": 1,
"PageID": 2,
"FieldID": 3,
"FieldName": "sample string 4",
"FieldNote": "sample string 5",
"FieldType": 6,
"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,
"FieldName": "sample string 4",
"FieldNote": "sample string 5",
"FieldType": 6,
"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:
<ArrayOfWebUIPageFieldDef xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
<WebUIPageFieldDef>
<Ctrl_Pos_Bottom>1</Ctrl_Pos_Bottom>
<Ctrl_Pos_Left>1</Ctrl_Pos_Left>
<Ctrl_Pos_Right>1</Ctrl_Pos_Right>
<Ctrl_Pos_Top>1</Ctrl_Pos_Top>
<FieldID>3</FieldID>
<FieldName>sample string 4</FieldName>
<FieldNote>sample string 5</FieldNote>
<FieldType>6</FieldType>
<IfReadonly>1</IfReadonly>
<LabelAlignment>1</LabelAlignment>
<Label_Pos_Bottom>1</Label_Pos_Bottom>
<Label_Pos_Left>1</Label_Pos_Left>
<Label_Pos_Right>1</Label_Pos_Right>
<Label_Pos_Top>1</Label_Pos_Top>
<PageID>2</PageID>
<ProjectID>1</ProjectID>
</WebUIPageFieldDef>
<WebUIPageFieldDef>
<Ctrl_Pos_Bottom>1</Ctrl_Pos_Bottom>
<Ctrl_Pos_Left>1</Ctrl_Pos_Left>
<Ctrl_Pos_Right>1</Ctrl_Pos_Right>
<Ctrl_Pos_Top>1</Ctrl_Pos_Top>
<FieldID>3</FieldID>
<FieldName>sample string 4</FieldName>
<FieldNote>sample string 5</FieldNote>
<FieldType>6</FieldType>
<IfReadonly>1</IfReadonly>
<LabelAlignment>1</LabelAlignment>
<Label_Pos_Bottom>1</Label_Pos_Bottom>
<Label_Pos_Left>1</Label_Pos_Left>
<Label_Pos_Right>1</Label_Pos_Right>
<Label_Pos_Top>1</Label_Pos_Top>
<PageID>2</PageID>
<ProjectID>1</ProjectID>
</WebUIPageFieldDef>
</ArrayOfWebUIPageFieldDef>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SetFieldsOnPage
ApiReturn| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Error | ErrorInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Error": {
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
}
}
application/xml, text/xml
Sample:
<ApiReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
<Error>
<ErrorCode>1</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</Error>
<Success>true</Success>
</ApiReturn>