POST api/GUI/GroupEditingPages

Get all pages and fields for group editing

Request Information

URI Parameters

None.

Body Parameters

GroupEditingPageFieldsBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
TaskIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "TaskIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<GroupEditingPageFieldsBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ProjectId>1</ProjectId>
  <TaskIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TaskIds>
</GroupEditingPageFieldsBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get all pages and fields for group editing

API_Data_EditingPageFielsResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

EditingPageFielsResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "TabOption": {
      "EnableSingleTab": true,
      "SingleTabName": "sample string 2"
    },
    "Pages": [
      {
        "PageId": 1,
        "PageName": "sample string 2",
        "ParentPageId": 3,
        "Customizable": false
      },
      {
        "PageId": 1,
        "PageName": "sample string 2",
        "ParentPageId": 3,
        "Customizable": false
      }
    ],
    "FieldValues": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<API_Data_EditingPageFielsResponse 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.GUI">
    <d2p1:FieldValues xmlns:d3p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Task">
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
    </d2p1:FieldValues>
    <d2p1:Pages>
      <d2p1:PageControl>
        <d2p1:Fields i:nil="true" />
        <d2p1:NotCustomizable>true</d2p1:NotCustomizable>
        <d2p1:PageId>1</d2p1:PageId>
        <d2p1:PageName>sample string 2</d2p1:PageName>
        <d2p1:ParentPageId>3</d2p1:ParentPageId>
      </d2p1:PageControl>
      <d2p1:PageControl>
        <d2p1:Fields i:nil="true" />
        <d2p1:NotCustomizable>true</d2p1:NotCustomizable>
        <d2p1:PageId>1</d2p1:PageId>
        <d2p1:PageName>sample string 2</d2p1:PageName>
        <d2p1:ParentPageId>3</d2p1:ParentPageId>
      </d2p1:PageControl>
    </d2p1:Pages>
    <d2p1:TabOption>
      <d2p1:EnableSingleTab>true</d2p1:EnableSingleTab>
      <d2p1:SingleTabName>sample string 2</d2p1:SingleTabName>
    </d2p1:TabOption>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_EditingPageFielsResponse>