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 challenges, and provide interactive educational content.

URL: https://cernerdemo.api.us-1.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-1.healtheintent.com/consumer-engagement/v1/event-locations', headers: headers, body: {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"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-1.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","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

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. ConsumerEngagementPublicApi_Entities_V1_Events_Location
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "address": {
        "lines": [
          "8779 Hillcrest Road",
          "Innovations Campus"
        ],
        "city": "Kansas City",
        "district": "Jackson County",
        "state": "MO",
        "country": "US",
        "postalCode": "64138"
      },
      "restrictedToCatalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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
availableForCatalog query array[string] false N/A Filters by those locations available for the specified catalog. -
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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323', headers: headers, body: {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"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-1.healtheintent.com/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323', headers: headers)

print JSON.pretty_generate(result)


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

GET /event-locations/{locationId}

Retrieves an event location by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Location
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-categories', headers: headers, body: {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"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-1.healtheintent.com/consumer-engagement/v1/event-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

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. ConsumerEngagementPublicApi_Entities_V1_Events_Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "code": {
        "code": "310422005",
        "display": "Prevention/screening",
        "system": "2.16.840.1.113883.6.96"
      },
      "restrictedToCatalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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
availableForCatalog query array[string] false N/A Filters by those categories available for the specified catalog. -
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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354', headers: headers, body: {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"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-1.healtheintent.com/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354', headers: headers)

print JSON.pretty_generate(result)


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

GET /event-categories/{categoryId}

Retrieves an event category by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Category
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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. ConsumerEngagementPublicApi_Entities_V1_Events_Catalog
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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-1.healtheintent.com/consumer-engagement/v1/event-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991', 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-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991 \
-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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-catalogs/{catalogId}

Retrieves an event catalog by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Catalog
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"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,"status":"ACTIVE","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"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"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,"status":"ACTIVE","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"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

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. ConsumerEngagementPublicApi_Entities_V1_Events_Event
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "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.",
        "names": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "descriptions": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "address": {
          "lines": [
            "8779 Hillcrest Road",
            "Innovations Campus"
          ],
          "city": "Kansas City",
          "district": "Jackson County",
          "state": "MO",
          "country": "US",
          "postalCode": "64138"
        },
        "restrictedToCatalogs": [
          {
            "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
          }
        ]
      },
      "category": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "name": "Preventive Health",
        "names": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "code": {
          "code": "310422005",
          "display": "Prevention/screening",
          "system": "2.16.840.1.113883.6.96"
        },
        "restrictedToCatalogs": [
          {
            "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
          }
        ]
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ],
      "series": {
        "id": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
      },
      "scopes": [
        {
          "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465"
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20"
}

GET /events

Retrieves all of the events that meet the specified parameters. 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. If the registration status is OPEN, only events that take place in the future are returned. -
catalogId query array[string] false N/A Filters by the ID of the catalog. -
scopeId query array[string] false N/A Filters by the ID of the scope. -
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. -
status query string false N/A Filters by the status 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. Events
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', 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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"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,"status":"ACTIVE","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"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"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,"status":"ACTIVE","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"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete an Event

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /events/{eventId}

Deletes an event. This request is intended for events that are created in error. Events with registrations cannot be deleted. If an event has registrations, the event should be updated to set the status field to CANCELED.

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
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /events/{eventId}

Retrieves a single event by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Event
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/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.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/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.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}

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. ConsumerEngagementPublicApi_Entities_V1_Events_Slot
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "337c98f3-b1aa-4ab2-9c9c-1a973457cfe7",
      "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.",
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "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",
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. 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. -
status query string false N/A Filters by the status of the slot. -
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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', 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.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-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.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete an Event Slot

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /events/{eventId}/slots/{slotId}

Deletes an event slot. This request is intended for event slots that are created in error. Event slots with registrations cannot be deleted. If an event slot has registrations, the event slot should be updated to set the status field to CANCELED.

Parameters

Parameter In Type Required Default Description Accepted Values
eventId path integer(int32) true N/A No description -
slotId path integer(int32) true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

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

Retrieves a single event slot by its event and slot IDs. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Slot
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create Multiple Slots for 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-1.healtheintent.com/consumer-engagement/v1/event-slots', headers: headers, body: {"slots":[{"event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe"},"descriptions":[{"locale":"en-US","value":"Localized value."}],"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","status":"ACTIVE"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-slots \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"slots":[{"event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe"},"descriptions":[{"locale":"en-US","value":"Localized value."}],"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","status":"ACTIVE"}]}

POST /event-slots

