Filtering Participants

This step shows how to filter participants via PerculusAPI

There are two ways to filter participants:

• With ATTENDANCE_CODE

• With EMAIL

• With Participant Details

Available parameters:

Parameter	Type	Description
user_id	string
attendance_code	string
name	string
surname	string
email	string
role	string	'u' for Users, 'e' for Instructors and 'a' for Admins
mobile	string
page_size	integer
page_number	integer

Filtering with ATTENDANCE_CODE

You need the SESSION_ID of the session and the ATTENDANCE_CODE, which is the participant ID of the user, to get the participant details for a session.

Example Payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<ATTENDANCE_CODE>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get the attandee by ATTENDANCE_CODE
attendee = client.attendees.get_by_attendance_code(
    session_id="<SESSION_ID>",
    attendance_code="<ATTENDANCE_CODE>"
)
print(attendee)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get Attendee
const attendee = client.attendees.getAttendee(
    "<SESSION_ID>", "<ATTENDANCE_CODE>" 
)
console.log(attendee)

GO

// ASAP :)

Filtering with EMAIL

You need the SESSION_ID of the session and the EMAIL, which is the email of the user, to update the participant in a session.

Example Payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get the attandee by EMAIL
attendee = client.attendees.get_by_email(
    session_id="<SESSION_ID>",
    email="<EMAIL>"
)
print(attendee)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get Attendee
const attendee = client.attendees.getAttendee(
    "<SESSION_ID>", "<EMAIL>" 
)
console.log(attendee)

GO

// ASAP :)

Filtering with Participant Details

Example payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: x-www-form-urlencoded' \
--data-urlencode 'name=john' \
--data-urlencode 'surname=doe'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Filter Attendees
attendees = client.attendees.search_attendees(
    session_id="<SESSION_ID>",
    params={
        "name": "<NAME>",
        "role": "<ROLE>"
    }
)
print(attendees)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get Attendees
const attendees = client.attendees.searchAttendees("<SESSION_ID>",
    {
        name: "<NAME>",
        role: "<ROLE>"
    }
)
console.log(attendees)

GO

// ASAP :)