GET /payments/retrieveStops
Searches the database for stops matching the given request parameters. Query parameters to be used as search
criteria; All Query parameters are optional.
Roles that can access this endpoint are Payment Service.
Parameters
| name |
description |
type |
default |
type |
| movementId |
(Optional) The movement Id for the Stop.
If no value is submitted then all available stops are eligible to be
returned.
There is no default value |
query
|
|
String
|
| recordLength |
(Optional) Number of records to return.
If no value is submitted then the value will default to the
mobile_service.max_search value in the Mobile Service control |
query
|
|
Integer
|
| recordOffset |
(Optional) Start of offset in the returned data result set.
Defaults to 0 |
query
|
|
Integer
|
Result
List
<
RowStop
>
of type:
application/xml
application/json
List RowStop of type: application/xml application/json
a List of RowStop Objects
The response will be filtered to only return stops that are.
Pagination: To page the result set, provide the following reserved query parameters:
recordLength and recordOffset
There is a secondary control that may further limit the pagination results to a maximum
specified by the customer.
For example: /payments/retrieveStops?recordLength=100&recordOffset=50
It 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.
If pagination is used, the response data will include a __type 'URI' element
that represents the next paginated /retrieve URI.
Try It Out
Request