NAV Navbar
Logo cerner
Ruby Shell

Consumer Engagement API v1

The Consumer Engagement service provides a way to directly interact with your consumers to encourage them to be involved and invested in their health journeys. This service allows you to inform and update consumers, coordinate events, and provide interactive educational content.

URL: https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1

Event

An event is an activity that is intended to support the discovery and development of healthy habits. The event resources can be used to create and manage single session and multisession events to engage consumers.

Create an Event Location

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations', headers: headers, body: {"name":"Innovations Healthe Clinic","description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Innovations Healthe Clinic","description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"}}

POST /event-locations

Creates a new event location where an event can be held. The event location represents a physical or virtual address.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventLocations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Location
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Locations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "cea6f1d9-f986-4695-be33-0c2034579323",
      "name": "Innovations Healthe Clinic",
      "description": "Clinic located in the North tower lobby of the Cerner Innovations Campus.",
      "address": {
        "lines": [
          "8779 Hillcrest Road",
          "Innovations Campus"
        ],
        "city": "Kansas City",
        "district": "Jackson County",
        "state": "MO",
        "country": "US",
        "postalCode": "64138"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations?offset=0&limit=20"
}

GET /event-locations

Retrieves all of the event locations where an event can be held.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Locations
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event Location

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations/c2dfa405-6f11-47ea-b0f1-27c1478bfcdb', headers: headers, body: {"name":"Innovations Healthe Clinic","description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations/c2dfa405-6f11-47ea-b0f1-27c1478bfcdb \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Innovations Healthe Clinic","description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"}}

PUT /event-locations/{locationId}

Updates the information for an event location.

Parameters

Parameter In Type Required Default Description Accepted Values
locationId path string true N/A The ID of the location. -
body body putEventLocations true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Location

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations/c2dfa405-6f11-47ea-b0f1-27c1478bfcdb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-locations/c2dfa405-6f11-47ea-b0f1-27c1478bfcdb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-locations/{locationId}

Retrieves an event location by its ID. This is used to retrieve information for a single event location.

Parameters

Parameter In Type Required Default Description Accepted Values
locationId path string true N/A The ID of the location. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Location
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories', headers: headers, body: {"name":"Preventive Health","code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"}}

POST /event-categories

Creates a new event category that classifies events. The event category groups events based on the event’s classification.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Category
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Categories

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "da4cac69-462d-4e3e-8870-a39fad628354",
      "name": "Preventive Health",
      "code": {
        "code": "310422005",
        "display": "Prevention/screening",
        "system": "2.16.840.1.113883.6.96"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories?offset=0&limit=20"
}

GET /event-categories

Retrieves all of the event categories that can classify an event.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Categories
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories/0987babb-4c50-4134-b1d4-9586a8181b2b', headers: headers, body: {"name":"Preventive Health","code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories/0987babb-4c50-4134-b1d4-9586a8181b2b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"}}

PUT /event-categories/{categoryId}

Updates the information for an event category.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -
body body putEventCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories/0987babb-4c50-4134-b1d4-9586a8181b2b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-categories/0987babb-4c50-4134-b1d4-9586a8181b2b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-categories/{categoryId}

Retrieves an event category by its ID. This is used to retrieve information for a single event category.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Category
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs', headers: headers, body: {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}

POST /event-catalogs

Creates a new event catalog that can group events and event series. Events and event series can be included in event catalogs to group the events and event series. To remove an event or event series from an event catalog, the event or event series must be updated to remove the event catalog reference.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Catalog
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Catalogs

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991",
      "name": "2019 Incentivized Events Catalog",
      "description": "Catalog to group incentivized events in 2019."
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs?offset=0&limit=20"
}

GET /event-catalogs

Retrieves all of the event catalogs that can group events and event series.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Catalogs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs/5a6d8aef-5f34-4621-95be-e47193510da8', headers: headers, body: {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs/5a6d8aef-5f34-4621-95be-e47193510da8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}

PUT /event-catalogs/{catalogId}

Updates the information for an event catalog.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the catalog. -
body body putEventCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve an Event Catalog

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs/5a6d8aef-5f34-4621-95be-e47193510da8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-catalogs/5a6d8aef-5f34-4621-95be-e47193510da8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-catalogs/{catalogId}

Retrieves an event catalog by its ID. This is used to retrieve information for a single event catalog.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the catalog. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Catalog
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events', headers: headers, body: {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}

POST /events

Creates a new event, which allows consumers to view information about the event. For a consumer to register for the event, an event slot must be created.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEvents true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Event
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Events

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8",
      "name": "Stress Management Seminar 2019",
      "description": "This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.",
      "leader": {
        "name": "Dr. Jane Elizabeth Smith",
        "telecoms": [
          {
            "system": "EMAIL",
            "value": "jane.smith@rockhurst.edu"
          }
        ]
      },
      "registrationStatus": "OPEN",
      "startsAt": "2019-01-15T08:00:00",
      "endsAt": "2019-10-15T16:00:00",
      "timeZone": "America/New_York",
      "multislot": true,
      "location": {
        "id": "cea6f1d9-f986-4695-be33-0c2034579323",
        "name": "Innovations Healthe Clinic",
        "description": "Clinic located in the North tower lobby of the Cerner Innovations Campus.",
        "address": {
          "lines": [
            "8779 Hillcrest Road",
            "Innovations Campus"
          ],
          "city": "Kansas City",
          "district": "Jackson County",
          "state": "MO",
          "country": "US",
          "postalCode": "64138"
        }
      },
      "category": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "name": "Preventive Health",
        "code": {
          "code": "310422005",
          "display": "Prevention/screening",
          "system": "2.16.840.1.113883.6.96"
        }
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ],
      "series": {
        "id": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20"
}

GET /events

Retrieves all of the events that meet the specified parameters. This can be used to display available events to consumers. The retrieved events include the location and category information.

Parameters

Parameter In Type Required Default Description Accepted Values
from query string false N/A Filters the retrieved events to only those with at least one slot whose start time is on or after the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
to query string false N/A Filters the retrieved events to only those with at least one slot whose end time is on or before the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
categoryId query string false N/A Filters by the ID of the category. -
locationId query string false N/A Filters by the ID of the location. -
registrationStatus query string false N/A Filters by the registration status of the event. -
catalogId query array[string] false N/A Filters by the ID of the catalog. -
seriesId query array[string] false N/A Filters by the ID or IDs of one or many series. -
partOfSeries query boolean false N/A Filters the retrieved events to only those that are part of a series. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Events
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/f34701e0-d94a-421b-b62c-c29df9e7337e', headers: headers, body: {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/f34701e0-d94a-421b-b62c-c29df9e7337e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}

PUT /events/{eventId}

Updates information for an event as well as any series, catalog, location, and category associations. Any slots associated with the event are not affected by this update.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -
body body putEvents true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/f34701e0-d94a-421b-b62c-c29df9e7337e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/f34701e0-d94a-421b-b62c-c29df9e7337e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /events/{eventId}

Retrieves a single event by its ID. This can be used to get information for a single event. This request retrieves only information about the Event resource. Location and category information is not included.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Event
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Slot

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots', headers: headers, body: {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York"}

