registerUser

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

This service registers an existing user into an offering on the DigitalChalk system.

Request Elements

authSee above
emailAddressThe email address of the user to register
offeringIdThe unique identifier for the offering into which the user will be
registeredResponseElements

<?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:registerUserRequest>
      <dcAPI:auth>
        <dcAPI:accessKey>?</dcAPI:accessKey>
        <dcAPI:timestamp>?</dcAPI:timestamp>
        <dcAPI:signature>?</dcAPI:signature>
      </dcAPI:auth>
      <dcAPI:username>?</dcAPI:username>
      <dcAPI:offeringId>?</dcAPI:offeringId>
    </dcAPI:registerUserRequest>
  </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:registerUserResponse 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:registerUserResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>