Education API v1
The HealtheIntent Education API allows systems to interact with education libraries and content. An education library can be integrated with a third-party education provider and can include custom HealtheIntent content.
URL: https://cernerdemo.api.us-1.healtheintent.com/education/v1
Education Content
Education content is made up of resources that exist in HealtheIntent and external systems and are intended to educate people on a topic.
Create an Education Content Item
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/education/v1/content', headers: headers, body: {"title":[{"text":"ACL Injury: Exercises To Do Before Treatment","locale":"en-US"}],"description":[{"text":"After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion\n and stability of the knee.","locale":"en-US"}],"sourceReference":"abq6161","sourceSystem":"healthwise","contentType":"article","categoryId":["11e8901dafad94f7a9b701d255a00ad0","31e8901dafad94f7a9b701d245a00ad9"],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/education/v1/content \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"ACL Injury: Exercises To Do Before Treatment","locale":"en-US"}],"description":[{"text":"After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion\n and stability of the knee.","locale":"en-US"}],"sourceReference":"abq6161","sourceSystem":"healthwise","contentType":"article","categoryId":["11e8901dafad94f7a9b701d255a00ad0","31e8901dafad94f7a9b701d245a00ad9"],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}
Example response
{
"contentId": "11e8901dafad94f7a9b701d255a00ad0",
"title": [
{
"locale": "en-US",
"text": "Preventive Health"
}
],
"description": [
{
"locale": "en-US",
"text": "After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion and stability\n of the knee. It is important that you regain your leg strength and motion as soon as possible,\n regardless of whether you choose to have surgery for your ACL injury."
}
],
"sourceReference": "abq6161",
"sourceSystem": "healthwise",
"categoryId": [
"19908363-9a1f-485d-a690-914fdbd7ee60",
"cdd189b6-6564-46ec-8193-96be480ccdd0"
],
"content": "<!DOCTYPE html><html xml:lang=en-us...</div></body></html>",
"contentData": {
"headHtml": "<link rel=\\\"stylesh....media=\\\"screen\\\" />",
"bodyHtml": "<div id=\\\"HwMain\\\"..../></a></div>",
"logo": "<div class=\\\"HwLogo\\\">..../></a></div>",
"disclaimer": "<div class=\\\"HwDisclaimer\\\"><p>...</p></div>",
"copyright": "<div class=\\\"HwCopyright\\\"><p>...</p></div>",
"mediaToken": "_d4843c2211f14796d9d2d306f5d7e7f3ee080e1c5e"
},
"contentType": "article",
"createdAt": "2018-12-15T12:23:12Z",
"updatedAt": "2018-05-15T12:23:12Z",
"consumerGroups": [
{
"id": "e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"
}
]
}
POST /content
Creates an education content item.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postContent | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created Education Content | Content |
400 | Bad Request | Bad Request. The education content 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 locales for the titles and descriptions must be unique.- missingTitle Title is required. Specify a title for the locale and description to continue.- categoryNotFound A specified category ID was not found. |
BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
Retrieve a List of Education Content Items
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/education/v1/content', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/education/v1/content \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"contentId": "11e8901dafad94f7a9b701d255a00ad0",
"title": [
{
"locale": "en-US",
"text": "Preventive Health"
}
],
"description": [
{
"locale": "en-US",
"text": "After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion and stability\n of the knee. It is important that you regain your leg strength and motion as soon as possible,\n regardless of whether you choose to have surgery for your ACL injury."
}
],
"sourceReference": "abq6161",
"sourceSystem": "healthwise",
"categoryId": [
"19908363-9a1f-485d-a690-914fdbd7ee60",
"cdd189b6-6564-46ec-8193-96be480ccdd0"
],
"contentType": "article",
"createdAt": "2018-12-15T12:23:12Z",
"updatedAt": "2018-05-15T12:23:12Z",
"consumerGroups": [
{
"id": "e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/education/v1/content?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/education/v1/content?offset=0&limit=20"
}
GET /content
Retrieves a list of education content items.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
contentId | query | array[string] | false | N/A | Filters the retrieved content by content IDs. | - |
searchTerms | query | string | false | N/A | Filters the retrieved content to that which contains specified text in the title, | - |
sourceReference | query | string | false | N/A | An ID or URL reference to education content in a source system | - |
contentType | query | string | false | N/A | Filters the retrieved content to only the specified type. | article, pdf, video |
categoryId | query | array[string] | false | N/A | Filters the retrieved content by category IDs. | - |
availableForConsumerGroup | query | array[string] | false | N/A | Filters by those available for the specified consumer group. | - |
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 | N/A | Filters the retrieved content by locale. | - |
orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | title |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ContentLists |
400 | Bad Request | Bad Request | BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
Delete an Education Content Item
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/education/v1/content/11e8902c9e2908c69718f13503066bee', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/education/v1/content/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /content/{contentId}
Deletes an education content item.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
contentId | path | string | true | N/A | The ID of the education content. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted Education Content | None |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
Update an Education Content Item
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/education/v1/content/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"title":[{"text":"ACL Injury: Exercises To Do Before Treatment","locale":"en-US"}],"description":[{"text":"After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion\n and stability of the knee.","locale":"en-US"}],"sourceReference":"abq6161","sourceSystem":"healthwise","contentType":"article","categoryId":["11e8901dafad94f7a9b701d255a00ad0","31e8901dafad94f7a9b701d245a00ad9"],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/education/v1/content/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"ACL Injury: Exercises To Do Before Treatment","locale":"en-US"}],"description":[{"text":"After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion\n and stability of the knee.","locale":"en-US"}],"sourceReference":"abq6161","sourceSystem":"healthwise","contentType":"article","categoryId":["11e8901dafad94f7a9b701d255a00ad0","31e8901dafad94f7a9b701d245a00ad9"],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}
PATCH /content/{contentId}
Updates an education content item. This is a PATCH request and not a PUT request as many HealtheIntent APIs use, and the updated resource replaces the previous version. See JSON Merge Patch on the Internet Engineering Task Force (IETF) website for more information about PATCH requests.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
contentId | path | string | true | N/A | The ID of the education content. | - |
body | body | patchContent | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated Education Content | 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.- duplicateLocale The locales for the titles and descriptions must be unique.- missingTitle Title is required. Specify a title for the locale and description to continue.- categoryNotFound A specified category ID was not found. |
BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
409 | Conflict | Conflict | Conflict |
Retrieve a Single Education Content Item
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/education/v1/content/11e8902c9e2908c69718f13503066bee', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/education/v1/content/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"contentId": "11e8901dafad94f7a9b701d255a00ad0",
"title": [
{
"locale": "en-US",
"text": "Preventive Health"
}
],
"description": [
{
"locale": "en-US",
"text": "After an anterior cruciate ligament (ACL) injury, you lose leg strength and motion and stability\n of the knee. It is important that you regain your leg strength and motion as soon as possible,\n regardless of whether you choose to have surgery for your ACL injury."
}
],
"sourceReference": "abq6161",
"sourceSystem": "healthwise",
"categoryId": [
"19908363-9a1f-485d-a690-914fdbd7ee60",
"cdd189b6-6564-46ec-8193-96be480ccdd0"
],
"content": "<!DOCTYPE html><html xml:lang=en-us...</div></body></html>",
"contentData": {
"headHtml": "<link rel=\\\"stylesh....media=\\\"screen\\\" />",
"bodyHtml": "<div id=\\\"HwMain\\\"..../></a></div>",
"logo": "<div class=\\\"HwLogo\\\">..../></a></div>",
"disclaimer": "<div class=\\\"HwDisclaimer\\\"><p>...</p></div>",
"copyright": "<div class=\\\"HwCopyright\\\"><p>...</p></div>",
"mediaToken": "_d4843c2211f14796d9d2d306f5d7e7f3ee080e1c5e"
},
"contentType": "article",
"createdAt": "2018-12-15T12:23:12Z",
"updatedAt": "2018-05-15T12:23:12Z",
"consumerGroups": [
{
"id": "e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"
}
]
}
GET /content/{contentId}
Retrieves a single education content item by ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
locale | query | string | false | N/A | Filters the retrieved content by locale. | - |
contentId | path | string | true | N/A | The ID of the education content. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Content |
400 | Bad Request | Bad Request | BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | ETag | string | The ETag of the retrieved content. |
Categories
Categories are groups of education content items, for example, education content that is part of a Cerner learning module or a third-party system.
Create an Education 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/education/v1/categories', headers: headers, body: {"title":[{"text":"Preventive Health","locale":"en-US"}],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"Preventive Health","locale":"en-US"}],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}
Example response
{
"categoryId": "11e8901dafad94f7a9b701d255a00ad0",
"title": [
{
"locale": "en-US",
"text": "Preventive Health"
}
],
"createdAt": "2018-12-15T12:23:12Z",
"updatedAt": "2018-05-15T12:23:12Z",
"consumerGroups": [
{
"id": "e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"
}
]
}
POST /categories
Creates an education category.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postCategories | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | No Content | Category |
400 | Bad Request | Bad Request. The category 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 if it is used in the body.- duplicateLocale The locales for the titles must be unique.- missingField Review and complete all required information to continue. |
BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
Retrieve a List of Education 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/education/v1/categories', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"categoryId": "11e8901dafad94f7a9b701d255a00ad0",
"title": [
{
"locale": "en-US",
"text": "Preventive Health"
}
],
"createdAt": "2018-12-15T12:23:12Z",
"updatedAt": "2018-05-15T12:23:12Z",
"consumerGroups": [
{
"id": "e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories?offset=0&limit=20"
}
GET /categories
Retrieves a list of education categories.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
locale | query | string | false | N/A | Filters modules by locale. If no locale is specified, all the available | - |
availableForConsumerGroup | query | array[string] | false | N/A | Filters by those available for the specified consumer group. | - |
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 | OK | CategoryLists |
400 | Bad Request | Bad Request | BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
Delete an Education 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/education/v1/categories/21e8902c9e2908c69718f13503065be7', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories/21e8902c9e2908c69718f13503065be7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /categories/{categoryId}
Deletes an education category.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
categoryId | path | string | true | N/A | The ID of a category. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
Update an Education Category
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'If-Match' => {
"type": "string"
}
}
result = HTTParty.patch('https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories/21e8902c9e2908c69718f13503065be7', headers: headers, body: {"title":[{"text":"Preventive Health","locale":"en-US"}],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories/21e8902c9e2908c69718f13503065be7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"title":[{"text":"Preventive Health","locale":"en-US"}],"consumerGroups":[{"id":"e1a6fac2-f3c6-11e9-81b4-2a2ae2dbcce4"}]}
PATCH /categories/{categoryId}
Updates an education category. This is a PATCH request and not a PUT request as many HealtheIntent APIs use, and the updated resource replaces the previous version. See JSON Merge Patch on the Internet Engineering Task Force (IETF) website for more information about PATCH requests.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
If-Match | header | string | true | N/A | The ETag for a specific version of a resource. If a user | - |
categoryId | path | string | true | N/A | The ID of a category. | - |
body | body | patchCategories | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request. The category 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 must be unique.- missingField Review and complete all required information to continue. |
BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
409 | Conflict | Conflict | Conflict |
Retrieve a Single Education 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/education/v1/categories/21e8902c9e2908c69718f13503065be7', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/education/v1/categories/21e8902c9e2908c69718f13503065be7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /categories/{categoryId}
Retrieves a single education category.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
categoryId | path | string | true | N/A | The ID of a category. | - |
locale | query | string | false | N/A | Filters modules by locale. If no locale is specified, all the available | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Category |
400 | Bad Request | Bad Request | BadRequest |
401 | Unauthorized | Unauthorized | Unauthorized |
403 | Forbidden | Forbidden | Forbidden |
404 | Not Found | Not Found | NotFound |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | ETag | string | The entity tag (ETag) of the retrieved category. |
Schema Definitions
postContent
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
title | [object] | true | A list of titles for the locales. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the World Wide Web Consortium (W3C) website. | - |
» text | string | true | The title of the education content for the specified locale. The maximum length is 191 characters. | - |
description | [object] | false | The description of the education content. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the W3C website. | - |
» text | string | true | The descriptions of the education content for the specified locale. The maximum length is 65,535 characters. | - |
sourceReference | string | true | An ID or URL reference to education content in a source system outside of HealtheIntent. The maximum length is 191 characters. | - |
sourceSystem | string | false | The source system of the education content. The maximum length is 191 characters. | - |
contentType | string | true | The type of the education content. | article, pdf, video |
categoryId | [string] | false | A list of category IDs for the education content. | - |
consumerGroups | [object] | false | Reference to the consumer groups which the education content is created for. | - |
» id | string | true | The ID of the consumer group. | - |
Content
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
contentId | string | true | The unique ID of the education content. | - |
title | [Locale] | true | The title of the education content. | - |
description | [Locale] | false | A brief description of the content. | - |
sourceReference | string | true | An ID or URL reference to education content in a source system. | - |
sourceSystem | string | false | The source system of the education content. | - |
categoryId | [string] | false | The category IDs of the education content. | - |
content | string | false | The content or link to the content of an education item. Note: This field is deprecated; use the contentData field instead. | - |
contentData | string | false | The content data of the education content. Note: This field replaces the content field. | - |
contentType | string | true | The type of the education content. | article, pdf, video |
createdAt | string(date-time) | false | The date and time when the content was created, in International Organization for Standardization (ISO) 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
updatedAt | string | false | The date and time when the content was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
consumerGroups | [ConsumerGroup] | false | Reference to the consumer groups for which the education content is created. | - |
Locale
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
locale | string | true | The locale. | - |
text | string | true | The text for the locale. | - |
ConsumerGroup
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the consumer group. | - |
Unauthorized
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 | [string] | false | A list of additional error details. | - |
Forbidden
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 | [string] | false | A list of additional error details. | - |
BadRequest
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 | [string] | false | A list of additional error details. | - |
ContentLists
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [ContentList] | 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. | - |
ContentList
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
contentId | string | true | The unique ID of the education content. | - |
title | [string] | true | The title of the education content. | - |
description | [string] | false | A brief description of the content. | - |
sourceReference | string | true | An ID or URL reference to education content in a source system. | - |
sourceSystem | string | false | The source system of the education content. | - |
categoryId | [string] | false | The category IDs of the education content. | - |
contentType | string | true | The type of the education content. | article, pdf, video |
createdAt | string(date-time) | false | The date and time when the content was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
updatedAt | string | false | The date and time when the content was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
consumerGroups | [ConsumerGroup] | false | Reference to the consumer groups for which the education content is created. | - |
NotFound
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 | [string] | false | A list of additional error details. | - |
patchContent
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
title | [object] | false | A list of titles for locales. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the W3C website. | - |
» text | string | true | The title of the education content for the specified locale. The maximum length is 191 characters. | - |
description | [object] | false | The description of the education content. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the W3C website. | - |
» text | string | true | The descriptions of the education content for the specified locale. The maximum length is 65,535 characters. | - |
sourceReference | string | false | An ID or URL reference to education content in a source system. The maximum length is 191 characters. | - |
sourceSystem | string | false | The source system of the education content. The maximum length is 191 characters. | - |
contentType | string | false | The type of the education content. | article, pdf, video |
categoryId | [string] | false | A list of category IDs for the education content. | - |
consumerGroups | [object] | false | Reference to the consumer groups for which the education content is created. | - |
» id | string | true | The ID of the consumer group. | - |
Conflict
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 | [string] | false | A list of additional error details. | - |
postCategories
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
title | [object] | true | The title of the category in a different locale. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the World Wide Web Consortium (W3C) website. | - |
» text | string | true | The title of the category for the specified locale. The maximum length is 191 characters. | - |
consumerGroups | [object] | false | Reference to the consumer groups which the education content category is created for. | - |
» id | string | true | The ID of the consumer group. | - |
Category
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
categoryId | string | true | The ID of the category. | - |
title | [Locale] | true | The title of the education category. | - |
createdAt | string(date-time) | false | The date and time when the category was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
updatedAt | string | false | The date and time when the category was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
consumerGroups | [ConsumerGroup] | false | Reference to the consumer groups for which the education content category is created. | - |
CategoryLists
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [CategoryList] | 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. | - |
CategoryList
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
categoryId | string | true | The ID of the category. | - |
title | [string] | true | The title of the education category. | - |
createdAt | string(date-time) | false | The date and time when the category was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
updatedAt | string | false | The date and time when the category was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. | - |
consumerGroups | [ConsumerGroup] | false | Reference to the consumer groups for which the education content category is created. | - |
patchCategories
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
title | [object] | false | The title of the category in a different locale. | - |
» locale | string | true | The locale. Locales should be defined as described on the Language Tags in HTML and XML page on the W3C website. | - |
» text | string | true | The title of the category for the specified locale. The maximum length is 191 characters. | - |
consumerGroups | [object] | false | Reference to the consumer groups for which the education content category is created. | - |
» id | string | true | The ID of the consumer group. | - |