POST /events/{eventId}/slots

Creates a new event slot for an event. An event slot provides the period of time when the event is hosted as well as registration information.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -
body body postEventsEventidSlots true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Slot
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Event Slots

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "86bf670f-36bb-4b6a-b597-2c811353b4c6",
      "description": "The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.",
      "maxRegistrations": 100,
      "availableRegistrations": 100,
      "startsAt": "2019-09-15T08:00:00",
      "endsAt": "2019-09-15T16:00:00",
      "registrationEndsAt": "2019-09-14T08:00:00",
      "timeZone": "America/New_York"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots?offset=0&limit=20"
}

GET /events/{eventId}/slots

Retrieves all of the event slots for the specified event ID. This can be used to display the event slots to a consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Slots
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event Slot

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots/66b06c89-0761-4782-aaf4-17b49c29029d', headers: headers, body: {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots/66b06c89-0761-4782-aaf4-17b49c29029d \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York"}

PUT /events/{eventId}/slots/{slotId}

Updates the information for an event slot. The event that the event slot belongs to is not affected by this update.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -
slotId path string true N/A The ID of the event slot. -
body body putEventsEventidSlots true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Slot

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots/66b06c89-0761-4782-aaf4-17b49c29029d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/events/9f715f2f-8d16-47fc-9afc-de561016f14b/slots/66b06c89-0761-4782-aaf4-17b49c29029d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /events/{eventId}/slots/{slotId}

Retrieves a single event slot by its event and slot IDs. This can be used to retrieve information for a single event slot.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path string true N/A The ID of the event. -
slotId path string true N/A The ID of the event slot. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Slot
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Series

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series', headers: headers, body: {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

POST /event-series

Creates a new event series, which groups events. An event series is used to link related events so they can be interacted with together.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventSeries true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Series
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Series

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "86bf670f-36bb-4b6a-b597-2c811353b4c6",
      "name": "Screenings 2019",
      "description": "Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.",
      "registrationStatus": "OPEN",
      "leader": {
        "name": "Dr. Jane Elizabeth Smith",
        "telecoms": [
          {
            "system": "EMAIL",
            "value": "jane.smith@rockhurst.edu"
          }
        ]
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series?offset=0&limit=20"
}

GET /event-series

Retrieves all of the event series that meet the specified parameters. This can be used to display available event series to consumers.

Parameters

Parameter In Type Required Default Description Accepted Values
from query string false N/A Filters the retrieved series to only those with all events with at least one slot that starts on or after the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. If any event in the series starts after this date and time, the series is retrieved. -
to query string false N/A Filters the retrieved series to only those with all events with at least one slot that ends on or before the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. If any event in the series ends before this date and time, the series is retrieved. -
categoryId query string false N/A Filters by the ID of the category. If any event in the series is in this category, the series is retrieved. -
locationId query string false N/A Filters by the ID of the location. If any event in the series occurs at this location, the series is retrieved. -
registrationStatus query string false N/A Filters by the registration status of the series. -
catalogId query array[string] false N/A Filters by the ID of the catalog. If any event in the series is in this catalog, the series is retrieved. -
eventId query string false N/A Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Series
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Event Series

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series/f9f34ccf-4ce7-488c-b619-7b446928bc1e', headers: headers, body: {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series/f9f34ccf-4ce7-488c-b619-7b446928bc1e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

PUT /event-series/{seriesId}

Updates the information for an event series. Any events that are included in this event series are not affected by this update.

Parameters

Parameter In Type Required Default Description Accepted Values
seriesId path string true N/A The ID of the event series. -
body body putEventSeries true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Series

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series/f9f34ccf-4ce7-488c-b619-7b446928bc1e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-series/f9f34ccf-4ce7-488c-b619-7b446928bc1e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-series/{seriesId}

Retrieves an event series by its ID. This can be used to retrieve information for a single event series.

Parameters

Parameter In Type Required Default Description Accepted Values
seriesId path string true N/A The ID of the event series. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Series
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Registration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations', headers: headers, body: {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}

POST /event-registrations

