POST api/articles/service

Method for adding an service article

Request Information

URI Parameters

None.

Body Parameters

ArticleServicePostRequest
NameDescriptionTypeAdditional information
Article

Article information about the service

 ArticlePostRequest

Required
Duration

Duration

 date

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "Article": {
    "ArticleListPrice": {
      "SupplierId": "b8d9a4ab-660a-4403-8028-f058c4b6e87f",
      "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:04:07 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
  },
  "Duration": "12/21/2025 1:04:07 PM"
}

application/xml, text/xml

Sample: 
<ArticleServicePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Duration>2025-12-21T13:04:07.2638853+00:00</Duration>
  <Article>
    <AccountingEntryTemplateId>6</AccountingEntryTemplateId>
    <AlternativeArticleNumber>1</AlternativeArticleNumber>
    <ArticleNo>1</ArticleNo>
    <CommodityId>sample string 15</CommodityId>
    <CompilatorId>1</CompilatorId>
    <DateOfTermination>2025-12-21T13:04:07.2638853+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>b8d9a4ab-660a-4403-8028-f058c4b6e87f</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>
</ArticleServicePostRequest>

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

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>