Data Integration eSSentials - eLogic Learning€¦ · • Event Roster – This provides the ability to return a list of all users registered for a specific event including any information

eSSential LMS v10 Web Service API – 2017_v3

1 eLogic Learning Proprietary and Confidential © 2017

Data Integration eSSentials

Contents Introduction .................................................................................................................................................. 5

Overview ................................................................................................................................................... 5

Security ..................................................................................................................................................... 6

Create the “WebService” Role .............................................................................................................. 6

Web Service URL ................................................................................................................................... 8

User Record Management (RegisterUserInTheLMS) .................................................................................... 9

Description: ............................................................................................................................................... 9

Inputs: ....................................................................................................................................................... 9

Response: ................................................................................................................................................ 12

SOAP 1.1 .................................................................................................................................................. 12

SOAP 1.2 .................................................................................................................................................. 14

End User Attribute ...................................................................................................................................... 17

Description .............................................................................................................................................. 17

Inputs: ..................................................................................................................................................... 17

Response: ................................................................................................................................................ 17

SOAP 1.1 .................................................................................................................................................. 18

SOAP 1.2 .................................................................................................................................................. 19

User Role ..................................................................................................................................................... 21

Description .............................................................................................................................................. 21

Inputs: ..................................................................................................................................................... 21

Response: ................................................................................................................................................ 21

SOAP 1.1 .................................................................................................................................................. 22

SOAP 1.2 .................................................................................................................................................. 23

Organizational Unit ..................................................................................................................................... 25

Description .............................................................................................................................................. 25

Inputs: ..................................................................................................................................................... 25

Response: ................................................................................................................................................ 26

SOAP 1.1 .................................................................................................................................................. 27



SOAP 1.2 .................................................................................................................................................. 29

Organizational Unit Manager ...................................................................................................................... 31

Description .............................................................................................................................................. 31

Inputs: ..................................................................................................................................................... 31

Response: ................................................................................................................................................ 31

SOAP 1.1 .................................................................................................................................................. 32

SOAP 1.2 .................................................................................................................................................. 33

Return Registrations for User ..................................................................................................................... 35

Description: ............................................................................................................................................. 35

Inputs: ..................................................................................................................................................... 35

Response: ................................................................................................................................................ 35

SOAP 1.1 .................................................................................................................................................. 36

SOAP 1.2 .................................................................................................................................................. 37

Register User for Curricula .......................................................................................................................... 38

Description: ............................................................................................................................................. 38

Inputs: ..................................................................................................................................................... 38

Response: ................................................................................................................................................ 40

SOAP 1.1 .................................................................................................................................................. 40

SOAP 1.2 .................................................................................................................................................. 41

Event Roster (Return Registration Data) .................................................................................................... 44

Description: ............................................................................................................................................. 44

Inputs: ..................................................................................................................................................... 44

Response: ................................................................................................................................................ 44

SOAP 1.1 .................................................................................................................................................. 45

SOAP 1.2 .................................................................................................................................................. 45

Mark Attendance for User .......................................................................................................................... 47

Description .............................................................................................................................................. 47

Inputs: ..................................................................................................................................................... 47

Response: ................................................................................................................................................ 47

SOAP 1.1 .................................................................................................................................................. 48

SOAP 1.2 .................................................................................................................................................. 49

Catalog ........................................................................................................................................................ 50



Description: ............................................................................................................................................. 50

Inputs: ..................................................................................................................................................... 50

Response: ................................................................................................................................................ 50

SOAP 1.1 .................................................................................................................................................. 51

SOAP 1.2 .................................................................................................................................................. 52

Return Detailed Curriculum Information .................................................................................................... 53

Description: ............................................................................................................................................. 53

Inputs: ..................................................................................................................................................... 53

Response: ................................................................................................................................................ 53

SOAP 1.1 .................................................................................................................................................. 56

SOAP 1.2 .................................................................................................................................................. 56

Return Transcript Data ................................................................................................................................ 58

Description: ............................................................................................................................................. 58

Inputs: ..................................................................................................................................................... 58

Response: ................................................................................................................................................ 58

SOAP 1.1 .................................................................................................................................................. 59

SOAP 1.2 .................................................................................................................................................. 59

Retrieve Transcript ...................................................................................................................................... 61

Description: ............................................................................................................................................. 61

Inputs: ..................................................................................................................................................... 61

Response: ................................................................................................................................................ 61

SOAP 1.1 .................................................................................................................................................. 62

SOAP 1.2 .................................................................................................................................................. 62

User License ................................................................................................................................................ 64

Description: ............................................................................................................................................. 64

Inputs: ..................................................................................................................................................... 64

Response: ................................................................................................................................................ 64

SOAP 1.1 .................................................................................................................................................. 65

SOAP 1.2 .................................................................................................................................................. 66

EventDetail .................................................................................................................................................. 68

Description: ............................................................................................................................................. 68

Inputs: ..................................................................................................................................................... 68



Response: ................................................................................................................................................ 68

SOAP 1.1 .............................................................................................................................................. 70

SOAP 1.2 .............................................................................................................................................. 71

CouponAddEdit ........................................................................................................................................... 73

Description: ............................................................................................................................................. 73

Inputs: ..................................................................................................................................................... 73

Response: ................................................................................................................................................ 75

SOAP 1.1 .............................................................................................................................................. 75

SOAP 1.2 .............................................................................................................................................. 77

CouponRedemption .................................................................................................................................... 79

Description: ............................................................................................................................................. 79

Inputs: ..................................................................................................................................................... 79

Response: ................................................................................................................................................ 79

SOAP 1.1 .............................................................................................................................................. 80

SOAP 1.2 .............................................................................................................................................. 81



Introduction

Overview The eSSential web service API provides the ability for a client to integrate the eSSential platform into

their application and or corporate portal. It enables the client the ability to both insert and extract data

from the application. This can allow clients to build a web application around the LMS for a more

complete integration. The following is a description of each web service currently available:

• User Record Management – This provides the ability to add and edit user account records in the

LMS.

• Return Registrations for User – This provides the ability to return a list of all current registrations

for a specific user.

• Register User for Curricula – This provides the ability to register a user for a specific curriculum

item in the LMS.

• Event Roster – This provides the ability to return a list of all users registered for a specific event

including any information already marked on the Manage Registrant page (score, status, hours,

etc.)

• Mark Attendance for User – This will likely be used in combination with the Event Roster web

method. This provides the ability to mark attendance for a user in a single day event.

• Catalog – This will return a list of all curricula in the LMS or a list of curricula available to a

specific user.

• Return Detailed Curriculum Information – This provides curriculum detail information for a

specific curriculum item.

• Return Transcript Data – This will return curriculum transcript data for a specific user

(completed courses, training sessions, learning paths, and external training).

• End User Attribute – This will insert, update and/or remove attributes from a user’s profile.

• Organization – This will insert and update organizational units for the organizational hierarchy

• Organization Unit Manager – This will insert or remove unit managers from organizational units.

By utilizing standard SOAP calls the client can obtain the data and then display or use it to create other

functions within their own application.



Security The Web Service user account will be managed by your organization. The account that will be used for

authentication into the API calls will need to be assigned to the Role of “Web Service”. By default the

Role of “Web Service” does not exist so it will have to be created so that users can be assigned that role.

Create the “WebService” Role

Sign into eSSential using a “Site Administrator” user account. Under the “Users” menu item in the

Administrator toolbar, select “Role Management.

Click the Search button to ensure that there is not a role called “WebService” (IMPORTANT… No space

between the two words).

Once confirmed, click the “Add Role” link at the top right of the screen to access the interface to create

a new Role.

1. Type “WebService” into the text box labled “Role Name”.

2. The description is a free form field but type you want to make the description clear enough for

other administrators to understand the purpose of the role. We suggest something along the

lines of “Users will be granted access to the API calls”.

3. Select “Active” as the status in the provided drope down box.

4. The account needs to also be granted “View” access to the “User managerment” module in the

application. In the”Available” list box on the left scroll down and find “User Management” and

click the checkbox next to it. Thec click the “Add” button to move it over to the “Selected” list

box. “View” access should be the default setting. Not change is needed there.

5. Click the Submit button at thebottom right of the screen



6. Under “Users” select “User Management”

7. Navigate to the account that will be used to access the APIs by using the search form criteria.

8. Click on the user’s last name to access the user management screen.



9. Click on the magnifying glass icon next to the “Role” text box.

10. In the popup box select “WebService”.

11. Click “Add” and the Role will be moved into the list of user’s selected roles.

12. Click the “Submit” button at the bottom with of the screen

This user account can now use its credentials (username and password) to make calls to the API. If

you ever wish to cancel this account’s access to the APIs, simply remove the role from the user’s

profile or set the user status to “Inactive”.

Web Service URL

Web services are client specific. Each client has their own web service URL based on the domain/sub-domain of their site.

eLogic Domain Clients (yourcompany is replaced by the sub-domain your organization selected) - https://yourcompany.elogiclearning.com/Service/2017_v3/essential_webservice.asmx

Non-eLogic Domain Clients (yourdomain is replaced by the URL your organization selected for the site) - https://yourdomain/Service/2017_v3/essential_webservice.asmx

https://yourcompany.elogiclearning.com/Service/2017_v3/essential_webservice.asmx

https://yourdomain/Service/2017_v3/essential_webservice.asmx



User Record Management (RegisterUserInTheLMS)

Description: The User Record Management method facilitates the creation and update of user records (accounts) in the LMS environment. All of the inputs listed below are required or the method will fail but only some of the elements listed under the User Object are required. Each required element is identified with a red asterisk when a user is created. Only LoginID is required for updates to an already existing user record. Additionally, your organization may have determined that other fields under the user object should be required from a business logic perspective. Please consult with your business owners to ensure all the appropriate data elements are being sent to the LMS application based on your business needs. Finally, this web method in the initial release will only be able to be used for Student roles only. You will not be able to set additional roles using the web method. The same is true for attributes. This web method does not include the ability to set/update attributes. If additional roles are required or attributes need to be updated, you will need to use the DCE method for that information.

Inputs:

• Username – The username of the account to be used to call the service. This is the Web Service

user described in the overview section of this document. This is an alphanumeric field with a

250 character limit.

• Password – The password of the account that will be used to call the service. This is the Web

Service user described in the overview section of this document. This is an alphanumeric field