Creates a new event registration, which reserves an event slot for a consumer. This can be used to plan for who is attending an event. When the event slot is full or the slot’s registration period is expired, an error is sent. If the associated event or event slot is updated, the event registration is retained.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventRegistrations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Registration
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Registrations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "86bf670f-36bb-4b6a-b597-2c811353b4c6",
      "consumer": {
        "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
      },
      "slot": {
        "id": "1914d1c6-43ca-4925-acd2-9183b3841312",
        "event": {
          "id": "35eb9e2d-0bb4-4e30-8245-fd07525da9fe",
          "seriesId": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations?offset=0&limit=20"
}

GET /event-registrations

Retrieves all of the event registrations that meet the specified parameters. This can be used to display event registrations to a consumer or to plan for an event.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId query string false N/A Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved. -
seriesId query string false N/A Filters by the ID of a series. -
slotId query string false N/A Filters by the ID of the event slot. -
consumerId query string false N/A Filters by the ID of the consumer. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Registrations
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete an Event Registration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations/0c124a21-a06b-4ebd-95f1-3d9d4246d749', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations/0c124a21-a06b-4ebd-95f1-3d9d4246d749 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-registrations/{registrationId}

Deletes an event registration, which unregisters the consumer from the event slot.

Parameters

Parameter In Type Required Default Description Accepted Values
registrationId path string true N/A The ID of the event registration. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Registration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations/0c124a21-a06b-4ebd-95f1-3d9d4246d749', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-registrations/0c124a21-a06b-4ebd-95f1-3d9d4246d749 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-registrations/{registrationId}

Retrieves a single event registration by its ID. This can be used to retrieve information for a single event registration.

Parameters

Parameter In Type Required Default Description Accepted Values
registrationId path string true N/A The ID of the event registration. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Registration
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Event Attendance

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances', headers: headers, body: {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}

POST /event-attendances

Creates a new event attendance, which records that the consumer attended the event. An event registration is not required to create an event attendance.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEventAttendances true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. Attendance
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Event Attendances

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "86bf670f-36bb-4b6a-b597-2c811353b4c6",
      "consumer": {
        "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
      },
      "slot": {
        "id": "1914d1c6-43ca-4925-acd2-9183b3841312",
        "event": {
          "id": "35eb9e2d-0bb4-4e30-8245-fd07525da9fe",
          "seriesId": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances?offset=0&limit=20"
}

GET /event-attendances

Retrieves all of the event attendances for an event that meet the specified parameters. This can be used to display event attendances for a consumer or to log who attended an event.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId query string false N/A Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved. -
seriesId query string false N/A Filters by the ID of a series. -
slotId query string false N/A Filters by the ID of the event slot. -
consumerId query string false N/A Filters by the ID of the consumer. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Attendances
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete an Event Attendance

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances/4b51a7b3-0f72-4e6f-b187-31d723c541c7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances/4b51a7b3-0f72-4e6f-b187-31d723c541c7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-attendances/{attendanceId}

Deletes an event attendance, which indicates that the consumer did not attend the event.

Parameters

Parameter In Type Required Default Description Accepted Values
attendanceId path string true N/A The ID of the event attendance. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Attendance

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances/4b51a7b3-0f72-4e6f-b187-31d723c541c7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/event-attendances/4b51a7b3-0f72-4e6f-b187-31d723c541c7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-attendances/{attendanceId}

Retrieves a single event attendance by its ID. This is used to retrieve information for a single event attendance.

Parameters

Parameter In Type Required Default Description Accepted Values
attendanceId path string true N/A The ID of the event attendance. -

Response Statuses

Status Meaning Description Schema
200 OK Success. Attendance
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Learning Module

A learning module is an organized collection of educational content.

Create a Learning Module

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules', headers: headers, body: {"definitionId":"77a233a3-54d4-4ad3-9e63-53bb71762290","status":"PUBLISHED","imageUrl":"https://heathwise.edu/1.jpg","title":[{"text":"Diabetes Prevention","locale":"en-US"}],"description":[{"text":"Diabetes prevention","locale":"en-US"}],"keywords":[{"text":["prevent","diabetes"],"locale":"en-US"}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"definitionId":"77a233a3-54d4-4ad3-9e63-53bb71762290","status":"PUBLISHED","imageUrl":"https://heathwise.edu/1.jpg","title":[{"text":"Diabetes Prevention","locale":"en-US"}],"description":[{"text":"Diabetes prevention","locale":"en-US"}],"keywords":[{"text":["prevent","diabetes"],"locale":"en-US"}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "definitionId": "77a233a3-54d4-4ad3-9e63-53bb71762290",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "status": "PUBLISHED",
  "thumbnailUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "prevent",
        "diabetes"
      ]
    }
  ],
  "categories": [
    "0276ea55-a3cc-4b0a-88dc-284629d"
  ],
  "catalogs": [
    {
      "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /learning-modules

Creates a learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postLearningModules true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created The learning module was created. Module
400 Bad Request Bad Request. The learning module was not created. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others:
- noDefaultLocale The default locale (en-US) is required for the title.
- duplicateLocale The locale for the provided titles and descriptions must be unique.
- missingTitle Title is required. Specify a title for the locale and description to continue.
- catgoryNotFound The category was not found.
BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Learning Modules

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "description": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "status": "PUBLISHED",
      "imageUrl": "https://heathwise.edu/1.jpg",
      "keywords": [
        {
          "locale": "en-US",
          "text": [
            "prevent",
            "diabetes"
          ]
        }
      ],
      "categories": [
        "0276ea55-a3cc-4b0a-88dc-284629d"
      ],
      "catalogs": [
        {
          "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
        }
      ],
      "consumerGroups": [
        {
          "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
        }
      ],
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules?offset=0&limit=20"
}

GET /learning-modules

Retrieves a list of learning modules.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters modules by module IDs. -
categoryIds query array[string] false N/A Filters modules by category IDs. -
keywords query array[string] false N/A Filters modules by keywords. -
searchTerms query string false N/A Filters the retrieved modules to those that contain specific text. Partial matching is supported. -
status query array[string] false N/A Filters modules by status. -
catalogId query array[string] false N/A Filters modules by catalog ID. -
consumerGroupId query array[string] false N/A Filters modules by consumer group ID. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
locale query string false en-US Filters modules by locale. -
orderBy query string false updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, createdAt, -createdAt, status, -status

Response Statuses

Status Meaning Description Schema
200 OK OK TranslatedModules
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Learning Module

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-modules/{moduleId}

Deletes a single learning module by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -

Response Statuses

Status Meaning Description Schema
204 No Content The module was deleted. None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Learning Module

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"imageUrl":"https://heathwise.edu/1.jpg","status":"PUBLISHED","title":[{"text":"Diabetes prevention","locale":"en-US"}],"description":[{"text":"Diabetes prevention","locale":"en-US"}],"keywords":[{"text":["Diabetes","prevention"],"locale":"en-US"}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d","0276ea55-a3cc-4b0a-88dc-28462qq"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"imageUrl":"https://heathwise.edu/1.jpg","status":"PUBLISHED","title":[{"text":"Diabetes prevention","locale":"en-US"}],"description":[{"text":"Diabetes prevention","locale":"en-US"}],"keywords":[{"text":["Diabetes","prevention"],"locale":"en-US"}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d","0276ea55-a3cc-4b0a-88dc-28462qq"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d"}]}

PATCH /learning-modules/{moduleId}

Updates a learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -
body body patchLearningModules true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content The module was updated. None
400 Bad Request Bad Request. The education content was not updated. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others:
- noDefaultLocale The default locale (en-US) is required for the title if it is used in the body.
- duplicateLocale The locales for the titles and descriptions must be unique.
- categoryNotFound The category was not found.
BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict Error

Retrieve a Single Module

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "definitionId": "77a233a3-54d4-4ad3-9e63-53bb71762290",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "status": "PUBLISHED",
  "thumbnailUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "prevent",
        "diabetes"
      ]
    }
  ],
  "categories": [
    "0276ea55-a3cc-4b0a-88dc-284629d"
  ],
  "catalogs": [
    {
      "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /learning-modules/{moduleId}

Retrieves a single module by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -

Response Statuses

Status Meaning Description Schema
200 OK OK Module
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Task

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "moduleReference": "11e8902c9e2908c69718f13503066bee",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "sourceReference": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
    "kind": "education#content"
  },
  "order": "4",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /learning-modules/{moduleId}/tasks

Creates a task in the learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -
body body postLearningModulesModuleidTasks true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created The learning module task was created. Task
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Tasks for a Learning Module

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "moduleReference": "11e8902c9e2908c69718f13503066bee",
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "sourceReference": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
        "kind": "education#content"
      },
      "order": "4",
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/db5f4eec-0e29-40b4-b051-707ad8a30b1d/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/db5f4eec-0e29-40b4-b051-707ad8a30b1d/tasks?offset=0&limit=20"
}

GET /learning-modules/{moduleId}/tasks

Retrieves a list of tasks for a learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -
sourceSystemId query string false N/A The source ID in an external system, for example, the education library. -
sourceSystemKind query string false N/A The source type in an external system, for example, the education library. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
locale query string false en-US Filters modules by locale. -
orderBy query string false updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK OK Tasks
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Task

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-modules/{moduleId}/tasks/{taskId}

Deletes a single task in a learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -
taskId path string true N/A The ID of the module task. -

Response Statuses

Status Meaning Description Schema
204 No Content The task was deleted. None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Task

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /learning-modules/{moduleId}/tasks/{taskId}

Updates a single task in a learning module.

Parameters

Parameter In Type Required Default Description Accepted Values
moduleId path string true N/A The module ID. -
taskId path string true N/A The ID of the module task. -
body body patchLearningModulesModuleidTasks true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content The task was updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict Error

