POST api/Field

Get field info based by field id or field name

Request Information

URI Parameters

None.

Body Parameters

FieldBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
Field

If Option equals 0, Value should be a field's Id , else Value should be a field's Name.

 ParamValueObject

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProjectId": 1,
  "Field": {
    "Value": "sample string 1",
    "Option": 2
  }
}

application/xml, text/xml

Sample: 
<FieldBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <Field>
    <Option>2</Option>
    <Value>sample string 1</Value>
  </Field>
  <ProjectId>1</ProjectId>
</FieldBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get field info based by field id or field name

API_Data_TFieldUI
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

TFieldUI

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "FieldId": 1,
    "FieldName": "sample string 2",
    "Attributes": 3,
    "FieldType": "sample string 4",
    "FieldTypeId": 5,
    "MandatoryOnSubmit": true
  }
}

application/xml, text/xml

Sample: 
<API_Data_TFieldUI 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:Attributes>3</d2p1:Attributes>
    <d2p1:FieldId>1</d2p1:FieldId>
    <d2p1:FieldName>sample string 2</d2p1:FieldName>
    <d2p1:FieldType>sample string 4</d2p1:FieldType>
    <d2p1:FieldTypeId>5</d2p1:FieldTypeId>
    <d2p1:MandatoryOnSubmit>true</d2p1:MandatoryOnSubmit>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_TFieldUI>