GET api/catalogs/{catalogName}

Returns info for the product catalog by name.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
catalogName

Catalog name.

string

Required

Body Parameters

None.

Response Information

Resource Description

ProductCatalog
NameDescriptionTypeAdditional information
Id

ID of the catalog in RDB.

integer

None.

Name

Public catalog name.

string

None.

DefaultLanguage

Default language of products and groups in the catalog.

string

None.

Languages

All available languages for the catalog.

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "defaultLanguage": "sample string 3",
  "languages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ProductCatalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PDB.Api.Models">
  <DefaultLanguage>sample string 3</DefaultLanguage>
  <Id>1</Id>
  <Languages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Languages>
  <Name>sample string 2</Name>
</ProductCatalog>