Add a Consumer to a Module

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
  "consumerReference": {
    "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
  },
  "moduleReference": {
    "id": "d4454f2a-665c-49d4-87db-8c167feae17d"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /learning-module-enrollments

Creates a wellness learning module enrollment, which enrolls the consumer in the module.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postLearningModuleEnrollments true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created The learning enrollment was created. Enrollment
400 Bad Request Bad Request. The learning module was not created due to issues with the request. The request should be reattempted. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others:
- consumerAlreadyEnrolled The person is already enrolled in the learning module.
- invalidField A field is incorrect in some way, for example, the data type is incorrect.
- missingField Review and complete all required information to continue.
BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Enrolled Wellness Learning Modules

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
      "consumerReference": {
        "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
      },
      "moduleReference": {
        "id": "d4454f2a-665c-49d4-87db-8c167feae17d"
      },
      "status": "notStarted",
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments?offset=0&limit=20"
}

GET /learning-module-enrollments

Retrieves a list of the modules in which a consumer is enrolled.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerReferenceId query string false N/A Filters enrollments by consumer ID. -
moduleReferenceId query string false N/A Filters enrollments by learning module ID. -
status query array[string] false N/A Filters enrollments by status. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK OK Enrollments
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Remove a Consumer from a Module

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-module-enrollments/{enrollmentId}

Deletes a learning module enrollment, which unenrolls a consumer from a module.

Parameters

Parameter In Type Required Default Description Accepted Values
enrollmentId path string true N/A The enrollment ID. -

Response Statuses

Status Meaning Description Schema
204 No Content The enrollment was deleted. None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Wellness Learning Module Enrollment

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
  "consumerReference": {
    "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
  },
  "moduleReference": {
    "id": "d4454f2a-665c-49d4-87db-8c167feae17d"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /learning-module-enrollments/{enrollmentId}

Retrieves a single wellness learning module enrollment by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
enrollmentId path string true N/A The enrollment ID. -

Response Statuses

Status Meaning Description Schema
200 OK OK Enrollment
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Tasks

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "f35241f0-968d-46bb-8ee0-f59818892c61",
      "moduleTaskReference": {
        "id": "d4454f2a-665c-49d4-87db-8c167feae17d"
      },
      "status": "NOT_STARTED",
      "order": "4",
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/11e8902c9e2908c69718/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/11e8902c9e2908c69718/tasks?offset=0&limit=20"
}

GET /learning-module-enrollments/{enrollmentId}/tasks

Retrieves a list of tasks for a specific module in which a consumer is enrolled.

Parameters

Parameter In Type Required Default Description Accepted Values
enrollmentId path string true N/A The enrollment ID. -
status query string false N/A Filters enrollments by status. NOT_STARTED, COMPLETED
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, order, module_task_id, status

Response Statuses

Status Meaning Description Schema
200 OK OK EnrollmentTasks
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Task Status

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks/d96a3cd2-01c1-4abf-aa1b-9be4605bfaed', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks/d96a3cd2-01c1-4abf-aa1b-9be4605bfaed \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /learning-module-enrollments/{enrollmentId}/tasks/{enrollmentTaskId}

Updates the status of a task in a learning module in which a consumer is enrolled.

Parameters

Parameter In Type Required Default Description Accepted Values
enrollmentId path string true N/A The enrollment ID. -
enrollmentTaskId path string true N/A The enrollment ID of the learning module task. -
body body patchLearningModuleEnrollmentsEnrollmentidTasks true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request. The resource cannot be updated due to issues with the request. The request should be reattempted. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others:
- statusEnrollmentIssue The learning module is already in the specified status.
- invalidField A field is incorrect in some way, for example, the data type is incorrect.
BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict Error

Create a Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories', headers: headers, body: {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /learning-module-categories

Creates a category.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postLearningModuleCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created The category was created. LearningModuleCategory
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Categories

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories?offset=0&limit=20"
}

GET /learning-module-categories

Retrieves a list of categories.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK OK LearningModuleCategories
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}

PATCH /learning-module-categories/{categoryId}

Updates a category.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -
body body patchLearningModuleCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content The category was updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict Error

Delete a Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-module-categories/{categoryId}

Deletes a single category.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -

Response Statuses

Status Meaning Description Schema
204 No Content The category was deleted. None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /learning-module-categories/{categoryId}

Retrieves a single category by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -
locale query string false en-US Filters modules by locale. -

Response Statuses

Status Meaning Description Schema
200 OK OK LearningModuleCategory
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Learning Module Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs', headers: headers, body: {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}

POST /learning-module-catalogs

Creates a new learning module catalog. Learning modules can be included in learning module catalogs to group the learning modules. To remove a learning module from a learning module catalog, the learning module must be updated to remove the learning module catalog reference.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postLearningModuleCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. LearningModuleCatalog
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of learning Module Catalogs

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991",
      "name": "2019 Incentivized Learning Module Catalog",
      "description": "Catalog to group incentivized learning modules in 2019."
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs?offset=0&limit=20"
}

GET /learning-module-catalogs

Retrieves all of the learning module catalogs that can group learning modules.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success. LearningModuleCatalogs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Learning Module Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers, body: {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}

PUT /learning-module-catalogs/{catalogId}

Updates information for a learning module catalog that can be used to group learning modules.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the catalog. -
body body putLearningModuleCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Learning Module Catalog

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /learning-module-catalogs/{catalogId}

Retrieves a learning module catalog based on its ID. This is used to retrieve information for a single learning module catalog.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the catalog. -

Response Statuses

Status Meaning Description Schema
200 OK Success. LearningModuleCatalog
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Challenges

Challenges are a social connection tool designed to get and keep consumers engaged with one another and their wellness programs, ultimately increasing the potential for positive behavior change and improved health outcomes.

Create a Challenge

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges', headers: headers, body: {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","categories":[{"id":"f90eb318-bdec-11e9-9cb5-2a2ae2dbcce4"}],"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"tags":[{"key":"Environment","value":"Production"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","categories":[{"id":"f90eb318-bdec-11e9-9cb5-2a2ae2dbcce4"}],"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"tags":[{"key":"Environment","value":"Production"}]}

Example response

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "categories": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Steps Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Challenges that involve running or walking"
        }
      ]
    }
  ],
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Get Your BMI Into a Healthy Range Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get your BMI into a healthy range"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "tags": [
    {
      "key": "Environment",
      "value": "Production"
    }
  ]
}

POST /challenges

