GET /serviceFailures
Gets all service failures matching the request criteria. If no criteria given,
then all service failures for the current company are returned.
For example, /serviceFailures?driver_id=MBROOKS&minutes_late=>60&status=O
would find open service failures in which driver MBROOKS was over 60 minutes late.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
request |
read for query parameters to be used as search criteria; use any combination
of fields from the customer table |
context
|
|
HttpServletRequest
|
Result
List
<
RowServiceFail
>
of type:
application/xml
application/json
a list of RowServiceFail objects
Additional attributes:
__ediStandardCodeDescr
This value represents the description of the delay code, found in the servicefail.edi_standard_code
field.
Child Elements:
RowUsers
This element represents the dispatcher user associated with the service failure, by the servicefail.dispatcher_user_id
field.
The element contains a __name
attribute with the value dispatcherUser
.
RowUsers
This element represents the operations user associated with the service failure, by the servicefail.operations_user
field.
The element contains a __name
attribute with the value operationsUser
.
RowUsers
This element represents the driver manager user associated with the service failure, by the servicefail.fleet_manager
field.
The element contains a __name
attribute with the value fleetManagerUser
.
RowUsers
This element represents the caused by user associated with the service failure, by the servicefail.user_id
field.
The element contains a __name
attribute with the value causedByUser
.
RowUsers
This element represents the reviewed by user associated with the service failure, by the servicefail.reviewed_by
field.
The element contains a __name
attribute with the value reviewedByUser
.
RowDriver
This element represents the driver user associated with the service failure, by the servicefail.driver_id
field.
The element contains a __name
attribute with the value driver
.
RowPayee
This element represents the carrier user associated with the service failure, by the servicefail.override_payee_id
field.
The element contains a __name
attribute with the value carrier
.
RowCustomer
This element represents the customer associated with the service failure, by the servicefail.customer_id
field.
The element contains a __name
attribute with the value customer
.
RowLocation
This element represents the location of the terminal associated with the service failure, by the servicefail.terminal_id
field.
The element contains a __name
attribute with the value terminalLocation
.
Try It Out
Request