Documentation - An overview of our available services

Appointments

URL: https://api.learningassistant.com/webservices/soap/appointments.cfc?wsdl

Function Name	Description
CreateAppointments	Create an appointment/review against a candidate
GetAppointmentCategories	Get a list of all valid appointment categories
GetAppointments	Get a list of appointments, optionally filtered by trainer, candidate, course etc.
GetAppointmentStatuses	Get a list of all valid appointment statuses
UpdateAppointments	Update an appointment/review against a candidate

Authentication

URL: https://api.learningassistant.com/webservices/soap/authenticate.cfc?wsdl

Function Name	Description
Authenticate	Authenticates a webservice user
AuthenticateUser	Authenticates a system user to use the LA API. NOTE: AuthenticateUser is not yet implemented in the SOAP API. Continue to use Authenticate

Companies

URL: https://api.learningassistant.com/webservices/soap/company.cfc?wsdl

Function Name	Description
CreateCompany
GetCompanies	Gets a list of companies within the system
UpdateCompanyDetails

Contact Diary

URL: https://api.learningassistant.com/webservices/soap/contactdiary.cfc?wsdl

Function Name	Description
AssignDocumentToContactDiary
CreateContactDiary
DeleteContactDiary
GetDiaryEntryDetails
UpdateContactDiary

Courses

URL: https://api.learningassistant.com/webservices/soap/course.cfc?wsdl

Function Name	Description
GetFrameworks	Gets a list of courses in the system
GetFrameworksFull

Evidence

URL: https://api.learningassistant.com/webservices/soap/EvidenceService.cfc?wsdl

Function Name	Description
CreateEvidence
DeleteEvidence
UpdateEvidence

Group Enrolment

URL: https://api.learningassistant.com/webservices/soap/enrolment.cfc?wsdl

Function Name	Description
GroupEnrolment	Enrols a Candidate on a Course

Group Enrolment - Update

URL: https://api.learningassistant.com/webservices/soap/enrolment_update.cfc?wsdl

Function Name	Description
UpdateEnrolment	Updates a Candidate Enrolment

Learner

URL: https://api.learningassistant.com/webservices/soap/learner.cfc?wsdl

Function Name	Description
GetElements

Messages

URL: https://api.learningassistant.com/webservices/soap/MessageCentreSoapApi.cfc?wsdl

Function Name	Description
GetUnreadMessages	Gets a list of unread messages from a particular users message centre in Learning Assistant.
UpdateMessageStatus	This Method updates the read status of a particular message in Learning Assistant from the Routemap.

Task

URL: https://api.learningassistant.com/webservices/soap/TaskSoapApi.cfc?wsdl

Function Name	Description
GetTaskProgress
UpdateTaskStatus

Tasks

URL: https://api.learningassistant.com/webservices/soap/tasks.cfc?wsdl

Function Name	Description
GetQualificationTasksProgress
UpdateTaskStatus

Team Manager

URL: https://api.learningassistant.com/webservices/soap/TeamManager.cfc?wsdl

Function Name	Description
AssignCoursesToTrainer
CreateTrainer

Trainers

URL: https://api.learningassistant.com/webservices/soap/TrainerServiceSoapApi.cfc?wsdl

Function Name	Description
GetAssessorOverdueNotes	Gets a list of Overdue Notifications for a particular Assessor/Tutor from Learning Assistant.
GetAssessorReferrals	Gets a list of Verifier Referrals sent to a particular Assessor in Learning Assistant.
GetElementsToReview	Gets a list of Elements which need to be reviewed by a particular Assessor in Learning Assistant.
GetIVReferrals	Gets a list Assessor's Updates to a IV's Verifier Referrals in Learning Assistant.
GetUnitsAwaitingVerification	Gets a list of Units awaiting Verification for a particular IV from Learning Assistant.

Users

URL: https://api.learningassistant.com/webservices/soap/user.cfc?wsdl

Function Name	Description
GetCandidates	Gets a list of candidates
GetEthnicities	Gets a list of system ethnicities
GetNationalities	Gets a list of system nationalities
GetProgress	Gets candidates progress
GetProgressFull	Gets candidates progress (includes statuses and elements)
GetTrainers	Gets a list of trainers in their respective user groups