with a 40 character limit.

• SiteName – string representing the name of the site where the user will be added. This is an

alphanumeric field with a 50 character limit.

User Object

The user object consists of the following elements. Not all of these elements are required in eSSential.

The values that you will use will depend on the setup decisions made by your organization.

• *Username – The string representing the login id for the user to be created or updated (NOT

the username for the web service account). This is an alphanumeric field with a 250 character

limit.

• ModifyUsername – The string representing the new login ID (username for the user). This

allows for the update of the username in instances where the username has changed (marriage,

divorce, etc. resulting in last name change that prompts a username change). The new value

must be unique or the update process will fail. This is an alphanumeric field with a 250

character limit.

• EmployeeId – The string representing a unique value for that user in the clients base system.

This is an alphanumeric field with a 50 character limit.

• *FirstName - a string value for the user’s first name. This is an alphanumeric field with a 40

character limit.



• MiddleName – a string value for the user’s middle name. This is an alphanumeric field with a 40

character limit.

• *LastName – a string value for the user’s last name. This is an alphanumeric field with a 40

character limit.

• PreferredName – a string value for the user’s preferred name. This can be used instead of the

First Name on email communications and the certificate of completion. This is an alphanumeric

field with a 40 character limit.

• *OrgCode – a string representing the Organizational Code in the system. This is an alphanumeric


• GeoCode – a string representing the users Geographical code in the essential system. This is an


• EmailAddress – a string containing the user’s email address. This is an alphanumeric field with a


• Opt-Out – a Boolean value which controls the Notification Opt-Out field. 1 = Opt-out (no

emails) and 0 = Opt-in (emails will be sent).

• ManagerFlag – a Boolean value, true or false, indicating the user being loaded is a manager

• *Status – a Boolean value indicating the user is active (1) or inactive (0)

• Theme - The theme controls the look and feel that the user will experience when in the LMS.

This includes header, site color, menu structure, etc. Clients must create at least one theme but

there is no limit to the number of themes that can be created. Insert the name of the theme

you would like assigned to this user. If no theme is provided, the default theme for the site will

be assigned.

• LMSLicense - Indicates what type of LMS license the user will consume. This is only applicable

for clients who have purchased a hybrid license model where some users will be full use license

and others will be charge per registration licenses. 1 = Full Use License and 2 = Charge per

Registration. If no licensetype is provided, the default type for the site will be assigned.

• Password – a string with the user’s password for system access. This is an alphanumeric field

with a 40 character limit. NOTE - The password is required to create a user via the bulk load or

web service but there is an option in Site Configuration to set a default password for all new

users thus eliminating the need to include this column in the feed if your organization will be

using a default for all new users. Similarly, if your organization will allow users to manage their

password in the LMS, there is an option on the Site Configuration page to ignore password

updates sent through the interface.

• PasswordReset – a Boolean value of 0 or 1. If 0 is sent, the user will be forced to reset their

password upon next login. If 1 is sent, the user will not be required to reset their password.

Often clients who want password management to take place in the LMS, will send a 0 for a user

create and a 1 for user updates.

• Pin – An integer which must be 4 digits in length. This defines the personal identification

number for the user. This can be used for electronic signature instead or using the

username/password combination. This is frequently used for SSO clients where the end user

does not know their LMS username/ password.



• SecurityQuestion – a string with the user’s security question. It must match one of the security

questions in the system to be loaded correctly. This is an alphanumeric field with a 250

character limit.

• SecurityAnswer -a string that is the users response to the security question. This is an


• NotificationPreference- an integer representing the preferred method of notification 1 – email,

2 email and text

• PrimaryAddressFlag – an integer indicating the primary address to be used. 1 – Home, 2 –

Business

• HomeAddress

o AddressLine1 - a string with a 255 character limit.


o City - a string with a 255 character limit.

o ZipCode - a string with a 50 character limit.

o StateName - a string with a 200 character limit.

o CountryName - a string with a 200 character limit.

• BusinessAddress



o City - a string with a 255 character limit.

o ZipCode - a string with a 50 character limit.

o StateName - a string with a 200 character limit.

o CountryName - a string with a 200 character limit.

• Phone1

o PhoneNumber string with a 50 character limit.

o PhoneType string with a 8 character limit.

• Phone2



• Phone3



• Biography – is an HTML field with a 3,000 character limit.

• IsSSOUser - a Boolean value indicating that the user being loaded will access the system via

Single Sign On

• WorkflowOutOfOffice - an integer indicating that the user is currently out of office 0 – no, 1 –

yes

• ManagerEmailNotificationOptOut – an integer indicating that the manager will opt out of email

notifications

• WorkflowOutOfOffice_StartDate - a date stamp of the beginning of the ”Out of Office” period

• WorkflowOutOfOffice_EndDate - a date stamp of the end of the ”Out of Office” period



• Language - This field is only available for clients who have purchased the multi-language option.

This drives the language displayed to the user for end user facing pages (admin pages are not

translated). Must pass the Microsoft API language code. Please contact eLogic Learning

support for a full list of the valid names.

• AdvApproveOpt – For clients using the advanced manager approval feature, this field allows the

type of approval the user will require to be sent via API. Only 3 values are valid for this field (0,

1, and 2). Each is described below.

o 0 = No approval required

o 1 = 1 Approval required (organization owner)

o 2 = 2 approvals required (organization owner plus second approver). If this option is

passed, the user must have a second approver username passed as well.

• SecondApprover – When the AdvApproveOpt is set to 2, then a username for the second

approver must be sent with the user record. This username must exist in the LMS and be

active.

Response: The response will be a list of the API Response object. This will contain one or more of the following

responses.

• SuccessNoErrors

• CredentialsAreNotMemberOfWebServiceGroup

• UnableToAuthenticateServiceCredentials

• UserNameDoesNotExist – This will return if the LoginID provided as an input does not exist in the application.

• SystemError – this is any other unhandled error.

• ValidOrganizationCodeRequired – this is when no organization code is present or an invalid code was sent. The user cannot be created without a valid organizational code.

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 /Service/2015_v2/essential_webservice.asmx HTTP/1.1

Host: crvl.elogiclearning.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/RegisterUserInTheLMS"

<?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>

<RegisterUserInTheLMS xmlns="http://tempuri.org/">

<creds>



<UserName>string</UserName>

<Password>string</Password>

</creds>

<SiteName>string</SiteName>

<user>

<UserId>int</UserId>

<Username>string</Username>

<EmployeeId>string</EmployeeId>

<FirstName>string</FirstName>

<MiddleName>string</MiddleName>

<LastName>string</LastName>

<OrgCode>string</OrgCode>

<GeoCode>string</GeoCode>

<EmailAddress>string</EmailAddress>

<ManagerFlag>boolean</ManagerFlag>

<Status>boolean</Status>


<SecurityQuestion>string</SecurityQuestion>

<SecurityAnswer>string</SecurityAnswer>

<NotificationPreference>int</NotificationPreference>

<PrimaryAddressFlag>int</PrimaryAddressFlag>

<HomeAddress>

<AddressLine1>string</AddressLine1>


<City>string</City>

<ZipCode>string</ZipCode>

<StateName>string</StateName>

<CountryName>string</CountryName>

<FullAddress>string</FullAddress>

</HomeAddress>

<BusinessAddress>



<City>string</City>





</BusinessAddress>

<Phone1>

<PhoneNumber>string</PhoneNumber>

<PhoneType>string</PhoneType>

<PhoneTypeId>int</PhoneTypeId>

</Phone1>

<Phone2>




</Phone2>

<Phone3>




</Phone3>

<Biography>string</Biography>

<IsSSOUser>boolean</IsSSOUser>




<SiteId>int</SiteId>

<WorkflowOutOfOffice>int</WorkflowOutOfOffice>

<ManagerEmailNotificationOptOut>int</ManagerEmailNotificationOptOut>

<WorkflowOutOfOffice_StartDate>dateTime</WorkflowOutOfOffice_StartDate>

<WorkflowOutOfOffice_EndDate>dateTime</WorkflowOutOfOffice_EndDate>

<PasswordReset>int</PasswordReset>

<Language>string</Language>

<AdvApproveOpt>int</AdvApproveOpt>

<SecondApprover>string</SecondApprover>

<SecondApproverId>int</SecondApproverId>

<Theme>string</Theme>

<LMSLicense>int</LMSLicense>

<IsLearnLive>boolean</IsLearnLive>

<AccessExpiration>dateTime</AccessExpiration>

<ModifyUsername>string</ModifyUsername>

</user>

</RegisterUserInTheLMS>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<RegisterUserInTheLMSResponse xmlns="http://tempuri.org/">

<RegisterUserInTheLMSResult>string</RegisterUserInTheLMSResult>

</RegisterUserInTheLMSResponse>

</soap:Body>

</soap:Envelope>


with actual values.



Content-Type: application/soap+xml; charset=utf-8



<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"


xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<RegisterUserInTheLMS xmlns="http://tempuri.org/">

<creds>



</creds>




<user>

<UserId>int</UserId>


<EmployeeId>string</EmployeeId>

<FirstName>string</FirstName>

<MiddleName>string</MiddleName>

<LastName>string</LastName>

<OrgCode>string</OrgCode>

<GeoCode>string</GeoCode>

<EmailAddress>string</EmailAddress>

<ManagerFlag>boolean</ManagerFlag>

<Status>boolean</Status>


<SecurityQuestion>string</SecurityQuestion>

<SecurityAnswer>string</SecurityAnswer>

<NotificationPreference>int</NotificationPreference>

<PrimaryAddressFlag>int</PrimaryAddressFlag>

<HomeAddress>



<City>string</City>





</HomeAddress>

<BusinessAddress>



<City>string</City>





</BusinessAddress>

<Phone1>




</Phone1>

<Phone2>




</Phone2>

<Phone3>




</Phone3>

<Biography>string</Biography>

<IsSSOUser>boolean</IsSSOUser>


<SiteId>int</SiteId>

<WorkflowOutOfOffice>int</WorkflowOutOfOffice>

<ManagerEmailNotificationOptOut>int</ManagerEmailNotificationOptOut>



<WorkflowOutOfOffice_StartDate>dateTime</WorkflowOutOfOffice_StartDate>

<WorkflowOutOfOffice_EndDate>dateTime</WorkflowOutOfOffice_EndDate>

