Visitor events

A visitor event is a record listing the details of a visit, including the visitor's name, where they visited, contact details, basic question answers, and sign in/out mode and time.

Use the visitor event API to retrieve your visitor event list, add a new visitor event, or update or delete a visitor event.

List all visitor events

Returns a list of visitor sign in and out events.

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 any visitor event value.

Example: q=location_id:100
order
string <string>

Order by any element returned, prefix with a - to reverse order.

Example: order=location_id
limit
integer <date-string>

Limits the amount of records to return.

Example: limit=10
header Parameters
If-Modified-Since
string <int32>

A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only entities created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Responses
200

List of visitor sign in and out events

403

Access denied to this resource

404

Resource not found

500

Internal server error

get/visitor/event
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/visitor/event?q=string&order=string&limit=0' \
  -H 'If-Modified-Since: string'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Create a visitor event

Creates a new visitor sign in and out event.

Request
Request Body schema: application/json
name
string <string>
type
string
Value: "visit"
location_id
integer <int32>
visiting_staff_id
integer <int32>
signed_in
string <date-time>
signed_out
string <date-time>
email
string <string>
from
string <string>
phone
string <string>
mobile
string <string>
title
string <string>
assistance
any <boolean>
purpose
string <string>
carpark_registration
string <string>
carpark_number
string <string>
cardnumber
string <string>
id_verification_reference
string <boolean>
id_verification_type
string <string>
lacp_in_id
integer <int32>
lacp_out_id
integer <int32>
Responses
201

Event created

403

Access denied to this resource

500

Internal server error

post/visitor/event
Request samples
application/json
{
  • "name": "Elayne Trakand",
  • "type": "visit",
  • "location_id": 301,
  • "visiting_staff_id": 534,
  • "signed_in": "2021-11-25T12:01:09.380Z",
  • "signed_out": "2021-11-25T13:01:09.380Z",
  • "email": "example.email@example.org",
  • "from": "Andor",
  • "phone": "+1 206 555 0123",
  • "mobile": "+1 206 555 0123",
  • "title": "Ms",
  • "assistance": false,
  • "purpose": "visiting",
  • "carpark_registration": "MRU366",
  • "carpark_number": "5",
  • "cardnumber": "cn001",
  • "id_verification_reference": true,
  • "id_verification_type": "licence",
  • "lacp_in_id": 239,
  • "lacp_out_id": 239
}
Response samples
application/json
application/json
application/xml
{
  • "id": 138,
  • "created": "2021-11-25T14:47:34+13:00",
  • "modified": "2021-11-25T15:01:08+13:00",
  • "location_id": 301,
  • "created_staff_id": 349,
  • "visiting_staff_id": 823,
  • "signed_in": "2021-11-25T14:47:36+13:00",
  • "signed_out": "2021-11-25T15:01:08+13:00",
  • "mode_in": "Kiosk",
  • "mode_out": "Kiosk",
  • "signed_in_by": 823,
  • "signed_out_by": 823,
  • "name": "Elayne Trakand",
  • "email": "example-email@whosonlocation.com",
  • "from": "Andor",
  • "phone": "+1 206 555 0123",
  • "mobile": "+1 206 555 0123",
  • "title": "Ms",
  • "assistance": false,
  • "expected": false,
  • "printed": true,
  • "pass": true,
  • "purpose": "Just visiting",
  • "carpark_question": false,
  • "carpark_registration": "MRU366",
  • "carpark_number": "5",
  • "cardnumber": "cn001",
  • "id_verification_checked": true,
  • "id_verification_type": "licence",
  • "accessdenied": false,
  • "id_verification_reference": "Reference verification",
  • "visiting_staff_name": "Staff Member",
  • "location_name": "Head Office",
  • "lacp_in_name": "Reception",
  • "lacp_out_name": "Reception",
  • "signed_in_by_name": "Person in reception",
  • "signed_out_by_name": "Person in reception",
  • "onsite": "13 minutes 32 seconds",
  • "type": "visit",
  • "lacp_in_id": 239,
  • "lacp_out_id": 239
}

Retrieve a visitor event

Retrieves a single visitor sign in and out event, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the visitor sign in and out event to retrieve

Responses
200

Event returned

403

Access denied to resource

404

Resource not found

500

Internal server error

