POST api/articles/tube

Method for adding article tube

Request Information

URI Parameters

None.

Body Parameters

ArticleTubePostRequest
NameDescriptionTypeAdditional information
Article

Article information about the tube

ArticlePostRequest

Required

SectionWidth

decimal(9,2)

decimal number

None.

AspectRatio

decimal(9,2)

decimal number

None.

RimDiameter

decimal(9,2)

decimal number

None.

Valve

Valve

string

Max length: 10

Weight

Weight

decimal number

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample:
{
  "Article": {
    "ArticleListPrice": {
      "SupplierId": "fe401a7e-11fe-442a-a274-396273d0c1ac",
      "Price": 1.0,
      "Discount": 1.0
    },
    "RecyclingArticleNumbers": [
      1,
      2
    ],
    "ArticleTexts": [
      {
        "ShortText": "sample string 1",
        "Text": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "ShortText": "sample string 1",
        "Text": "sample string 2",
        "Description": "sample string 3"
      }
    ],
    "ArticleNo": 1,
    "MainGroupId": 2,
    "SubGroupId": 3,
    "IsActive": true,
    "Ean": "sample string 5",
    "DateOfTermination": "12/21/2025 1:06:18 PM",
    "UnitId": 1,
    "AlternativeArticleNumber": 1,
    "AccountingEntryTemplateId": 6,
    "RequestCostAtSale": true,
    "InfoDocumentUri": "sample string 8",
    "ReplacementArticleNumber": 1,
    "SupplierArticleId": "sample string 9",
    "CompilatorId": 1,
    "VatId": 1,
    "OriginalArticleNumber": "sample string 10",
    "ProductLine": "sample string 11",
    "OriginalEquipment": true,
    "Make": "sample string 12",
    "NetNetCalculationId": 1,
    "OEM": "sample string 13",
    "SearchCode": "sample string 14",
    "CommodityId": "sample string 15",
    "ListPrice": 16.0,
    "ListPriceDiscountFactor": 17.0
  },
  "SectionWidth": 1.0,
  "AspectRatio": 1.0,
  "RimDiameter": 1.0,
  "Valve": "sample string 1",
  "Weight": 1.0
}

application/xml, text/xml

Sample:
<ArticleTubePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <AspectRatio>1</AspectRatio>
  <RimDiameter>1</RimDiameter>
  <SectionWidth>1</SectionWidth>
  <Valve>sample string 1</Valve>
  <Weight>1</Weight>
  <Article>
    <AccountingEntryTemplateId>6</AccountingEntryTemplateId>
    <AlternativeArticleNumber>1</AlternativeArticleNumber>
    <ArticleNo>1</ArticleNo>
    <CommodityId>sample string 15</CommodityId>
    <CompilatorId>1</CompilatorId>
    <DateOfTermination>2025-12-21T13:06:18.3666008+00:00</DateOfTermination>
    <Ean>sample string 5</Ean>
    <InfoDocumentUri>sample string 8</InfoDocumentUri>
    <IsActive>true</IsActive>
    <ListPrice>16</ListPrice>
    <ListPriceDiscountFactor>17</ListPriceDiscountFactor>
    <MainGroupId>2</MainGroupId>
    <Make>sample string 12</Make>
    <NetNetCalculationId>1</NetNetCalculationId>
    <OEM>sample string 13</OEM>
    <OriginalArticleNumber>sample string 10</OriginalArticleNumber>
    <OriginalEquipment>true</OriginalEquipment>
    <ProductLine>sample string 11</ProductLine>
    <ReplacementArticleNumber>1</ReplacementArticleNumber>
    <RequestCostAtSale>true</RequestCostAtSale>
    <SearchCode>sample string 14</SearchCode>
    <SubGroupId>3</SubGroupId>
    <SupplierArticleId>sample string 9</SupplierArticleId>
    <UnitId>1</UnitId>
    <VatId>1</VatId>
    <ArticleListPrice>
      <Discount>1</Discount>
      <Price>1</Price>
      <SupplierId>fe401a7e-11fe-442a-a274-396273d0c1ac</SupplierId>
    </ArticleListPrice>
    <ArticleTexts>
      <ArticleText>
        <Description>sample string 3</Description>
        <ShortText>sample string 1</ShortText>
        <Text>sample string 2</Text>
      </ArticleText>
      <ArticleText>
        <Description>sample string 3</Description>
        <ShortText>sample string 1</ShortText>
        <Text>sample string 2</Text>
      </ArticleText>
    </ArticleTexts>
    <RecyclingArticleNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </RecyclingArticleNumbers>
  </Article>
</ArticleTubePostRequest>

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

Response Information

Resource Description

ArticlePostResponse
NameDescriptionTypeAdditional information
Errors

List of errors when adding article

Collection of PostArticleError

None.

Success

Returns true if article is added

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample:
<ArticlePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Errors>
    <PostArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostArticleError>
    <PostArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostArticleError>
  </Errors>
  <Success>true</Success>
</ArticlePostResponse>