POST api/customfieldgroup/{save}

Save a custom field group for a predefined type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
save

string

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.SaveCustomFieldGroupCommandDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Order

integer

None.

AppliesTo

Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.CustomFieldGroupType

None.

SystemStatus

Dezrez.Rezi.Domain.System.SystemStatus

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SaveCustomFieldGroupCommandDataContract'.

application/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'Agency' with type 'Dezrez.Rezi.Domain.Agencies.Agency'. Path 'SystemStatus.Agency.Branches[0].ContactDetails.Addresses[0].AddressType'.

text/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'Agency' with type 'Dezrez.Rezi.Domain.Agencies.Agency'. Path 'SystemStatus.Agency.Branches[0].ContactDetails.Addresses[0].AddressType'.

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.CustomFieldGroupDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Fields

Collection of Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.CustomFieldDataContract

None.

Order

integer

None.

SystemStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Fields": [
    {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ControlType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 1",
      "Validator": "sample string 2",
      "Order": 3,
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 4
    },
    {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ControlType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 1",
      "Validator": "sample string 2",
      "Order": 3,
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 4
    }
  ],
  "Order": 2,
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}