POST api/customfield/{save}

Save a custom field within a predefinied custom field group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
save

string

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.SaveCustomFieldCommandDataContract
NameDescriptionTypeAdditional information
CustomFieldGroupId

integer

None.

TypeSystemName

string

None.

ControlTypeSystemName

string

None.

Name

string

None.

Validator

string

None.

Order

integer

None.

Options

Collection of string

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 'SaveCustomFieldCommandDataContract'.

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 'AddressType' with type 'Dezrez.Rezi.Domain.Location.AddressType'. Path 'SystemStatus.Agency.Branches[0].ContactDetails.Addresses[0]'.

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 'AddressType' with type 'Dezrez.Rezi.Domain.Location.AddressType'. Path 'SystemStatus.Agency.Branches[0].ContactDetails.Addresses[0]'.

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Custom.Query.Get.CustomFieldDataContract
NameDescriptionTypeAdditional information
Type

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

None.

ControlType

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

None.

Name

string

None.

Validator

string

None.

Order

integer

None.

Options

Collection of string

None.

SystemStatus

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

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "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
}