Creates multiple slots for a single event. Each event slot shows the time when the event is hosted as well as registration information. The event is specified by its ID within the Post body, and the event ID for all slots should be the same. The ordering of the response will be the same as the ordering of the request. The request can contain as many slots necessary for a singular event. If one of the slots is invalid, no slots will be created.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. ConsumerEngagementPublicApi_Entities_V1_Events_EventSlotList
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

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. ConsumerEngagementPublicApi_Entities_V1_Events_Series
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "registrationStatus": "OPEN",
      "leader": {
        "name": "Dr. Jane Elizabeth Smith",
        "telecoms": [
          {
            "system": "EMAIL",
            "value": "jane.smith@rockhurst.edu"
          }
        ]
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ],
      "scopes": [
        {
          "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465"
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. 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. If the registration status is OPEN, only series that take place in the future are returned. -
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. -
scopeId query array[string] false N/A Filters by the ID of scope. If any event in the series is in this scope, 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. -
status query string false N/A Filters by the status of the event 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. Series
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', 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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-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.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete an Event Series

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-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-series/{seriesId}

Deletes an event series. This request is intended for event series that are created in error. Event series with registrations cannot be deleted. If an event series has registrations, the event series should be updated to set the status field to CANCELED.

Parameters

Parameter In Type Required Default Description Accepted Values
seriesId path integer(int32) true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-series/{seriesId}

Retrieves an event series by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Series
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Registration
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.healtheintent.com/consumer-engagement/v1/event-registrations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "2c26d041-fb14-4d63-8d55-c59905c3de22",
      "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-1.healtheintent.com/consumer-engagement/v1/event-registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. 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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22 \
-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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-registrations/{registrationId}

Retrieves a single event registration by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Registration
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a List of Event Attendances

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-1.healtheintent.com/consumer-engagement/v1/event-attendances', headers: headers, body: {"attendances":[{"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-1.healtheintent.com/consumer-engagement/v1/event-attendances \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"attendances":[{"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 list of event attendance, which records that the consumer attended the event. An event registration is not required to create an event attendance. If multiple attendances are passed to this call, and a single attendance fails, no attendances will be created.

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. ConsumerEngagementPublicApi_Entities_V1_Events_AttendanceList
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.healtheintent.com/consumer-engagement/v1/event-attendances \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "e9c16850-0082-47eb-b091-ae4db5c70ecb",
      "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-1.healtheintent.com/consumer-engagement/v1/event-attendances?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. 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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb \
-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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb', headers: headers)

print JSON.pretty_generate(result)


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

GET /event-attendances/{attendanceId}

Retrieves a single event attendance by its ID. 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. ConsumerEngagementPublicApi_Entities_V1_Events_Attendance
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create an Event Scope

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-1.healtheintent.com/consumer-engagement/v1/event-scopes', headers: headers, body: {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020."}.to_json )

print JSON.pretty_generate(result)




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

POST /event-scopes

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

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. ConsumerEngagementPublicApi_Entities_V1_Events_Scope
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Event Scopes

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-1.healtheintent.com/consumer-engagement/v1/event-scopes', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465",
      "name": "2020 Incentivized Events Scope",
      "kind": "Scope to group incentivized events in 2020."
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes?offset=0&limit=20"
}

GET /event-scopes

Retrieves all of the event scopes 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. Scopes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete an Event Scope

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-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-scopes/{scopeId}

Deletes the single scope with the specified ID.

Parameters

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

Response Statuses

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

Update an Event Scope

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-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers, body: {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020."}

PUT /event-scopes/{scopeId}

Updates the information for an event scope.

Parameters

Parameter In Type Required Default Description Accepted Values
scopeId path string true N/A The ID of the scope. -
body body putEventScopes true N/A No description -

Response Statuses

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

Retrieve a Single Event Scope

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-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-scopes/{scopeId}

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

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success. ConsumerEngagementPublicApi_Entities_V1_Events_Scope
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/learning-modules', headers: headers, body: {"definitionId":"77a233a3-54d4-4ad3-9e63-53bb71762290","imageUrl":"https://heathwise.edu/1.jpg","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","imageUrl":"https://heathwise.edu/1.jpg","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}

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": "DRAFT",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "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-12-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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_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.
Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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": "A 12-week course to help you establish healthy weight practices and habits."
        }
      ],
      "status": "PUBLISHED",
      "imageUrl": "https://heathwise.edu/1.jpg",
      "keywords": [
        {
          "locale": "en-US",
          "text": [
            "Diabetes",
            "prevention"
          ]
        }
      ],
      "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-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. DRAFT, PUBLISHED, RETIRED
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, title, -title

Response Statuses

Status Meaning Description Schema
200 OK OK TranslatedModules
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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 Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"imageUrl":"https://heathwise.edu/1.jpg","status":"PUBLISHED","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.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":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}

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.
Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
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-1.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-1.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": "DRAFT",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "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-12-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 ConsumerEngagementPublicApi_Entities_V1_LearningModules_Module
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Copy a Learning Module

Example Request:


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

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

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

print JSON.pretty_generate(result)


# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/clone \
-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": "DRAFT",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "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-12-15T12:23:12Z"
}

POST /learning-modules/{moduleId}/clone

Copies a learning module with a specified ID to create a new learning module and its associated tasks.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created The learning module was cloned. ConsumerEngagementPublicApi_Entities_V1_LearningModules_Module
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks', headers: headers, body: {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1}

Example response

