Community member movements

List all community-member movements

Retrieves a list of community-member movement records.

Request
query Parameters
q
integer <int32>

Filters the result. See Using the API for more information.

Example: q=community_id:123456
order
string <string>

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

Example: order=id
limit
integer <int32>

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 community-member movement records

403

Access denied to this resource

404

Resource not found

500

Internal server error

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

Create or update a community-member movement

Creates or updates an community-member movement record.

Request
Request Body schema: application/json

Data required to create or update an community member movement:

onsite_status
required
string <string>

Describes whether the movement is 'onsite' or 'offsite'

location_id
required
integer <int32>
member_id
required
integer <int32>
lacp_id
integer <int32>

Location access point ID. Not mandatory.

zone_id
integer <int32>

ID of the zone being signed into. Not mandatory.

zone_other
string <string>

Zone note for this movement. Not mandatory

carpark_question
boolean <boolean>

Can be set as either 1/0 or true/false. Not mandatory.

carpark_registration
string <string>

Vehicle registration. Not mandatory.

carpark_number
string <string>

Carpark number. Not mandatory.

purpose
string <string>

Reason for visit. Not mandatory.

assistance
boolean <boolean>

Whether the member requires assistance. Not mandatory.

expected
integer <int32>

Expected time on-site in minutes. Not mandatory

Responses
200

Updated movement

403

Access denied to this resource

500

Internal server error

put/community/{community_id}/movement
Request samples
application/json
{
  • "onsite_status": "onsite",
  • "location_id": 301,
  • "member_id": 54,
  • "lacp_id": 38,
  • "zone_id": 3443,
  • "zone_other": "string",
  • "carpark_question": true,
  • "carpark_registration": "MRD346",
  • "carpark_number": "0014",
  • "purpose": "Water station repairs",
  • "assistance": true,
  • "expected": 60
}
Response samples
application/json
application/json
application/xml
{
  • "id": 4938,
  • "created": "2021-10-28T12:57:14+13:00",
  • "modified": "2021-11-15T12:57:14+13:00",
  • "location_id": 2538,
  • "community_id": 30142,
  • "member_id": 16348,
  • "signed_in": "2021-10-28T12:57:14+13:00",
  • "signed_out": "2021-10-28T16:57:14+13:00",
  • "mode_in": "Sign In/Out Manager",
  • "mode_out": "Sign In/Out Manager",
  • "zone_id": 32,
  • "zone_other": "office",
  • "signed_in_by": 823493,
  • "signed_out_by": 823493,
  • "carpark_question": true,
  • "carpark_registration": "DRU706",
  • "carpark_number": "SP003",
  • "purpose": "Repairs",
  • "assistance": false,
  • "expected": true,
  • "accessdenied": false,
  • "accessdenied_reason": "trigger",
  • "loneworker": true,
  • "interzone": true,
  • "from_zone": 87,
  • "selected_language": "english",
  • "lacp_in_name": "Reception",
  • "lacp_out_name": "Reception",
  • "zone_group_name": "Maintenance",
  • "photo_url": "your.site/storage/contractorphoto.jpg",
  • "signout_photo_url": "your.site/storage/contractorphoto.jpg"
}

Retrieve a community member movement x

Retrieves a single community member movement, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the community member movement to retrieve

Responses
200
403

Access denied to resource

404

Resource not found

500

Internal server error

get/community/{community_id}/movement/{id}
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/community/{community_id}/movement/:id'
Response samples
application/json
application/json
application/xml
{
  • "id": 4938,
  • "created": "2021-10-28T12:57:14+13:00",
  • "modified": "2021-11-15T12:57:14+13:00",
  • "location_id": 2538,
  • "community_id": 30142,
  • "member_id": 16348,
  • "signed_in": "2021-10-28T12:57:14+13:00",
  • "signed_out": "2021-10-28T16:57:14+13:00",
  • "mode_in": "Sign In/Out Manager",
  • "mode_out": "Sign In/Out Manager",
  • "zone_id": 32,
  • "zone_other": "office",
  • "signed_in_by": 823493,
  • "signed_out_by": 823493,
  • "carpark_question": true,
  • "carpark_registration": "DRU706",
  • "carpark_number": "SP003",
  • "purpose": "Repairs",
  • "assistance": false,
  • "expected": true,
  • "accessdenied": false,
  • "accessdenied_reason": "trigger",
  • "loneworker": true,
  • "interzone": true,
  • "from_zone": 87,
  • "selected_language": "english",
  • "lacp_in_name": "Reception",
  • "lacp_out_name": "Reception",
  • "zone_group_name": "Maintenance",
  • "photo_url": "your.site/storage/contractorphoto.jpg",
  • "signout_photo_url": "your.site/storage/contractorphoto.jpg"
}