<PasswordReset>int</PasswordReset>

<Language>string</Language>

<AdvApproveOpt>int</AdvApproveOpt>

<SecondApprover>string</SecondApprover>

<SecondApproverId>int</SecondApproverId>

<Theme>string</Theme>

<LMSLicense>int</LMSLicense>

<IsLearnLive>boolean</IsLearnLive>

<AccessExpiration>dateTime</AccessExpiration>

<ModifyUsername>string</ModifyUsername>

</user>

</RegisterUserInTheLMS>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<RegisterUserInTheLMSResponse xmlns="http://tempuri.org/">

<RegisterUserInTheLMSResult>string</RegisterUserInTheLMSResult>

</RegisterUserInTheLMSResponse>

</soap12:Body>

</soap12:Envelope>



End User Attribute

Description The End User Attribute method is used to insert and update attributes on a user’s profile. The attribute

feature within the LMS allows clients to create an unlimited number of new fields in the LMS for the

purposes of tracking end user specific profile information. To use this method, the user must already

exist in the application and the attribute field/values must also exist. All of the inputs listed below with

a red asterisk are required or the method will fail.

Inputs:

• *Username – The username of the account to be used to call the service. This is the Web Service user described in the overview section of this document. This is an alphanumeric field with a 250 character limit.

• *Password – The password of the account that will be used to call the service. This is the Web Service user described in the overview section of this document. This is an alphanumeric field with a 40 character limit.

• *LoginId – The loginid (username) for the user that will be assigned the attribute. This is an alphanumeric field with a 250 character limit.

• *AttributeName – This is the field name (exact spelling) of the attribute created in the LMS. This is an alphanumeric field with a 50 character limit.

• *AttributeValue– This is the value to insert in the field. If the Attribute is a multi-select list or a dropdown, the value must match an existing value in the list. If the field is a date, the value sent must be a MM/DD/YYYY format. If the field is a currency or numeric data type, then only a numeric value can be sent. This is an alphanumeric field with a 50 character limit.

• Remove– The remove flag is optional and should only be used when wanting to remove a multi-select value from a user. For all other field data types (currency, text, dropdown, numeric, and date), the field is a single value field so sending a new value overwrites the existing value. If you want to remove a multi-select value, send the number 1 with this input field.


responses:

• SuccessNoErrors

• Invalid user credentials

• User does not exist – This will return if the LoginID provided as an input does not exist in the application.

• Attribute Name does not exist

• Attribute Value does not exist or is invalid

• SystemError – this is any other unhandled error

• Missing required information



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 /Service/essential_webservice.asmx HTTP/1.1

Host: ui.elogiclearning.com



SOAPAction: "http://tempuri.org/EndUserAttribute"





<soap:Body>

<EndUserAttribute xmlns="http://tempuri.org/">

<creds>



</creds>

<userAttributeList>

<APIUserAttribute>


<AttributeTypeName>string</AttributeTypeName>

<AttributeValue>string</AttributeValue>

<Remove>int</Remove>

</APIUserAttribute>

<APIUserAttribute>





</APIUserAttribute>

</userAttributeList>

</EndUserAttribute>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<EndUserAttributeResponse xmlns="http://tempuri.org/">

<EndUserAttributeResult>

<APIResponse>

<_ResponseList>

<APIResponse xsi:nil="true" />

http://tempuri.org/EndUserAttribute

http://www.w3.org/2001/XMLSchema-instance

http://www.w3.org/2001/XMLSchema

http://schemas.xmlsoap.org/soap/envelope/

http://tempuri.org/



http://schemas.xmlsoap.org/soap/envelope/

http://tempuri.org/




</_ResponseList>

<Id>int</Id>

<Description>string</Description>

</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</EndUserAttributeResult>

</EndUserAttributeResponse>

</soap:Body>

</soap:Envelope>


with actual values.


Host: ui.elogiclearning.com







<soap12:Body>

<EndUserAttribute xmlns="http://tempuri.org/">

<creds>



</creds>

<userAttributeList>

<APIUserAttribute>





</APIUserAttribute>

<APIUserAttribute>





</APIUserAttribute>

</userAttributeList>

</EndUserAttribute>



http://www.w3.org/2003/05/soap-envelope

http://tempuri.org/



</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<EndUserAttributeResponse xmlns="http://tempuri.org/">

<EndUserAttributeResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</EndUserAttributeResult>

</EndUserAttributeResponse>

</soap12:Body>

</soap12:Envelope>



http://www.w3.org/2003/05/soap-envelope

http://tempuri.org/



User Role

Description The User Role method is used to insert and update LMS Security Roles on a user’s profile. The role

feature within the LMS allows clients to create an unlimited number of security privileges in the LMS.

These privileges control what LMS administrative pages and reports the user will be able to access and

what level of access they will have on the page (View Only, View/Edit, View/Edit/Add, etc.). To use this

method, the user must already exist in the application and the role must also exist. All of the inputs

listed below with a red asterisk are required or the method will fail.

Inputs:



• *LoginId – The loginid (username) for the user that will be assigned the role. This is an alphanumeric field with a 250 character limit.

• *Role – This is the role name (exact spelling) in the LMS. This is an alphanumeric field with a 100 character limit.

• *StartDate– This is the date the user’s access to the role will start. The value sent must be a MM/DD/YYYY format.

• *EndDate– This is the date the user’s access to the role will end. This value is required. If you want the user to have effectively no end date, then send 12/31/2099 as the end date. The value sent must be a MM/DD/YYYY format.

• Remove– The remove flag is optional and should only be used when wanting to remove the role completely from the user. If a value of 1 is sent, the role will be deleted from the user’s record in the LMS. In most instances you will want to end date the role instead of removing to provide an audit history that the user had the role at one time.


responses:

• SuccessNoErrors



• Role Name does not exist

• Start date is not a valid format

• End Date is not a valid format

• End Date must be greater than start date





• Invalid remove value. Value must be a 1 to remove role

SOAP 1.1



Host: crvlui.stg.elogiclearning.com



SOAPAction: "http://tempuri.org/UserRoleLoad"





<soap:Body>

<UserRoleLoad xmlns="http://tempuri.org/">

<creds>



</creds>

<userRoleDetails>

<APIUserRole>


<RoleName>string</RoleName>

<StartDate>string</StartDate>

<EndDate>string</EndDate>


</APIUserRole>

<APIUserRole>






</APIUserRole>

</userRoleDetails>

</UserRoleLoad>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>



<UserRoleLoadResponse xmlns="http://tempuri.org/">

<UserRoleLoadResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</UserRoleLoadResult>

</UserRoleLoadResponse>

</soap:Body>

</soap:Envelope>


with actual values.









<soap12:Body>

<UserRoleLoad xmlns="http://tempuri.org/">

<creds>



</creds>

<userRoleDetails>

<APIUserRole>






</APIUserRole>

<APIUserRole>








</APIUserRole>

</userRoleDetails>

</UserRoleLoad>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<UserRoleLoadResponse xmlns="http://tempuri.org/">

<UserRoleLoadResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</UserRoleLoadResult>

</UserRoleLoadResponse>

</soap12:Body>

</soap12:Envelope>



Organizational Unit

Description The Organizational Unit method is used to create and update organizations in the organizational

hierarchy. An organization is the hierarchy method within the LMS to group users together for

reporting, curricula access, security, workflow and ecommerce pricing. The hierarchy is a tree structure

and can be as deep as needed with as many branches as desired. All of the inputs listed below with a

red asterisk are required or the method will fail.

Inputs:



• *OrgUnitCode – This is organizational unit code for the organization where the unit manager will be associated. A unit manager can be associated to one or more organizations. An organization can have more than one different unit manager as well. This is an alphanumeric field with a 50 character limit.

• *OrgUnitName –This is the name or description of the organization. This is an alphanumeric field with a 250 character limit.

• *Status –This defines the status of the organization. 1 = active and 0 = inactive.

• *ParentCode – This is the organizational unit code for the organization that this organizational unit reports to in the hierarchy. If the organization being created is the top level of your hierarchy use the code BASE for the parent code. This is an alphanumeric field with a 50 character limit.

• *Owner – The loginid (username) for the user that will be assigned as the owner of the organization. An organization can have one and only one owner. An organization can have an unlimited number of unit managers. These unit managers are defined with the Organization Unit Manager method. This is an alphanumeric field with a 250 character limit.

• IsEcommerceEnabled – Marks organization as ecommerce or not. Only users assigned to eCommerce orgs can be charged for training. 0 = disabled and 1 = enabled.

• BillMe – Selects or removes the Bill Me payment method for the organization. This applies to eCommerce clients only. 0 is disabled, 1 is enabled with no approval, 2 is enabled with organization owner approval, and 3 is enabled with secondary approval.

• BillMeSecondApprover – Username for the user who will be second approver for any Bill Me purchase requests. This should only be used if Bill Me option 3 is selected.

• PO – Selects or removes the PO payment method for the organization. This applies to eCommerce clients only. 0 is disabled, 1 is enabled with no approval, 2 is enabled with organization owner approval, and 3 is enabled with secondary approval.

• POSecondApprover – Username for the user who will be second approver for any PO purchase requests. This should only be used if PO option 3 is selected.



• Visa – This enables or disables the Visa payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Mastercard – This enables or disables the Mastercard payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• AmericanExpress – This enables or disables the American Express payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Discover – This enables or disables the Discover payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Credits – This enables or disables the Training Credits payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• WireTransfer – This enables or disables the Wire Transfer payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Check – This enables or disables the Check payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Concession – This enables or disables the Concession payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• InternalCharge – This enables or disables the Internal Charge payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• Intercompany – This enables or disables the Intercompany payment method. This should be used by eCommerce clients only. 0 is disabled and 1 is enabled.

• InitialCreditBalance – This field establishes the initial training credit balance for an organization. This should be used by eCommerce clients only. The value must be a positive whole number.

• CreditAdjustment - This field is used to adjust the training credit balance for an organization. This must be a whole number and will adjust the training credit balance for the organization (positive number will increase the balance and negative will decrease the balance).

• OrgLicense – This optional field can be used by clients who want to provide their clients with a maximum number of active users in the LMS. This allows the setting of the maximum license allowed per organization. In order to use this functionality, your LMS site will need to be configured by eLogic to allow license level to be defined at the organization level. Please contact eLogic if you would like to explore this option.

