Notifications

OnLocation sends email, SMS, and OnLocation Mobile push notifications. Use the notification API to retrieve a list of all notifications and provide a notification ID to retrieve a single notification.

List all notifications

Returns a list of all notification records.

Filter by any notification element. A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.

Request
query Parameters
q
string <string>

Filter by notification value

Example: q=method:sms,location_id:7
Responses
200

List of notification records

403

Access denied to this resource

404

Resource not found

get/notification
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/notification?q=string'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Retrieve a notification

Retrieves a single notification, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the notification to retrieve

Responses
200

Notification returned

403

Access denied to resource

404

Resource not found

get/notification/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/notification/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 192,
  • "created": "2021-11-25T15:01:31+13:00",
  • "modified": "2021-11-25T15:01:33+13:00",
  • "location_id": 301,
  • "visitor_id": 139,
  • "for_staff_id": 82,
  • "to_staff_id": 431,
  • "method": "sms",
  • "type": "signin",
  • "recipient": "64 212143775",
  • "messageid": "18f007ae1767d54b6654bae703d472808634a123@yoursite.whosonlocation.com",
  • "to_staff_name": "Great Scott",
  • "for_staff_name": "Great Scott",
  • "status": [
    ]
}