GET api/ArticlePackage/{id}

Gets a specific article package

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of the article package

globally unique identifier

Required

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

ArticlePackageHeadResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

Required

Name

string

Required

Max length: 50

TotalDuration

Gets the total duration for this article package.
If the article does not have a quantity 4 is used as default.
Also if the article has no duration, zero is used as default.

decimal number

None.

Articles

Collection of ArticlePackageLineResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "e82ec55f-bfeb-4f7e-8338-1a9fd779c6f2",
  "Name": "sample string 2",
  "TotalDuration": 0.0,
  "Articles": [
    {
      "ArticleNumber": 1,
      "Description": "sample string 2",
      "Quantity": 1,
      "Duration": "00:00:00.1234567"
    },
    {
      "ArticleNumber": 1,
      "Description": "sample string 2",
      "Quantity": 1,
      "Duration": "00:00:00.1234567"
    }
  ]
}

application/xml, text/xml

Sample:
<ArticlePackageHeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Articles>
    <ArticlePackageLineResponse>
      <ArticleNumber>1</ArticleNumber>
      <Description>sample string 2</Description>
      <Duration>PT0.1234567S</Duration>
      <Quantity>1</Quantity>
    </ArticlePackageLineResponse>
    <ArticlePackageLineResponse>
      <ArticleNumber>1</ArticleNumber>
      <Description>sample string 2</Description>
      <Duration>PT0.1234567S</Duration>
      <Quantity>1</Quantity>
    </ArticlePackageLineResponse>
  </Articles>
  <Id>e82ec55f-bfeb-4f7e-8338-1a9fd779c6f2</Id>
  <Name>sample string 2</Name>
</ArticlePackageHeadResponse>