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

List of article packages in page

 Collection of ArticlePackageHeadResponse

None.
TotalPages

Total number of pages.

 integer

None.
NextPage

Link to the next page.

 string

None.
PreviousPage

Link to the previous page.

 string

None.
LastPage

Link to the last page.

 string

None.
FirstPage

Link to the first page.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ArticlePackages": [
    {
      "Id": "04272fdd-6c4d-4735-9c4c-e569ad870abf",
      "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": "04272fdd-6c4d-4735-9c4c-e569ad870abf",
      "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>04272fdd-6c4d-4735-9c4c-e569ad870abf</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>04272fdd-6c4d-4735-9c4c-e569ad870abf</Id>
      <Name>sample string 2</Name>
    </ArticlePackageHeadResponse>
  </ArticlePackages>
</PagedArticlePackageResponse>