POST api/CompanyArticle/FilterCompanyArticles?companyId={companyId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

globally unique identifier

Required

Body Parameters

SearchCriterion
NameDescriptionTypeAdditional information
CountCatalogsForArticle

boolean

None.

IgnoreInactiveCatalogs

boolean

None.

IgnoreCompanyLogo

boolean

None.

IgnoreCompanyVitrine

boolean

None.

IgnoreArticleImage

boolean

None.

StringCriteria

string

None.

pageSize

integer

None.

pageCount

integer

None.

SortBy

string

None.

SortDirection

string

None.

CatalogId

string

None.

ToDashboardQueryString

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CountCatalogsForArticle": true,
  "IgnoreInactiveCatalogs": true,
  "IgnoreCompanyLogo": true,
  "IgnoreCompanyVitrine": true,
  "IgnoreArticleImage": true,
  "StringCriteria": "sample string 6",
  "pageSize": 7,
  "pageCount": 8,
  "SortBy": "sample string 9",
  "SortDirection": "sample string 10",
  "CatalogId": "sample string 11",
  "ToDashboardQueryString": "pageSize=7&pageCount=8&SortBy=sample string 9&SortDirection=sample string 10&CatalogId=sample string 11&StringCriteria=sample string 6"
}

application/xml, text/xml

Sample:
<SearchCriterion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MesHalles.Common.Objects">
  <CatalogId>sample string 11</CatalogId>
  <CountCatalogsForArticle>true</CountCatalogsForArticle>
  <IgnoreArticleImage>true</IgnoreArticleImage>
  <IgnoreCompanyLogo>true</IgnoreCompanyLogo>
  <IgnoreCompanyVitrine>true</IgnoreCompanyVitrine>
  <IgnoreInactiveCatalogs>true</IgnoreInactiveCatalogs>
  <SortBy>sample string 9</SortBy>
  <SortDirection>sample string 10</SortDirection>
  <StringCriteria>sample string 6</StringCriteria>
  <pageCount>8</pageCount>
  <pageSize>7</pageSize>
</SearchCriterion>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CommonArticle
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CompanyId

globally unique identifier

None.

Label

string

None.

Description

string

None.

Unitprice

decimal number

None.

PriceUnit

CommonPriceUnit

None.

ImageSrcDir

string

None.

ImageName

string

None.

ImageContent

string

None.

NewImageContent

string

None.

ImageUrl

string

None.

CatalogsHavingArticle

Collection of CommonCatalog

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.