Enterprise Knowledge Platform API

EKP exposes some of its functionality via an Application Programming Interface (API). This document is both a reference for that functionality, and a tool that enables developers to learn about the API by invoking it interactively.

Table of Contents

  1. News Actions
    1. publicNews
    2. userNews
    3. article
  2. Learning Record and Enrollment Actions
    1. enrollments
    2. records
    3. trainingHistoryXml
    4. completedTrainingRecordsXml
    5. learningStatusesCsv
    6. learningStatusesPsv
    7. learningStatusesXls
    8. contentHandler/trainingHistoryCsv
    9. enrollmentHandler
  3. Learning Module Actions
    1. successfactorsLearningActivities
    2. successfactorsCompetencyMappings
    3. catalog
    4. module
    5. resourcesXml
    6. learningObjectsCsv
    7. learningObjects200405Csv
    8. learningObjectsPsv
    9. learningObjects200405Psv
    10. learningObjectsXls
    11. learningObjects200405Xls
  4. User Actions
    1. user200510Xml
    2. users200510Xml
    3. usersCsv
    4. csUsersCsv
    5. usersPsv
    6. csUsersPsv
    7. usersXls
    8. csUsersXls
    9. contentHandler/imsEnterprise
    10. contentHandler/usersCsv
    11. contentHandler/ekpXml
    12. contentHandler/userMergeXml
  5. Exam Actions
    1. exam

News Actions

publicNews

Returns a feed of public news articles. (That is, news articles that are configured to display on the login page.)

Authentication: Not required

URL: http://utest2.netdimensions.com/utest/api/publicNews

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
formatrssteasers for RSS 2.0 with teasers, rssfull for RSS 2.0 with full text, or atom for Atom 1.0.

Response Content Type: application/rss+xml, application/atom+xml

userNews

Returns a feed of news articles for a user.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/userNews

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdThe ID of a user. If this is not the ID of the authenticating user, then the authenticating user must have the Switch User permission. If unspecified, articles for the authenticating user are returned.
formatrssteasers for RSS 2.0 with teasers, rssfull for RSS 2.0 with full text, or atom for Atom 1.0.

Response Content Type: application/rss+xml, application/atom+xml

article

Returns an article as an Atom 1.0 entry.

Authentication: Not required

URL: http://utest2.netdimensions.com/utest/api/article

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
idThe ID of an article.

Response Content Type: application/atom+xml

Learning Record and Enrollment Actions

enrollments

Returns the active (incomplete) enrollments for a user.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/enrollments

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdSpecifies the ID of the user for whom to return the enrollments. If this is not the authenticating user, then the authenticating user must have the Switch User permission. If unspecified, enrollments for the authenticating user are returned.

Response Content Type: application/xml

records

Returns the training records for a user.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/records

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdSpecifies the ID of the user for whom to return the records. If this is not the authenticating user, then the authenticating user must have the Switch User permission. If unspecified, records for the authenticating user are returned.

Response Content Type: application/xml

trainingHistoryXml

Returns training records for the specified user (or for all users if userId is not specified) in XML format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/trainingHistoryXml

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdSpecifies the user whose training records will be returned
Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/xml

Response Schema: xsd/trainingHistory200510.xsd

completedTrainingRecordsXml

Returns training records for completed courses for the specified user (or for all users if userId is not specified) in XML format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/completedTrainingRecordsXml

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdSpecifies the user whose training records will be returned
Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/xml

Response Schema: xsd/trainingHistory200510.xsd

learningStatusesCsv

Returns information about all training records/transcripts in CSV (comma delimited) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningStatusesCsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningStatusesPsv

Returns information about all training records/transcripts in PSV (pipe delimited) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningStatusesPsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningStatusesXls

Returns information about all training records/transcripts in XLS (Microsoft Excel 97) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningStatusesXls

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/vnd.ms-excel

contentHandler/trainingHistoryCsv

This simple comma-delimited text (CSV) format allows training records to be added and modified. It can also be used to enroll users in existing courses.

For details, refer to the Training History Import/Export document (EN145_EKP_TrainingHistoryImportExport_V1.0.pdf).

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/contentHandler/trainingHistoryCsv

Method: POST

Request Content Type: text/plain

enrollmentHandler

Enables an external system to submit enrollment requests to EKP.

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/enrollmentHandler

Method: POST

Request Content Type: text/plain

Response Content Type: text/plain

Learning Module Actions

successfactorsLearningActivities

Returns information about programs and modules in SuccessFactors Learning Activity Import CSV format.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/successfactorsLearningActivities

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
catalogIdOptional. If specified, only programs and modules in the catalog with the corresponding ID are returned. If unspecified, all programs and modules are returned.
charsetSpecifies the character encoding of the returned data
guidDigitsSpecifies the number of digits in the GUID.
popupSpecifies whether activities should be launched in a pop-up window.
removeLineSeparatorsSpecifies whether to replace line separators with spaces in FIELD1 (the description).

Response Content Type: text/plain

successfactorsCompetencyMappings

