POST api/v1/customer/search

Search into customers

Request Information

URI Parameters

None.

Body Parameters

The parameters to search

Collection of CustomerSearchModel

Name	Description	Type	Additional information
SearchKey		CustomerSearcherKeyEnum	None.
SearchValue		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:

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

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 customers found by the search parameters

Collection of CustomerSearchResult

Name	Type	Additional information
DebitorNumber	integer	None.
CustomerNumber	integer	None.
CustomerName	string	None.
IsActive	boolean	None.
CustomerIdentifier	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DebitorNumber": 1,
    "CustomerNumber": 2,
    "CustomerName": "sample string 3",
    "IsActive": true,
    "CustomerIdentifier": "4a457d04-7d8c-4aeb-8208-027eba2217f3"
  },
  {
    "DebitorNumber": 1,
    "CustomerNumber": 2,
    "CustomerName": "sample string 3",
    "IsActive": true,
    "CustomerIdentifier": "4a457d04-7d8c-4aeb-8208-027eba2217f3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <CustomerSearchResult>
    <CustomerIdentifier>4a457d04-7d8c-4aeb-8208-027eba2217f3</CustomerIdentifier>
    <CustomerName>sample string 3</CustomerName>
    <CustomerNumber>2</CustomerNumber>
    <DebitorNumber>1</DebitorNumber>
    <IsActive>true</IsActive>
  </CustomerSearchResult>
  <CustomerSearchResult>
    <CustomerIdentifier>4a457d04-7d8c-4aeb-8208-027eba2217f3</CustomerIdentifier>
    <CustomerName>sample string 3</CustomerName>
    <CustomerNumber>2</CustomerNumber>
    <DebitorNumber>1</DebitorNumber>
    <IsActive>true</IsActive>
  </CustomerSearchResult>
</ArrayOfCustomerSearchResult>