• OrgAccessExpiration - This provides a default access expiration date for any user created for this organization regardless of how the user is created unless a different value is specifically defined. When the access expiration is passed, the user’s records will automatically be set to inactive.

• OrgSiteName – This is used for multi-site clients to provide the site name where the organization will be created. If no value is provided, the organization will be created in Site 1.


responses:

• SuccessNoErrors


• User does not exist – This will return if the LoginID provided for the owner does not exist in the application.





SOAP 1.1



Host: v10.elogiclearning.com



SOAPAction: "http://tempuri.org/OrganizationalUnit"





<soap:Body>

<OrganizationalUnit xmlns="http://tempuri.org/">

<creds>



</creds>

<orgUnitList>

<APIOrgUnit>

<OrgUnitCode>string</OrgUnitCode>

<OrgUnitName>string</OrgUnitName>

<Status>int</Status>

<ParentCode>string</ParentCode>

<Owner>string</Owner>

<IsEcommerceEnabled>short</IsEcommerceEnabled>

<BillMe>int</BillMe>

<PO>int</PO>

<Visa>int</Visa>

<MasterCard>int</MasterCard>

<AmericanExpress>int</AmericanExpress>

<Discover>int</Discover>

<Credits>int</Credits>

<BillMeSecondApprover>string</BillMeSecondApprover>

<POSecondApprover>string</POSecondApprover>

<InitialBalance>int</InitialBalance>

<CreditAdjustment>int</CreditAdjustment>

<WireTransfer>int</WireTransfer>

<Check>int</Check>

<Concession>int</Concession>

<InternalCharge>int</InternalCharge>

<Intercompany>int</Intercompany>

<OrgLicense>int</OrgLicense>

<OrgAccessExpiration>dateTime</OrgAccessExpiration>

<OrgSiteName>string</OrgSiteName>

</APIOrgUnit>

<APIOrgUnit>










<PO>int</PO>

<Visa>int</Visa>










<Check>int</Check>







</APIOrgUnit>

</orgUnitList>

</OrganizationalUnit>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<OrganizationalUnitResponse xmlns="http://tempuri.org/">

<OrganizationalUnitResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</OrganizationalUnitResult>

</OrganizationalUnitResponse>

</soap:Body>

</soap:Envelope>




with actual values.









<soap12:Body>

<OrganizationalUnit xmlns="http://tempuri.org/">

<creds>



</creds>

<orgUnitList>

<APIOrgUnit>








<PO>int</PO>

<Visa>int</Visa>










<Check>int</Check>







</APIOrgUnit>

<APIOrgUnit>










<PO>int</PO>

<Visa>int</Visa>










<Check>int</Check>







</APIOrgUnit>

</orgUnitList>

</OrganizationalUnit>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<OrganizationalUnitResponse xmlns="http://tempuri.org/">

<OrganizationalUnitResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</OrganizationalUnitResult>

</OrganizationalUnitResponse>

</soap12:Body>

</soap12:Envelope>



Organizational Unit Manager

Description The Organizational Unit Manager method is used to associate or remove unit managers from specific

organizations. A unit manager of an organization has the ability to view end-user activity for any user

associated with that organization or any organization below that in that branch of the organizational

hierarchy. To use this method, the organization and the user must already exist in the application and

the user must have the unit manager flag marked on their user profile. All of the inputs listed below

with a red asterisk are required or the method will fail.

Inputs:



• *OrgUnitCode – This is organizational unit code for the organization where the unit manager will be associated. A unit manager can be associated to one or more organizations. An organization can have more than one different unit manager as well. This is an alphanumeric field with a 50 character limit.

• *LoginId – The loginid (username) for the user that will be associated with the organization. This is an alphanumeric field with a 250 character limit.

• Remove– The remove flag is optional and should only be used when wanting to remove a unit manager from being associated with the organization. A value of 1 will remove the unit manager from the organization.


responses:

• SuccessNoErrors



• Organization does not exist – This will return if the organization unit code provided does not match an organization in the LMS.

• User is not a unit manager





SOAP 1.1






SOAPAction: "http://tempuri.org/OrganizationalUnitManager"





<soap:Body>

<OrganizationalUnitManager xmlns="http://tempuri.org/">

<creds>



</creds>

<orgUnitManagerList>

<APIOrgUnitManager>




</APIOrgUnitManager>

<APIOrgUnitManager>





</orgUnitManagerList>

</OrganizationalUnitManager>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<OrganizationalUnitManagerResponse xmlns="http://tempuri.org/">

<OrganizationalUnitManagerResult>

<APIResponse>

<_ResponseList>



</_ResponseList>



<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</OrganizationalUnitManagerResult>

</OrganizationalUnitManagerResponse>

</soap:Body>

</soap:Envelope>


with actual values.









<soap12:Body>

<OrganizationalUnitManager xmlns="http://tempuri.org/">

<creds>



</creds>

<orgUnitManagerList>

<APIOrgUnitManager>





<APIOrgUnitManager>





</orgUnitManagerList>

</OrganizationalUnitManager>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK









<soap12:Body>

<OrganizationalUnitManagerResponse xmlns="http://tempuri.org/">

<OrganizationalUnitManagerResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</OrganizationalUnitManagerResult>

</OrganizationalUnitManagerResponse>

</soap12:Body>

</soap12:Envelope>



Return Registrations for User

Description: The Return Registrations for User method is used to view the in process registrations for a user. Any registration that is missed, completed or dropped will not display in the results set. This only returns in process or not started registrations. All of the inputs listed below are required or the method will fail.

Inputs:

• Username – The username of the account to be used to call the service. This is the Web Service user described in the overview section of this document. This is an alphanumeric field with a 250 character limit.

• Password – The password of the account that will be used to call the service. This is the Web Service user described in the overview section of this document. This is an alphanumeric field with a 40 character limit.

• LoginId – The user which you wish to retrieve registrations for. This is an alphanumeric field with a 250 character limit.

Response: If there is an error with the inputs, the response will be one of the following error responses:





• NOTE – if the user has no in process registrations, then an empty results set will return.

If the inputs were successful, the response will be an XML document that is contains the following elements:

• currId - integer representing the unique curriculum ID in the system

• regEventId - the integer that corresponds to a registered event, -1 indicates no event

• regDate - The date when the curriculum was registered

• currName - string representing the curriculum name

• currType - integer representation of the curriculum type 1-Training Session , 2- Course, 3 –Learning Path, 6 – Library Item, 7 – Compliance Path, and 8 - Checklist

• currTypeName - Course, Training Session, Learning Path, Library, Compliance Path, and Checklist

• Due Date - The Date when the curriculum must be completed

• currTeaser - The string representing the teaser description

• EventDate – The start date of the event.

• currCertId - integer of the certification id. 0 if there is no certification

• preCount - integer representing the number of prerequisites associated with this curriculum



• regCompStatus - integer representing the current completion status

• regCompStatusName – this is the full name of the completion status

• regStatusName – this is the name of the registration status (complete, incomplete, pending approval)

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





SOAPAction: "http://tempuri.org/ReturnRegistrationsForUser"





<soap:Body>

<ReturnRegistrationsForUser xmlns="http://tempuri.org/">

<creds>



</creds>

<LoginId>string</LoginId>

</ReturnRegistrationsForUser>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<ReturnRegistrationsForUserResponse xmlns="http://tempuri.org/">

<ReturnRegistrationsForUserResult>xmlxml</ReturnRegistrationsForUserResult>

</ReturnRegistrationsForUserResponse>

</soap:Body>

</soap:Envelope>




with actual values.









<soap12:Body>

<ReturnRegistrationsForUser xmlns="http://tempuri.org/">

<creds>



</creds>


</ReturnRegistrationsForUser>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<ReturnRegistrationsForUserResponse xmlns="http://tempuri.org/">

<ReturnRegistrationsForUserResult>xmlxml</ReturnRegistrationsForUserResult>

</ReturnRegistrationsForUserResponse>

</soap12:Body>

</soap12:Envelope>



Register User for Curricula

Description: The Register User for Curricula web service will allow the consumer to register a piece of Curriculum to a

user in the essential LMS. This web service can be used for courses, training sessions, electronic library

items, compliance paths, contests and learning paths. You should NOT use this for registering users for

learning paths which have electives. The web service has not been designed to include elective

registration designation. This will cause an error to the user in the application when they try to complete

the Learning path. Additionally, if you use this web service to register a user for a training session,

please be mindful to ensure there are future events available for the training session if the event ID or

schedule ID field is not passed in the API. If these parameters are not sent, the user will still need to

select the event they want to attend. If there are no events available, this may lead to confusion and

frustration. The web service is built with all the controls of the front end application. If you try to

register a user for curriculum that the user is already registered for, the registration will not process (no

error response, it will just not process). The application does not allow the user in the application to be

registered (and not complete) for the same curriculum more than once. This API can also perform

updates to existing registrations if the ExtRefNumber field is used when the registration is created.

Sending this value again causes the API to update the existing registration instead of creating a new

registration.

Inputs:







• LoginId – The string that represents the loginid (username) of the user to be registered. This is

an alphanumeric field with a 250 character limit.

• CurriculumNumber – This is the string value that represents the curriculum number assigned to

the curriculum number in the essential curriculum management screen. This is an alphanumeric


• Mandatory – This is a Boolean value that will be passed as a 1 (true) or 2 (false), indicating that

the user’s registration is mandatory and cannot be dropped.

• EventID – This is an optional field and will be sent if the registration is for a single day or multi-

day training session and the user is to be registered for a specific event.

• ScheduleID – This is an optional field and will be sent if the registration is for complex class

schedule training session and the user is to be registered for the entire class schedule.

• Notification – This is a Boolean value that will be passed as a 1 (true) or 0 (false), indicating that

the user’s registration should trigger the registration notification if a template is associated with



the training. If a 1 is sent but there is not a registration notification template at the curriculum

or event level, then no registration notification will be sent.

• Status– This is required field.

o Unmarked – If event is in the future and attendance will be marked in LMS.

o Not Started – If the course has not been started

o In Process – For all other curriculum types other than courses, electronic library items,

e-Books, and training sessions.

o In Progress – This status is used for Electronic Library Items and e-Books