Creates a challenge using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postChallenges true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Challenge
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a List of Challenges.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Walking Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get into shape by walking"
        }
      ],
      "imageURL": "https://cerner.com/download/101/bewell_profile.png",
      "startsAt": "2019-08-13T12:23:12Z",
      "endsAt": "2019-08-30T12:23:12Z",
      "registrationStartsAt": "2019-08-06T12:23:12Z",
      "registrationEndsAt": "2019-08-20T12:23:12Z",
      "timeZone": "America/New_York",
      "categories": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Steps Challenges"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "Challenges that involve running or walking"
            }
          ]
        }
      ],
      "catalogs": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Kansas City Wellness Challenges"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "All challenges for the Kansas City location"
            }
          ]
        }
      ],
      "goals": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Get Your BMI Into a Healthy Range Challenge"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "90-day challenge to get your BMI into a healthy range"
            }
          ],
          "type": "STEPS",
          "value": 100000,
          "unit": "STEPS"
        }
      ],
      "tags": [
        {
          "key": "Environment",
          "value": "Production"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges?offset=0&limit=20"
}

GET /challenges

Retrieves a list of challenges.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
catalogId query array[string] false N/A The ID of one or more catalogs by which to filter the challenges. -
tag query array[string] false N/A One or more tags by which to filter the challenges. A tag is the combination of a key and value and uses a colon as a delimiter, for example, Environment:Production. -

Response Statuses

Status Meaning Description Schema
200 OK Success Challenges
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Delete a Challenge

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenges/{challengeId}

Deletes a single challenge by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
challengeId path string true N/A The ID of the challenge. -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Single Challenge

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "categories": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Steps Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Challenges that involve running or walking"
        }
      ]
    }
  ],
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Get Your BMI Into a Healthy Range Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get your BMI into a healthy range"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "tags": [
    {
      "key": "Environment",
      "value": "Production"
    }
  ]
}

GET /challenges/{challengeId}

Retrieves a single challenge by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
challengeId path string true N/A The ID of the challenge. -

Response Statuses

Status Meaning Description Schema
200 OK Success Challenge
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Create a Challenge Goal

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals', headers: headers, body: {"names":[{"text":"Get Your BMI Into a Healthy Range Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get your BMI into a healthy range","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Get Your BMI Into a Healthy Range Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get your BMI into a healthy range","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Get Your BMI Into a Healthy Range Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get your BMI into a healthy range"
    }
  ],
  "type": "STEPS",
  "value": 100000,
  "unit": "STEPS"
}

POST /challenge-goals

Creates a challenge goal using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postChallengeGoals true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Goal
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a List of Challenge Goals.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Get Your BMI Into a Healthy Range Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get your BMI into a healthy range"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals?offset=0&limit=20"
}

GET /challenge-goals

Retrieves a list of challenge goals.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
type query array[string] false N/A One or more challenge goal types by which to filter results. -

Response Statuses

Status Meaning Description Schema
200 OK Success Goals
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Delete a Challenge Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-goals/{goalId}

Deletes a single challenge goal by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the challenge goal. -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Single Challenge Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Get Your BMI Into a Healthy Range Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get your BMI into a healthy range"
    }
  ],
  "type": "STEPS",
  "value": 100000,
  "unit": "STEPS"
}

GET /challenge-goals/{goalId}

Retrieves a single challenge goal by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the challenge goal. -

Response Statuses

Status Meaning Description Schema
200 OK Success Goal
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Create a Challenge Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Steps Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Challenges that involve running or walking"
    }
  ]
}

POST /challenge-categories

Creates a challenge category using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postChallengeCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Category
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a list of Challenge Categories.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Steps Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Challenges that involve running or walking"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories?offset=0&limit=20"
}

GET /challenge-categories

Retrieves a list of challenge categories.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Categories
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Updates a Challenge Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /challenge-categories/{categoryId}

Updates a specific challenge category using the provided parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the challenge category. -
body body putChallengeCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Delete a Challenge Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-categories/{categoryId}

Deletes a single challenge category by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the challenge category. -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Challenge Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-categories/ef2618d7-7d66-4471-a1fc-dc8074902cbe \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Steps Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Challenges that involve running or walking"
    }
  ]
}

GET /challenge-categories/{categoryId}

Retrieves a single challenge category by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the challenge category. -

Response Statuses

Status Meaning Description Schema
200 OK Success Category
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Create a Challenge Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Kansas City Wellness Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "All challenges for the Kansas City location"
    }
  ]
}

POST /challenge-catalogs

Creates a challenge catalog using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postChallengeCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Catalog
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a List of Challenge Catalogs.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs?offset=0&limit=20"
}

GET /challenge-catalogs

Retrieves a list of challenge catalogs.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Catalogs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Updates a Challenge Catalog

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /challenge-catalogs/{catalogId}

Updates a specific challenge catalog using the provided parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the challenge catalog. -
body body putChallengeCatalogs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Delete a Challenge Catalog

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-catalogs/{catalogId}

Deletes a single challenge catalog by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the challenge catalog. -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Single Challenge Catalog

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Kansas City Wellness Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "All challenges for the Kansas City location"
    }
  ]
}

GET /challenge-catalogs/{catalogId}

Retrieves a single challenge catalog by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId path string true N/A The ID of the challenge catalog. -

Response Statuses

Status Meaning Description Schema
200 OK Success Catalog
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Create a Challenge Registration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations', headers: headers, body: {"challengeId":"94b44ea3-fb6b-4245-886b-caa8e156f125","consumerId":"94b44ea3-fb6b-4245-886b-caa8e156f125","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"94b44ea3-fb6b-4245-886b-caa8e156f125","consumerId":"94b44ea3-fb6b-4245-886b-caa8e156f125","status":"ACTIVE"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "consumerId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "status": "ACTIVE"
}

POST /challenge-registrations

Creates a challenge registration using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postChallengeRegistrations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Registration
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a List of Challenge Registrations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "challengeId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "consumerId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/registrations?offset=0&limit=20"
}

GET /challenge-registrations

Retrieves a list of challenge registrations.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
consumerId query array[string] false N/A The ID of one or more consumers whose challenge registrations are to be retrieved. -
challengeId query array[string] false N/A The ID of one or more challenges by which to filter the challenge registrations. -

Response Statuses

Status Meaning Description Schema
200 OK Success Registrations
401 Unauthorized Unauthorized UnauthorizedError

Delete a Challenge Registration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-registrations/{registrationId}

Deletes a single challenge registration by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
registrationId path string true N/A The ID of the challenge registration. -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Single Challenge Registration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "consumerId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "status": "ACTIVE"
}

GET /challenge-registrations/{registrationId}

Retrieves a single challenge registration by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
registrationId path string true N/A The ID of the challenge registration. -

Response Statuses

Status Meaning Description Schema
200 OK Success Registration
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Schema Definitions

postEventLocations

Name Type Required Description Accepted Values
name string true The name of the location. -
description string false The free-text description of the location. -
address object false The address of the venue where the event is being held. -
» lines [string] false The lines of the address that indicate the building number, street number, street name, street direction, and similar address information. -
» city string false The city of the event venue. -
» district string false The district of the event venue. -
» state string false The state of the event venue. -
» country string false The country of the event venue. -
» postalCode string false The postal code of the event venue. -

Location

Name Type Required Description Accepted Values
id string true The ID of the location. -
name string true The name of the location. -
description string false The free-text description of the location. -
address Address false The address of the venue where the event is being held. -

Address

Name Type Required Description Accepted Values
lines [string] false The lines of the address that indicate the building number, street number, street name, street direction, and similar address information. -
city string false The city of the event venue. -
district string false The district of the event venue. -
state string false The state of the event venue. -
country string false The country of the event venue. -
postalCode string false The postal code of the event venue. -

BadRequestError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [BadRequestErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

BadRequestErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

UnauthorizedError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [UnauthorizedErrorDetail] false A list of additional error details. -

UnauthorizedErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

ForbiddenError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ForbiddenErrorDetail] false A list of additional error details. -

ForbiddenErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Locations

Name Type Required Description Accepted Values
items [Location] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEventLocations

Name Type Required Description Accepted Values
name string true The name of the location. -
description string false The free-text description of the location. -
address object false The address of the venue where the event is being held. -
» lines [string] false The lines of the address that indicate the building number, street number, street name, street direction, and similar address information. -
» city string false The city of the event venue. -
» district string false The district of the event venue. -
» state string false The state of the event venue. -
» country string false The country of the event venue. -
» postalCode string false The postal code of the event venue. -

NotFoundError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [NotFoundErrorDetail] false A list of additional error details. -

NotFoundErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

postEventCategories

Name Type Required Description Accepted Values
name string true The name of the category. -
code object false The code of the category from a single, specified code system. -
» code string true The unique ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false A human-readable representation of the code. -

Category

Name Type Required Description Accepted Values
id string true The ID of the category. -
name string true The name of the category. -
code Code false The code of the category from a single, specified code system. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Categories

Name Type Required Description Accepted Values
items [Category] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEventCategories

Name Type Required Description Accepted Values
name string true The name of the category. -
code object false The code of the category from a single, specified code system. -
» code string true The unique ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false A human-readable representation of the code. -

postEventCatalogs

Name Type Required Description Accepted Values
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

Catalog

Name Type Required Description Accepted Values
id string true The ID of the catalog. -
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

Catalogs

Name Type Required Description Accepted Values
items [Catalog] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEventCatalogs

Name Type Required Description Accepted Values
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

postEvents

Name Type Required Description Accepted Values
name string true The name of the event. -
description string false Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on. -
leader object true Information about the individual who will provide guidance and instructions for the event. -
» name string true The full name of the person who is assigned as the leader of the event or series. -
» telecoms [object] false The contact details of the person who is assigned as the leader of the event or series. -
»» system string true The system of the telecom. -
»» value string true The value of the telecom. -
registrationStatus string false The current registration status of the event. The following statuses are possible:
- OPEN: The event has open slots available for registration.
- FULL: Registrations for all slots in the event have reached capacity.
- CLOSED: The registration period for all slots in the event has ended.
OPEN, FULL, CLOSED
startsAt string true The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone. -
multislot boolean true Indicates whether the event has the same session hosted multiple times. -
location object true The location of the event. -
» id string true The ID of the location. -
category object true The category of the event. -
» id string true The ID of the category. -
catalogs [object] false References to the catalogs in which the event is grouped. -
» id string true The ID of the catalog. -
series object false References to the series to which the event belongs. -
» id string true The ID of the event series. -

Event

Name Type Required Description Accepted Values
id string true The ID of the event. -
name string true The name of the event. -
description string false Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on. -
leader Leader true Information about the individual who will provide guidance and instructions for the event. -
registrationStatus string true The current registration status of the event. The following statuses are possible:
- OPEN: The event has open slots available for registration.
- FULL: Registrations for all slots in the event have reached capacity.
- CLOSED: The registration period for all slots in the event has ended.
OPEN, FULL, CLOSED
startsAt string true The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone. -
multislot boolean true Indicates whether the event has the same session hosted multiple times. -
location Location true The location of the event. -
category Category true The category of the event. -
catalogs [CatalogReference] false References to the catalogs in which the event is grouped. -
series SeriesReference false References to the series to which the event belongs. -

Leader

Name Type Required Description Accepted Values
name string true The full name of the person who is assigned as the leader of the event or series. -
telecoms [Telecom] false The contact details of the person who is assigned as the leader of the event or series. -

Telecom

Name Type Required Description Accepted Values
system string true The system of the telecom. EMAIL, PHONE, OTHER
value string true The value of the telecom. -

CatalogReference

Name Type Required Description Accepted Values
id string true The ID of the catalog. -

SeriesReference

Name Type Required Description Accepted Values
id string true The ID of the event series. -

Events

Name Type Required Description Accepted Values
items [Event] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEvents

Name Type Required Description Accepted Values
name string true The name of the event. -
description string false Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on. -
leader object true Information about the individual who will provide guidance and instructions for the event. -
» name string true The full name of the person who is assigned as the leader of the event or series. -
» telecoms [object] false The contact details of the person who is assigned as the leader of the event or series. -
»» system string true The system of the telecom. -
»» value string true The value of the telecom. -
registrationStatus string false The current registration status of the event. The following statuses are possible:
- OPEN: The event has open slots available for registration.
- FULL: Registrations for all slots in the event have reached capacity.
- CLOSED: The registration period for all slots in the event has ended.
OPEN, FULL, CLOSED
startsAt string true The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone. -
multislot boolean true Indicates whether the event has the same session hosted multiple times. -
location object true The location of the event. -
» id string true The ID of the location. -
category object true The category of the event. -
» id string true The ID of the category. -
catalogs [object] false References to the catalogs in which the event is grouped. -
» id string true The ID of the catalog. -
series object false References to the series to which the event belongs. -
» id string true The ID of the event series. -

postEventsEventidSlots

Name Type Required Description Accepted Values
description string false Additional details about the event slot that describe the session, schedule, and so on. -
maxRegistrations integer(int32) false The maximum number of attendees for this session of the event. -
startsAt string true The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
registrationEndsAt string false The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone. -

Slot

Name Type Required Description Accepted Values
id string true The ID of the event slot. -
description string false Additional details about the event slot that describe the session, schedule, and so on. -
maxRegistrations integer(int32) false The maximum number of attendees for this session of the event. -
availableRegistrations integer(int32) false The number of available registrations for this session of the event. The number of available registrations cannot be less than 0 or greater than the value of the maxRegistrations field. The default value is the value of the maxRegistrations field. -
startsAt string true The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
registrationEndsAt string false The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone. -

Slots

Name Type Required Description Accepted Values
items [Slot] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEventsEventidSlots

Name Type Required Description Accepted Values
description string false Additional details about the event slot that describe the session, schedule, and so on. -
maxRegistrations integer(int32) false The maximum number of attendees for this session of the event. -
startsAt string true The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
endsAt string true The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
registrationEndsAt string false The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
timeZone string true The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone. -

postEventSeries

Name Type Required Description Accepted Values
name string true The name of the event series. -
description string false Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on. -
leader object false Information about the individual who will provide guidance and instructions for the series. -
» name string true The full name of the person who is assigned as the leader of the event or series. -
» telecoms [object] false The contact details of the person who is assigned as the leader of the event or series. -
»» system string true The system of the telecom. -
»» value string true The value of the telecom. -
registrationStatus string false The current registration status of the event series. The following statuses are possible:
- OPEN: The series has events with open slots available for registration.
- FULL: Registrations for all slots for at least one event in the series have reached capacity.
- CLOSED: The registration period for all slots for at least one event in the series has ended.
OPEN, FULL, CLOSED
catalogs [object] false References to the catalogs in which the series is grouped. -
» id string true The ID of the catalog. -

Series

