createAndRegisterUser

Last modified on September 11, 2023 at 5:47 pm

This service creates a new user with your organization in the DigitalChalk system and registers that new user into the given course.

Request Elements

authSee above
emailAddressThe email address of the user to create
usernameThe email address of the user to create
firstNameThe first name of the user to create
lastNameThe last name of the user to create
passwordThe plaintext password of the user to create (this will be encrypted in the DigitalChalk system and will not be retrievable).
passwordResetPossible values are “true” or “false” (without the quotes). Indicate true if the user should reset his or her password when they login to the system.
licenseAgreedtrue/false, true if the digitalchalk license is agreed to
tagsThe space separated tags for the user. These can be used to filter who has access to register for an offering.
offeringIdThe unique identifier for the offering into which the user will be registered
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dcAPI="http://digitalchalk.com/api/v4">
  <soap:Body>
    <dcAPI:createAndRegisterUserRequest>
      <dcAPI:auth>
        <dcAPI:accessKey>?</dcAPI:accessKey>
        <dcAPI:timestamp>?</dcAPI:timestamp>
        <dcAPI:signature>?=</dcAPI:signature>
      </dcAPI:auth>
      <dcAPI:user>
        <dcAPI:emailAddress>?</dcAPI:emailAddress>
        <dcAPI:username>?</dcAPI:username>
        <dcAPI:firstName>?</dcAPI:firstName>
        <dcAPI:lastName>?</dcAPI:lastName>
        <dcAPI:licenseAgreed>?</dcAPI:licenseAgreed>
        <dcAPI:password>?</dcAPI:password>
        <dcAPI:passwordReset>?</dcAPI:passwordReset>
        <dcAPI:tags/>
      </dcAPI:user>
      <dcAPI:offeringId>?</dcAPI:offeringId>
    </dcAPI:createAndRegisterUserRequest>
  </soap:Body>
</soap:Envelope>

Response Elements

success
  • true if the user was registered successfully
  • false if not (although you will receive a soap fault with a more specific message in this case)
offeringIdThe unique identifier of the offering
offeringTitleThe title of the offering
studentRegistrationIdThe unique identifier of the student registration
studentUsernameThe username/email address of the registered user
studentNameThe full name of the registered user
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <dcAPI:createAndRegisterUserResponse xmlns:dcAPI="http://digitalchalk.com/api/v4">
      <dcAPI:studentUsername>?</dcAPI:studentUsername>
      <dcAPI:studentName>?</dcAPI:studentName>
      <dcAPI:studentRegistrationId>?</dcAPI:studentRegistrationId>
      <dcAPI:offeringId>?</dcAPI:offeringId>
      <dcAPI:offeringTitle>?</dcAPI:offeringTitle>
      <dcAPI:success>?</dcAPI:success>
    </dcAPI:createAndRegisterUserResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>