CommunityMembers

List of all community members

Returns a list of all community members

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 a greater/less than separator searches number/date ranges.

Request
query Parameters
q
string <string>

Filter by any community member value,

Example: q=year:3
Responses
200

List of community members

403

Access denied to resource

404

Resource not found

500

Internal server error

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

Create a community member

Creates a new community member.

Request
Request Body schema: application/json

Information to use when creating a new community member record.

location_id
integer <int32>
community_id
integer <int32>
external_id
string <string>
name
string <string>
year
integer <int32>
title
string <string>
email
string <string>
mobile
string <string>
Responses
201

Community created

403

Access denied to this resource

500

Internal server error

post/community/{community_id}/member
Request samples
application/json
{
  • "location_id": 35,
  • "community_id": 77,
  • "external_id": "C123456789",
  • "name": "John Doe",
  • "year": 12,
  • "title": "Mr",
  • "email": "example@example.org",
  • "mobile": "0212345566"
}
Response samples
application/json
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "external_id": "C123456789",
  • "location_id": 35,
  • "community_id": 77,
  • "name": "John Doe",
  • "year": 12,
  • "title": "Mr",
  • "email": "example@example.org",
  • "mobile": "0212345566"
}

Retrieve a community member

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

Request
path Parameters
id
required
integer <int32>

ID of the community member to retrieve

Responses
200
403

Access denied to resource

404

Resource not found

500

Internal server error

get/community/{community_id}/member/{id}
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/community/{community_id}/member/:id'
Response samples
application/json
application/json
application/xml
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "external_id": "C123456789",
  • "location_id": 35,
  • "community_id": 77,
  • "name": "John Doe",
  • "year": 12,
  • "title": "Mr",
  • "email": "example@example.org",
  • "mobile": "0212345566"
}

Update a community member

Updates the details of a community member.

Request
path Parameters
id
required
integer <int32>

ID of the community member to update

Request Body schema: application/json

Information used to create the community member record

name
string <string>
external_id
string <string>
year
integer <int32>
title
string <string>
email
string <string>
mobile
string <string>
Responses
200

Updated resource

403

Access denied to this resource

500

Internal server error

put/community/{community_id}/member/{id}
Request samples
application/json
{
  • "name": "Harry Dresden",
  • "external_id": "C123456789",
  • "year": 12,
  • "title": "Mr",
  • "email": "emailaddress@mailinator.com",
  • "mobile": "0212345566"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "external_id": "C123456789",
  • "location_id": 35,
  • "community_id": 77,
  • "name": "John Doe",
  • "year": 12,
  • "title": "Mr",
  • "email": "example@example.org",
  • "mobile": "0212345566"
}

Delete a community member

Deletes a community member using the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the community member to delete

Responses
204

Community member deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

delete/community/{community_id}/member/{id}
Request samples
curl -i -X DELETE \
  'https://api.whosonlocation.com/v1/community/{community_id}/member/:id'