POST api/CustomEditor/SelectFieldCode

Request Information

URI Parameters

None.

Body Parameters

CustomFieldViewModel
NameDescriptionTypeAdditional information
Text

string

None.

IoType

integer

None.

Code

integer

None.

ObjectTag

string

None.

MyData

string

None.

SubCode

integer

None.

Category

integer

None.

ListIndex

integer

None.

Zone

integer

None.

Value

string

None.

TextColor

string

None.

Request Formats

application/json, text/json

Sample:
{
  "text": "sample string 1",
  "ioType": 2,
  "code": 3,
  "objectTag": "sample string 4",
  "myData": "sample string 5",
  "subCode": 6,
  "category": 7,
  "listIndex": 8,
  "zone": 9,
  "value": "sample string 10",
  "textColor": "sample string 11"
}

application/xml, text/xml

Sample:
<CustomFieldViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Category>7</Category>
  <Code>3</Code>
  <IoType>2</IoType>
  <ListIndex>8</ListIndex>
  <MyData>sample string 5</MyData>
  <ObjectTag>sample string 4</ObjectTag>
  <SubCode>6</SubCode>
  <Text>sample string 1</Text>
  <TextColor>sample string 11</TextColor>
  <Value>sample string 10</Value>
  <Zone>9</Zone>
</CustomFieldViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomCodeViewModel
NameDescriptionTypeAdditional information
Categories

Collection of LookupDto

None.

UseGrids

boolean

None.

FieldCodes

Collection of CustomCodeDetailViewModel

None.

SelectedCategoryId

integer

None.

SelectedFieldCodeId

integer

None.

SelectedFieldCode

CustomCodeDetailViewModel

None.

SelectedSubCategory

integer

None.

IsAddMethod

boolean

None.

NewUserTextCaption

string

None.

IsShiftKeyPressed

boolean

None.

SubCategoryRadio

Collection of RadioButtonDto

None.

Response Formats

application/json, text/json

Sample:
{
  "subCategoryRadio": [
    {
      "value": true,
      "visible": true,
      "enabled": true
    },
    {
      "value": true,
      "visible": true,
      "enabled": true
    }
  ],
  "categories": [
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "b6523113-1747-4fe2-b23e-f80bd1bab0d6",
      "parentUid": "f4310b59-6f63-43fd-b85d-62935118a607"
    },
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "b6523113-1747-4fe2-b23e-f80bd1bab0d6",
      "parentUid": "f4310b59-6f63-43fd-b85d-62935118a607"
    }
  ],
  "useGrids": true,
  "fieldCodes": [
    {
      "description": "sample string 1",
      "fieldCode": 2,
      "sample": "sample string 3",
      "ioType": "sample string 4",
      "ioTypeId": 5
    },
    {
      "description": "sample string 1",
      "fieldCode": 2,
      "sample": "sample string 3",
      "ioType": "sample string 4",
      "ioTypeId": 5
    }
  ],
  "selectedCategoryId": 2,
  "selectedFieldCodeId": 3,
  "selectedFieldCode": {
    "description": "sample string 1",
    "fieldCode": 2,
    "sample": "sample string 3",
    "ioType": "sample string 4",
    "ioTypeId": 5
  },
  "selectedSubCategory": 4,
  "isAddMethod": true,
  "newUserTextCaption": "sample string 6",
  "isShiftKeyPressed": true
}

application/xml, text/xml

Sample:
<CustomCodeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
    <d2p1:LookupDto>
      <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
      <d2p1:_x003C_ParentUid_x003E_k__BackingField>f4310b59-6f63-43fd-b85d-62935118a607</d2p1:_x003C_ParentUid_x003E_k__BackingField>
      <d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
      <d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
      <d2p1:_x003C_UniqueId_x003E_k__BackingField>b6523113-1747-4fe2-b23e-f80bd1bab0d6</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
    <d2p1:LookupDto>
      <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
      <d2p1:_x003C_ParentUid_x003E_k__BackingField>f4310b59-6f63-43fd-b85d-62935118a607</d2p1:_x003C_ParentUid_x003E_k__BackingField>
      <d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
      <d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
      <d2p1:_x003C_UniqueId_x003E_k__BackingField>b6523113-1747-4fe2-b23e-f80bd1bab0d6</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
  </Categories>
  <FieldCodes>
    <CustomCodeDetailViewModel>
      <Description>sample string 1</Description>
      <FieldCode>2</FieldCode>
      <IoType>sample string 4</IoType>
      <IoTypeId>5</IoTypeId>
      <Sample>sample string 3</Sample>
    </CustomCodeDetailViewModel>
    <CustomCodeDetailViewModel>
      <Description>sample string 1</Description>
      <FieldCode>2</FieldCode>
      <IoType>sample string 4</IoType>
      <IoTypeId>5</IoTypeId>
      <Sample>sample string 3</Sample>
    </CustomCodeDetailViewModel>
  </FieldCodes>
  <IsAddMethod>true</IsAddMethod>
  <IsShiftKeyPressed>true</IsShiftKeyPressed>
  <NewUserTextCaption>sample string 6</NewUserTextCaption>
  <SelectedCategoryId>2</SelectedCategoryId>
  <SelectedFieldCode>
    <Description>sample string 1</Description>
    <FieldCode>2</FieldCode>
    <IoType>sample string 4</IoType>
    <IoTypeId>5</IoTypeId>
    <Sample>sample string 3</Sample>
  </SelectedFieldCode>
  <SelectedFieldCodeId>3</SelectedFieldCodeId>
  <SelectedSubCategory>4</SelectedSubCategory>
  <SubCategoryRadio xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:RadioButtonDto>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Value>true</d2p1:Value>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:RadioButtonDto>
    <d2p1:RadioButtonDto>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:Value>true</d2p1:Value>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:RadioButtonDto>
  </SubCategoryRadio>
  <UseGrids>true</UseGrids>
</CustomCodeViewModel>