{
  "id": "d4454f2a-665c-49d4-87db-8c167feae17d",
  "moduleReference": {
    "id": "11e8902c9e2908c69718f13503066bee"
  },
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "A 12-week course to help you establish healthy weight practices and habits."
    }
  ],
  "sourceReference": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
    "kind": "education#content"
  },
  "order": "4",
  "weeksBeforeActive": 1,
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_Task
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "d4454f2a-665c-49d4-87db-8c167feae17d",
      "moduleReference": {
        "id": "11e8902c9e2908c69718f13503066bee"
      },
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "description": [
        {
          "locale": "en-US",
          "text": "A 12-week course to help you establish healthy weight practices and habits."
        }
      ],
      "sourceReference": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
        "kind": "education#content"
      },
      "order": "4",
      "weeksBeforeActive": 1,
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/db5f4eec-0e29-40b4-b051-707ad8a30b1d/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. -
sourceReferenceId query string false N/A The source ID in an external system, for example, the education library. -
sourceReferenceKind 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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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 Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158', headers: headers, body: {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1,"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.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' \
-d {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1,"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}]}

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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
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-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments', headers: headers, body: {"moduleReferenceId":"11e8902c9e2908c69718f13503066bee","consumerReferenceId":"9fb56347-07bd-4a48-a495-fc86ef804ba7"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"moduleReferenceId":"11e8902c9e2908c69718f13503066bee","consumerReferenceId":"9fb56347-07bd-4a48-a495-fc86ef804ba7"}

Example response

{
  "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
  "consumerReference": {
    "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
  },
  "moduleReference": {
    "id": "11e8902c9e2908c69718f13503066bee"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_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.
Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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": "11e8902c9e2908c69718f13503066bee"
      },
      "status": "notStarted",
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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. notStarted, inProgress, completed, unenrolled
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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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 Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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": "11e8902c9e2908c69718f13503066bee"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-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 ConsumerEngagementPublicApi_Entities_V1_LearningModules_Enrollment
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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",
      "taskActivity": {
        "id": "21c2341c-a273-4103-92f0-028653384bea"
      },
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/11e8902c9e2908c69718/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 order A comma-separated list of fields by which to sort. updatedAt, -updatedAt, order, -order, status

Response Statuses

Status Meaning Description Schema
200 OK OK EnrollmentTasks
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks/d96a3cd2-01c1-4abf-aa1b-9be4605bfaed', headers: headers, body: {"status":"completed","taskActivity":{"id":"21c2341c-a273-4103-92f0-028653384bea"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.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' \
-d {"status":"completed","taskActivity":{"id":"21c2341c-a273-4103-92f0-028653384bea"}}

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.
Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
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-1.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-1.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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCategory
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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-1.healtheintent.com/consumer-engagement/v1/learning-module-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
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-1.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-1.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 Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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 ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCategory
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalog
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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-1.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-1.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 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

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-1.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-1.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. ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalog
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Challenges

Challenges are engagement programs that encourage consumers to meet a personal or team-based goal. Challenges can be designed for individual consumers or for groups of consumers to complete together. Wellness programs can use challenges to create social awareness of healthy activities, facilitate competitions, and increase participation in the program, ultimately leading to positive behavior change and improved health outcomes. Additionally, challenge outcomes can be used for challenge leaderboards to compare how a particular consumer performed compared to all the other consumers participating in the challenge.

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-1.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-1.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": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Challenge
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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": "Complete 150,000 steps in four weeks"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "Walk 5000 steps every day to meet your goal"
            }
          ],
          "type": "STEPS",
          "value": 100000,
          "unit": "STEPS"
        }
      ],
      "tags": [
        {
          "key": "Environment",
          "value": "Production"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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
catalogId query array[string] false N/A The ID or IDs 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. -
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 Challenges
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update 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.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', 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 PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-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"}]}

PUT /challenges/{challengeId}

Updates a single challenge by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
challengeId path integer(int32) true N/A No description -
body body putChallenges true N/A No description -

Response Statuses

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

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-1.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-1.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": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Challenge
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Team 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-1.healtheintent.com/consumer-engagement/v1/team-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","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"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-1.healtheintent.com/consumer-engagement/v1/team-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","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"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",
  "canConsumerCreateTeam": true,
  "timeZone": "America/New_York",
  "maxTeamRegistrations": 50,
  "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": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "tags": [
    {
      "key": "Environment",
      "value": "Production"
    }
  ]
}

POST /team-challenges

Creates a team challenge using the specified parameters.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Retrieve a List of Team 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-1.healtheintent.com/consumer-engagement/v1/team-challenges', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-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",
      "canConsumerCreateTeam": true,
      "timeZone": "America/New_York",
      "maxTeamRegistrations": 50,
      "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": "Complete 150,000 steps in four weeks"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "Walk 5000 steps every day to meet your goal"
            }
          ],
          "type": "STEPS",
          "value": 100000,
          "unit": "STEPS"
        }
      ],
      "tags": [
        {
          "key": "Environment",
          "value": "Production"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges?offset=0&limit=20"
}

GET /team-challenges

Retrieves a list of team challenges.

Parameters

Parameter In Type Required Default Description Accepted Values
catalogId query array[string] false N/A The ID or IDs 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. -
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 TeamChallenges
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Delete a Team 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-1.healtheintent.com/consumer-engagement/v1/team-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-1.healtheintent.com/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /team-challenges/{teamChallengeId}

Deletes a single team challenge by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Team 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.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', 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","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"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 PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-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","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"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"}]}

PUT /team-challenges/{teamChallengeId}

Updates a single team challenge by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
teamChallengeId path integer(int32) true N/A No description -
body body putTeamChallenges true N/A No description -

Response Statuses

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

Retrieve a Single Team 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-1.healtheintent.com/consumer-engagement/v1/team-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-1.healtheintent.com/consumer-engagement/v1/team-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",
  "canConsumerCreateTeam": true,
  "timeZone": "America/New_York",
  "maxTeamRegistrations": 50,
  "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": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "tags": [
    {
      "key": "Environment",
      "value": "Production"
    }
  ]
}

GET /team-challenges/{teamChallengeId}

Retrieves a single team challenge by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Team Definition

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-1.healtheintent.com/consumer-engagement/v1/team-definitions', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"2281caf2-4757-11ea-b77f-2e728ce88125","kind":"CONSUMER"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"2281caf2-4757-11ea-b77f-2e728ce88125","kind":"CONSUMER"}}

Example response

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
  "name": "Fitness Squad",
  "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "availableRegistrations": 5,
  "createdBy": {
    "id": "2281caf2-4757-11ea-b77f-2e728ce88125",
    "kind": "CONSUMER"
  }
}

POST /team-definitions

Creates a team definition using the specified parameters. A team can be created by either consumers participating in the challenge or an administrator.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Retrieve a List of Team Definitions

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-1.healtheintent.com/consumer-engagement/v1/team-definitions', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
      "name": "Fitness Squad",
      "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
      "imageURL": "https://cerner.com/download/101/bewell_profile.png",
      "availableRegistrations": 5,
      "createdBy": {
        "id": "2281caf2-4757-11ea-b77f-2e728ce88125",
        "kind": "CONSUMER"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions?offset=0&limit=20"
}

GET /team-definitions

Retrieves a list of team definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
teamChallengeId query array[string] false N/A The ID or IDs of one or more team challenges by which to filter the team registrations. -
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 TeamDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Delete a Team Definition

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-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /team-definitions/{teamDefinitionId}