o Dropped – If user is canceling or rescheduling their registration ILT/VILT (we will update

the correct registration record using the EventID/ScheduleID and Username

combination). Only valid for single day or multi-day event registrations (not class

schedule or other curriculum types).

o Complete – If in-house seminar and attendance is marked by customer service after the

fact. Or walk up customer and entered into CMS by customer service for billing

purposes. Only valid for single day or multi-day event registrations (not class schedule or

other curriculum types). If this status is sent, we need to call the Roll-up proc.

• Price – This will populate the price field stored on the registration record in the LMS. This will

allow the client to send the price charged to the user to attend the training when the purchase

is handled outside the LMS and still provide the ability to have the price available in the LMS for

reporting. This can also be sent as an update if the user cancels or transfers their training and

are charged for the transfer to a different class. This is an optional field.

• DropReason – This will populate the drop reason field in the LMS. This field can only be

populated via the API call. This provides visibility in the LMS for any drops initiated by an

outside system.

• ExtRefNumber – This will populate the external reference number field stored on the

registration record when the registration record is created via the API call. We recommend this

be the Order Number plus line number concatenated together so that it is a unique value for

each training that is registered (in the event more than one registration is generated from a

same order). This field is the unique identifier for records created via this API and will

determine if the system performs an insert to create a new registration or an update to an

existing registration. If the External Reference ID exists in the LMS, then an update is

performed. If it does not exist, then an insert is performed.

• ADANote – This is an optional field which can be used for instructor led event registrations only.

This field allows for Americans with Disabilities Act (ADA) information to be stored for instructor

led training event registrations. This field is an HTML enabled field and thus HTML can be sent

in the web service. Once sent to the LMS for a user’s registration, the information is visible to

the instructor or administrator from the Manage Registrant page or by creating an ad hoc report

using the Curriculum_Activity Data Source.

• Subscription – This is an optional field which can be used to set the subscription flag for

eLearning Courses, electronic Library items, e-Book Library Items, and Learning Paths which



have courses, electronic library items, and/or e-Book Library items. To set the subscription flag,

pass the value 1 in the API.


responses:

• EventID is not valid

• EventIdNotAssociatedToCurriculum - EventID is not associated to Curriculum Number provided

• Waitlisted – The user was waitlisted for the event.

• WaitlistDisabled – The event is full and the event waitlist is disabled so the user cannot be

registered.

• Invalid status – returns when the status is not a recognized regcomp status.

• Invalid status for curriculum type – returns when the API provided a status that is not valid for

the current curriculum type (i.e. Unmarked for an eLearning Course)

• Status is required – returns when no status as set in the request.

• Price must be a positive valid number with a maximum of two decimals of precision.

• SuccessNoErrors – Record was created successfully



• CurriculumDoesNotExist

• UserNameDoesNotExist – This will return if the LoginID provided as an input does not exist in

the application.

• UserNameIsInactive – This will return if the LoginID provided as an input is inactive in the

application.



with actual values.





SOAPAction: "http://tempuri.org/RegisterUserForCurricula"





<soap:Body>

<RegisterUserForCurricula xmlns="http://tempuri.org/">

<creds>





</creds>


<CurriculumNumber>string</CurriculumNumber>

<Mandatory>boolean</Mandatory>

<EventId>int</EventId>

<ScheduleId>int</ScheduleId>

<Notification>boolean</Notification>

<Status>string</Status>

<Price>decimal</Price>

<DropReason>string</DropReason>

<ExtRefNumber>string</ExtRefNumber>

<ADANote>string</ADANote>

<Subscription>string</Subscription>

</RegisterUserForCurricula>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<RegisterUserForCurriculaResponse xmlns="http://tempuri.org/">

<RegisterUserForCurriculaResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</RegisterUserForCurriculaResult>

</RegisterUserForCurriculaResponse>

</soap:Body>

</soap:Envelope>


with actual values.











<soap12:Body>

<RegisterUserForCurricula xmlns="http://tempuri.org/">

<creds>



</creds>



<Mandatory>boolean</Mandatory>


<ScheduleId>int</ScheduleId>

<Notification>boolean</Notification>


<Price>decimal</Price>

<DropReason>string</DropReason>

<ExtRefNumber>string</ExtRefNumber>

<ADANote>string</ADANote>

<Subscription>string</Subscription>

</RegisterUserForCurricula>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<RegisterUserForCurriculaResponse xmlns="http://tempuri.org/">

<RegisterUserForCurriculaResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>




</APIResponse>

</RegisterUserForCurriculaResult>

</RegisterUserForCurriculaResponse>

</soap12:Body>

</soap12:Envelope>



Event Roster (Return Registration Data)

Description: The Event Roster API will return all users registered for an event by Event ID. This will not display any users who registered and dropped the event or registered and rescheduled. It will only return users currently registered for the event. All of the inputs listed below are required or the method will fail.

Inputs:



• EventId – Integer representing the unique Event ID in the system.





• EventIDDoesNotExist

• NoUsersRegistered – Response if the event has not registered users.



• Last Name – The users last name

• First Name – The users first name

• LoginID – The username for the user registered for the event.

• Registration Date – The Date and time the user was registered for the event

• Attendance – Attendance status in s string format possible values: o Not Attended o Not Started o InProgress o Incomplete o Complete o Pass o Fail o Missed o Unmarked



• Completed Hours – The decimal value of the number of hours completed by the user in reference to the event. If this is a multi-day event, then this will display the total hours.

• Score – Integer representing the users score in the Event 0 – 100. This will not have a value if attendance has not been marked.


POST /Avalon/Service/eSSential_webservice.asmx HTTP/1.1

Host: localhost



SOAPAction: "http://tempuri.org/ReturnRegistrationData"





<soap:Body>

<ReturnRegistrationData xmlns="http://tempuri.org/">

<creds>



</creds>

<EventID>int</EventID>

</ReturnRegistrationData>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<ReturnRegistrationDataResponse xmlns="http://tempuri.org/">

<ReturnRegistrationDataResult>xmlxml</ReturnRegistrationDataResult>

</ReturnRegistrationDataResponse>

</soap:Body>

</soap:Envelope>


with actual values.




Host: localhost







<soap12:Body>

<ReturnRegistrationData xmlns="http://tempuri.org/">

<creds>



</creds>

<EventID>int</EventID>

</ReturnRegistrationData>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<ReturnRegistrationDataResponse xmlns="http://tempuri.org/">

<ReturnRegistrationDataResult>xmlxml</ReturnRegistrationDataResult>

</ReturnRegistrationDataResponse>

</soap12:Body>

</soap12:Envelope>



Mark Attendance for User

Description The Mark Attendance for User method is used to mark attendance for a user in a single day event that is

defined in the eSSential application (this method does not update multi-day events at this time because

of the hours by day requirement). The user must already exist in the application, the event must exist

and the user must be registered for the event in order for this method to complete successfully. This

method will adhere to our completion logic in the application. If the event is the last item to complete

in a learning path, the user will receive credit for the learning path if they are marked as completing the

event. If the event is for a training session that has a certification type associated, the user will be

awarded the certification record, if they are marked as completing the event. All of the inputs listed

below with a red asterisk are required or the method will fail.

Inputs:



• *LoginId – The loginid (username) for the user that is being marked as attended. This is an alphanumeric field with a 250 character limit.

• *EventId – The integer that represents the unique identifier for the event. This can be found on the event management page.

• Score – The numeric score received by the user, an integer between 0 and 100

• *Hours – The number of hours associated with the event. Can be represented up to two decimal places of precision (fractions of an hour versus actual minutes).

• Notes – Any notes that will be included in the attendance record. This is an alphanumeric field with a 1,000 character limit.

• *Status – This is the status of the user as it relates to the event. It will be passed as text. Any one of the values below will be accepted:

o “Not Attended” o “Incomplete” o “Complete” o “Unmarked”


responses:

• SuccessNoErrors






• There is no completion status for the training session

• Unable to retrieve completion status

• CurriculumDoesNotExist


SOAP 1.1



Host: localhost



SOAPAction: "http://tempuri.org/MarkAttendanceForUser"





<soap:Body>

<MarkAttendanceForUser xmlns="http://tempuri.org/">

<creds>



</creds>



<Score>int</Score>

<Hours>long</Hours>

<Notes>string</Notes>


</MarkAttendanceForUser>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<MarkAttendanceForUserResponse xmlns="http://tempuri.org/">

<MarkAttendanceForUserResult>string</MarkAttendanceForUserResult>

</MarkAttendanceForUserResponse>

</soap:Body>



</soap:Envelope>

SOAP 1.2



Host: localhost







<soap12:Body>

<MarkAttendanceForUser xmlns="http://tempuri.org/">

<creds>



</creds>



<Score>int</Score>

<Hours>long</Hours>

<Notes>string</Notes>


</MarkAttendanceForUser>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<MarkAttendanceForUserResponse xmlns="http://tempuri.org/">

<MarkAttendanceForUserResult>string</MarkAttendanceForUserResult>

</MarkAttendanceForUserResponse>

</soap12:Body>

</soap12:Envelope>



Catalog

Description: The Catalog method will return a high level description of curriculum records in the LMS. This method can either return all curricula records or it can be filtered to display only curricula records available to a specific user based on the curriculum assignment rules established in the LMS.

Inputs:



• LoginID – This is an optional input. If provided, the catalog returned will only include curricula that the user has access to based on the curriculum assignment rules established in the LMS. If not provided, then all curricula in the LMS will be returned is the response XML. The string value of the username which you wish to retrieve available curricula. This is an alphanumeric field with a 250 character limit.


• SuccessNoErrors






• CurriculumID – the integer representing the unique ID of the curriculum in the system

• CurriculumName – the string name of the curriculum

• CurriculumNumber – string representing the curriculum number in the system

• CurriculumType – This displays the curriculum type (Training Session, Learning Path, Course, Library Item, Compliance Path, Checklist, Kit, and Product)

• CurriculumStatus – string representing the status of the curriculum, active or inactive

• CurriculumTeaser – string containing the teaser description of the curriculum

• Hours – Number of hours to complete the course

• CEU – decimal indicating the number of continued educational credits associated with the curriculum



• CEUType – string representing the CEU type. These values come from the system values and are client specific

• Price – If a specific LoginID (username) is submitted to the method, the price returned will be the price that is available to the user. If a LoginID was not submitted, the price displayed will be the cost on the curriculum master record (if any).

