s1 API Host

GetProductsForACatalogueGroupRequest

The following routes are available for this service:
GET, OPTIONS	/api/products/catalogues/{catalogueId}/{providerKey}	Gets the products for the specified group in a catalogue	User has to be authenticated to search for products.

Parameters:
Name	Parameter	Data Type	Required	Description
catalogueId	path	string	Yes	The catalogues id
groupId	query	int	Yes	The group id
providerKey	path	string	Yes	Catalogue by prodiver
Skip	query	int	No	The amount of search results that need to be skipped. Default value is 0.
Take	query	int	No	The amount of search results that need to be taken. Default value is 25.
SortKey	query	string	No	The key on which the sort needs to be applied. There is no default sorting applied.
SortDirection	query	string	No	The direction in which the sorting needs to be applied. SortKey is a required field if you use this parameter. There is no default sort direction applied.
IncludeFilterOptions	query	bool	No	Default is false. If set to true, will return the filter options for the given products.
IncludeAssets	query	bool	No	Default is false. If set to true, will return extra assets for the given products.
WithoutRouteInfo	query	bool	No	If set to true, will not return route info which will decrease response times.
WithoutNettoPrice	query	bool	No	If set to true, will not return net prices which will decrease response times.

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetProductsForACatalogueGroupRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetProductsForACatalogueGroupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <IncludeAssets>false</IncludeAssets>
  <IncludeFilterOptions>false</IncludeFilterOptions>
  <Skip>0</Skip>
  <SortDirection>String</SortDirection>
  <SortKey>String</SortKey>
  <Take>0</Take>
  <WithoutNettoPrice>false</WithoutNettoPrice>
  <WithoutRouteInfo>false</WithoutRouteInfo>
  <CatalogueId>String</CatalogueId>
  <GroupId>String</GroupId>
  <ProviderKey>String</ProviderKey>
</GetProductsForACatalogueGroupRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <Assets xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products.Assets" i:nil="true" />
  <DebugInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models">
    <d2p1:Durations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:TotalDuration>0</d2p1:TotalDuration>
  </DebugInfo>
  <FilterOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products.Filter" i:nil="true" />
  <IsTruncated>false</IsTruncated>
  <Products i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <SpecialToolProducts i:nil="true" />
  <TotalResults>0</TotalResults>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</GetProductsResponse>