Name Type Required Description Accepted Values
id string true The ID of the event series. -
name string true The name of the event series. -
description string false Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on. -
registrationStatus string true The current registration status of the event series. The following statuses are possible:
- OPEN: The series has events with open slots available for registration.
- FULL: Registrations for all slots for at least one event in the series have reached capacity.
- CLOSED: The registration period for all slots for at least one event in the series has ended.
OPEN, FULL, CLOSED
leader Leader false Information about the individual who will provide guidance and instructions for the series. -
catalogs [CatalogReference] false References to the catalogs in which the series is grouped. -

putEventSeries

Name Type Required Description Accepted Values
name string true The name of the event series. -
description string false Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on. -
leader object false Information about the individual who will provide guidance and instructions for the series. -
» name string true The full name of the person who is assigned as the leader of the event or series. -
» telecoms [object] false The contact details of the person who is assigned as the leader of the event or series. -
»» system string true The system of the telecom. -
»» value string true The value of the telecom. -
registrationStatus string false The current registration status of the event series. The following statuses are possible:
- OPEN: The series has events with open slots available for registration.
- FULL: Registrations for all slots for at least one event in the series have reached capacity.
- CLOSED: The registration period for all slots for at least one event in the series has ended.
OPEN, FULL, CLOSED
catalogs [object] false References to the catalogs in which the series is grouped. -
» id string true The ID of the catalog. -

postEventRegistrations

Name Type Required Description Accepted Values
consumer object true A reference to the HealtheIntent consumer who registered for the event. -
» id string true The ID of the HealtheIntent consumer. -
slot object true A reference to the event slot for which the HealtheIntent consumer registered. -
» id string true The ID of the event slot. -
» event object true A reference to the event to which this slot belongs. -
»» id string true The ID of the event. -
»» seriesId string false The ID of the event series. -

Registration

Name Type Required Description Accepted Values
id string true The ID of the event registration. -
consumer ConsumerReference true A reference to the HealtheIntent consumer who registered for the event. -
slot SlotReference true A reference to the event slot for which the HealtheIntent consumer registered. -

ConsumerReference

Name Type Required Description Accepted Values
id string true The ID of the HealtheIntent consumer. -

SlotReference

Name Type Required Description Accepted Values
id string true The ID of the event slot. -
event EventReference true A reference to the event to which this slot belongs. -

EventReference

Name Type Required Description Accepted Values
id string true The ID of the event. -
seriesId string false The ID of the event series. -

Registrations

Name Type Required Description Accepted Values
items [Registration] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postEventAttendances

Name Type Required Description Accepted Values
consumer object true A reference to the HealtheIntent consumer who attended the event. -
» id string true The ID of the HealtheIntent consumer. -
slot object true A reference to the event slot that the HealtheIntent consumer attended. -
» id string true The ID of the event slot. -
» event object true A reference to the event to which this slot belongs. -
»» id string true The ID of the event. -
»» seriesId string false The ID of the event series. -

Attendance

Name Type Required Description Accepted Values
id string true The ID of the event attendance. -
consumer ConsumerReference true A reference to the HealtheIntent consumer who attended the event. -
slot SlotReference true A reference to the event slot that the HealtheIntent consumer attended. -

Attendances

Name Type Required Description Accepted Values
items [Attendance] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postLearningModules

Name Type Required Description Accepted Values
definitionId string true The definition ID of a learning module. -
status string true The status of the learning module. This can be either DRAFT, PUBLISHED, or RETIRED. -
imageUrl string false An image URL for a wellness learning module. -
title [object] true A list of learning module titles for different locales. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The title of the learning module for a given locale. -
description [object] false A list of learning module descriptions for a different locale. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The descriptions of the learning module for a given locale. -
keywords [object] false A list of learning module keywords for different locales. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The keywords of the learning module for a given locale. -
categories [string] false A list of category IDs for the learning module. -
catalogs [object] false A list of catalogs for the learning modules -
» id string true A catalog reference ID for a learning module. -
consumerGroups [object] false A list of consumer groups for the learning modules. -
» id string true A consumer group reference ID for a learning module. -

Module

Name Type Required Description Accepted Values
id string true The ID of the module. -
definitionId string true The ID of the definition of the learning module. -
title [Locale] true The title of the learning module. -
description [Locale] false The description of the learning module. -
status string true The status of the learning module. DRAFT, PUBLISHED, RETIRED
thumbnailUrl string false The image URL of the learning module. -
keywords [Keyword] false The keywords of the learning module. -
categories [string] true The categories of the learning module. -
catalogs [LearningModuleCatalogReference] false The catalogs of the learning module. -
consumerGroups [ConsumerGroupReference] false The consumer groups of the learning module. -
createdAt string(date-time) false The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Locale

Name Type Required Description Accepted Values
locale string true The locale. -
text string true The text in the locale. -

Keyword

Name Type Required Description Accepted Values
locale string true The locale. -
text [string] true The text in the locale. -

LearningModuleCatalogReference

Name Type Required Description Accepted Values
id string true The ID of the catalog. -

ConsumerGroupReference

Name Type Required Description Accepted Values
id string true The ID of the consumer group. -

TranslatedModules

Name Type Required Description Accepted Values
items [TranslatedModule] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

TranslatedModule

Name Type Required Description Accepted Values
id string true The ID of the module. -
title [string] true The title of the learning module. -
description [string] false The description of the learning module. -
status string true The status of the learning module. DRAFT, PUBLISHED, RETIRED
imageUrl string false The image URL of the learning module. -
keywords [string] false The keywords of the learning module. -
categories [string] true The categories of the learning module. -
catalogs [LearningModuleCatalogReference] false The catalogs of the learning module. -
consumerGroups [ConsumerGroupReference] false The consumer groups of the learning module. -
createdAt string(date-time) false The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

patchLearningModules

Name Type Required Description Accepted Values
imageUrl string false An image URL for a wellness learning module. -
status string false The status of the learning module. This can be either DRAFT, PUBLISHED, or RETIRED. -
title [object] false A list of learning module titles for different locales. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The title of the learning module for a given locale. -
description [object] false A list of learning module descriptions for different locales. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The descriptions of the learning module for a given locale. -
keywords [object] false A list of learning module keywords for different locales. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The keywords of the learning module for a given locale. -
categories [string] false A list of category IDs for the learning module. -
catalogs [object] false A list of catalogs for the learning modules. -
» id string true A catalog reference ID for a learning module. -
consumerGroups [object] false A list of consumer groups for the learning modules. -
» id string true A consumer group reference ID for a learning module. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

postLearningModulesModuleidTasks

Name Type Required Description Accepted Values
sourceReferenceId string true The source ID in an external system, for example, the education library. -
sourceReferenceKind string true The source type in an external system, for example, the education library. -
order string true The task order of the learning module. -

Task

Name Type Required Description Accepted Values
id string true The ID of the task. -
moduleReference string true The ID of the learning module. -
title [Locale] true The title of the task. -
sourceReference string false The ID of the task in an external source system. -
order string true The order of the tasks in the learning module. -
createdAt string(date-time) false The date and time when the task was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when the task was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Tasks

Name Type Required Description Accepted Values
items [Task] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

patchLearningModulesModuleidTasks