Deletes a single team definition by ID. This operation also deletes team challenge outcomes, team outcomes, team availabilities, and team registrations for the team. Deleting a team definition when the team challenge is in progress affects the team challenge outcome because the team’s contribution is removed from the outcome.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Team Definition

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-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"2281caf2-4757-11ea-b77f-2e728ce88125","kind":"CONSUMER"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"2281caf2-4757-11ea-b77f-2e728ce88125","kind":"CONSUMER"}}

PUT /team-definitions/{teamDefinitionId}

Update a single team definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
teamDefinitionId path string true N/A The ID of the team definition. -
body body putTeamDefinitions true N/A No description -

Response Statuses

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

Retrieve a Single Team Definition

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-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
  "name": "Fitness Squad",
  "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "availableRegistrations": 5,
  "createdBy": {
    "id": "2281caf2-4757-11ea-b77f-2e728ce88125",
    "kind": "CONSUMER"
  }
}

GET /team-definitions/{teamDefinitionId}

Retrieves a single team definition by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Team 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-1.healtheintent.com/consumer-engagement/v1/team-registrations', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"6c235b5a-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"6c235b5a-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125"
}

POST /team-registrations

Creates a team registration using the specified parameters. Consumers can register to be in a team only if the team has registrations available and registration is still open for the team challenge.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Retrieve a List of Team 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-1.healtheintent.com/consumer-engagement/v1/team-registrations', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations?offset=0&limit=20"
}

GET /team-registrations

Retrieves a list of team registrations.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query array[string] false N/A The ID or IDs of one or more consumers whose team registrations are to be retrieved. -
teamChallengeId query array[string] false N/A The ID or IDs of one or more team challenges by which to filter the team registrations. -
teamId query array[string] false N/A The ID of the team. -
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 TeamRegistrations
401 Unauthorized Unauthorized Error

Delete a Team 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-1.healtheintent.com/consumer-engagement/v1/team-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /team-registrations/{teamRegistrationId}

Deletes a single team registration for a consumer by ID. Deleting a registration while the challenge is in progress removes the consumer’s contribution and changes the team’s total.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Retrieve a Single Team 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-1.healtheintent.com/consumer-engagement/v1/team-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125"
}

GET /team-registrations/{teamRegistrationId}

Retrieves a single team registration by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.healtheintent.com/consumer-engagement/v1/challenge-goals', headers: headers, body: {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","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-1.healtheintent.com/consumer-engagement/v1/challenge-goals \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Complete 150,000 steps in four weeks"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Walk 5000 steps every day to meet your goal"
    }
  ],
  "type": "STEPS",
  "value": 100000,
  "unit": "STEPS"
}

POST /challenge-goals

Creates a challenge goal using the specified parameters. A goal linked to an individual challenge is complete when the consumer reaches the value of the goal within the duration of the challenge. A goal linked to a team-based challenge is complete when the team’s total reaches the value of the goal within the duration of the team challenge.

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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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
type query array[string] false N/A One or more challenge goal types by which to filter results. -
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 Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update 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.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS"}

PUT /challenge-goals/{goalId}

Updates a challenge goal by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path integer(int32) true N/A No description -
body body putChallengeGoals true N/A No description -

Response Statuses

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

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-1.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-1.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": "Complete 150,000 steps in four weeks"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Walk 5000 steps every day to meet your goal"
    }
  ],
  "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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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. A category can be used to group challenges based on health categories. For example, you can create challenges with goals that target the nutrition or physical health of the consumer and then display a Nutrition or Physical Health challenge collection to the consumers.

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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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-1.healtheintent.com/consumer-engagement/v1/challenge-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
401 Unauthorized Unauthorized Error

Update 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-1.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-1.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
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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 Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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. A catalog provides a way to group and organize challenges together.

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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.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-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
401 Unauthorized Unauthorized Error

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-1.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-1.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
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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 Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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 ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.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": "90d80434-470d-11ea-b77f-2e728ce88125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "status": "ACTIVE"
}

POST /challenge-registrations

Creates a challenge registration using the specified parameters. If you created a team challenge, use the team-registrations resource to register consumers in a team.

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 ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

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-1.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-1.healtheintent.com/consumer-engagement/v1/challenge-registrations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "90d80434-470d-11ea-b77f-2e728ce88125",
      "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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
consumerId query array[string] false N/A The ID or IDs of one or more consumers whose challenge registrations are to be retrieved. -
challengeId query array[string] false N/A The ID or IDs of one or more challenges by which to filter the challenge registrations. -
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 ChallengeRegistrations
401 Unauthorized Unauthorized Error

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-1.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-1.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 of a consumer by ID. Deleting a registration while the challenge is in progress removes the consumer’s contribution and changes the team’s total.

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
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

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-1.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-1.healtheintent.com/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "90d80434-470d-11ea-b77f-2e728ce88125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "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 ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes', headers: headers, body: {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /challenge-outcomes

Creates an outcome for the consumer in the challenge using the specified data. The total is used to calculate the rank of a consumer compared to totals from other consumers in the challenge.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
409 Conflict Conflict Error

Retrieve a List of Challenge Outcomes

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-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes?offset=0&limit=20"
}

GET /challenge-outcomes

Retrieves a list of challenge outcomes. Outcomes by default are sorted by rank. Outcomes can be used for challenge leaderboards to compare how a particular consumer performed compared to all the other consumers participating in the challenge.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query string false N/A Filters the challenge outcomes by consumer ID. -
challengeId query string false N/A Filters the challenge outcomes by challenge ID. -
status query string false N/A Filters the challenge outcomes by the completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
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 ChallengeOutcomes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Delete a Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /challenge-outcomes/{challengeOutcomeId}

Deletes a single challenge outcome by ID. Deleting a challenge outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}

PUT /challenge-outcomes/{challengeOutcomeId}

Updates a single challenge outcome by ID using the specified data. Updating a challenge outcome does not immediately update the overall rankings.

