Activities
Activities are are how participants earn CME credit. In eeds, activities belong to conferences. The eeds API exposes endpoints to list, retrieve, and search activities.
The activity model
The activity model contains selected information about an activity.
Properties
- Name
ain- Type
- string
- Description
The activity identification number serves as the unique identifier for the activity.
- Name
city- Type
- string
- Description
The city where the activity takes place.
- Name
conference- Type
- dictionary
- Description
The conference with which the activity is associated.
- Name
credits- Type
- array
- Description
The types and amounts of credits offered by the activity.
- Name
date- Type
- string
- Description
The date of the activity.
- Name
startDate- Type
- string
- Description
The date on which the activity starts.
- Name
endDate- Type
- string
- Description
The date on which the activity ends.
- Name
presentations- Type
- array
- Description
The presentations associated with the activity.
- Name
registrationUrl- Type
- string
- Description
The URL where learners may register to attend the activity.
- Name
room- Type
- string
- Description
The facility/room where the activity takes place.
- Name
state- Type
- string
- Description
The state where the activity takes place.
- Name
time- Type
- string
- Description
The time at which the activity is scheduled to take place.
List all activities
This endpoint allows you to retrieve a paginated list of all of the activities you are authorized to access. By default, a maximum of 20 activities are shown per page.
Optional query parameters
- Name
page- Type
- integer
- Description
The page of results to return.
- Name
perPage- Type
- integer
- Description
The number of results to return per page.
- Name
from- Type
- string
- Description
Return activities on or after this ISO 8601 timestamp.
- Name
to- Type
- string
- Description
Return activities on or before this ISO 8601 timestamp.
- Name
creditTypeId- Type
- array of integers
- Description
Only return activities with the given credit type IDs.
- Name
hasAttendance- Type
- boolean
- Description
If true, only return activities with at least one attendee. If false, only return activities with no attendees.
Request
curl -G https://newapi.eeds.com/api/activities \
-H "Authorization: Bearer {token}"
Response
{
"pageSize": 20,
"currentPage": 1,
"totalItems": 6679,
"totalPages": 134,
"data": [
{
"ain": "001211413",
"city": "Asheville",
"conference": {
"id": "488771",
"name": "Family Medicine Grand Rounds",
"type": "Recurring Event"
},
"credits": [
{
"creditTypeId": 1,
"type": "AMA PRA Category 1 Credit",
"amount": 1,
"unit": "Credit(s)"
}
// ...
],
"date": "2023-03-08T00:00:00",
"startDate": "2023-03-08T12:00:00",
"endDate": "2023-03-08T13:00:00",
"presentations": [
{
"id": 544706,
"title": "Outpatient Treatment of Benzodiazepine Use Disorder",
"speakers": [
{
"id": 843971,
"firstName": "J. Paul",
"lastName": "Martin",
"degree": "MD"
},
// ...
]
},
{
"id": 544706,
// ...
},
],
"room": "Memorial Conference 101",
"state": "NC",
"time": "9:00 AM - 9:45 AM",
"registrationUrl": "https://www.eeds.com/portal_recurring_event.aspx?AIN=001211413&SIN=000000"
},
{
"ain": "001211967",
// ...
}
]
}
Retrieve an activity
This endpoint allows you to retrieve an activity by providing its AIN. Refer to the list at the top of this page to see which properties are included with activity objects.
Request
curl -G https://newapi.eeds.com/api/activities/001211413 \
-H "Authorization: Bearer {token}"
Response
{
"ain": "001211413",
"city": "Asheville",
"conference": {
"id": "488771",
"name": "Family Medicine Grand Rounds",
"type": "Recurring Event"
},
"credits": [
{
"creditTypeId": 1,
"type": "AMA PRA Category 1 Credit",
"amount": 1,
"unit": "Credit(s)"
}
// ...
],
"date": "2023-03-08T00:00:00",
"startDate": "2023-03-08T12:00:00",
"endDate": "2023-03-08T13:00:00",
"presentations": [
{
"id": 544706,
"title": "Outpatient Treatment of Benzodiazepine Use Disorder",
"speakers": [
{
"id": 843971,
"firstName": "J. Paul",
"lastName": "Martin",
"degree": "MD"
},
// ...
]
},
{
"id": 544706,
// ...
},
],
"room": "Memorial Conference 101",
"state": "NC",
"time": "9:00 AM - 9:45 AM",
"registrationUrl": "https://www.eeds.com/portal_recurring_event.aspx?AIN=001211413&SIN=000000"
}
Retrieve an activity's attendees
This endpoint allows you to retrieve a list of participants for the specified activity. Refer to the participant model to see which properties are included with participant objects.
Request
curl -G https://newapi.eeds.com/api/activities/001211413/attendees \
-H "Authorization: Bearer {token}"
Response
[
{
"pin": "99001200",
"firstName": "Lewis",
"lastName": "Alberstone",
"degree": "MD",
"specialty": "Addictionology",
"address": "6543 West Henderson Road",
"city": "Asheville",
"state": "NC",
"postalCode": "28801",
"credits": [
{
"creditTypeId": 1,
"creditName": "<i>AMA PRA Category 1 Credit™</i>",
"creditEarned": 6.5
},
{
"creditTypeId": 12,
"creditName": "Attendance w/ No Credit",
"creditEarned": 6.5
}
],
},
{
"pin": "01000001",
// ...
}
]
Search activities
This endpoint allows you to search for activities by their presentations. In order to provide optimal response times, it returns a paginated list of results containing a limited subset of attributes from the standard activity object. Unlike paginated responses for non-searchable endpoints, the number of results is not configurable and a maximum of 50 results will be returned per request.
Required query parameters
- Name
query- Type
- string
- Description
The search query string.
Optional query parameters
Request
curl -G https://newapi.eeds.com/api/activities/search \
-H "Authorization: Bearer {token}" \
--data-urlencode query="grand rounds"
Response
{
"pageSize": 50,
"currentPage": 1,
"totalItems": 321,
"totalPages": 7,
"data": [
{
"id": "432324",
"name": "Pediatric Grand Rounds",
"city": "El Paso",
"state": "TX"
},
{
"id": 463524
// ...
}
]
}