PUT api/CustomFields

Request Information

URI Parameters

None.

Body Parameters

CustomFieldsBinding
NameDescriptionTypeAdditional information
Cluster

string

Required

RemoveValues

boolean

None.

Fields

Collection of CustomFieldItemBinding

Required

Request Formats

application/json, text/json

Sample:
{
  "Cluster": "sample string 1",
  "RemoveValues": true,
  "Fields": [
    {
      "Id": 1,
      "Label": "sample string 1",
      "TypeId": 2,
      "Required": true,
      "Position": 4,
      "Size": "sample string 5",
      "Options": [
        {
          "Value": "sample string 1",
          "Label": "sample string 2"
        },
        {
          "Value": "sample string 1",
          "Label": "sample string 2"
        }
      ],
      "IsPublic": true
    },
    {
      "Id": 1,
      "Label": "sample string 1",
      "TypeId": 2,
      "Required": true,
      "Position": 4,
      "Size": "sample string 5",
      "Options": [
        {
          "Value": "sample string 1",
          "Label": "sample string 2"
        },
        {
          "Value": "sample string 1",
          "Label": "sample string 2"
        }
      ],
      "IsPublic": true
    }
  ]
}

application/xml, text/xml

Sample:
<CustomFieldsBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShipperCore.ViewModels">
  <Cluster>sample string 1</Cluster>
  <Fields>
    <CustomFieldItemBinding>
      <Id>1</Id>
      <IsPublic>true</IsPublic>
      <Label>sample string 1</Label>
      <Options>
        <OptionViewModel>
          <Label>sample string 2</Label>
          <Value>sample string 1</Value>
        </OptionViewModel>
        <OptionViewModel>
          <Label>sample string 2</Label>
          <Value>sample string 1</Value>
        </OptionViewModel>
      </Options>
      <Position>4</Position>
      <Required>true</Required>
      <Size>sample string 5</Size>
      <TypeId>2</TypeId>
    </CustomFieldItemBinding>
    <CustomFieldItemBinding>
      <Id>1</Id>
      <IsPublic>true</IsPublic>
      <Label>sample string 1</Label>
      <Options>
        <OptionViewModel>
          <Label>sample string 2</Label>
          <Value>sample string 1</Value>
        </OptionViewModel>
        <OptionViewModel>
          <Label>sample string 2</Label>
          <Value>sample string 1</Value>
        </OptionViewModel>
      </Options>
      <Position>4</Position>
      <Required>true</Required>
      <Size>sample string 5</Size>
      <TypeId>2</TypeId>
    </CustomFieldItemBinding>
  </Fields>
  <RemoveValues>true</RemoveValues>
</CustomFieldsBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.