• Due Date – If a specific LoginID (username) is submitted to the method, the due date returned will be the days from registration for that user (based on the assignment record available to the user). If a LoginID was not submitted, the due date displayed will be days from registration based on the time limit on the curriculum master record (if any).






SOAPAction: "http://tempuri.org/Catalog"





<soap:Body>

<Catalog xmlns="http://tempuri.org/">

<creds>



</creds>


</Catalog>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<CatalogResponse xmlns="http://tempuri.org/">

<CatalogResult>xmlxml</CatalogResult>

</CatalogResponse>

</soap:Body>

</soap:Envelope>




with actual values.









<soap12:Body>

<Catalog xmlns="http://tempuri.org/">

<creds>



</creds>


</Catalog>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<CatalogResponse xmlns="http://tempuri.org/">

<CatalogResult>xmlxml</CatalogResult>

</CatalogResponse>

</soap12:Body>

</soap12:Envelope>



Return Detailed Curriculum Information

Description: By curriculum number, this API will return a data table containing the information about the curriculum which is common across curriculum types. This method will not return detail information about curriculum included in learning paths or event information related to a training session. This is to provide common elements across all curriculum types so that a client could display more detail in their web portal/application than what is returned in the Catalog method. All of the inputs listed below are required or the method will fail.

Inputs:



• CurriculumNumber – This will become an optional input. If provided, the API will return only information for the entered CurriculumNumber. If not provided, the API will return all curricula in the system (based on the UpdatedSince parameter if that element is provided).

• UpdatedSince – This is an optional input. If provided, the API will return only curricula which were created or updated since the date entered including the date entered (i.e. if 5/16/2016 is passed then all events created or update from 5/16/2016 until now will be includes in the response XML). This parameter would typically not be passed when the CurriculumNumber is also sent (but it will work if both are sent). The CurriculumNumber allows return of a single curriculum record.




• InvalidCurriculumNumber – This returns if the curriculum number sent does not match a

curriculum number in the LMS.

• InvalidDate – This returns if the date provide in the UpdatedSince field is not in a valid date

format.


• NoRecordsReturned – Input parameters passed validation but to records were in the response

• NOTE – there is no error handling if an invalid curriculum number is passed to the method. The

call will just return an empty result set.




• Curriculum Name – the string name of the curriculum

• Curriculum Number – string representing the curriculum number in the system

• CurriculumType (change the name of this element)– This displays the curriculum type (Training Session, Learning Path, Course, Library Item, Compliance Path, Checklist, Kit, and Product)

• Curriculum ID – the integer representing the unique ID of the curriculum in the system

• Site Name – the string name of the site

• Status – string representing the status of the curriculum, active, inactive, or pending

• Manager – Manager’s username

• ManagerFirstName – Manager’s first name

• ManagerLasName – Manager’s last name

• ManagerBio – this is the html for the manager’s biography (Unicode so the HTML returns appropriately in the result set)

• Keyword – Keyword for Searching

• Entry Survey Name – Name of the Entry Survey

• Exit Survey Name – Name of the Exit Survey

• Time Limit Type – ‘Days from Registration’ or ‘None’

• Time Limit – Number associated with the Registration Type

• Overview – HTML containing the curriculum overview (Unicode so the HTML returns appropriately in the result set)

• Teaser – string containing the teaser description of the curriculum

• Objective – HTML containing the curriculum objective (Unicode so the HTML returns appropriately in the result set)

• Resources – HTML containing the curriculum resources (Unicode so the HTML returns appropriately in the result set)

• CEU – decimal indicating the number of continued educational credits associated with the curriculum

• CEU Type – string representing the CEU type. These values come from the system values and are client specific

• Hours – Number of hours to complete the course

• Pre Assessment – string representing the name of the pre assessment curriculum if any

• Post Assessment – string representing the name of the post assessment curriculum if any. This will only be returned for training sessions and learning paths where defined.

• Score Required - integer indicating whether the curriculum requires a score 1 – yes, 0 – no. This will only be returned for training sessions.

• Created Date – Date Time when the Curriculum was added to the system

• Created By – the loginid of the user who created the curriculum in the system

• Updated Date – Date Time when the Curriculum was added to the system

• Updated By – the loginid of the user who created the curriculum in the system

• IsAssessment – This will return a Boolean value. 1 indicates the course is an assessment only course and not training. 0 indicates the course is full eLearning course. This element only applies to eLearning courses.

• FailureReapproval - This will return a Boolean value. 1 indicates the course requires reapproval after failure. 0 indicates the course can be retaken without approval. This element only applies to eLearning courses.

• Featured – This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.



• AllowNotes – This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.

• AllowReview – This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.

• EnableRating – This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.

• EnableFeedbackReview – This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.

• EnableReviewNotification - This will return a Boolean value. 1 indicates the value is selected and 0 indicates this value is not selected.

• Private – This will return a Boolean value. 1 indicates the training is marked private. 0 indicates the training is public.

• E-Signature – This returns the name of the e-signature form associated with the training if applicable.

• Provider – string representing the provider. These values come from the system values and are client specific.

• Certificate – This returns the name of the certificate of completion associated with the training if applicable.

• Certification – This returns the name of the certification earned when the training is completed if applicable.

• Type – This will be the library item type field and will send a string value with the description of the item type for library items. This will be the training session type (single day, multi-day, or class schedule) for training sessions. This will be the product type for products (physical good, credit, or coupon).

• URL – This is the URL for the electronic library item.

• CompliancePeriodType – This will return days from registration or specific date range.

• DaysFromRegistration – This will return the days from registration value if this is a compliance path with the days from registration option selected.

• ComplianceStartDate – This will return the compliance period start date if specific date range is selected.

• ComplianceEndDate – This will return the compliance period end date if specific date range is selected.

• SearchCategories – This is a nested listing of each search category associated with the training. This could be one or many rows within the nested list.

• AdditionalItems - This is a nested list of each additional item of interest for the current curriculum record. The nested list will include the curriculum name, curriculum number, and curriculum type.

• Prerequisites - This is a nested list of each prerequisite for the current curriculum record. The nested list will include the curriculum name, curriculum number, and curriculum type.

• CurriculumAttributes – This is a nested listing of each curriculum attribute field and the selected values associated with the curriculum type. If the curriculum attribute field is a multi-select list, multiple records could return for that field in a subnested list. Each curriculum attribute field will have an element of the attribute name. All fields will be returned that are defined for the curriculum type even if the field is not populated for the curriculum record. (Unicode curriculum attributes that are webeditor data type so the HTML returns appropriately in the result set)



• ChildCurricula – This is a nested list of each child of the learning path. The nested list will include the curriculum name, curriculum number, curriculum type, and sort order for each child.


POST /Service/2016_v2/eSSential_webservice.asmx HTTP/1.1




SOAPAction: "http://tempuri.org/ReturnDetailedCourseInformation"





<soap:Body>

<ReturnDetailedCourseInformation xmlns="http://tempuri.org/">

<creds>



</creds>


<UpdatedSince>string</UpdatedSince>

</ReturnDetailedCourseInformation>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<ReturnDetailedCourseInformationResponse xmlns="http://tempuri.org/">

<ReturnDetailedCourseInformationResult>xml</ReturnDetailedCourseInformationRe

sult>

</ReturnDetailedCourseInformationResponse>

</soap:Body>

</soap:Envelope>


with actual values.











<soap12:Body>

<ReturnDetailedCourseInformation xmlns="http://tempuri.org/">

<creds>



</creds>



</ReturnDetailedCourseInformation>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<ReturnDetailedCourseInformationResponse xmlns="http://tempuri.org/">

<ReturnDetailedCourseInformationResult>xml</ReturnDetailedCourseInformationRe

sult>

</ReturnDetailedCourseInformationResponse>

</soap12:Body>

</soap12:Envelope>



Return Transcript Data

Description: The Return Transcript Data API will allow the consumer to retrieve the transcript information for a user by loginid. This returns curriculum transcript records and will not return certification information. Additionally, any external training entered by the user and not marked as “hide” by an admin will also be returned in the results set. Only completed or missed registrations will display. Dropped, in process, pending manager approval, pending completion survey, etc registration records will not be included in the results set. This is meant to only display items that display to the user when they view their transcript through the LMS. All of the inputs listed below are required or the method will fail.

Inputs: • Username – The username of the account to be used to call the service. This is the Web Service

user described in the overview section of this document. This is an alphanumeric field with a 250 character limit.


• LoginId – The string value of the username for the user whose transcript you wish to retrieve. This is an alphanumeric field with a 250 character limit.







• Curriculum Name – The Name of the curriculum

• Curriculum Number – The alpha numeric curriculum number in the system

• Type – The string representation of the type of curriculum: Course, Training Session, Learning Path

• Completed Date – The date and time that the curriculum was marked as completed

• Score – The integer value of the score given to the user for that piece of curriculum 0 – 100

• Status – The string representing a Pass or Fail for a piece of curriculum

• CEU – The decimal value of the continued educational units

• Hours – The number of hours that were associated with that piece of curriculum

• RegCompRegId – Registration Completion ID is the integer that is the unique value of that record in the essential system



• Notes – This is any notes that are associated with the transcript record



Host: localhost



SOAPAction: "http://tempuri.org/ReturnTranscriptData"





<soap:Body>

<ReturnTranscriptData xmlns="http://tempuri.org/">

<creds>



</creds>


</ReturnTranscriptData>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<ReturnTranscriptDataResponse xmlns="http://tempuri.org/">

<ReturnTranscriptDataResult>xmlxml</ReturnTranscriptDataResult>

</ReturnTranscriptDataResponse>

</soap:Body>

</soap:Envelope>


with actual values.


Host: localhost









<soap12:Body>

<ReturnTranscriptData xmlns="http://tempuri.org/">

<creds>



</creds>


</ReturnTranscriptData>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<ReturnTranscriptDataResponse xmlns="http://tempuri.org/">

<ReturnTranscriptDataResult>xmlxml</ReturnTranscriptDataResult>

</ReturnTranscriptDataResponse>

</soap12:Body>

</soap12:Envelope>



Retrieve Transcript

Description: The Retrieve Transcript API will allow the consumer to retrieve the transcript information for all users by date range. This is different than the return transcript data API which only returns data for a single user. This returns completion data for all users since the last time the API was called or it can return completions based on the date/time range provided in the API call.