Parameters

Parameter In Type Required Default Description Accepted Values
challengeOutcomeId path integer(int32) true N/A No description -
body body putChallengeOutcomes true N/A No description -

Response Statuses

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

Retrieve a Single Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /challenge-outcomes/{challengeOutcomeId}

Retrieves a single challenge outcome by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Team Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-outcomes', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000
}

POST /team-outcomes

Creates an outcome for the consumer in a team challenge using the specified data. The total is used to calculate the rank of a consumer compared to totals from the other consumers in the team.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcomeCreateResponse
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Retrieve a List of Team Outcomes

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-1.healtheintent.com/consumer-engagement/v1/team-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes?offset=0&limit=20"
}

GET /team-outcomes

Retrieves a list of team outcomes. Outcomes by default are sorted by rank. Outcomes can be used for team leaderboards to compare how a particular consumer performed compared to all the other consumers of the team participating in the challenge.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query array[string] false N/A Filters the team outcomes by consumer ID. -
teamChallengeId query array[string] false N/A Filters the team outcomes by team challenge ID. -
teamId query array[string] false N/A Filters the team outcomes by team ID. -
status query array[string] false N/A Filters the team outcomes by the completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
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 TeamOutcomes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Delete a Team Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /team-outcomes/{teamOutcomeId}

Deletes a single team outcome by ID. Deleting a team outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Team Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}

PUT /team-outcomes/{teamOutcomeId}

Updates a single team outcome by ID using the specified data. Updating a team outcome does not immediately update the overall rankings and status.

Parameters

Parameter In Type Required Default Description Accepted Values
teamOutcomeId path string true N/A The ID of the team outcome. -
body body putTeamOutcomes true N/A No description -

Response Statuses

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

Retrieve a Single Team Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /team-outcomes/{teamOutcomeId}

Retrieves a single team outcome by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcome
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Create a Team Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "total": 10000
}

POST /team-challenge-outcomes

Creates an outcome for the team in a team challenge using the specified data. The total is used to calculate the rank of a team compared to totals from other teams in a team challenge.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcomeCreateResponse
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Retrieve a List of Team Challenge Outcomes

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-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "average": 5000.5,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes?offset=0&limit=20"
}

GET /team-challenge-outcomes

Retrieves a list of team challenge outcomes. Outcomes by default are sorted by rank. Outcomes can be used for team challenge leaderboards to compare how a particular team performed compared to all the other teams participating in the team challenge.

Parameters

Parameter In Type Required Default Description Accepted Values
teamChallengeId query array[string] false N/A Filters the team challenge outcomes by team challenge ID. -
teamId query array[string] false N/A Filters the team challenge outcomes by team ID. -
status query array[string] false N/A Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE. -
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 TeamChallengeOutcomes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error

Delete a Team Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /team-challenge-outcomes/{teamChallengeOutcomeId}

Deletes a single team challenge outcome by ID. Deleting a team challenge outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Team Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}

PUT /team-challenge-outcomes/{teamChallengeOutcomeId}

Updates a single team challenge outcome by ID using the specified data. Updating a team challenge outcome does not immediately update the overall rankings.

Parameters

Parameter In Type Required Default Description Accepted Values
teamChallengeOutcomeId path string true N/A The ID of the team challenge outcome. -
body body putTeamChallengeOutcomes true N/A No description -

Response Statuses

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

Retrieve a Single Team Challenge Outcome

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-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "average": 5000.5,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /team-challenge-outcomes/{teamChallengeOutcomeId}

Retrieves a single team challenge outcome by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcome
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Schema Definitions

postEventLocations

Name Type Required Description Accepted Values
name string false The name of the location. -
names [object] false A list of localized names for the location. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
description string false The free-text description of the location. -
descriptions [object] false A list of localized free-text descriptions for the location. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
restrictedToCatalogs [object] false References to the catalogs in which the location is grouped. -
» id string true The ID of the catalog. -

ConsumerEngagementPublicApi_Entities_V1_Events_Location

Name Type Required Description Accepted Values
id string true The ID of the location. -
name string false The name of the location. -
description string false The free-text description of the location. -
names [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] true A list of localized names for the location. -
descriptions [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] false A list of localized free-text descriptions for the location. -
address ConsumerEngagementPublicApi_Entities_V1_Events_Address false The address of the venue where the event is being held. -
restrictedToCatalogs [ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference] false References to the catalogs in which the location is grouped. -

ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute

Name Type Required Description Accepted Values
locale string true The locale of the translated attribute. -
value string true The value of the translated attribute. -

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

ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference

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

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

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

Locations

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_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 false The name of the location. -
names [object] false A list of localized names for the location. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
description string false The free-text description of the location. -
descriptions [object] false A list of localized free-text descriptions for the location. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
restrictedToCatalogs [object] false References to the catalogs in which the location is grouped. -
» id string true The ID of the catalog. -

postEventCategories

Name Type Required Description Accepted Values
name string false The name of the category. -
names [object] false A list of localized names for the category. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
restrictedToCatalogs [object] false References to the catalogs in which the category is grouped. -
» id string true The ID of the catalog. -

ConsumerEngagementPublicApi_Entities_V1_Events_Category

Name Type Required Description Accepted Values
id string true The ID of the category. -
name string false The name of the category. -
names [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] true A list of localized names for the category. -
code ConsumerEngagementPublicApi_Entities_V1_Events_Code false The code of the category from a single, specified code system. -
restrictedToCatalogs [ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference] false References to the catalogs in which the category is grouped. -

