GET api/CustomPanel/GetStructure

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomPanelModel
NameDescriptionTypeAdditional information
Name

string

Required

String length: inclusive between 0 and 512

Description

string

None.

CustomFields

Collection of CustomFieldModel

None.

Order

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "name": "sample string 1",
    "description": "sample string 2",
    "customFields": [
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "type": 0,
        "order": 3
      },
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "type": 0,
        "order": 3
      }
    ],
    "order": 3
  },
  {
    "name": "sample string 1",
    "description": "sample string 2",
    "customFields": [
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "type": 0,
        "order": 3
      },
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "type": 0,
        "order": 3
      }
    ],
    "order": 3
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomPanelModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum.CustomPanel">
  <CustomPanelModel>
    <CustomFields>
      <CustomFieldModel>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Order>3</Order>
        <Type>Text</Type>
      </CustomFieldModel>
      <CustomFieldModel>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Order>3</Order>
        <Type>Text</Type>
      </CustomFieldModel>
    </CustomFields>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Order>3</Order>
  </CustomPanelModel>
  <CustomPanelModel>
    <CustomFields>
      <CustomFieldModel>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Order>3</Order>
        <Type>Text</Type>
      </CustomFieldModel>
      <CustomFieldModel>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Order>3</Order>
        <Type>Text</Type>
      </CustomFieldModel>
    </CustomFields>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Order>3</Order>
  </CustomPanelModel>
</ArrayOfCustomPanelModel>