POST api/articles/endoflife/{articleNumber}

Method that sets end of life on an article

Request Information

URI Parameters

NameDescriptionTypeAdditional information
articleNumber

Article number of the article that will be set to end of life

integer

Required

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

EndOfLifeArticleResponse
NameDescriptionTypeAdditional information
Errors

List of errors when setting end off life on article

Collection of EndOfLifeArticleError

None.

Success

Returns true if article is set to end o life

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:
<EndOfLifeArticleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Errors>
    <EndOfLifeArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </EndOfLifeArticleError>
    <EndOfLifeArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </EndOfLifeArticleError>
  </Errors>
  <Success>true</Success>
</EndOfLifeArticleResponse>