POST api/AnalyticalDescriptions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
documentId	integer	Required
elements	Collection of AnalyticalDescriptionDimension	Required
companyData	CompanyData	None.

Request Formats

application/json, text/json

Sample:

{
  "documentId": 1,
  "elements": [
    {
      "lp": 1,
      "positionValue": "sample string 2",
      "percentage": 3.0,
      "value": 4.0,
      "setPercentage": true,
      "options": [
        {
          "dimensionName": "sample string 1",
          "dimensionValue": "sample string 2",
          "optionIndex": 1,
          "columnIndex": 1
        },
        {
          "dimensionName": "sample string 1",
          "dimensionValue": "sample string 2",
          "optionIndex": 1,
          "columnIndex": 1
        }
      ]
    },
    {
      "lp": 1,
      "positionValue": "sample string 2",
      "percentage": 3.0,
      "value": 4.0,
      "setPercentage": true,
      "options": [
        {
          "dimensionName": "sample string 1",
          "dimensionValue": "sample string 2",
          "optionIndex": 1,
          "columnIndex": 1
        },
        {
          "dimensionName": "sample string 1",
          "dimensionValue": "sample string 2",
          "optionIndex": 1,
          "columnIndex": 1
        }
      ]
    }
  ],
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<AnalyticalDescriptionElement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <documentId>1</documentId>
  <elements>
    <AnalyticalDescriptionDimension>
      <dimensionGuid>sample string 1</dimensionGuid>
      <lp>1</lp>
      <options>
        <AnalyticalDescriptionDimensionOption>
          <columnIndex>1</columnIndex>
          <dimensionName>sample string 1</dimensionName>
          <dimensionValue>sample string 2</dimensionValue>
          <optionIndex>1</optionIndex>
        </AnalyticalDescriptionDimensionOption>
        <AnalyticalDescriptionDimensionOption>
          <columnIndex>1</columnIndex>
          <dimensionName>sample string 1</dimensionName>
          <dimensionValue>sample string 2</dimensionValue>
          <optionIndex>1</optionIndex>
        </AnalyticalDescriptionDimensionOption>
      </options>
      <percentage>3</percentage>
      <positionValue>sample string 2</positionValue>
      <setPercentage>true</setPercentage>
      <value>4</value>
    </AnalyticalDescriptionDimension>
    <AnalyticalDescriptionDimension>
      <dimensionGuid>sample string 1</dimensionGuid>
      <lp>1</lp>
      <options>
        <AnalyticalDescriptionDimensionOption>
          <columnIndex>1</columnIndex>
          <dimensionName>sample string 1</dimensionName>
          <dimensionValue>sample string 2</dimensionValue>
          <optionIndex>1</optionIndex>
        </AnalyticalDescriptionDimensionOption>
        <AnalyticalDescriptionDimensionOption>
          <columnIndex>1</columnIndex>
          <dimensionName>sample string 1</dimensionName>
          <dimensionValue>sample string 2</dimensionValue>
          <optionIndex>1</optionIndex>
        </AnalyticalDescriptionDimensionOption>
      </options>
      <percentage>3</percentage>
      <positionValue>sample string 2</positionValue>
      <setPercentage>true</setPercentage>
      <value>4</value>
    </AnalyticalDescriptionDimension>
  </elements>
</AnalyticalDescriptionElement>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.