Last modified on October 21, 2013 at 5:53 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
auth | See above |
emailAddress | The email address of the user to create |
username | The email address of the user to create |
firstName | The first name of the user to create |
lastName | The last name of the user to create |
password | The plaintext password of the user to create (this will be encrypted in the DigitalChalk system and will not be retrievable). |
passwordReset | Possible 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. |
licenseAgreed | true/false, true if the digitalchalk license is agreed to |
tags | The space separated tags for the user. These can be used to filter who has access to register for an offering. |
offeringId | The 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>
Response Elements
success |
|
offeringId | The unique identifier of the offering |
offeringTitle | The title of the offering |
studentRegistrationId | The unique identifier of the student registration |
studentUsername | The username/email address of the registered user |
studentName | The 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>