POST api/Article/CreateArticleDefinition

Creates the article definition.

Access

Requires authentication.

Requires SSL.

Request Information

Parameters

NameDescriptionAdditional information
articleDefinition 
The article definition.

Define this parameter in the request body.

Request body formats

application/xml, text/xml

Sample: 
<ArticleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>1</Id>
  <Readonly>true</Readonly>
  <SpecificationListingId>1</SpecificationListingId>
  <ArticleId>1</ArticleId>
  <GalvanizationType>sample string 2</GalvanizationType>
  <RowRevision>sample string 3</RowRevision>
  <Quantity>1</Quantity>
  <QuantityType>Amount</QuantityType>
  <SurfaceTreatment>
    <ExternalCode>sample string 1</ExternalCode>
  </SurfaceTreatment>
</ArticleDefinition>

application/json, text/json

Sample: 
{
  "Quantity": 1.0,
  "QuantityType": 0,
  "SurfaceTreatment": {
    "ExternalCode": "sample string 1"
  },
  "SpecificationListingId": 1,
  "ArticleId": 1,
  "GalvanizationType": "sample string 2",
  "RowRevision": "sample string 3",
  "Id": 1,
  "Readonly": true
}

Response Information

Response body formats

application/xml, text/xml

Sample: 
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ResponseCode>1</ResponseCode>
  <ResponseDescription>sample string 2</ResponseDescription>
  <MethodExpirationDate>2024-05-17T19:49:23.1856006+02:00</MethodExpirationDate>
  <ResponseObject>
    <ModelId>1</ModelId>
    <ModelGUID>sample string 1</ModelGUID>
  </ResponseObject>
</ApiResponse>

application/json, text/json

Sample: 
{
  "ResponseCode": 1,
  "ResponseDescription": "sample string 2",
  "MethodExpirationDate": "2024-05-17T19:49:23.1856006+02:00",
  "ResponseObject": {
    "ModelId": 1,
    "ModelGUID": "sample string 1"
  }
}