POST api/Products/List

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Description	string	None.
Category	string	None.
Brand	integer	None.
Tag	integer	None.
PriceMin	decimal number	None.
PriceMax	decimal number	None.
Order	integer	None.
Page	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "Category": "sample string 2",
  "Brand": 1,
  "Tag": 1,
  "PriceMin": 1.0,
  "PriceMax": 1.0,
  "Order": 1,
  "Page": 1,
  "PageSize": 1
}

application/xml, text/xml

Sample:

<ProductsParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mastersoft.BigDipper.Entities">
  <Brand>1</Brand>
  <Category>sample string 2</Category>
  <Description>sample string 1</Description>
  <Order>1</Order>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <PriceMax>1</PriceMax>
  <PriceMin>1</PriceMin>
  <Tag>1</Tag>
</ProductsParam>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProductsParam'.

Response Information

Resource Description

ProductsResult

Name	Type	Additional information
Pages	integer	None.
Products	Collection of Product	None.
Errors	APIErrors	None.

Response Formats

application/json, text/json

Sample:

{
  "Pages": 1,
  "Products": [
    {
      "ProductId": 1,
      "Code": "sample string 2",
      "Codart": "sample string 3",
      "DescriptionLong": "sample string 4",
      "DescriptionShort": "sample string 5",
      "ListId": 1,
      "Price": 1.0,
      "StockMin": 1.0,
      "StockMax": 1.0,
      "Stock": 1.0,
      "IVAIncluded": "sample string 6",
      "IVAPercent": 1.0,
      "DiscountPercent": 1.0,
      "Image": "sample string 7",
      "Pages": 8,
      "InHabilitado": 9,
      "Favoritos": 10,
      "DataSheet": "sample string 11",
      "Carrousel": [
        "sample string 1",
        "sample string 2"
      ],
      "Links": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "ProductId": 1,
      "Code": "sample string 2",
      "Codart": "sample string 3",
      "DescriptionLong": "sample string 4",
      "DescriptionShort": "sample string 5",
      "ListId": 1,
      "Price": 1.0,
      "StockMin": 1.0,
      "StockMax": 1.0,
      "Stock": 1.0,
      "IVAIncluded": "sample string 6",
      "IVAPercent": 1.0,
      "DiscountPercent": 1.0,
      "Image": "sample string 7",
      "Pages": 8,
      "InHabilitado": 9,
      "Favoritos": 10,
      "DataSheet": "sample string 11",
      "Carrousel": [
        "sample string 1",
        "sample string 2"
      ],
      "Links": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "Errors": {
    "HasErrors": true,
    "ErrorList": [
      {
        "Message": "sample string 1",
        "Source": "sample string 2"
      },
      {
        "Message": "sample string 1",
        "Source": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mastersoft.BigDipper.Entities">
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Mastersoft.BigDipper.Entities.Domain">
    <ErrorList>
      <APIErrorMessage>
        <Message>sample string 1</Message>
        <Source>sample string 2</Source>
      </APIErrorMessage>
      <APIErrorMessage>
        <Message>sample string 1</Message>
        <Source>sample string 2</Source>
      </APIErrorMessage>
    </ErrorList>
    <HasErrors>true</HasErrors>
  </Errors>
  <Pages>1</Pages>
  <Products>
    <Product>
      <Carrousel xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Carrousel>
      <Codart>sample string 3</Codart>
      <Code>sample string 2</Code>
      <DataSheet>sample string 11</DataSheet>
      <DescriptionLong>sample string 4</DescriptionLong>
      <DescriptionShort>sample string 5</DescriptionShort>
      <DiscountPercent>1</DiscountPercent>
      <Favoritos>10</Favoritos>
      <IVAIncluded>sample string 6</IVAIncluded>
      <IVAPercent>1</IVAPercent>
      <Image>sample string 7</Image>
      <InHabilitado>9</InHabilitado>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Links>
      <ListId>1</ListId>
      <Pages>8</Pages>
      <Price>1</Price>
      <ProductId>1</ProductId>
      <Stock>1</Stock>
      <StockMax>1</StockMax>
      <StockMin>1</StockMin>
    </Product>
    <Product>
      <Carrousel xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Carrousel>
      <Codart>sample string 3</Codart>
      <Code>sample string 2</Code>
      <DataSheet>sample string 11</DataSheet>
      <DescriptionLong>sample string 4</DescriptionLong>
      <DescriptionShort>sample string 5</DescriptionShort>
      <DiscountPercent>1</DiscountPercent>
      <Favoritos>10</Favoritos>
      <IVAIncluded>sample string 6</IVAIncluded>
      <IVAPercent>1</IVAPercent>
      <Image>sample string 7</Image>
      <InHabilitado>9</InHabilitado>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Links>
      <ListId>1</ListId>
      <Pages>8</Pages>
      <Price>1</Price>
      <ProductId>1</ProductId>
      <Stock>1</Stock>
      <StockMax>1</StockMax>
      <StockMin>1</StockMin>
    </Product>
  </Products>
</ProductsResult>