elapi Web Service

elapi

Click here for a complete list of operations.

CreateUser9

Create a user account. User may be assigned to a particular hierarchy level. Includes entering Skills Checklist, Competency Tracker Reporter, Training Plan Enrollment and Module Enrollment Manager permissions. Includes Comparison Group

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
authorizationId:
passcode:
organizationId:
globalUniqueId:
firstName:
lastName:
userName:
password:
email:
administrator:
instructor:
learner:
UserSupervisor:
EnrollmentSupervisor:
ReportSupervisor:
SkillsCheckListObserver:
SkillsCheckListDataEntry:
CompetencyTrackerReporter:
HierarchyID:
HireDate:
TerminationDate:
DateOfBirth:
learnerID:
organization:
jobTitle:
department:
phone:
fax:
address:
address2:
city:
state:
country:
zip:
comments:
clientDrive:
nickname:
photoIcon:
cellPhone:
blogUniformResourceLocator:
userResume:
resumeAttach:
education:
experience:
reflections:
languagePreference:
Active:
location:
udf1:
udf2:
udf3:
userCategory:
employmentType:
whitelistExempt:
Restricted:
RequirePasswordChangeOnNextLogin:
Gender:
Ethnicity:
WarningEmailNotificationRecipient:
additionalHierarchyIds:
comparisonGroup:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/elapi.asmx HTTP/1.1
Host: training.reliaslearning.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "WebServices/elapi.asmx/CreateUser9"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateUser9 xmlns="WebServices/elapi.asmx">
      <authorizationId>string</authorizationId>
      <passcode>string</passcode>
      <organizationId>string</organizationId>
      <globalUniqueId>string</globalUniqueId>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <userName>string</userName>
      <password>string</password>
      <email>string</email>
      <administrator>int</administrator>
      <instructor>int</instructor>
      <learner>int</learner>
      <UserSupervisor>int</UserSupervisor>
      <EnrollmentSupervisor>int</EnrollmentSupervisor>
      <ReportSupervisor>int</ReportSupervisor>
      <SkillsCheckListObserver>int</SkillsCheckListObserver>
      <SkillsCheckListDataEntry>int</SkillsCheckListDataEntry>
      <CompetencyTrackerReporter>int</CompetencyTrackerReporter>
      <HierarchyID>string</HierarchyID>
      <HireDate>string</HireDate>
      <TerminationDate>string</TerminationDate>
      <DateOfBirth>string</DateOfBirth>
      <learnerID>string</learnerID>
      <organization>string</organization>
      <jobTitle>string</jobTitle>
      <department>string</department>
      <phone>string</phone>
      <fax>string</fax>
      <address>string</address>
      <address2>string</address2>
      <city>string</city>
      <state>string</state>
      <country>string</country>
      <zip>string</zip>
      <comments>string</comments>
      <clientDrive>string</clientDrive>
      <nickname>string</nickname>
      <photoIcon>string</photoIcon>
      <cellPhone>string</cellPhone>
      <blogUniformResourceLocator>string</blogUniformResourceLocator>
      <userResume>string</userResume>
      <resumeAttach>string</resumeAttach>
      <education>string</education>
      <experience>string</experience>
      <reflections>string</reflections>
      <languagePreference>string</languagePreference>
      <Active>string</Active>
      <location>string</location>
      <udf1>string</udf1>
      <udf2>string</udf2>
      <udf3>string</udf3>
      <userCategory>string</userCategory>
      <employmentType>string</employmentType>
      <whitelistExempt>string</whitelistExempt>
      <Restricted>string</Restricted>
      <RequirePasswordChangeOnNextLogin>string</RequirePasswordChangeOnNextLogin>
      <Gender>string</Gender>
      <Ethnicity>string</Ethnicity>
      <WarningEmailNotificationRecipient>string</WarningEmailNotificationRecipient>
      <additionalHierarchyIds>string</additionalHierarchyIds>
      <comparisonGroup>string</comparisonGroup>
    </CreateUser9>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateUser9Response xmlns="WebServices/elapi.asmx">
      <CreateUser9Result>int</CreateUser9Result>
    </CreateUser9Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/elapi.asmx HTTP/1.1