ConsumerEngagementPublicApi_Entities_V1_Events_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 [ConsumerEngagementPublicApi_Entities_V1_Events_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 false The name of the category. -
names [object] false A list of localized names for the category. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
restrictedToCatalogs [object] false References to the catalogs in which the category is grouped. -
» id string true The ID of the catalog. -

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

ConsumerEngagementPublicApi_Entities_V1_Events_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 [ConsumerEngagementPublicApi_Entities_V1_Events_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 false 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. -
names [object] false A list of localized names for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
descriptions [object] false A list of localized free-text descriptions for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. EMAIL, PHONE, OTHER
»» 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. -
status string false The current status of the event. The following statuses are possible:
- ACTIVE: The event is active.
- CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.
ACTIVE, CANCELED
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. -
scopes [object] false A list of references to the scopes in which the event is grouped. -
» id string true The ID of the scope. -

ConsumerEngagementPublicApi_Entities_V1_Events_Event

Name Type Required Description Accepted Values
id string true The ID of the event. -
name string false 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. -
names [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] true A list of localized names for the event. -
descriptions [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] false A list of localized free-text descriptions for the event. -
leader ConsumerEngagementPublicApi_Entities_V1_Events_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 ConsumerEngagementPublicApi_Entities_V1_Events_Location true The location of the event. -
category ConsumerEngagementPublicApi_Entities_V1_Events_Category true The category of the event. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference] false References to the catalogs in which the event is grouped. -
series ConsumerEngagementPublicApi_Entities_V1_Events_SeriesReference false References to the series to which the event belongs. -
scopes [ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference] false A list of references to the scopes in which the event is grouped. -
status string false The current status of the event. The following statuses are possible:
- ACTIVE: The event is active.
- CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.
ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_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 [ConsumerEngagementPublicApi_Entities_V1_Events_Telecom] false The contact details of the person who is assigned as the leader of the event or series. -

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

ConsumerEngagementPublicApi_Entities_V1_Events_SeriesReference

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

ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference

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

Events

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_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 false 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. -
names [object] false A list of localized names for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
descriptions [object] false A list of localized free-text descriptions for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. EMAIL, PHONE, OTHER
»» 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. -
status string false The current status of the event. The following statuses are possible:
- ACTIVE: The event is active.
- CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.
ACTIVE, CANCELED
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. -
scopes [object] false A list of references to the scopes in which the event is grouped. -
» id string true The ID of the scope. -

postEventsEventidSlots

Name Type Required Description Accepted Values
description string false Additional details about the event slot that describe the session, schedule, and so on. -
descriptions [object] false A list of localized free-text descriptions for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
status string false The current status of the event slot. The following statuses are possible:
- ACTIVE: The event slot is active.
- CANCELED: The event slot is canceled.
ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_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. -
descriptions [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] false A list of localized free-text descriptions for the event. -
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. -
status string false The current status of the event slot. The following statuses are possible:
- ACTIVE: The event slot is active.
- CANCELED: The event slot is canceled.
ACTIVE, CANCELED

Slots

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_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. -
descriptions [object] false A list of localized free-text descriptions for the event. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. -
status string false The current status of the event slot. The following statuses are possible:
- ACTIVE: The event slot is active.
- CANCELED: The event slot is canceled.
ACTIVE, CANCELED

postEventSlots

Name Type Required Description Accepted Values
slots [object] true A grouping of event slots. -
» event object true The ID of the event. -
»» id string true The ID of the event. -
» descriptions [object] false A list of localized free-text descriptions for the slot. -
»» locale string true The locale of the translated attribute. -
»» value string true The value of the translated attribute. -
» 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. -
» status string false The current status of the event slot. The following statuses are possible:
- ACTIVE: The event slot is active.
- CANCELED: The event slot is canceled.
ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_EventSlotList

Name Type Required Description Accepted Values
slots [ConsumerEngagementPublicApi_Entities_V1_Events_EventSlot] true A grouping of event slots. -

ConsumerEngagementPublicApi_Entities_V1_Events_EventSlot

Name Type Required Description Accepted Values
id string true The ID of the event slot. -
event ConsumerEngagementPublicApi_Entities_V1_Events_SlotEventReference true The ID of the corresponding slot’s event. -
descriptions [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] false A list of localized free-text descriptions for the slot. -
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. -
status string false The current status of the event slot. The following statuses are possible:
- ACTIVE: The event slot is active.
- CANCELED: The event slot is canceled.
ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_SlotEventReference

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

postEventSeries

Name Type Required Description Accepted Values
name string false 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. -
names [object] false A list of localized names for the series. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
descriptions [object] false A list of localized free-text descriptions for the series. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. EMAIL, PHONE, OTHER
»» 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
status string false The current status of the series. The following statuses are possible:
- ACTIVE: The series is active.
- CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.
ACTIVE, CANCELED
catalogs [object] false References to the catalogs in which the series is grouped. -
» id string true The ID of the catalog. -
scopes [object] false A list of references to the scopes in which the series is grouped. -
» id string true The ID of the scope. -

ConsumerEngagementPublicApi_Entities_V1_Events_Series

Name Type Required Description Accepted Values
id string true The ID of the event series. -
name string false 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. -
names [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] true A list of localized names for the series. -
descriptions [ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute] false A list of localized free-text descriptions for the series. -
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 ConsumerEngagementPublicApi_Entities_V1_Events_Leader false Information about the individual who will provide guidance and instructions for the series. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference] false References to the catalogs in which the series is grouped. -
scopes [ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference] false A list of references to the scopes in which the series is grouped. -
status string false The current status of the series. The following statuses are possible:
- ACTIVE: The series is active.
- CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.
ACTIVE, CANCELED

Series

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_Series] 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. -

putEventSeries

Name Type Required Description Accepted Values
name string false 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. -
names [object] false A list of localized names for the series. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
descriptions [object] false A list of localized free-text descriptions for the series. -
» locale string true The locale of the translated attribute. -
» value string true The value of the translated attribute. -
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. EMAIL, PHONE, OTHER
»» 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
status string false The current status of the series. The following statuses are possible:
- ACTIVE: The series is active.
- CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.
ACTIVE, CANCELED
catalogs [object] false References to the catalogs in which the series is grouped. -
» id string true The ID of the catalog. -
scopes [object] false A list of references to the scopes in which the series is grouped. -
» id string true The ID of the scope. -

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

