POST api/widget

Request Information

URI Parameters

None.

Body Parameters

Widget
NameDescriptionTypeAdditional information
WidgetId

integer

None.

WidgetName

string

None.

WidgetCodeName

string

None.

WidgetDescription

string

None.

WidgetLink

string

None.

WidgetActive

integer

None.

WidgetActiveDate

date

None.

WidgetVariables

Collection of WidgetVariable

None.

Request Formats

application/json, text/json

Sample:
{
  "WidgetId": 1,
  "WidgetName": "sample string 2",
  "WidgetCodeName": "sample string 3",
  "WidgetDescription": "sample string 4",
  "WidgetLink": "sample string 5",
  "WidgetActive": 6,
  "WidgetActiveDate": "2020-04-01T20:58:40.2003228-05:00",
  "WidgetVariables": [
    {
      "WidgetVariableId": 1,
      "WidgetId": 2,
      "VariableName": "sample string 3",
      "VariableCodeName": "sample string 4",
      "VariableDescription": "sample string 5",
      "WidgetVariableType": {
        "VariableTypeId": 1,
        "VariableTypeName": "sample string 2",
        "VariableTypeCodeName": "sample string 3",
        "VariableTypeDescription": "sample string 4",
        "VariableValueType": "sample string 5",
        "VariableTypeActive": 6,
        "VariableTypeActiveDate": "2020-04-01T20:58:40.2003228-05:00"
      },
      "VariableOrder": 6,
      "VariableActive": 7,
      "VariableActiveDate": "2020-04-01T20:58:40.2003228-05:00",
      "WidgetVariableOptions": [
        {
          "WidgetVariableOptionId": 1,
          "WidgetVariableId": 2,
          "WidgetVariableOptionName": "sample string 3",
          "WidgetVariableOptionValue": "sample string 4",
          "WidgetVariableOptionValueNumber": 5.1,
          "WidgetVariableOptionOrder": 6
        },
        {
          "WidgetVariableOptionId": 1,
          "WidgetVariableId": 2,
          "WidgetVariableOptionName": "sample string 3",
          "WidgetVariableOptionValue": "sample string 4",
          "WidgetVariableOptionValueNumber": 5.1,
          "WidgetVariableOptionOrder": 6
        }
      ]
    },
    {
      "WidgetVariableId": 1,
      "WidgetId": 2,
      "VariableName": "sample string 3",
      "VariableCodeName": "sample string 4",
      "VariableDescription": "sample string 5",
      "WidgetVariableType": {
        "VariableTypeId": 1,
        "VariableTypeName": "sample string 2",
        "VariableTypeCodeName": "sample string 3",
        "VariableTypeDescription": "sample string 4",
        "VariableValueType": "sample string 5",
        "VariableTypeActive": 6,
        "VariableTypeActiveDate": "2020-04-01T20:58:40.2003228-05:00"
      },
      "VariableOrder": 6,
      "VariableActive": 7,
      "VariableActiveDate": "2020-04-01T20:58:40.2003228-05:00",
      "WidgetVariableOptions": [
        {
          "WidgetVariableOptionId": 1,
          "WidgetVariableId": 2,
          "WidgetVariableOptionName": "sample string 3",
          "WidgetVariableOptionValue": "sample string 4",
          "WidgetVariableOptionValueNumber": 5.1,
          "WidgetVariableOptionOrder": 6
        },
        {
          "WidgetVariableOptionId": 1,
          "WidgetVariableId": 2,
          "WidgetVariableOptionName": "sample string 3",
          "WidgetVariableOptionValue": "sample string 4",
          "WidgetVariableOptionValueNumber": 5.1,
          "WidgetVariableOptionOrder": 6
        }
      ]
    }
  ]
}

text/html

Sample:
{"WidgetId":1,"WidgetName":"sample string 2","WidgetCodeName":"sample string 3","WidgetDescription":"sample string 4","WidgetLink":"sample string 5","WidgetActive":6,"WidgetActiveDate":"2020-04-01T20:58:40.2003228-05:00","WidgetVariables":[{"WidgetVariableId":1,"WidgetId":2,"VariableName":"sample string 3","VariableCodeName":"sample string 4","VariableDescription":"sample string 5","WidgetVariableType":{"VariableTypeId":1,"VariableTypeName":"sample string 2","VariableTypeCodeName":"sample string 3","VariableTypeDescription":"sample string 4","VariableValueType":"sample string 5","VariableTypeActive":6,"VariableTypeActiveDate":"2020-04-01T20:58:40.2003228-05:00"},"VariableOrder":6,"VariableActive":7,"VariableActiveDate":"2020-04-01T20:58:40.2003228-05:00","WidgetVariableOptions":[{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6},{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6}]},{"WidgetVariableId":1,"WidgetId":2,"VariableName":"sample string 3","VariableCodeName":"sample string 4","VariableDescription":"sample string 5","WidgetVariableType":{"VariableTypeId":1,"VariableTypeName":"sample string 2","VariableTypeCodeName":"sample string 3","VariableTypeDescription":"sample string 4","VariableValueType":"sample string 5","VariableTypeActive":6,"VariableTypeActiveDate":"2020-04-01T20:58:40.2003228-05:00"},"VariableOrder":6,"VariableActive":7,"VariableActiveDate":"2020-04-01T20:58:40.2003228-05:00","WidgetVariableOptions":[{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6},{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6}]}]}

