POST api/v1/indent/search

Search for an sales order

Request Information

URI Parameters

None.

Body Parameters

The parameters to search

Collection of IndentSearchModel
NameDescriptionTypeAdditional information
SearchKey

Search key

IndentSearchKeyEnum

None.

SearchValue

Search value

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:
<ArrayOfIndentSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Indent">
  <IndentSearchModel>
    <SearchKey>Invalid</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </IndentSearchModel>
  <IndentSearchModel>
    <SearchKey>Invalid</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </IndentSearchModel>
</ArrayOfIndentSearchModel>

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

Collection of IndentSearchResult
NameDescriptionTypeAdditional information
IndentNumberPrefix

The prefix of the indent number

string

None.

IndentNumber

The indent number

integer

None.

IndentNumberSuffix

the suffix of the indent number

string

None.

CustomerName

Name of the customer the indent is created for

string

None.

IsClosed

Is the indent closed?

boolean

None.

IndentPrintedState

The printed state of the indent

GeneralStateEnum

None.

IndentOrderedState

The ordered state of the indent

IndentStateEnum

None.

IndentDelivarableState

Obsolete, will be removed in the near future

IndentStateEnum

None.

IndentDeliverableState

The deliverable state of the indent

IndentStateEnum

None.

IndentDeliveredState

The delivered state of the indent

IndentStateEnum

None.

IndentCalculatedState

The calculated state of the indent

IndentStateEnum

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "IndentNumberPrefix": "sample string 1",
    "IndentNumber": 2,
    "IndentNumberSuffix": "sample string 3",
    "CustomerName": "sample string 4",
    "IsClosed": true,
    "IndentPrintedState": 0,
    "IndentOrderedState": 0,
    "IndentDelivarableState": 0,
    "IndentDeliverableState": 0,
    "IndentDeliveredState": 0,
    "IndentCalculatedState": 0
  },
  {
    "IndentNumberPrefix": "sample string 1",
    "IndentNumber": 2,
    "IndentNumberSuffix": "sample string 3",
    "CustomerName": "sample string 4",
    "IsClosed": true,
    "IndentPrintedState": 0,
    "IndentOrderedState": 0,
    "IndentDelivarableState": 0,
    "IndentDeliverableState": 0,
    "IndentDeliveredState": 0,
    "IndentCalculatedState": 0
  }
]

application/xml, text/xml

Sample:
<ArrayOfIndentSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <IndentSearchResult>
    <CustomerName>sample string 4</CustomerName>
    <IndentCalculatedState>Unknown</IndentCalculatedState>
    <IndentDelivarableState>Unknown</IndentDelivarableState>
    <IndentDeliverableState>Unknown</IndentDeliverableState>
    <IndentDeliveredState>Unknown</IndentDeliveredState>
    <IndentNumber>2</IndentNumber>
    <IndentNumberPrefix>sample string 1</IndentNumberPrefix>
    <IndentNumberSuffix>sample string 3</IndentNumberSuffix>
    <IndentOrderedState>Unknown</IndentOrderedState>
    <IndentPrintedState>Unknown</IndentPrintedState>
    <IsClosed>true</IsClosed>
  </IndentSearchResult>
  <IndentSearchResult>
    <CustomerName>sample string 4</CustomerName>
    <IndentCalculatedState>Unknown</IndentCalculatedState>
    <IndentDelivarableState>Unknown</IndentDelivarableState>
    <IndentDeliverableState>Unknown</IndentDeliverableState>
    <IndentDeliveredState>Unknown</IndentDeliveredState>
    <IndentNumber>2</IndentNumber>
    <IndentNumberPrefix>sample string 1</IndentNumberPrefix>
    <IndentNumberSuffix>sample string 3</IndentNumberSuffix>
    <IndentOrderedState>Unknown</IndentOrderedState>
    <IndentPrintedState>Unknown</IndentPrintedState>
    <IsClosed>true</IsClosed>
  </IndentSearchResult>
</ArrayOfIndentSearchResult>