GET api/Pricelists/{id}

Gets a pricelist using paging for the pricelist lines.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Remarks


Paging parameters are passed with the request url and the following parameters apply:
Parameter
Description
pageSize
Defines how many items to return in each page. The page size cannot be larger than 1000. If the page size is omitted a default page size of 25 is used.
pageNumber
Defines the current page number starting with 1. The default page number is 1 if not given.

Example

//Gets the pricelist with id = {Guid} and all lines in the first page.
http://localhost/api/pricelists/{Guid}

//Gets the pricelist with id = {Guid} and all lines in the fifth page with a page size of 25.
http://localhost/api/pricelists/{Guid}?pageNumber=5&pageSize=25

//Gets the pricelist with id = {Guid} and all lines in the 1 page using default page size.
http://localhost/api/pricelists/{Guid}?pageNumber=1

Response Information

Resource Description

Returns the pricelist with the specified id with pricelist lines paged.

PagedPricelistHeadResponse
NameDescriptionTypeAdditional information
PricelistHeadReponse

PricelistHeadResponse

None.
TotalPages

integer

None.
NextPage

string

None.
PreviousPage

string

None.
LastPage

string

None.
FirstPage

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "PricelistHeadReponse": {
    "Id": "0789fb7d-b294-4c5b-a82b-cec07869988b",
    "Name": "sample string 2",
    "Expire": "2026-01-21 22:52:33",
    "CurrencyId": 3,
    "CurrencyName": "sample string 4",
    "IncludeVat": true,
    "PriceListLines": [
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "cf6d830b-79e8-42f3-8a2d-5527648d7e7e"
      },
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "cf6d830b-79e8-42f3-8a2d-5527648d7e7e"
      }
    ]
  },
  "TotalPages": 1,
  "NextPage": "sample string 2",
  "PreviousPage": "sample string 3",
  "LastPage": "sample string 4",
  "FirstPage": "sample string 5"
}

application/xml, text/xml

Sample: 
<PagedPricelistHeadResponse 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>
  <PricelistHeadReponse>
    <CurrencyId>3</CurrencyId>
    <CurrencyName>sample string 4</CurrencyName>
    <Expire>2026-01-21T22:52:33.1240318+01:00</Expire>
    <Id>0789fb7d-b294-4c5b-a82b-cec07869988b</Id>
    <IncludeVat>true</IncludeVat>
    <Name>sample string 2</Name>
    <PriceListLines>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>cf6d830b-79e8-42f3-8a2d-5527648d7e7e</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>cf6d830b-79e8-42f3-8a2d-5527648d7e7e</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
    </PriceListLines>
  </PricelistHeadReponse>
</PagedPricelistHeadResponse>