ConsumerEngagementPublicApi_Entities_V1_Events_Registration

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

ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerReference

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

ConsumerEngagementPublicApi_Entities_V1_Events_SlotReference

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

ConsumerEngagementPublicApi_Entities_V1_Events_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 [ConsumerEngagementPublicApi_Entities_V1_Events_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
attendances [object] true A list of Event attendances. -
» 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. -

ConsumerEngagementPublicApi_Entities_V1_Events_AttendanceList

Name Type Required Description Accepted Values
attendances [ConsumerEngagementPublicApi_Entities_V1_Events_Attendance] true A list of Event attendances. -

ConsumerEngagementPublicApi_Entities_V1_Events_Attendance

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

Attendances

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_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. -

postEventScopes

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

ConsumerEngagementPublicApi_Entities_V1_Events_Scope

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

Scopes

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Events_Scope] 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. -

putEventScopes

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

postLearningModules

Name Type Required Description Accepted Values
definitionId string true The definition ID of a learning module. -
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. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale] true The title of the learning module. -
description [ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale] false The description of the learning module. -
status string false The status of the learning module. The default value for a new learning module is DRAFT. DRAFT, PUBLISHED, RETIRED
imageUrl string false The image URL of the learning module. -
keywords [ConsumerEngagementPublicApi_Entities_V1_LearningModules_Keyword] false The keywords of the learning module. -
categories [string] false The categories of the learning module. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference] false The catalogs of the learning module. -
consumerGroups [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Keyword

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_ConsumerGroupReference

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

TranslatedModules

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 false 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] false The categories of the learning module. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference] false The catalogs of the learning module. -
consumerGroups [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -

postLearningModulesModuleidTasks

Name Type Required Description Accepted Values
title [object] true The title of the task. -
» 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 task for a given locale. -
description [object] false The description of the task. -
» 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 description of the task for a given locale. -
sourceReference object true The source reference ID and type in an external system, for example, an education library, questionnaire, or tracker. -
» id string true The source ID in an external system -
» kind string true The source type in an external system, for example, wellness#education and wellness#tracker. -
order integer(int32) true The task order of the learning module. -
weeksBeforeActive integer(int32) false The number of weeks from when the user enrolled before they can complete the task. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale] true The title of the task. -
description [ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale] false The description of the task. -
sourceReference string false The ID of the task in an external source system. -
order integer(int32) true The order of the tasks in the learning module. -
weeksBeforeActive integer(int32) false The number of weeks from when the user enrolled before they can complete the task. -
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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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
title [object] false The title of the task. -
» 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 task for a given locale. -
sourceReference object false The source reference ID and type in an external system, for example, an education library, questionnaire, or tracker. -
» id string true The source ID in an external system. -
» kind string true The source type in an external system, for example, wellness#education and wellness#tracker. -
order integer(int32) false The task order of the learning module. -
weeksBeforeActive integer(int32) false The number of weeks from when the user enrolled before they can complete the task. -
description [object] false The description of the task. -
» 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 description of the task for a given locale. -

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -
taskActivity string false The ID of the qualifying consumer activity in the source system, for example, a questionnaire response or quiz response. -
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. -
taskActivity object false A HealtheIntent consumer activity source ID. The maximum length is 36 characters. -
» id string true The source ID in an external system. -

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCategory

Name Type Required Description Accepted Values
id string true The ID of the category. -
title [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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. -

ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 [ConsumerEngagementPublicApi_Entities_V1_LearningModules_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 category. -
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. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_Challenge

Name Type Required Description Accepted Values
id string true The ID of the challenge. -
names ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation true A list of localized names for the challenge. -
descriptions ConsumerEngagementPublicApi_Entities_V1_Challenges_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 [ConsumerEngagementPublicApi_Entities_V1_Challenges_Category] true A list of categories to which the challenge belongs. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog] true A list of catalogs with which the challenge is associated. -
goals [ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal] true A list of goals for the challenge. -
tags [ConsumerEngagementPublicApi_Entities_V1_Challenges_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. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_Category

Name Type Required Description Accepted Values
id string true The ID of the challenge category. -
names ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation true A list of localized names for the challenge category. -
descriptions ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation false A list of localized descriptions for the challenge category. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog

Name Type Required Description Accepted Values
id string true The ID of the challenge catalog. -
names ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation true A list of localized names for the challenge catalog. -
descriptions ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation false A list of localized descriptions for the challenge catalog. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal

Name Type Required Description Accepted Values
id string true The ID of a challenge goal. -
names ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation true A list of localized names for the challenge goal. -
descriptions ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation false A list of localized descriptions for the challenge goal. -
type string true The type of the challenge. STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION
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

ConsumerEngagementPublicApi_Entities_V1_Challenges_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 [ConsumerEngagementPublicApi_Entities_V1_Challenges_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. -

putChallenges

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

postTeamChallenges

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. -
canConsumerCreateTeam boolean false Indicates whether or not consumers belonging to a Team Challenge are allowed to create their own team. Defaults to false if not passed -
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. -
maxTeamRegistrations integer(int32) false The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team. -
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 category. -
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. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge

Name Type Required Description Accepted Values
id string true The ID of the team challenge. -
names ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation true A list of localized names for the team challenge. -
descriptions ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation false A list of localized descriptions for the team challenge. -
imageURL string false The URL of the marketing image for the team challenge. -
startsAt string(date-time) true The start date and time for the team challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endsAt string(date-time) true The end date and time for the team 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 team 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 team challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
canConsumerCreateTeam boolean false Indicates whether or not consumers belonging to a Team Challenge are allowed to create their own team. Defaults to false if not passed -
timeZone string true The time zone used to configure the start and end times for the team challenge. This value matches a valid time zone in the IANA database. -
maxTeamRegistrations integer(int32) false The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team. -
categories [ConsumerEngagementPublicApi_Entities_V1_Challenges_Category] true A list of categories to which the team challenge belongs. -
catalogs [ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog] true A list of catalogs with which the team challenge is associated. -
goals [ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal] true A list of goals for the team challenge. -
tags [ConsumerEngagementPublicApi_Entities_V1_Challenges_Tag] true A list of tags associated with the team 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. -

TeamChallenges

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge] 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. -

putTeamChallenges

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. -
canConsumerCreateTeam boolean false Indicates whether or not consumers belonging to a Team Challenge are allowed to create their own team. Defaults to false if not passed -
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. -
maxTeamRegistrations integer(int32) false The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team. -
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 category. -
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. -

postTeamDefinitions

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
name string true The name of the team. -
description string false The description of the team to help other consumers join the team. -
imageUrl string false The URL of the marketing image for the challenge. -
createdBy object true The details of who created the team. -
» id string false The unique ID of the person who created the team. -
» kind string true The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition

Name Type Required Description Accepted Values
id string true The ID of the team definition. -
teamChallengeId string true The ID of the team challenge that this team belongs to. -
name string true The name of the team. -
description string false The description of the team to help other consumers join the team. -
imageURL string false The URL of the team image. -
availableRegistrations integer(int32) false The number of registrations available for this team. A value of null indicates that there is no limit for registrations and any number of consumers can register for this team. -
createdBy ConsumerEngagementPublicApi_Entities_V1_Challenges_CreatedBy true The details of the person who created the team. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_CreatedBy

Name Type Required Description Accepted Values
id string false The ID of the person who created the team. -
kind string true The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’. -

TeamDefinitions

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition] 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. -

putTeamDefinitions

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
name string true The name of the team. -
description string false The description of the team to help other consumers join the team. -
imageUrl string false The URL of the marketing image for the challenge. -
createdBy object true The details of who created the team. -
» id string false The unique ID of the person who created the team. -
» kind string true The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’. -

postTeamRegistrations

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
consumerId string true The ID of a consumer. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration

Name Type Required Description Accepted Values
id string true The ID of a team challenge registration. -
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
consumerId string true The ID of a consumer. -

TeamRegistrations

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration] 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. STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION
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 [ConsumerEngagementPublicApi_Entities_V1_Challenges_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. -

putChallengeGoals

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. STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION
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

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration

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

ChallengeRegistrations

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration] 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. -

postChallengeOutcomes

Name Type Required Description Accepted Values
challengeId string true The ID of a challenge. -
consumerId string true The ID of a consumer. -
total integer(int32) true The total amount of activity done by consumer in the challenge. For example, 100,000 steps or 300 minutes of physical activity. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome

Name Type Required Description Accepted Values
id string true The ID of a challenge outcome. -
challengeId string true The ID of a challenge. -
consumerId string true The ID of a consumer. -
total integer(int32) true The total amount of activity completed by a consumer during the challenge, for example, 100,000 steps or 300 minutes of physical activity. -
rank integer(int32) true The rank of a consumer among all the participants of the challenge, calculated based on the total value. The rank can be null if outcomes are not yet processed. -
status string true The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
unit string true The unit for the total amount of activity completed by the consumer in the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt string(date-time) true The date and time when the challenge outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data. -

ChallengeOutcomes

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome] 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. -

putChallengeOutcomes

Name Type Required Description Accepted Values
challengeId string true The ID of a challenge. -
consumerId string true The ID of a consumer. -
total integer(int32) true The total amount of activity done by consumer in the challenge. For example, 100,000 steps or 300 minutes of physical activity. -

postTeamOutcomes

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity. -
consumerId string true The ID of a consumer. -
status string false The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
unit string false The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcomeCreateResponse

Name Type Required Description Accepted Values
id string true The ID of a team outcome. -
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
consumerId string true The ID of a consumer. -
total integer(int32) true The total amount of activity completed by a consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity. -

TeamOutcomes

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcome] 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. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcome

Name Type Required Description Accepted Values
id string true The ID of a team outcome. -
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
consumerId string true The ID of a consumer. -
total integer(int32) true The total amount of activity completed by a consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity. -
rank integer(int32) true The rank of a consumer among all the participants of a team for a challenge. The rank can be null if outcomes are not yet processed. -
status string true The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
unit string true The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt string(date-time) true The date and time when the team outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data. -

putTeamOutcomes

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity. -
consumerId string true The ID of a consumer. -
status string false The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE. -
unit string false The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. -

postTeamChallengeOutcomes

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity. -
status string false Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE. -
unit string false The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. -
average number(float) false The average value calculated based on the total and the number of consumers on a team during a team challenge. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcomeCreateResponse

Name Type Required Description Accepted Values
id string true The ID of a team challenge outcome. -
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity. -

TeamChallengeOutcomes

Name Type Required Description Accepted Values
items [ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcome] 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. -

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcome

Name Type Required Description Accepted Values
id string true The ID of a team challenge outcome. -
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity. -
average number(float) true The average value calculated based on the total and the number of consumers on a team during a team challenge. -
rank integer(int32) true The rank of a team among all the teams in a team challenge, calculated based on the total value. The rank can be null if outcomes are not yet processed. -
status string true The completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE. -
unit string true The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt string(date-time) true The date and time when the team challenge outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data. -

putTeamChallengeOutcomes

Name Type Required Description Accepted Values
teamChallengeId string true The ID of a team challenge. -
teamId string true The ID of a team. -
total integer(int32) true The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity. -
status string false Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE. -
unit string false The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES. -
average number(float) false The average value calculated based on the total and the number of consumers on a team during a team challenge. -