Skip to content

Visitor management

XPKit can be used as a visitor management system, below is an example and some instructions on how you can use XPKit for this use case.

In this example we are assuming:

  • Visitors are stored as profile resources
  • The things visitors do during a visit are stored as activity resources
  • Visits are attended by companies or individuals
  • Multiple companies and/or individuals can attend the same visit

Companies

You can use the custom resources service to create company resources.

A company could look like: 

{
    "resource_id": "f8ad7eff-48a3-4436-a6a0-07f8b10650ff",
    "resource_url": "/api/company/f8ad7eff-48a3-4436-a6a0-07f8b10650ff",
    "resource": {
        "experience_id": "art-exhibition-2021",
        "name": "ABC"
    }
}

Visitors

You can link a person (profile) to the company like so:

{
    "resource_id": "8b3e199f-6393-4cca-a220-10bd420a0464",
    "resource_url": "/api/profile/8b3e199f-6393-4cca-a220-10bd420a0464",
    "resource": {
        "email": ["visitor@example.com"],
        "first_name": "Example",
        "last_name": "Visitor",
        "company_id": "f8ad7eff-48a3-4436-a6a0-07f8b10650ff"
    }
}

Note: you can now call the profiles service to find all profiles that belong to a particular company

/api/profile?company_id=f8ad7eff-48a3-4436-a6a0-07f8b10650ff

Visits

Like you did for companies, you can use the custom resources service to create visit resources.

A visit could look like:

{
    "resource_id": "13b9b789-933d-406b-bcf3-9e39d5163ea0",
    "resource_url": "/api/visit/13b9b789-933d-406b-bcf3-9e39d5163ea0",
    "resource": {
        "experience_id": "art-exhibition-2021",
        "timezone": "Australia/Sydney",
        "name": "Visit from ABC",
        "event_start_date": "2021-04-30T10:00:00+00:00",
        "location": "Sydney",
        "event_end_date": "2021-04-30T11:00:00+00:00",
        "status": "confirmed",
        "visit_code": "RVNFWCV2452",
        "companies": ["f8ad7eff-48a3-4436-a6a0-07f8b10650ff"],
        "individuals": []
    }
}

Attendees in the form of companies and profiles are referenced by their resource IDs.

Summary

Using the resources: profile, activity, company and visit it is possible to track all attendees to a visit (whether as individuals or as part of a company), when they arrived and left and what they did whilst they were there.