Host: training.reliaslearning.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateUser9 xmlns="WebServices/elapi.asmx">
      <authorizationId>string</authorizationId>
      <passcode>string</passcode>
      <organizationId>string</organizationId>
      <globalUniqueId>string</globalUniqueId>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <userName>string</userName>
      <password>string</password>
      <email>string</email>
      <administrator>int</administrator>
      <instructor>int</instructor>
      <learner>int</learner>
      <UserSupervisor>int</UserSupervisor>
      <EnrollmentSupervisor>int</EnrollmentSupervisor>
      <ReportSupervisor>int</ReportSupervisor>
      <SkillsCheckListObserver>int</SkillsCheckListObserver>
      <SkillsCheckListDataEntry>int</SkillsCheckListDataEntry>
      <CompetencyTrackerReporter>int</CompetencyTrackerReporter>
      <HierarchyID>string</HierarchyID>
      <HireDate>string</HireDate>
      <TerminationDate>string</TerminationDate>
      <DateOfBirth>string</DateOfBirth>
      <learnerID>string</learnerID>
      <organization>string</organization>
      <jobTitle>string</jobTitle>
      <department>string</department>
      <phone>string</phone>
      <fax>string</fax>
      <address>string</address>
      <address2>string</address2>
      <city>string</city>
      <state>string</state>
      <country>string</country>
      <zip>string</zip>
      <comments>string</comments>
      <clientDrive>string</clientDrive>
      <nickname>string</nickname>
      <photoIcon>string</photoIcon>
      <cellPhone>string</cellPhone>
      <blogUniformResourceLocator>string</blogUniformResourceLocator>
      <userResume>string</userResume>
      <resumeAttach>string</resumeAttach>
      <education>string</education>
      <experience>string</experience>
      <reflections>string</reflections>
      <languagePreference>string</languagePreference>
      <Active>string</Active>
      <location>string</location>
      <udf1>string</udf1>
      <udf2>string</udf2>
      <udf3>string</udf3>
      <userCategory>string</userCategory>
      <employmentType>string</employmentType>
      <whitelistExempt>string</whitelistExempt>
      <Restricted>string</Restricted>
      <RequirePasswordChangeOnNextLogin>string</RequirePasswordChangeOnNextLogin>
      <Gender>string</Gender>
      <Ethnicity>string</Ethnicity>
      <WarningEmailNotificationRecipient>string</WarningEmailNotificationRecipient>
      <additionalHierarchyIds>string</additionalHierarchyIds>
      <comparisonGroup>string</comparisonGroup>
    </CreateUser9>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateUser9Response xmlns="WebServices/elapi.asmx">
      <CreateUser9Result>int</CreateUser9Result>
    </CreateUser9Response>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /webservices/elapi.asmx/CreateUser9?authorizationId=string&passcode=string&organizationId=string&globalUniqueId=string&firstName=string&lastName=string&userName=string&password=string&email=string&administrator=string&instructor=string&learner=string&UserSupervisor=string&EnrollmentSupervisor=string&ReportSupervisor=string&SkillsCheckListObserver=string&SkillsCheckListDataEntry=string&CompetencyTrackerReporter=string&HierarchyID=string&HireDate=string&TerminationDate=string&DateOfBirth=string&learnerID=string&organization=string&jobTitle=string&department=string&phone=string&fax=string&address=string&address2=string&city=string&state=string&country=string&zip=string&comments=string&clientDrive=string&nickname=string&photoIcon=string&cellPhone=string&blogUniformResourceLocator=string&userResume=string&resumeAttach=string&education=string&experience=string&reflections=string&languagePreference=string&Active=string&location=string&udf1=string&udf2=string&udf3=string&userCategory=string&employmentType=string&whitelistExempt=string&Restricted=string&RequirePasswordChangeOnNextLogin=string&Gender=string&Ethnicity=string&WarningEmailNotificationRecipient=string&additionalHierarchyIds=string&comparisonGroup=string HTTP/1.1
Host: training.reliaslearning.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="WebServices/elapi.asmx">int</int>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/elapi.asmx/CreateUser9 HTTP/1.1
Host: training.reliaslearning.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authorizationId=string&passcode=string&organizationId=string&globalUniqueId=string&firstName=string&lastName=string&userName=string&password=string&email=string&administrator=string&instructor=string&learner=string&UserSupervisor=string&EnrollmentSupervisor=string&ReportSupervisor=string&SkillsCheckListObserver=string&SkillsCheckListDataEntry=string&CompetencyTrackerReporter=string&HierarchyID=string&HireDate=string&TerminationDate=string&DateOfBirth=string&learnerID=string&organization=string&jobTitle=string&department=string&phone=string&fax=string&address=string&address2=string&city=string&state=string&country=string&zip=string&comments=string&clientDrive=string&nickname=string&photoIcon=string&cellPhone=string&blogUniformResourceLocator=string&userResume=string&resumeAttach=string&education=string&experience=string&reflections=string&languagePreference=string&Active=string&location=string&udf1=string&udf2=string&udf3=string&userCategory=string&employmentType=string&whitelistExempt=string&Restricted=string&RequirePasswordChangeOnNextLogin=string&Gender=string&Ethnicity=string&WarningEmailNotificationRecipient=string&additionalHierarchyIds=string&comparisonGroup=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="WebServices/elapi.asmx">int</int>