Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The /1/learner endpoint provides for the creation of new learners.

...

Info
titleRequired Headers


KeyValueExample
User-Agentdmtd-rest-api
Acceptapplication/json
AuthorizationBearer <your token>Bearer wV1MLk5+sFzioJw/3M5r9A==
Content-Typeapplication/json


...

Info
titleFields


FieldTypeOptionalDescription
codeStringOptionalA unique code that correlates the student to an external database and/or obfuscates the student's name (maximum length 191 chars); correlates to X-LearnerCode
colorStringOptionalA CSS color to associate with the client (e.g. #ffffff)
dateOfBirthDateRequiredThe date of birth for the learner
firstNameStringOptional
lastNameStringOptional
genderIntegerOptional1 = male, 2 = female
isActiveBoolOptionalA flag that indicates whether the learner is being actively assessed (default = true)


...