EMUN1 ASP.NET

<back to all web services

QueryOrdersSearch

The following routes are available for this service:
All Verbs/service/QueryOrdersSearch
QueryOrdersSearch Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
OrderSearch Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CompanyNameformstringNo
RetailerIdformstringNo
PurchaseOrderformstringNo
OrderedOnformDateTimeNo
ShipOnformDateTimeNo
GrandTotalformfloatNo
WritingRepformstringNo
SalesRepIdformstringNo
VendorformstringNo
StatusformstringNo
ItemsformIEnumerable<OrderLine>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
OrderLineBase Parameters:
NameParameterData TypeRequiredDescription
OrderNumberformstringNo
PositionformintNo
ProductIdformstringNo
DescriptionformstringNo
QtyPurchasedformintNo
QtyOpenformintNo
PriceformdecimalNo
ExtendedTotalformdecimalNo
PromoDiscountformdecimalNo
OptionsformList<ILineOption>No
ActiveformboolNo
XmlOptionsformstringNo
CostformstringNo
VendorIdformstringNo
CategoryIdformstringNo
ShipDateformDateTime?No
StatusformstringNo
ILineOption Parameters:
NameParameterData TypeRequiredDescription
FieldIdformstringNo
OrderNumberformstringNo
PositionformintNo
UpchargeformdoubleNo
UpchargeTypeformstringNo
ValueIdformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /service/QueryOrdersSearch HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: String,
			companyName: String,
			retailerId: String,
			purchaseOrder: String,
			orderedOn: 0001-01-01,
			shipOn: 0001-01-01,
			grandTotal: 0,
			writingRep: String,
			salesRepId: String,
			vendor: String,
			status: String,
			items: 
			[
				{
					orderNumber: String,
					position: 0,
					productId: String,
					description: String,
					qtyPurchased: 0,
					qtyOpen: 0,
					price: 0,
					extendedTotal: 0,
					promoDiscount: 0,
					options: [],
					active: False,
					xmlOptions: <Options></Options>,
					cost: String,
					vendorId: String,
					categoryId: String,
					shipDate: 0001-01-01,
					status: String
				}
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}