POST api/v1/supplier/search

Search into suppliers

Request Information

URI Parameters

None.

Body Parameters

The parameters to search

Collection of SupplierSearchModel

Name	Description	Type	Additional information
SearchKey	Key of the value to search for	SupplierSearchKeyEnum	None.
SearchValue	Value to search for	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "SearchKey": 0,
    "SearchValue": "sample string 1"
  },
  {
    "SearchKey": 0,
    "SearchValue": "sample string 1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSupplierSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Suppliers">
  <SupplierSearchModel>
    <SearchKey>CompanyName</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </SupplierSearchModel>
  <SupplierSearchModel>
    <SearchKey>CompanyName</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </SupplierSearchModel>
</ArrayOfSupplierSearchModel>

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 'List`1'.

Response Information

Resource Description

Multiple suppliers found by the search parameters

Collection of SupplierSearchResult

Name	Type	Additional information
CreditorNumber	integer	None.
SupplierName	string	None.
IsActive	boolean	None.
SupplierIdentifier	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CreditorNumber": 1,
    "SupplierName": "sample string 2",
    "IsActive": true,
    "SupplierIdentifier": "4145cc3a-5752-4040-b803-12da49d69b0e"
  },
  {
    "CreditorNumber": 1,
    "SupplierName": "sample string 2",
    "IsActive": true,
    "SupplierIdentifier": "4145cc3a-5752-4040-b803-12da49d69b0e"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSupplierSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <SupplierSearchResult>
    <CreditorNumber>1</CreditorNumber>
    <IsActive>true</IsActive>
    <SupplierIdentifier>4145cc3a-5752-4040-b803-12da49d69b0e</SupplierIdentifier>
    <SupplierName>sample string 2</SupplierName>
  </SupplierSearchResult>
  <SupplierSearchResult>
    <CreditorNumber>1</CreditorNumber>
    <IsActive>true</IsActive>
    <SupplierIdentifier>4145cc3a-5752-4040-b803-12da49d69b0e</SupplierIdentifier>
    <SupplierName>sample string 2</SupplierName>
  </SupplierSearchResult>
</ArrayOfSupplierSearchResult>