go back to LocationService

GET /locations/search

Searches the database for locations matching the given request parameters.

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 location table using a prefix of location or no prefix.
For example, /locations/search?location.is_active=Y&location.is_trailer_pool=Y would find all active trailer pool locations.

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 location.id+ASC will be applied.

For example, /locations/search?location.id=*&orderBy=location.name+DESC would return all location records sorted descending by the location name. 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, /locations/search?location.is_active=Y&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.

context HttpServletRequest

Result

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

a list of RowLocation objects

Try It Out

Request

- Authentication Help