GET /quoteOrders/search

Searches the database for quote-orders matching the given request parameters.

Roles that can access this endpoint are Users, Customers.

Parameters

name description type default type

request

name	description	type	default	type
request	read for query parameters to be used as search criteria; use any combination of fields from tables: `quote_order` - use `quote_order` no prefix `quote_stop` - use `shipper` or `consignee` prefixes as appropriate `customer` - use `customer` prefix For example, `/quoteOrders/search?shipper.location_id=WARE&consignee.state=AL` would find quote-orders from shipper locations starting with 'WARE' to consignees in Alabama. Sorting:* To sort the result set, you can provide the following reserved query parameter: `orderBy` If the orderBy parameter is not provided a default sort of `quote_order.id+DESC` will be applied. For example, `/quoteOrders/search?shipper.sched_arrive_early=>=t-7&orderBy=quote_orders.id+DESC` would return all quote-order records with a ship date for the prior seven days sorted descending by quote_order.id. Multiple sort columns can be provided in a comma delimited format. `orderBy=prefix.field+direction,prefix.field+direction` Pagination: To page the result set, you can provide the following reserved query parameters: `recordLength and recordOffset` For example, `/quote_order/search?quote_order.id=&recordLength=100&recordOffset=50` would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied. Changed After Date:* To return only records that have been changed or added since a specific date and time, you can provide the `changedAfterDate` parameter. Dates are limited to the audit setting and days to keep value in the table properties configuration. For example, `/quoteOrders/search?quote_order.id=&changedAfterDate=t-1` would return all quote orders that have been added or updated since the beginning of the previous day. Change Types:* To further define the types of changes you want to filter, use the `changedAfterType` parameter. This parameter is to be used in conjunction with `changedAfterDate` to give the ability to specify if you want added or updated records. Allowed values: [Add, Update]. Any other value will result in an exception. If the `ChangedAfterType` parameter is not provided, both added and updated records will be returned. If you do not provide a corresponding `ChangedAfterDate` the `ChangedAfterType` parameter will be ignored. For example, `/quoteOrders/search?quote_order.id=*&changedAfterDate=t-1&changedAfterType=Add` would return all quote orders that have been added since the beginning of the previous day.	context		HttpServletRequest

read for query parameters to be used as search criteria; use any combination of fields from tables:

quote_order - use quote_order no prefix
quote_stop - use shipper or consignee prefixes as appropriate
customer - use customer prefix

For example, /quoteOrders/search?shipper.location_id=WARE*&consignee.state=AL would find quote-orders from shipper locations starting with 'WARE' to consignees in Alabama.

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of quote_order.id+DESC will be applied.

For example, /quoteOrders/search?shipper.sched_arrive_early=>=t-7&orderBy=quote_orders.id+DESC would return all quote-order records with a ship date for the prior seven days sorted descending by quote_order.id. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /quote_order/search?quote_order.id=*&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

Changed After Date: To return only records that have been changed or added since a specific date and time, you can provide the changedAfterDate parameter. Dates are limited to the audit setting and days to keep value in the table properties configuration.

For example, /quoteOrders/search?quote_order.id=*&changedAfterDate=t-1 would return all quote orders that have been added or updated since the beginning of the previous day.

Change Types: To further define the types of changes you want to filter, use the changedAfterType parameter. This parameter is to be used in conjunction with changedAfterDate to give the ability to specify if you want added or updated records.

Allowed values: [Add, Update]. Any other value will result in an exception. If the ChangedAfterType parameter is not provided, both added and updated records will be returned. If you do not provide a corresponding ChangedAfterDate the ChangedAfterType parameter will be ignored.

For example, /quoteOrders/search?quote_order.id=*&changedAfterDate=t-1&changedAfterType=Add would return all quote orders that have been added since the beginning of the previous day.

context

HttpServletRequest

Result

List < RowAbstractOrder > of type: application/xml application/json

a list of RowQuoteOrder objects

Additional attributes:

__statusDescr This value represents the description of the quote_order status, found in the quote_order.status field.
__collectionMethodDescr This value represents the description of the collection method, found in the quote_order.collection_method field.
__rateTypeDescr This value represents the description of the rate type, found in the quote_order.rate_type field.
__revenueTypeDescr This value represents the description of the revenue code, found in the quote_order.revenue_code_id field.
__equipmentTypeDescr This value represents the description of the equipment type, found in the quote_order.equipment_type_id field.
__tractorTypeDescr This value represents the description of the tractor type, found in the quote_order.tractor_type field.

Child Elements:

RowCustomer This element represent the customer associated with the quote-order, by the quote_order.customer_id field. The element contains a __name attribute with the value customer.
RowUsers This element represent the entered user associated with the quote-order, by the quote_order.entered_user_id field. The element contains a __name attribute with the value enteredUser.
RowUsers This element represent the operations user associated with the quote-order, by the quote_order.operations_user field. The element contains a __name attribute with the value operationsUser.
RowQuoteFreightGroup This element represents the quote-freight group associated with the quote-order. The element contains a __name attribute with the value freightGroup.
RowQuoteHdrXFgp These elements represent quote-accessorials associated with the quote-freight group. Each element contains a __name attribute with the value handlingRequirements.
RowQuoteFreightGroupItem These elements represent quote-freight items associated with the quote-freight group. Each element contains a __name attribute with the value freightGroupItems.
QuoteRevenueDetailPerFgiView These elements represent quote-revenue details associated with quote-freight items. Each element contains a __name attribute with the value revenueDetails.
RowQuoteFgpXBfg These elements represent the quote-billing freight groups associated with the quote-freight group. Each element contains a __name attribute with the value fgpXBfgs.
QuoteRevenueDetailPerFgiView These elements represent quote revenue details not associated with quote-freight items. Each element contains a __name attribute with the value revenueDetails.
RowQuoteStop These elements represent the quote-stops associated with the quote-order. Each element contains a __name attribute with the value stops.

GET /quoteOrders/search

Parameters

Result

Try It Out

Request

Response