Name Type Required Description Accepted Values
sourceSystemId string false The source ID in an external system, for example, the education library. -
sourceSystemKind string false The source type in an external system, for example, the education library. -
order string false The task order of the learning module. -

postLearningModuleEnrollments

Name Type Required Description Accepted Values
moduleReferenceId string true The learning module ID. The maximum length is 36 characters. -
consumerReferenceId string true The HealtheIntent consumer ID. See Consumer API for more information. -

Enrollment

Name Type Required Description Accepted Values
id string true The ID of the enrollment. -
consumerReference string true The ID of the consumer. -
moduleReference string true The ID of the learning module. -
status string true The enrollment status. -
createdAt string(date-time) false The date and time when the enrollment was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when enrollment was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Enrollments

Name Type Required Description Accepted Values
items [Enrollment] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

EnrollmentTasks

Name Type Required Description Accepted Values
items [EnrollmentTask] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

EnrollmentTask

Name Type Required Description Accepted Values
id string true The ID of the task. -
moduleTaskReference string true The ID of the enrolled task. -
status string true The enrolled task status of the learning module. -
order string true The order of tasks in the learning module. -
createdAt string(date-time) false The date and time when the task was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when the task was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

patchLearningModuleEnrollmentsEnrollmentidTasks

Name Type Required Description Accepted Values
status string true The status of the learning module task. -

postLearningModuleCategories

Name Type Required Description Accepted Values
title [object] true The title of the category in a different locale. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The title of the category in the locale. -

LearningModuleCategory

Name Type Required Description Accepted Values
id string true The ID of the category. -
title [Locale] true The category title in a different locale. -
createdAt string(date-time) false The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false The date and time when the module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

LearningModuleCategories

Name Type Required Description Accepted Values
items [LearningModuleCategory] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

patchLearningModuleCategories

Name Type Required Description Accepted Values
title [object] false The title of the category in a different locale. -
» locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
» text string true The title of the category in the locale. -

postLearningModuleCatalogs

Name Type Required Description Accepted Values
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

LearningModuleCatalog

Name Type Required Description Accepted Values
id string true The ID of the catalog. -
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

LearningModuleCatalogs

Name Type Required Description Accepted Values
items [LearningModuleCatalog] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putLearningModuleCatalogs

Name Type Required Description Accepted Values
name string true The name of the catalog. -
description string false The free-text description of the catalog. -

postChallenges

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge in different locales. -
» text string true The localized name of the challenge. -
» locale string true The locale for the challenge name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge in different locales. -
» text string true The localized description of the challenge. -
» locale string true The locale for the challenge description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
imageURL string false The URL of the marketing image for the challenge. -
startsAt string(date-time) true The start date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endsAt string(date-time) true The end date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
registrationStartsAt string(date-time) true The date and time for when consumers can start to register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
registrationEndsAt string(date-time) true The date and time after which consumers can no longer register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
timeZone string true The time zone used to configure the start and end times for the challenge. This value should match a valid time zone in the IANA database. -
categories [object] true The IDs of one or more categories of which the challenge is a part. -
» id string true The ID of a challenge catalog. -
catalogs [object] true The IDs of one or more catalogs with which the challenge is associated. -
» id string true The ID of a challenge catalog. -
goals [object] true The IDs of one or more goals associated with the challenge. -
» id string true The ID of a goal for the challenge. -
tags [object] true A list of tags associated with the challenge. -
» key string true The unique ID for the tag. -
» value string true The value for the tag. -

Challenge

Name Type Required Description Accepted Values
id string true The ID of the challenge. -
names Translation true A list of localized names for the challenge. -
descriptions Translation false A list of localized descriptions for the challenge. -
imageURL string false The URL of the marketing image for the challenge. -
startsAt string(date-time) true The start date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endsAt string(date-time) true The end date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
registrationStartsAt string(date-time) true The date and time when consumers can start to register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
registrationEndsAt string(date-time) true The date and time after which consumers can no longer register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
timeZone string true The time zone used to configure the start and end times for the challenge. This value matches a valid time zone in the IANA database. -
categories [Category] true A list of categories to which the challenge belongs. -
catalogs [Catalog] true A list of catalogs with which the challenge is associated. -
goals [Goal] true A list of goals for the challenge. -
tags [Tag] true A list of tags associated with the challenge. A tag is the combination of a key and value and uses a colon as a delimiter (for example, Environment:Production. This query parameter can be repeated multiple times to query for challenges that include a combination of tags. If multiple tags are specified, only results that include all of the tags are returned. -

Translation

Name Type Required Description Accepted Values
text string true The text of the translation. -
locale string true The locale of the translation. -

Goal

Name Type Required Description Accepted Values
id string true The ID of a challenge goal. -
names Translation true A list of localized names for the challenge goal. -
descriptions Translation false A list of localized descriptions for the challenge goal. -
type string true The type of the challenge, for example, STEPS, ACTIVITY, NUTRITION or HYDRATION. -
value integer(int32) true The total value that must be met over the duration of the challenge to complete it successfully. -
unit string true The units for the challenge. STEPS, MINUTES, DAYS_LOGGED, OUNCES

Tag

Name Type Required Description Accepted Values
key string true The unique ID for the tag. -
value string true The value for the tag. -

Challenges

Name Type Required Description Accepted Values
items [Challenge] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postChallengeGoals

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge goal in different locales. -
» text string true The localized name of the goal. -
» locale string true The locale for the goal name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge goal in different locales. -
» text string true The localized description of the goal. -
» locale string true The locale for the goal description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
type string true The type of the challenge, for example, STEPS, ACTIVITY, NUTRITION or HYDRATION. -
value integer(int32) true The total value that must be met over the duration of the challenge to complete it successfully. -
unit string true The units for the challenge. STEPS, MINUTES, DAYS_LOGGED, OUNCES

Goals

Name Type Required Description Accepted Values
items [Goal] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postChallengeCategories

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge category in different locales. -
» text string true The localized name of the category. -
» locale string true The locale for the category name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge category in different locales. -
» text string true The localized description of the category. -
» locale string true The locale for the category description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -

putChallengeCategories

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge category in different locales. -
» text string true The localized name of the category. -
» locale string true The locale for the category name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge category in different locales. -
» text string true The localized description of the category. -
» locale string true The locale for the category description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -

postChallengeCatalogs

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge catalog in different locales. -
» text string true The localized name of the catalog. -
» locale string true The locale for the catalog name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge catalog in different locales. -
» text string true The localized description of the catalog. -
» locale string true The locale for the catalog description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -

putChallengeCatalogs

Name Type Required Description Accepted Values
names [object] true A list of names for the challenge catalog in different locales. -
» text string true The localized name of the catalog. -
» locale string true The locale for the catalog name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -
descriptions [object] false A list of descriptions for the challenge catalog in different locales. -
» text string true The localized description of the catalog. -
» locale string true The locale for the catalog description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, en-US. -

postChallengeRegistrations

Name Type Required Description Accepted Values
challengeId string true The ID of a challenge. -
consumerId string true The ID of a consumer. -
status string false Tracks whether the consumer is currently registered or unregistered for a challenge. ACTIVE, INACTIVE