eeds API

Conferences

Conferences are central to CE program management. The eeds API exposes several endpoints you can use to interact with your organization's conferences.

The conference model

The conference model contains selected information about a conference and its connections to other resources in eeds.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the conference.

  • Name
    conferenceType
    Type
    string
    Description

    The type of the conference.

  • Name
    name
    Type
    string
    Description

    The name of the conference.

  • Name
    location
    Type
    string
    Description

    The facility/room where the conference typically takes place.

  • Name
    city
    Type
    string
    Description

    The city where the conference typically takes place.

  • Name
    state
    Type
    string
    Description

    The state where the conference typically takes place.

  • Name
    sin
    Type
    string
    Description

    The unique identifer of the conference's sponsor.

  • Name
    activitiesUrl
    Type
    string
    Description

    The URL from which the conference's activities can retrieved.

GET/conferences

List all conferences

This endpoint allows you to retrieve a paginated list of all of the conferences you are authorized to access. By default, a maximum of 20 conferences 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
    type
    Type
    integer
    Description

    Return only conferences with the given conference type ID.

  • Name
    id
    Type
    array of integers
    Description

    Return only conferences with the given IDs.

Request

GET
/conferences
curl -G https://newapi.eeds.com/api/conferences \
  -H "Authorization: Bearer {token}"

Response

{
  "pageSize": 20,
  "currentPage": 1,
  "totalItems": 6679,
  "totalPages": 134,
  "data": [
    {
      "id": "352424",
      "conferenceType": "Recurring Event",
      "name": " Site Based Review 2021 - Charlotte St.",
      "location": "Conference Room",
      "city": "Asheville",
      "state": "NC",
      "sin": "0001110",
      "activitiesUrl": "https://www.eeds.com/api/conferences/352424/activities"
    },
    {
      "id": "787546",
      // ...
    }
  ]
}
GET/conferences/:id

Retrieve a conference

This endpoint allows you to retrieve a conference by providing its ID. Refer to the list at the top of this page to see which properties are included with conference objects.

Request

GET
/conferences/880322
curl -G https://newapi.eeds.com/api/conferences/880322 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "880322",
  "conferenceType": "Recurring Event",
  "name": " Site Based Review 2021 - Charlotte St.",
  "location": "Conference Room",
  "city": "Asheville",
  "state": "NC",
  "sin": "0001110",
  "activitiesUrl": "https://www.eeds.com/api/conferences/880322/activities"
}
GET/conferences/:id/activities

Retrieve a conference's activities

This endpoint allows you to retrieve a list of activities for the specified conference. Refer to the activity model to see which properties are included with activity objects.

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.

Request

GET
/conferences/880322/activities
curl -G https://newapi.eeds.com/api/conferences/880322/activities \
  -H "Authorization: Bearer {token}"

Response

{
  "pageSize": 20,
  "currentPage": 1,
  "totalItems": 7,
  "totalPages": 1,
  "data": [
    {
      "ain": "001201640",
      "date": "2020-05-14T00:00:00",
      "time": "5:45 PM - 6:45 PM",
      "city": "Asheville",
      "state": "NC",
      "room": "Virtual Conference Room",
      "presentations": [
			{
				"id": 469491,
				"title": "Updates in Internal Medicine 2020",
				"speakers": [
					{
						"id": 716348,
						"firstName": "Wesley",
						"lastName": "Gribble",
						"degree": "BS"
					},
          {
            "id": 344353,
            // ...
          }
				]
			},
      {
        "id": 242345,
        // ...
      }
		],
		"conference": {
			"id": "880322",
			"name": "Internal Medicine Grand Rounds",
			"type": "Recurring Event"
		}
	},
	{
		"ain": "001201649",
    // ...
  }
  ]
}
GET/conferences/search

Search conferences

This endpoint allows you to search for conferences by name. In order to provide optimal response times, it returns a paginated list of results containing a limited subset of attributes from the standard conference 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

  • Name
    page
    Type
    integer
    Description

    The page of results to return.

  • 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.

Request

GET
/conferences/search
curl -G https://newapi.eeds.com/api/conferences/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,
      // ...
    }
  ]
}