go back to CallinService

GET /callins/search

Searches the database for callin records 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 callin table using a prefix of callin or no prefix.

For example, /callins/search?callin.setpoint_temp=>32 would find callins where the setpoint temperature exceeded 32 degrees fahrenheit.

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 callin.movement_id+ASC will be applied.

For example, /callins/search?callin.setpoint_temp=>32&orderBy=callin.tractor_id+DESC would return callins entered with a setpoint temperature exceeding 32 degrees sorted ascending by the tractor 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, /callins/search?callin.setpoint_temp=>32&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, /callins/search?callin.setpoint_temp=>32&changedAfterDate=t-1 would return callins that had a setpoint_temp greater than 32 degrees 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, /callins/search?callin.setpoint_temp=>32&changedAfterDate=t-1&changedAfterType=Add would return callins that had a setpoint_temp greater than 32 degrees that have been added since the beginning of the previous day.

context HttpServletRequest

Result

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

a list of RowCallin objects

Try It Out

Request

- Authentication Help