GET /orders/userSavedSearch
Retrieves a List of RowOrders objects based on an existing saved search.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| userId |
string indicating the current user |
query
|
|
String
|
| createUserId |
string indicating the user who created the saved search |
query
|
|
String
|
| screenClassName |
string indicating the class of the screen that is related to the saved search |
query
|
|
String
|
| searchName |
string indicating the name of the saved search |
query
|
|
String
|
Result
List
<
RowOrders
>
of type:
application/xml
application/json
a list of RowOrders objects
Additional attributes:
__statusDescr This value represents the description of the order status, found in the orders.status field.__collectionMethodDescr This value represents the description of the collection method, found in the orders.collection_method field.__rateTypeDescr This value represents the description of the rate type, found in the orders.rate_type field.__revenueTypeDescr This value represents the description of the revenue code, found in the orders.revenue_code_id field.__equipmentTypeDescr This value represents the description of the equipment type, found in the orders.equipment_type_id field.__tractorTypeDescr This value represents the description of the tractor type, found in the orders.tractor_type field.
Child Elements:
RowCustomer This element represent the customer associated with the order, by the order.customer_id field.
The element contains a __name attribute with the value customer.RowUsers This element represent the entered user associated with the order, by the 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 order, by the order.operations_user field.
The element contains a __name attribute with the value operationsUser.RowFreightGroup This element represents the freight group associated with the order.
The element contains a __name attribute with the value freightGroup.RowHdrXFgp These elements represent accessorials associated with the freight group.
Each element contains a __name attribute with the value handlingRequirements.RowFreightGroupItem These elements represent freight items associated with the freight group.
Each element contains a __name attribute with the value freightGroupItems.RevenueDetailPerFgiView These elements represent revenue details associated with freight items.
Each element contains a __name attribute with the value revenueDetails.FgpXBfg These elements represent the billing freight groups associated with the freight group.
Each element contains a __name attribute with the value fgpXBfgs.RevenueDetailPerFgiView These elements represent revenue details not associated with freight items.
Each element contains a __name attribute with the value revenueDetails.RowStop These elements represent the stops associated with the order.
Each element contains a __name attribute with the value stops.
Try It Out
Request