Returns information about mappings of competencies to programs and modules in SuccessFactors Competency Mapping Import CSV format.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/successfactorsCompetencyMappings

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
catalogIdOptional. If specified, mapping information is returned only for programs and modules in the catalog with the corresponding ID. If unspecified, mapping information for all programs and modules is returned.
charsetSpecifies the character encoding of the returned data
guidDigitsSpecifies the number of digits in the GUID.

Response Content Type: text/plain

catalog

Returns information about a catalog in XML format. Includes information about the catalog's parent and children and the modules it contains.

Authentication: Not required

URL: http://utest2.netdimensions.com/utest/api/catalog

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdOptional. Specifies the ID of the user on whose behalf the information is being requested. This user's permissions will determine whether this catalog is accessible, and which subcatalogs, if any, are visible. If this is not the authenticating user, then the authenticating user must have the Switch User permission. If unspecified, permissions are determined based on the authenticating user. If the user is not authenticated then only public catalogs are returned.
idSpecifies the ID of the catalog to return (*ROOT* for the top-level catalog)

Response Content Type: application/xml

module

Returns information about a program or module in XML format. Includes information about the module or program's sessions, if any.

Authentication: Not required

URL: http://utest2.netdimensions.com/utest/api/module

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
idSpecifies the ID of the module to return

Response Content Type: application/xml

resourcesXml

Returns information about all learning modules in XML format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/resourcesXml

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/xml

Response Schema: xsd/resources.xsd

learningObjectsCsv

Returns information about all learning modules in CSV (comma delimited) format, suitable for import into early versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjectsCsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningObjects200405Csv

Returns information about all learning modules in CSV (comma delimited) format, suitable for import into recent versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjects200405Csv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningObjectsPsv

Returns information about all learning modules in PSV (pipe delimited) format, suitable for import into early versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjectsPsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningObjects200405Psv

Returns information about all learning modules in PSV (pipe delimited) format, suitable for import into recent versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjects200405Psv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

learningObjectsXls

Returns information about all learning modules in XLS (Microsoft Excel 97) format, suitable for import into early versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjectsXls

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/vnd.ms-excel

learningObjects200405Xls

Returns information about all learning modules in XLS (Microsoft Excel 97) format, suitable for import into recent versions of Exxceed CompetencySuite 5

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/learningObjects200405Xls

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/vnd.ms-excel

User Actions

user200510Xml

Returns information about a single user in XML format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/user200510Xml

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
userIdSpecifies the user about whom information will be returned

Response Content Type: application/xml

Response Schema: xsd/users200510.xsd

users200510Xml

Returns information about all users in XML format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/users200510Xml

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/xml

Response Schema: xsd/users200510.xsd

usersCsv

Returns information about all users in a generic CSV (comma delimited) format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/usersCsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

csUsersCsv

Returns information about all users in CSV (comma delimited) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/csUsersCsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

usersPsv

Returns information about all users in a generic PSV (pipe delimited) format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/usersPsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

csUsersPsv

Returns information about all users in PSV (pipe delimited) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/csUsersPsv

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
charsetSpecifies the character encoding of the returned data

Response Content Type: text/plain

usersXls

Returns information about all users in a generic XLS (Microsoft Excel 97) format

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/usersXls

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/vnd.ms-excel

csUsersXls

Returns information about all users in XLS (Microsoft Excel 97) format, suitable for import into Exxceed CompetencySuite

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/api/csUsersXls

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
(no parameters)

Response Content Type: application/vnd.ms-excel

contentHandler/imsEnterprise

Based on the IMS Enterprise Version 1.1 Final XML Binding specification, this format allows for addition, modification and deletion of users (including organization memberships and direct appraisers in addition to basic properties and contact details), and addition, modification and deletion of organizations.

For details, refer to the Specification for EKP User Management APIs document (EN035_Specification_for_EKP_User_Management_API_4.0.pdf).

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/contentHandler/imsEnterprise

Method: POST

Request Content Type: application/xml

Request Schema: dtd/ims_epv1p1.dtd

contentHandler/usersCsv

This comma-delimited text (CSV) format allows for the addition, modification and deletion of users. This is the same format used by the CSV User Data Loader.

For details, refer to the Data Uploading Guide (EN029_EKP_Data_Uploading_Guide_V1_5.pdf).

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/contentHandler/usersCsv

Method: POST

Request Content Type: text/plain

contentHandler/ekpXml

This XML format allows for the addition, modification and deletion of users and learning objects.

For details, refer to the Data Uploading Guide (EN029_EKP_Data_Uploading_Guide_V1_5.pdf).

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/contentHandler/ekpXml

Method: POST

Request Content Type: application/xml

contentHandler/userMergeXml

This XML format allows for the addition, modification and merge (create and migrate) of users

Authentication: System authentication

URL: http://utest2.netdimensions.com/utest/contentHandler/userMergeXml

Method: POST

Request Content Type: application/xml

Exam Actions

exam

Returns information about a survey or exam in XML format.

Authentication: User authentication

URL: http://utest2.netdimensions.com/utest/api/exam

Method: GET

Parameters:

Parameter NameParameter ValueParameter Description
idA valid ID of the survey or exam to return.

Response Content Type: application/xml