NEJM Catalyst Portal API

Endpoints

Get Conferences

API Request Example

GET /api/conferences HTTP/1.1
Accept: application/json

API Sucessful Response Example

HTTP/1.1 200 OK
{
  "data": [
    {
      "id": 1,
      "name": "Conference Name #1",
      "start_date": "2019-04-04 08:00:00",
      "end_date": "2019-04-04 17:30:00",
      "timezone": "America/New_York",
      ...
    },
    {
      "id": 2,
      "name": "Conference Name #2",
      "start_date": "2019-05-04 08:00:00",
      "end_date": "2019-05-04 17:30:00",
      "timezone": "America/Los_Angeles",
      ...
    }
  ]
}

Get Conference

GET /api/conferences/<conference_id> HTTP/1.1

API Request Example

GET /api/conferences/1 HTTP/1.1
Accept: application/json

API Sucessful Response Example

HTTP/1.1 200 OK
{
  "data": {
    "id": 1,
    "name": "Conference Name #1",
    "start_date": "2019-04-04 08:00:00",
    "end_date": "2019-04-04 17:30:00",
    "timezone": "America/New_York",
    ...
  }
}

API Error Response Example - Missing or Invalid Conference

HTTP/1.1 200 OK
{
    "error": "Data not found."
}

Register User for Conference

POST /api/conferences/<conference_id>/users HTTP/1.1

API Request Example

POST /api/conferences/1/users HTTP/1.1
Content-Type: application/json
Accept: application/json

{
  "email": "bill.smith@company.com"
}

email is the only field accepted in this API, and is required.

The email being registered must be an existing user in the system. If the user does not yet exist, first register them using the Create User API.

API Error Response Example - Missing or Invalid Conference

HTTP/1.1 200 OK
{
    "error": "Data not found."
}

API Error Response Example - Missing or Invalid Email

HTTP/1.1 422 Unprocessable Entity
{
    "message": "The given data was invalid.",
    "errors": {
        "email": ["The selected email is invalid."]
    }
}

Fields

These are the fileds that can be supplied when creating or updating a conference. Additionally, these fields can be used to filter, sort or return specfic fields from the Get Conference API and Get Conferences API.

Field Type Notes
name String Required for conference creation
description String
photo1 Image
photo2 Image
state String (hidden, upcoming, live, archive) Required for conference creation
timezone[1] String (Timezone Format) Required for conference creation
start_date String (yyyy-mm-dd HH:MM:SS) Required for conference creation
end_date String (yyyy-mm-dd HH:MM:SS) Required for conference creation
event_url[2] String (URL) Read Only
URL to dedicated event landing page.
register_url String (URL) Read Only
Note: Temporary placeholder for event registration URL. This may change in the future.

Subresources

These sub-resources can (optionally) be returned when requesting conference resources.

  • presentations
  • presenters
  • sponsors
  • hosts

Footnotes

  1. Timezones - Currently supported timezones include America/New_York, America/Chicago, America/Denver, America/Phoenix, America/Los_Angeles, America/Anchorage, America/Adak, Pacific/Honolulu. Additional timezones can be added upon request. ↩︎

  2. Event URL - The event_url is based on a slugified version of the conference name. Changing the conference name will cause the event_url to be updated as well. ↩︎

← Users API →