Inputs:



• StartDate – This is an optional value. If this and the end date are not provided, then the API will return all completions since the last time the API was called. If this value is provided along with the EndDate parameter. Then only completions between those dates will be returned. The format required is MM/DD/YYY hh:mm:ss.

• EndDate - This is an optional value. If this and the start date are not provided, then the API will return all completions since the last time the API was called. If this value is provided along with the StartDate parameter. Then only completions between those dates will be returned. The format required is MM/DD/YYY hh:mm:ss.





• Invalid date format



• UserName – This is the username for the end user who completed the training.

• UserID – This is the database ID for the end user who completed the training.

• CurriculumName – The Name of the curriculum that was completed.

• CurriculumNumber – The unique alpha numeric curriculum number for the training that was completed.

• CompletionDate – The date and time that the curriculum was marked as completed

• CompletionStatus – The string representing completion status (Pass, Failed, Complete, etc.)

• Score – The integer value of the score given to the user for that piece of curriculum 0 – 100



• Hours – The number of hours that were associated with that piece of curriculum

• RegistrationID– Registration ID is the integer that is the unique value of the registration record

• DueDate– the due date, if applicable, for the registration record.

• Version – This is only applicable to eLearning, electronic library items, and e-books. This represents the version of the training that was completed.






SOAPAction: "http://tempuri.org/RetrieveTranscript"





<soap:Body>

<RetrieveTranscript xmlns="http://tempuri.org/">

<strStartDate>string</strStartDate>

<strEndDate>string</strEndDate>

</RetrieveTranscript>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<RetrieveTranscriptResponse xmlns="http://tempuri.org/">

<RetrieveTranscriptResult>

<APITranscript />

<APITranscript />

</RetrieveTranscriptResult>

</RetrieveTranscriptResponse>

</soap:Body>

</soap:Envelope>


with actual values.











<soap12:Body>

<RetrieveTranscript xmlns="http://tempuri.org/">

<strStartDate>string</strStartDate>

<strEndDate>string</strEndDate>

</RetrieveTranscript>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<RetrieveTranscriptResponse xmlns="http://tempuri.org/">

<RetrieveTranscriptResult>

<APITranscript />

<APITranscript />

</RetrieveTranscriptResult>

</RetrieveTranscriptResponse>

</soap12:Body>

</soap12:Envelope>



User License

Description: The User License API will allow the consumer to insert license information for a user by loginid. Only user license records related to licenses that already exist in the system can be inserted. All of the inputs listed below are required or the method will fail.

Inputs:



• LoginId – The string value of the username for the user whose transcript you wish to retrieve. This is an alphanumeric field with a 250 character limit.





• The License code does not exist in the system. – This will return if the License Coe provided as an input does not exist in the application.

• LicenseNumber is required. This is returned if the License Number is not provided.

• LicenseEarnedDate is required. This is returned if the License Earned Date is not provided.

• LicenseEffectiveDate is required. This is returned if the License Effective Date is not provided.

• LicenseExpirationDate is required. This is returned if the License Expiration is not provided.



• LoginId – The username of the user who will have the license.

• License Code – The unique code for the license in the LMS. This is what drives what license the user will have.

• License Number – The alphanumeric code assigned by the governing body (regulatory body) when the user earned the license.

• EarnedDate – The date in MM/DD/YYYY format when the user earned the license.

• EffectiveDate – The date in MM/DD/YYYY format when the user earned the license.

• ExpirationDate – The date in MM/DD/YYYY format when the user earned the license.








SOAPAction: "http://tempuri.org/UserLicense"





<soap:Body>

<UserLicense xmlns="http://tempuri.org/">

<creds>



</creds>

<userLicenseList>

<APIUserLicense>


<LicenseCode>string</LicenseCode>

<LicenseNumber>string</LicenseNumber>

<LicenseEarnedDate>string</LicenseEarnedDate>

<LicenseEffectiveDate>string</LicenseEffectiveDate>

<LicenseExpirationDate>string</LicenseExpirationDate>

</APIUserLicense>

<APIUserLicense>







</APIUserLicense>

</userLicenseList>

</UserLicense>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<UserLicenseResponse xmlns="http://tempuri.org/">

<UserLicenseResult>

<APIResponse>

<_ResponseList>





</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</UserLicenseResult>

</UserLicenseResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2










<soap12:Body>

<UserLicense xmlns="http://tempuri.org/">

<creds>



</creds>

<userLicenseList>

<APIUserLicense>







</APIUserLicense>

<APIUserLicense>









</APIUserLicense>

</userLicenseList>

</UserLicense>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<UserLicenseResponse xmlns="http://tempuri.org/">

<UserLicenseResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</UserLicenseResult>

</UserLicenseResponse>

</soap12:Body>

</soap12:Envelope>



EventDetail

Description: The EventDetail method will return each training session event in the LMS based on the parameters provided. This method can either return all future events or all events updated/created since a particular date.

Inputs:

• Username – The username of the account to be used to call the service. This is the Web Service user described in the overview section of this document. This is an alphanumeric field with a 250 character limit. For multi-site clients, the site associated with the username passed in this parameter will be the site used to drive the data returned in the result set.


• UpdatedSince – This is an optional input. If provided, the API will return only events which were created or updated since the date entered including the date entered (i.e. if 5/16/2016 is passed then all events created or update from 5/16/2016 until now will be includes in the response XML). If not provided, then all future events will be returned is the response XML. If any event session was updated that was part of an overall class schedule, then all class sessions associated with that class schedule will be returned even if the others were not updated since the timeframe provided.

• CurriculumNumber – Return all events for a curriculum number.


• SuccessNoErrors


• Invalid Date – This is the response if the value sent in the UpdatedSince field is not in the valid date format.

• InvalidCurriculumNumber – This is the response if the curriculum number provided does not exist in the LMS or is not associated with a training session.

• No records returned – This will be the response if there are no events for the parameters submitted.


If the inputs were successful, the response will be an XML document that is contains the following elements. For each event whether it is single day or multi-day, there will be one row per event. If the training session is a multi-day training session, there will be a nest list that has a row for session. For class schedule sessions, there will be a separate session record with a class schedule ID to tie the sessions together.

• CurriculumID – the integer representing the unique ID of the training session in the system

• CurriculumName – the string name of the training session



• CurriculumNumber – string representing the training session number in the system

• CurriculumStatus – string representing the status of the training session, active or inactive

• ScheduleID – This will only be populated for event session that are part of a complex class Schedule grouping

• SessionID – This will only be populated for event sessions that are associated with a class schedule training session.

• EventID - the integer representing the unique ID of the event in the system

• DeliveryMethod – string indicating the delivery method (physical or virtual)

• DeliveryType – string indicating the delivery method (classroom or video conference if the delivery method is physical. Web Conference or Teleconference if the delivery method is virtual)

• EventStatus - string representing the status of the event (active or inactive)

• ClassBlock – This is a nested list. For single day events, there will be one row. For multi-day events, there will be multiple rows. For complex class schedules, there will be one row.

o SessionID – This is the database ID for the class session schedule. o Date – This is the date of the session. o StartTime – This is the start time of the session. o EndTime – This is the end time of the session. o TimeZone – This is the time zone associated with the session (Short Zone Name). o InstructorFirstName– This is the primary instructor’s first name. o InstructorLastName - This is the primary instructor’s last name. o InstructorBio – HTML from instructor biography for the primary instructor. (Unicode so

the HTML returns appropriately in the result set) o Meeting Key – This is the meeting key for the web conference if applicable o Attendee URL – This is the attendee URL for the web conference if applicable o Attendee Password – This is the attendee password for the web conference if applicable o Presenter URL – This is the presenter URL for the web conference if applicable o Presenter Password – This is the presenter password for the web conference if

applicable ▪ Agenda – This is a nested list of the class agenda items if defined in the LMS.

For each agenda row, the following will be defined.

• SessionDate – This is the session date.

• SessionID - This is the database ID for the class session schedule.

• AgendaStartTime – This is the start time for the agenda item.

• AgendaEndTime – This is the end time for the agenda item.

• Topic – This is the agenda topic

• AgendaInstructorFirstName – This is the first name of the instructor selected for the agenda item.

• AgendaInstructorLastName - This is the last name of the instructor selected for the agenda item.

• Facility – This is the name of the facility

• FacilityAddLine1 – Address Line 1 for facility

• FacilityAddLine 2 - Address Line 1 for facility

• FacilityCity – City for the facility.

• FacilityState – State for the facility

• FacilityCountry – Country for the facility.

• Room – This is the name of the room.



• DialinNumber – This is the event dial-in number if applicable.

• DialinCode – This is the pass code for the event dial-in number if applicable.

• MaxAttendees – This is the maximum number of attendees for the event.

• MinAttendees – This is the minimum number of attendees suggested to hold the event.

• RegistrationCutoffDays – This is the registration cutoff days value (number of days prior to the earliest start date that event registration will no longer be allowed)

• RescheduleCutoffDays - This is the reschedule cutoff days value (number of days prior to the earliest start date that the user will no longer be allowed to reschedule to a different event)

• Private – This is a Boolean value indicating either 1 (event is marked private) or 0 (event is not marked private)

• Disable Waitlist – This is a Boolean value indicating either 1 (event waitlist is disabled) or 0 (event waitlist is available)

• Description – This is the event description

• ContactName – This is the contact name associated with the event.

• ContactPhone – This is the phone number for the event contact.

• ContactEmail – This is the email address for the event contact.

• Note – This is the note associated with the event.

• Provider – This is the provider’s name (if applicable).

• EventAttributes – This is a nested listing of each event attribute field and the selected values associated. If the event attribute field is a multi-select list, multiple records could return for that field in a subnested list. Each event attribute field will have an element of the attribute name. All fields will be returned that are defined for the event type even if the field is not populated for the event. (Unicode event attributes that are webeditor data type so the HTML returns appropriately in the result set)

• CreatedBy

• CreatedDate

• UpdatedBy

• UpdatedDate

SOAP 1.1






SOAPAction: "http://tempuri.org/EventDetail"





<soap:Body>

<EventDetail xmlns="http://tempuri.org/">

<creds>





</creds>



</EventDetail>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<EventDetailResponse xmlns="http://tempuri.org/">

<EventDetailResult>xml</EventDetailResult>

</EventDetailResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2










<soap12:Body>