get/visitor/event/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/visitor/event/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 138,
  • "created": "2021-11-25T14:47:34+13:00",
  • "modified": "2021-11-25T15:01:08+13:00",
  • "location_id": 301,
  • "created_staff_id": 349,
  • "visiting_staff_id": 823,
  • "signed_in": "2021-11-25T14:47:36+13:00",
  • "signed_out": "2021-11-25T15:01:08+13:00",
  • "mode_in": "Kiosk",
  • "mode_out": "Kiosk",
  • "signed_in_by": 823,
  • "signed_out_by": 823,
  • "name": "Elayne Trakand",
  • "email": "example-email@whosonlocation.com",
  • "from": "Andor",
  • "phone": "+1 206 555 0123",
  • "mobile": "+1 206 555 0123",
  • "title": "Ms",
  • "assistance": false,
  • "expected": false,
  • "printed": true,
  • "pass": true,
  • "purpose": "Just visiting",
  • "carpark_question": false,
  • "carpark_registration": "MRU366",
  • "carpark_number": "5",
  • "cardnumber": "cn001",
  • "id_verification_checked": true,
  • "id_verification_type": "licence",
  • "accessdenied": false,
  • "id_verification_reference": "Reference verification",
  • "visiting_staff_name": "Staff Member",
  • "location_name": "Head Office",
  • "lacp_in_name": "Reception",
  • "lacp_out_name": "Reception",
  • "signed_in_by_name": "Person in reception",
  • "signed_out_by_name": "Person in reception",
  • "onsite": "13 minutes 32 seconds",
  • "type": "visit",
  • "lacp_in_id": 239,
  • "lacp_out_id": 239
}

Update a visitor event

Updates a visitor sign in and out event based on the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the visitor event to update

Request Body schema: application/json

Information used to create the visitor event record

type
string <string>
location_id
integer <int32>
visiting_staff_id
integer <int32>
signed_in
string <date-time>
signed_out
string <date-time>
mode_id
string <string>
mode_out
string <string>
signed_in_by
integer <int32>
signed_out_by
integer <int32>
name
string <string>
email
string <string>
from
string <string>
phone
string <string>
mobile
string <string>
title
string <string>
assistance
any <boolean>
expected
boolean <boolean>
pass
boolean <boolean>
purpose
string <string>
carpark_question
boolean <boolean>
carpark_registration
string <string>
carpark_number
string <string>
cardnumber
string <string>
id_verification_reference
string <boolean>
id_verification_type
string <string>
accessdenied
boolean <boolean>
visiting_staff_name
string <string>
signed_in_by_name
string <string>
signed_out_by_name
string <string>
onsite
string <string>
lacp_in_id
integer <int32>
lacp_out_id
integer <int32>
Responses
204

Updated event

403

Access denied to this resource

500

Internal server error

put/visitor/event/{id}
Request samples
application/json
{
  • "type": "visit",
  • "location_id": 301,
  • "visiting_staff_id": 534,
  • "signed_in": "2021-11-25T12:01:09.380Z",
  • "signed_out": "2021-11-25T13:01:09.380Z",
  • "mode_id": "Kiosk",
  • "mode_out": "Kiosk",
  • "signed_in_by": 823,
  • "signed_out_by": 823,
  • "name": "Elayne Trakand",
  • "email": "example.email@whosonlocation.com",
  • "from": "Andor",
  • "phone": "+1 206 555 0123",
  • "mobile": "+1 206 555 0123",
  • "title": "Ms",
  • "assistance": false,
  • "expected": false,
  • "pass": true,
  • "purpose": "Just visiting",
  • "carpark_question": false,
  • "carpark_registration": "MRU366",
  • "carpark_number": "5",
  • "cardnumber": "cn001",
  • "id_verification_reference": true,
  • "id_verification_type": "licence",
  • "accessdenied": false,
  • "visiting_staff_name": "Staff Member",
  • "signed_in_by_name": "Person in reception",
  • "signed_out_by_name": "Person in reception",
  • "onsite": "13 minutes 32 seconds",
  • "lacp_in_id": 239,
  • "lacp_out_id": 239
}

Delete a visitor event

Deletes the specified visitor sign in and out event.

Request
path Parameters
id
required
integer <int32>

ID of the visitor sign in/out event to delete

Responses
204

Event deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

delete/visitor/event/{id}
Request samples
curl -i -X DELETE \
  https://api.whosonlocation.com/v1/visitor/event/:id