GET api/CustomEditorCode/{id}?categoryId={categoryId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryId

integer

Required

id

string

None.

Body Parameters

None.

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": "d95d65f8-fc85-4683-8014-ceef1b4c535f",
      "parentUid": "dd122c7c-6598-4f31-bcd0-d3536c50ee80"
    },
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "d95d65f8-fc85-4683-8014-ceef1b4c535f",
      "parentUid": "dd122c7c-6598-4f31-bcd0-d3536c50ee80"
    }
  ],
  "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>dd122c7c-6598-4f31-bcd0-d3536c50ee80</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>d95d65f8-fc85-4683-8014-ceef1b4c535f</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>dd122c7c-6598-4f31-bcd0-d3536c50ee80</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>d95d65f8-fc85-4683-8014-ceef1b4c535f</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>