POST api/v1/purchaseorder/search
Search for a purchase order
Request Information
URI Parameters
None.
Body Parameters
Collection of PurchaseOrderSearchModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchKey |
Set the key where you want to search for |
PurchaseOrderSearchKeyEnum |
None. |
| SearchValue |
Set the value where you want 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:
<ArrayOfPurchaseOrderSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.PurchaseOrder">
<PurchaseOrderSearchModel>
<SearchKey>SupplierName</SearchKey>
<SearchValue>sample string 1</SearchValue>
</PurchaseOrderSearchModel>
<PurchaseOrderSearchModel>
<SearchKey>SupplierName</SearchKey>
<SearchValue>sample string 1</SearchValue>
</PurchaseOrderSearchModel>
</ArrayOfPurchaseOrderSearchModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of PurchaseOrderSearchResult| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderNumber |
Number of the purchase order |
integer |
None. |
| SupplierName |
Name of the supplier |
string |
None. |
| SupplierCreditorNumber |
Number of the supplier |
integer |
None. |
| AssignedPurchaseOrderAction |
Name of the action that is the assigned action |
string |
None. |
| IsCanceled |
Is the purchase order cancelled |
boolean |
None. |
| IsClosed |
Is the purchase order closed |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"PurchaseOrderNumber": 1,
"SupplierName": "sample string 2",
"SupplierCreditorNumber": 3,
"AssignedPurchaseOrderAction": "sample string 4",
"IsCanceled": true,
"IsClosed": true
},
{
"PurchaseOrderNumber": 1,
"SupplierName": "sample string 2",
"SupplierCreditorNumber": 3,
"AssignedPurchaseOrderAction": "sample string 4",
"IsCanceled": true,
"IsClosed": true
}
]
application/xml, text/xml
Sample:
<ArrayOfPurchaseOrderSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
<PurchaseOrderSearchResult>
<AssignedPurchaseOrderAction>sample string 4</AssignedPurchaseOrderAction>
<IsCanceled>true</IsCanceled>
<IsClosed>true</IsClosed>
<PurchaseOrderNumber>1</PurchaseOrderNumber>
<SupplierCreditorNumber>3</SupplierCreditorNumber>
<SupplierName>sample string 2</SupplierName>
</PurchaseOrderSearchResult>
<PurchaseOrderSearchResult>
<AssignedPurchaseOrderAction>sample string 4</AssignedPurchaseOrderAction>
<IsCanceled>true</IsCanceled>
<IsClosed>true</IsClosed>
<PurchaseOrderNumber>1</PurchaseOrderNumber>
<SupplierCreditorNumber>3</SupplierCreditorNumber>
<SupplierName>sample string 2</SupplierName>
</PurchaseOrderSearchResult>
</ArrayOfPurchaseOrderSearchResult>