GET api/CustomForms/GetCustomForm/{id}

Gets custom form, its settings, custom html layout if any, its fields.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetCustomFormResult

Name	Description	Type	Additional information
Id	The custom form id	integer	None.
Disabled	If true the custom form is disabled	boolean	None.
Name	The custom form's name	string	None.
Description	The custom form's description	string	None.
CustomLayout	If true the custom form has defined custom layout template in LayoutTemplate property	boolean	None.
LayoutTemplate	Html layout template	string	None.
Fields	The custom form's fields	Collection of GetCustomFormFieldResult	None.
CustomFormLayoutServiceType	The custom form's type	CustomFormLayoutServiceTypeEnum	None.
ServiceLimitedAccess	True if custom form's is limited only for selected services	boolean	None.
CategoryLimitedAccess	True if custom form's is limited only for selected category items	boolean	None.
ServiceIds	The services when the custom form is visible only if ServiceLimitedAccess is set to true	Collection of integer	None.
CategoryItemIds	The services when the custom form is visible only if CategoryLimitedAccess is set to true	Collection of integer	None.
ShowInEditModeInDefault	The custom form should be shown in edit mode by default	boolean	None.
AnOperatorCanEditAfterClosingTheTicket	The custom form can be edited after closing the ticket	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Disabled": false,
  "Name": "Form",
  "Description": "Additional information",
  "CustomLayout": false,
  "LayoutTemplate": null,
  "Fields": [
    {
      "Id": 1,
      "Title": "Type your favorite name",
      "Description": null,
      "Type": 2,
      "Required": false,
      "Items": null,
      "AddPleaseSelect": false,
      "RequiredWhenFinished": false,
      "AllowEditingByOperatorsOnly": false,
      "PlaceHolderText": null,
      "RegularExpression": null,
      "Disabled": false,
      "DateType": null
    },
    {
      "Id": 2,
      "Title": "Select your favorite color",
      "Description": null,
      "Type": 1,
      "Required": false,
      "Items": [
        {
          "Id": 1,
          "Title": "Red",
          "Disabled": false,
          "Index": 0,
          "DefaultValueBoolean": false,
          "CustomFormFieldItemParentId": null,
          "CustomFormFieldParentId": null
        },
        {
          "Id": 2,
          "Title": "Green",
          "Disabled": false,
          "Index": 0,
          "DefaultValueBoolean": false,
          "CustomFormFieldItemParentId": null,
          "CustomFormFieldParentId": null
        },
        {
          "Id": 3,
          "Title": "Blue",
          "Disabled": false,
          "Index": 0,
          "DefaultValueBoolean": false,
          "CustomFormFieldItemParentId": null,
          "CustomFormFieldParentId": null
        }
      ],
      "AddPleaseSelect": false,
      "RequiredWhenFinished": false,
      "AllowEditingByOperatorsOnly": false,
      "PlaceHolderText": null,
      "RegularExpression": null,
      "Disabled": false,
      "DateType": null
    }
  ],
  "CustomFormLayoutServiceType": 0,
  "ServiceLimitedAccess": false,
  "CategoryLimitedAccess": false,
  "ServiceIds": null,
  "CategoryItemIds": null,
  "ShowInEditModeInDefault": false,
  "AnOperatorCanEditAfterClosingTheTicket": false
}