Wiki
Clone wikiNumera.LibrisAPI / event.search
Home > API Reference Documentation > event.search
event.search
The event.search action is used to search events for a device, event collector, across a realm, or across all the devices you have access to.
You will only be able to search events belonging to event collectors that either existed in your realm(s) or to the devices you (as a user) directly manage. The events are returned in descending order based on the time the event was created.
For a complete listing of all events, and what they mean please look at the Event Dictionary
Input Parameters
| Property | Required | Description |
|---|---|---|
imei | no | The imei of the device you want to restrict your event search to |
realm | no | the realm you would like to search |
event_collector_id | no | If you supplied an imei and you do not supply a value for this field, then the device's current event collector will be used as a filter. To get the complete event history for a device, specify the value of all for this field. |
event_types | no | An array of strings you can use to restrict the events you are searching |
limit | no | The maximum number of events to return, default is 100 and the maximum you can get at one time is 200 |
time_filter_start | no | if you need to load more history, you can supply the time string from the last event you received on the previous search and this will return all events that occurred before this time. All time strings are in UTC. |
time_filter_end | no | an iso formatted UTC date/time string you can use as a filter, events that were opened after or on this time will be returned |
with_locations | no | if you want to limit the results to only events that contain location fixes, set this to true |
Output
The result object will contain an events[] array, with each event defined as below:
| Property | Description |
|---|---|
id | event id |
time | event time |
event_collector_id | event_collector related to the event |
imei | device imei |
realm | realm in use at time of event |
event_type | type of event |
script | a string that usually contains a json object that can be re-hydrated, see the Event Dictionary for more details of how this is used for each event type |
state | state of the event |
rv | if the event was related to a real time server connection, this would represent the id of that connection |
fall_time | for call events related to falls |
fall_disposition | if the call center agent set the disposition on the call, it will show up here |
location | if the event has a location on it, this will contain a location object with the following properties: |
time- time the location was obtainedlatitude- latitude of the fixlongitude- longitude of the fixmethod- how the fix was obtained
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NO_ACCESS_TO_EVENT_COLLECTOR | User has no access to the events being requested |
1001 | NO_ACCESS_TO_IMEI | The imei you supplied either does not exist or the user does not have permissions to use it |
1002 | NO_ACCESS_TO_REALM | The user does not have access to the realm being requested |
Updated