POST api/v1/ProductCatalogue

Returns a collection of product catalogues and asociated items

Request Information

URI Parameters

None.

Body Parameters

ProductCatalogueParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
OnlyCatalogueName

Specific catalogue to get. Leave null/empty for all

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "OnlyCatalogueName": "sample string 1",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<ProductCatalogueParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OnlyCatalogueName>sample string 1</OnlyCatalogueName>
  <apiKey>sample string 1</apiKey>
</ProductCatalogueParams>

Response Information

Resource Description

Returns:
200 OK Returns collection of product id's and codes
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if no catalogues are defined 503 Service Unavailable

Catalogues
NameDescriptionTypeAdditional information
CatalogueList

Collection of Catalogue

None.

Response Formats

application/json, text/json

Sample: 
{
  "CatalogueList": [
    {
      "Name": "sample string 1",
      "CatItems": [
        {
          "ID": 1,
          "Code": "sample string 2",
          "Seq": 3
        },
        {
          "ID": 1,
          "Code": "sample string 2",
          "Seq": 3
        }
      ]
    },
    {
      "Name": "sample string 1",
      "CatItems": [
        {
          "ID": 1,
          "Code": "sample string 2",
          "Seq": 3
        },
        {
          "ID": 1,
          "Code": "sample string 2",
          "Seq": 3
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<Catalogues xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Catalogue>
    <Name>sample string 1</Name>
    <CatItems>
      <CatItem>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Seq>3</Seq>
      </CatItem>
      <CatItem>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Seq>3</Seq>
      </CatItem>
    </CatItems>
  </Catalogue>
  <Catalogue>
    <Name>sample string 1</Name>
    <CatItems>
      <CatItem>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Seq>3</Seq>
      </CatItem>
      <CatItem>
        <ID>1</ID>
        <Code>sample string 2</Code>
        <Seq>3</Seq>
      </CatItem>
    </CatItems>
  </Catalogue>
</Catalogues>