POST api/Field/EditDTKSysFieldName

Get field info based by field id or field name

Request Information

URI Parameters

None.

Body Parameters

FieldNameDefBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.
FieldId

integer

None.
langNames

Dictionary of integer [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "langNames": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "ProjectId": 1,
  "FieldId": 2
}

application/xml, text/xml

Sample: 
<FieldNameDefBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <FieldId>2</FieldId>
  <ProjectId>1</ProjectId>
  <langNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </langNames>
</FieldNameDefBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get field info based by field id or field name

ApiReturn
NameDescriptionTypeAdditional 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>