<EventDetail xmlns="http://tempuri.org/">

<creds>



</creds>



</EventDetail>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK









<soap12:Body>

<EventDetailResponse xmlns="http://tempuri.org/">

<EventDetailResult>xml</EventDetailResult>

</EventDetailResponse>

</soap12:Body>

</soap12:Envelope>



CouponAddEdit

Description: The CouponAddEdit method facilitates the creation and update of coupons in the LMS environment. Not all of the inputs listed below are required. Each required element is identified with a red asterisk when a coupon is created.

Inputs:



250 character limit. For multi-site clients, the site associated with the username passed in this

parameter will be the site used to drive the data returned in the result set.




Coupon Object

The coupon object consists of the following elements. Not all of these elements are required in to

create a coupon. The values that you will use will depend on the setup decisions made by your

organization.

• *CouponNumber – The string representing a unique value for the coupon. This is an

alphanumeric field with a 400 character limit. If the coupon number sent is not found in the

LMS, the API will create a new coupon. If the coupon number is found in the LMS, the API will

perform an update. This is a required element.

• *Name –The string representing the coupon name. This is an alphanumeric field with a 300

character limit. This is a required element or the coupon cannot be created.

• *Site – The string representing the site the coupon will be created. This is an optional element.

Most clients only have a single site and thus if the site value is not passed the coupon will be

created in Site 1. This is an alphanumeric field with a 50 character limit.

• *Status – This is a required element. 1 indicates the coupon is active. 0 indicates the coupon is

inactive.

• *StartDate - This is a required element. This defines when the coupon will start to be available

to be redeemed. This must be in the mm/dd/yyyy format.

• *EndDate - This is a required element. This defines the last date the coupon will be available to

be redeemed. This must be in the mm/dd/yyyy format.

• *AmountType – This is a required element. This defines whether this will be a dollar off or

percent off coupon. The two valid values are “Dollar” and “Percent”.



• *Value - This is a required element. This defines the value off (either dollar or percent). If the

Amount Type is percent, then 100 is the maximum value that can be sent. This is a numeric

field.

• *Quantity – This is a required element. This represents the number of redemptions allow for the

coupon.

• *CouponType – This is a required element. This defines whether the coupon is global or

curricula specific.

• CurrNumber - This is a required element if the coupon type is curricula specific. If the coupon

type is global, this element should be empty. This defines the curriculum number the coupon is

associated with. This drives which curriculum record the coupon can be redeemed for in the

LMS.

• ParentCoupon – This is the coupon number for the parent coupon when the coupon being

created is a child of an existing coupon. If the coupon being created is a parent coupon, the

column will be present but empty.

• Administrator – This is an optional element and will be the username for the administrator of

the coupon. This value should be empty for any child coupons.

• Organization – This is the organization unit code if the coupon being created should be

restricted to a single organization. If it should not be restricted, this element should be present

but left empty.

• *Redeem – This sets the auto redemption flag in the LMS. A 1 indicates the coupon is auto

redeemable which means the user can enter the coupon number on the redemption page and

be automatically registered for the curriculum associated with the coupon. A 0 indicates the

coupon will be used for discounting purposes in conjunction with the shopping cart/ecommerce

feature.

• *Subscription – This element is only applicable if the Redeem flag is set to a 1. When the

redeem flag is set to a 1 and a user is registered for training by redeeming the coupon, this

determines if the user is registered as a subscription or one-time access for the training. If the

value in this element is a 1, the user will be registered with subscription access.

• SendNotification– This setting controls whether or not a notification will be sent to the Coupon

Administrator upon the creation or edit of the coupon. The administrator field is an optional

field for this web service. If there is no administrator, then a notification will not be sent. The

notification that is sent will be based on the Coupon-First Time notification template. Sending a

0 in this field will result in no notification being sent. A 1 value will result in sending the

notification.

• CouponExpirationMethod – This element is optional. If the value is not passed, the default will

be Standard. This setting controls the method the coupon expiration date is calculated. There

are two valid options.

o 0 – This represents the Standard expiration method. The start and expiration date will

be the Start and End Date provided in the API



o 2 – This represents the Days From expiration method. The start date will be the date

the coupon is purchased and the end date will be calculated based on the formula of

Purchase Date + CouponDaysFrom value.

• CouponDaysFrom – This field is required if the CouponExpirationMethod selected is Days From.

This must be a positive whole number. This will be used to calculate the expiration date of the

purchased coupon.


responses.

• SuccessNoErrors



• UserNameDoesNotExist – This will return if the username provided for the administrator is not valid.


• InvalidOrganization – This is returned when an invalid organization code was provided.

• CouponNumberRequired – This is returned if the coupon number is not provided.

• NameRequired – This is returned if the coupon name is not provided.

• StatusRequired – This is returned if the status is not provided.

• CouponNumberRequired – This is returned if the coupon number is not provided.

• InvalidStartDate – This is returned if the start date is not provided or it is provided in an invalid format.

• InvalidEndDate – This is returned if the end date is not provided or it is provided in an invalid format.

• InvalidAmountType – This is returned if the amount type is not provided or it is provided with an invalid value.

• InvalidCouponType – This is returned if the coupon type is not provided or it is provided with an invalid value.

• InvalidCurriculumNumber – This is returned if the curriculum number provided does not exist in the system or if curriculum number is provided but the coupon type is global. Curriculum number is not applicable if the type is global.

• InvalidValue - This is returned if the value is not provided or it is provided in an invalid format (not numeric or greater than 100 for percent type).

• InvalidQuantity - This is returned if the quantity is not provided or it is provided in an invalid format (not numeric and whole number).

• InvalidAdministrator – If an administrator is provided and the admin does not exist in the LMS

SOAP 1.1








SOAPAction: "http://tempuri.org/CouponAddEdit"





<soap:Body>

<CouponAddEdit xmlns="http://tempuri.org/">

<creds>



</creds>

<objAPICoupon>

<CouponNumber>string</CouponNumber>

<Name>string</Name>

<Site>string</Site>




<AmountType>string</AmountType>

<Value>decimal</Value>

<Quantity>string</Quantity>

<CouponType>string</CouponType>

<CurrNumber>string</CurrNumber>

<ParentCoupon>string</ParentCoupon>

<Administrator>string</Administrator>

<Organization>string</Organization>

<Redeem>int</Redeem>

<Subscription>int</Subscription>

<SendNotification>int</SendNotification>

<CouponExpirationMethod>int</CouponExpirationMethod>

<CouponDaysFrom>int</CouponDaysFrom>

</objAPICoupon>

</CouponAddEdit>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<CouponAddEditResponse xmlns="http://tempuri.org/">

<CouponAddEditResult>

<APIResponse>

<_ResponseList>





</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</CouponAddEditResult>

</CouponAddEditResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2










<soap12:Body>

<CouponAddEdit xmlns="http://tempuri.org/">

<creds>



</creds>

<objAPICoupon>


<Name>string</Name>

<Site>string</Site>




<AmountType>string</AmountType>

<Value>decimal</Value>

<Quantity>string</Quantity>

<CouponType>string</CouponType>

<CurrNumber>string</CurrNumber>

<ParentCoupon>string</ParentCoupon>

<Administrator>string</Administrator>

<Organization>string</Organization>

<Redeem>int</Redeem>

<Subscription>int</Subscription>

<SendNotification>int</SendNotification>



<CouponExpirationMethod>int</CouponExpirationMethod>

<CouponDaysFrom>int</CouponDaysFrom>

</objAPICoupon>

</CouponAddEdit>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<CouponAddEditResponse xmlns="http://tempuri.org/">

<CouponAddEditResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

</CouponAddEditResult>

</CouponAddEditResponse>

</soap12:Body>

</soap12:Envelope>



CouponRedemption

Description: The CouponRedemption method facilitates the redemption of a coupon for a user in the LMS environment. All input values are required for the method to successfully be executed.

Inputs:







• LoginID – The username for the user who the coupon is being redeemed for.

• CouponNumber – The coupon number being redeemed

• CurriculumNumber – The curriculum number associated with the coupon

• EventID – The event ID to be registered if the curriculum number is a training session.

• DisableDrop – This sets the disable drop flag. If a 0 is sent, the user will be allowed to drop the

registration in the LMS. If a 1 is sent, the user will not be allowed to drop the registration.


responses.

• SuccessNoErrors




• InvalidCoupon – The coupon provided does not match a coupon in the LMS.

• QuantityUnavailable – The coupon provided has 0 quantity remaining and cannot be redeemed

• InvalidDrop – The value provided in the drop element was not a 0 or 1.

• CurrentlyInProcess – The response when the user cannot be registered for the training because they are currently in process of that training under a different registration.

• InvalidCurriculumNumber – The curriculum number provided does not exist in the LMS.

• NotAssociatedCurriculumNumber – the curriculum number provided is not associated with the coupon.


• CouponIsOutOfDateRange – the coupon code provided is valid but is currently outside of the start and end date



SOAP 1.1






SOAPAction: "http://tempuri.org/CouponRedemption"





<soap:Body>

<CouponRedemption xmlns="http://tempuri.org/">

<creds>



</creds>




<RegEventId>string</RegEventId>

<Disabledrop>string</Disabledrop>

</CouponRedemption>

</soap:Body>

</soap:Envelope>

HTTP/1.1 200 OK







<soap:Body>

<CouponRedemptionResponse xmlns="http://tempuri.org/">

<CouponRedemptionResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>




</APIResponse>

</CouponRedemptionResult>

</CouponRedemptionResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2










<soap12:Body>

<CouponRedemption xmlns="http://tempuri.org/">

<creds>



</creds>




<RegEventId>string</RegEventId>

<Disabledrop>string</Disabledrop>

</CouponRedemption>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK







<soap12:Body>

<CouponRedemptionResponse xmlns="http://tempuri.org/">

<CouponRedemptionResult>

<APIResponse>

<_ResponseList>



</_ResponseList>

<Id>int</Id>


</APIResponse>

<APIResponse>

<_ResponseList>





</_ResponseList>

<Id>int</Id>


</APIResponse>

</CouponRedemptionResult>

</CouponRedemptionResponse>

</soap12:Body>

</soap12:Envelope>

Documents

Data Integration eSSentials - eLogic Learning€¦ · • Event Roster – This provides the ability to return a list of all users registered for a specific event including any information