GET api/ArticlePackage

Get all article packages paged.

Request Information

URI Parameters

None.

Body Parameters

None.

Remarks

None.

Example

//Gets all article packages paged.
http://localhost/api/articlePackage/

//Gets article packages, page 1 with page size 25
http://localhost/api/articlePackage?pageNumber=1&pageSize=25

Response Information

Resource Description

Article packages

PagedArticlePackageResponse
NameDescriptionTypeAdditional information
ArticlePackages

Collection of ArticlePackageHeadResponse

None.

TotalPages

integer

None.

NextPage

string

None.

PreviousPage

string

None.

LastPage

string

None.

FirstPage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ArticlePackages": [
    {
      "Id": "b884f0fb-beba-4700-a66e-9acfc9ff2716",
      "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"
        }
      ]
    },
    {
      "Id": "b884f0fb-beba-4700-a66e-9acfc9ff2716",
      "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"
        }
      ]
    }
  ],
  "TotalPages": 1,
  "NextPage": "sample string 2",
  "PreviousPage": "sample string 3",
  "LastPage": "sample string 4",
  "FirstPage": "sample string 5"
}

application/xml, text/xml

Sample:
<PagedArticlePackageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <FirstPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 5</FirstPage>
  <LastPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 4</LastPage>
  <NextPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 2</NextPage>
  <PreviousPage xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">sample string 3</PreviousPage>
  <TotalPages xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO">1</TotalPages>
  <ArticlePackages>
    <ArticlePackageHeadResponse>
      <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>b884f0fb-beba-4700-a66e-9acfc9ff2716</Id>
      <Name>sample string 2</Name>
    </ArticlePackageHeadResponse>
    <ArticlePackageHeadResponse>
      <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>b884f0fb-beba-4700-a66e-9acfc9ff2716</Id>
      <Name>sample string 2</Name>
    </ArticlePackageHeadResponse>
  </ArticlePackages>
</PagedArticlePackageResponse>