application/xml, text/xml

Sample:
<Widget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FeedFlowAPI.Models.Out">
  <WidgetActive>6</WidgetActive>
  <WidgetActiveDate>2020-04-01T20:58:40.2003228-05:00</WidgetActiveDate>
  <WidgetCodeName>sample string 3</WidgetCodeName>
  <WidgetDescription>sample string 4</WidgetDescription>
  <WidgetId>1</WidgetId>
  <WidgetLink>sample string 5</WidgetLink>
  <WidgetName>sample string 2</WidgetName>
  <WidgetVariables>
    <WidgetVariable>
      <VariableActive>7</VariableActive>
      <VariableActiveDate>2020-04-01T20:58:40.2003228-05:00</VariableActiveDate>
      <VariableCodeName>sample string 4</VariableCodeName>
      <VariableDescription>sample string 5</VariableDescription>
      <VariableName>sample string 3</VariableName>
      <VariableOrder>6</VariableOrder>
      <WidgetId>2</WidgetId>
      <WidgetVariableId>1</WidgetVariableId>
      <WidgetVariableOptions>
        <WidgetVariableOption>
          <WidgetVariableId>2</WidgetVariableId>
          <WidgetVariableOptionId>1</WidgetVariableOptionId>
          <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
          <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
          <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
          <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
        </WidgetVariableOption>
        <WidgetVariableOption>
          <WidgetVariableId>2</WidgetVariableId>
          <WidgetVariableOptionId>1</WidgetVariableOptionId>
          <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
          <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
          <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
          <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
        </WidgetVariableOption>
      </WidgetVariableOptions>
      <WidgetVariableType>
        <VariableTypeActive>6</VariableTypeActive>
        <VariableTypeActiveDate>2020-04-01T20:58:40.2003228-05:00</VariableTypeActiveDate>
        <VariableTypeCodeName>sample string 3</VariableTypeCodeName>
        <VariableTypeDescription>sample string 4</VariableTypeDescription>
        <VariableTypeId>1</VariableTypeId>
        <VariableTypeName>sample string 2</VariableTypeName>
        <VariableValueType>sample string 5</VariableValueType>
      </WidgetVariableType>
    </WidgetVariable>
    <WidgetVariable>
      <VariableActive>7</VariableActive>
      <VariableActiveDate>2020-04-01T20:58:40.2003228-05:00</VariableActiveDate>
      <VariableCodeName>sample string 4</VariableCodeName>
      <VariableDescription>sample string 5</VariableDescription>
      <VariableName>sample string 3</VariableName>
      <VariableOrder>6</VariableOrder>
      <WidgetId>2</WidgetId>
      <WidgetVariableId>1</WidgetVariableId>
      <WidgetVariableOptions>
        <WidgetVariableOption>
          <WidgetVariableId>2</WidgetVariableId>
          <WidgetVariableOptionId>1</WidgetVariableOptionId>
          <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
          <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
          <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
          <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
        </WidgetVariableOption>
        <WidgetVariableOption>
          <WidgetVariableId>2</WidgetVariableId>
          <WidgetVariableOptionId>1</WidgetVariableOptionId>
          <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
          <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
          <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
          <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
        </WidgetVariableOption>
      </WidgetVariableOptions>
      <WidgetVariableType>
        <VariableTypeActive>6</VariableTypeActive>
        <VariableTypeActiveDate>2020-04-01T20:58:40.2003228-05:00</VariableTypeActiveDate>
        <VariableTypeCodeName>sample string 3</VariableTypeCodeName>
        <VariableTypeDescription>sample string 4</VariableTypeDescription>
        <VariableTypeId>1</VariableTypeId>
        <VariableTypeName>sample string 2</VariableTypeName>
        <VariableValueType>sample string 5</VariableValueType>
      </WidgetVariableType>
    </WidgetVariable>
  </WidgetVariables>
</Widget>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.