Common tasks performed with the API

Here is a selection of tasks that can be performed using the WhosOnLocation API.

For a full list, check the API schema.

Function

Description

Function

Staff

Add staff

Creates a new employee profile

 

Update staff

Updates a employee profile

 

Delete staff

Deletes a single employee profile based on the ID supplied

Custom Fields

List of member custom fields

Returns a list of all contractor member custom fields

 

List of organization custom fields

Returns a list of all contractor organization custom fields

 

List of employee custom fields

Returns a list of all employee custom fields

Locations

Add location

Creates a new location

 

Update location

Updates a location

 

Delete location

Deletes a single location based on the ID supplied

Departments

Add department

Creates a new department

 

Update department

Updates a department

 

Delete department

Deletes a single department based on the ID supplied

Contractor Members

Add member

Creates a contractor member profile

 

Update member

Updates a contractor member profile

 

Delete member 

Deletes a contractor member profile based on the ID supplied

Contractor Membership

List of membership mapping    

Returns a list of contractor members to organization mapping

 

Add membership

Creates a new contractor member to organization mapping

 

Update membership

Updates a contractor member to organization mapping

 

Delete membership

Deletes a contractor member to organization mapping based on the ID supplied

Contractor Organizations

Add organization

Creates a new contractor organization profile

 

Update organization

Updates a contractor organization profile

 

Delete organization

Deletes a contractor organization profile based on the ID supplied

Contractor Insurance

Add insurance policy

Creates a new contractor insurance policy

 

Update insurance policy

Update a contractor insurance policy

 

Delete insurance policy

Delete a contractor insurance policy based on the ID supplied

Contractor Role

List of contractor roles

Returns a list of contractor roles

Visitor Event

Add new visitor event

Create a new visitor event

 

Update visitor event

Updates a visitor event record

 

Delete visitor event

Deletes a visitor event record based on the ID supplied

Visitor Group

Add visitor group

Creates a single visitor group

 

Update visitor group

Updates a single visitor group

 

Delete visitor group

Deletes a single visitor group based on the ID supplied

Visitor Register

Add new visitor pre-registration event

Create a new visitor pre-registration event

 

Update visitor pre-registration event

Updates a visitor pre-registration event

 

Delete visitor pre-registration event

Deletes a single visitor pre-registration event based on the ID supplied

Visitor Person

List of visitors

The visitor endpoint returns a list of visitors

 

Add visitor

Creates a new visitor person

 

Update visitor

Updates a visitor person

 

Delete visitor

Deletes a single visitor person based on the ID supplied

Notifications

List of notifications

The notifications endpoint returns a list of messages sent to employees and visitors

Qualifications

List of qualifications 

Returns a list of qualifications

 

List of qualification holders

Returns a list of people holding a qualification

 

Add qualification association

Creates a new qualification holder association

 

Delete qualification association

Deletes a single qualification holder association based on on the ID supplied

 

Add qualification type

Creates a new qualification type

Inductions

List of inductions

Returns a list of inductions

 

Add induction

Creates a new induction 

 

Add induction association

Creates a new induction holder association

 

List of induction holders

Returns a list of people who have completed an induction

Custom Questionnaire

List of custom questionnaires

Returns a list of all custom questionnaires

 

List of all custom questions

Returns a list of all custom questions

 

List of custom questionnaire submissions

Returns a list of all custom questionnaire submissions

 

List of custom question answers

Returns a list of all custom question answers