POST api/v1/tender/search

Search for an sales order

Request Information

URI Parameters

None.

Body Parameters

The parameters to search

Collection of TenderSearchModel
NameDescriptionTypeAdditional information
SearchKey

Search key

TenderSearchKeyEnum

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

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 TenderSearchResult
NameDescriptionTypeAdditional information
TenderNumberPrefix

The prefix of the quote number

string

None.

TenderNumber

The quote number

integer

None.

TenderNumberSuffix

the suffix of the quote number

string

None.

CustomerName

Name of the customer the quote is created for

string

None.

IsClosed

Is the quote closed?

boolean

None.

TenderPrintedState

The printed state of the quote

GeneralStateEnum

None.

UpdateTime

Last change Date of the quote

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TenderNumberPrefix": "sample string 1",
    "TenderNumber": 2,
    "TenderNumberSuffix": "sample string 3",
    "CustomerName": "sample string 4",
    "IsClosed": true,
    "TenderPrintedState": 0,
    "UpdateTime": "2024-12-04T08:17:02.7527133+00:00"
  },
  {
    "TenderNumberPrefix": "sample string 1",
    "TenderNumber": 2,
    "TenderNumberSuffix": "sample string 3",
    "CustomerName": "sample string 4",
    "IsClosed": true,
    "TenderPrintedState": 0,
    "UpdateTime": "2024-12-04T08:17:02.7527133+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfTenderSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Tender">
  <TenderSearchResult>
    <CustomerName>sample string 4</CustomerName>
    <IsClosed>true</IsClosed>
    <TenderNumber>2</TenderNumber>
    <TenderNumberPrefix>sample string 1</TenderNumberPrefix>
    <TenderNumberSuffix>sample string 3</TenderNumberSuffix>
    <TenderPrintedState>Unknown</TenderPrintedState>
    <UpdateTime>2024-12-04T08:17:02.7527133+00:00</UpdateTime>
  </TenderSearchResult>
  <TenderSearchResult>
    <CustomerName>sample string 4</CustomerName>
    <IsClosed>true</IsClosed>
    <TenderNumber>2</TenderNumber>
    <TenderNumberPrefix>sample string 1</TenderNumberPrefix>
    <TenderNumberSuffix>sample string 3</TenderNumberSuffix>
    <TenderPrintedState>Unknown</TenderPrintedState>
    <UpdateTime>2024-12-04T08:17:02.7527133+00:00</UpdateTime>
  </TenderSearchResult>
</ArrayOfTenderSearchResult>