ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

LitmosDashboardAggregates

Dashboard aggregated data for litmos LMS.

API	Description
GET api/LitmosDashboardAggregates/GetAll?litmosid={litmosid}&lmsAccType={lmsAccType}&sourceAppId={sourceAppId}	Get List of dashboard aggregates - Where
GET api/LitmosDashboardAggregates?litmosid={litmosid}&lmsAccType={lmsAccType}&sourceAppId={sourceAppId}&productType={productType}	No documentation available.
POST api/LitmosDashboardAggregates?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosDashboardAggregates/Get?litmosid={litmosid}&lmsAccType={lmsAccType}&sourceAppId={sourceAppId}&productType={productType}	No documentation available.
POST api/LitmosDashboardAggregates/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosDashboardAggregates/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosDashboardAggregates/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosDashboardAggregates/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

Litmos_5i_RequestLoginKey

IN USE The RedSheet_LitmosID API is used to perform CRUD operations for a user's 5i Category Management Litmos ID.

API	Description
GET api/Litmos_5i_RequestLoginKey?litmosID={litmosID}	Get the user's LoginKey for 5i Cateogry Management.
GET api/Litmos_5i_RequestLoginKey/Get?litmosID={litmosID}	Get the user's LoginKey for 5i Cateogry Management.

LitmosUsers

ELearning controller encapsulates all actions and functions for the LMS learning platform. (LMS Integrations)

API	Description
GET api/LitmosUsers?litmosAccType={litmosAccType}&email={email}&sourceApp={sourceApp}	Returns all users associated with the specified Litmos account.
POST api/LitmosUsers?email={email}&firstname={firstname}&lastname={lastname}&litmosAccType={litmosAccType}	Creates the user with the specified litmos account.
POST api/LitmosUsers?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosUsers/Get?litmosAccType={litmosAccType}&email={email}&sourceApp={sourceApp}	Returns all users associated with the specified Litmos account.
POST api/LitmosUsers/Post?email={email}&firstname={firstname}&lastname={lastname}&litmosAccType={litmosAccType}	Creates the user with the specified litmos account.
POST api/LitmosUsers/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosUsers/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosUsers/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosUsers/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

LitmosTeams

Litmos Team Controller: Encapsulates all methods for team manipulation.

API	Description
GET api/LitmosTeams?litmosAccType={litmosAccType}	Get a list of all the teams in the LMS account. Account is selected by the Litmos Key that is passed in.
POST api/LitmosTeams?teamName={teamName}&description={description}&userLitmosID={userLitmosID}&litmosAccType={litmosAccType}&parentId={parentId}	POST: Adds the specified user to the specified team. If the team does not alreay exist it will be created.
GET api/LitmosTeams?name={name}&description={description}&litmosAccType={litmosAccType}	Creates parent team
POST api/LitmosTeams?teamName={teamName}&description={description}&litmosKey={litmosKey}	Creates Litmos Team and returns it's ID
POST api/LitmosTeams?teamName={teamName}&description={description}&litmosKey={litmosKey}&parentId={parentId}	Creates Litmos Child Team under parent by ID
POST api/LitmosTeams?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosTeams/Get?litmosAccType={litmosAccType}	Get a list of all the teams in the LMS account. Account is selected by the Litmos Key that is passed in.
POST api/LitmosTeams/Post?teamName={teamName}&description={description}&userLitmosID={userLitmosID}&litmosAccType={litmosAccType}&parentId={parentId}	POST: Adds the specified user to the specified team. If the team does not alreay exist it will be created.
GET api/LitmosTeams/CreateParentTeam?name={name}&description={description}&litmosAccType={litmosAccType}	Creates parent team
POST api/LitmosTeams/CreateLitmosTeam?teamName={teamName}&description={description}&litmosKey={litmosKey}	Creates Litmos Team and returns it's ID
POST api/LitmosTeams/CreateLitmosChildTeam?teamName={teamName}&description={description}&litmosKey={litmosKey}&parentId={parentId}	Creates Litmos Child Team under parent by ID
POST api/LitmosTeams/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosTeams/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosTeams/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosTeams/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

LitmosLearningPaths

Gets Litmos Learning Paths assigned to the specified user.

API	Description
GET api/LitmosLearningPaths?litmosID={litmosID}&lmsAccType={lmsAccType}	GET: Learning paths assigned to the specified user.
POST api/LitmosLearningPaths?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosLearningPaths/Get?litmosID={litmosID}&lmsAccType={lmsAccType}	GET: Learning paths assigned to the specified user.
POST api/LitmosLearningPaths/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosLearningPaths/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosLearningPaths/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosLearningPaths/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

Workflow_CompanyApplicationUsers

Encapsulates methods for Company Application Users.

API	Description
GET api/Workflow_CompanyApplicationUsers?applicationId={applicationId}&userId={userId}	Gets the users for the specified application who belong to the same company as the requestor.
GET api/Workflow_CompanyApplicationUsers/Get?applicationId={applicationId}&userId={userId}	Gets the users for the specified application who belong to the same company as the requestor.

Litmos_RedSheet_RequestLoginKey

IN USE The RedSheet_LitmosID API is used to perform CRUD operations for a user's 5i Category Management Litmos ID.

API	Description
GET api/Litmos_RedSheet_RequestLoginKey?litmosID={litmosID}	Get the user's LoginKey for RedSheet.
GET api/Litmos_RedSheet_RequestLoginKey/Get?litmosID={litmosID}	Get the user's LoginKey for RedSheet.

LitmosUserId

NOT USED!!!! /// Get the users LMS UserID for the specified account type.

API	Description
GET api/LitmosUserId?email={email}&lmsAccType={lmsAccType}	Get the specified users litmos id.
POST api/LitmosUserId?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosUserId/Get?email={email}&lmsAccType={lmsAccType}	Get the specified users litmos id.
POST api/LitmosUserId/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosUserId/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosUserId/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosUserId/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

LitmosLoginKey

Encapsulates all functionality for retrieving a login key.

API	Description
GET api/LitmosLoginKey?litmosID={litmosID}&lmsAccType={lmsAccType}	Get the login key for the user request.
POST api/LitmosLoginKey?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosLoginKey/Get?litmosID={litmosID}&lmsAccType={lmsAccType}	Get the login key for the user request.
POST api/LitmosLoginKey/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosLoginKey/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosLoginKey/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosLoginKey/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

Base

Base Controller class for the PPWebRESTServices

API	Description
POST api/Base?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/Base/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/Base/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/Base/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/Base/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file

Workflow_ApplicationTemplates

API methods for Workflow Application Templates.

API	Description
GET api/Workflow_ApplicationTemplates?applicationId={applicationId}&productId={productId}	GET all workflow project templates for the associated product for the specified application.
GET api/Workflow_ApplicationTemplates/Get?applicationId={applicationId}&productId={productId}	GET all workflow project templates for the associated product for the specified application.

LitmosUserCourses

Gets Litmos Learning Paths assigned to the specified user.

API	Description
GET api/LitmosUserCourses?litmosID={litmosID}&lmsAccType={lmsAccType}&sourceAppId={sourceAppId}&productType={productType}	No documentation available.
POST api/LitmosUserCourses?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
GET api/LitmosUserCourses/Get?litmosID={litmosID}&lmsAccType={lmsAccType}&sourceAppId={sourceAppId}&productType={productType}	No documentation available.
POST api/LitmosUserCourses/API_CanExecute?totalRequests={totalRequests}&LitmosAccType={LitmosAccType}	API_CanExecute will record the api usage and check if there is enough redundancy to execute it. The limit of API calls that can be made per mniute is currently set at 100. (This is set in the stored procedure used to check for availble resources).
POST api/LitmosUserCourses/SendAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Send an email
POST api/LitmosUserCourses/SaveAlert?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves details of the alert in the database
POST api/LitmosUserCourses/SendToLogFile?title={title}&email={email}&message={message}&timestamp={timestamp}	Saves the alert to log file