Users - GetProgress - Gets candidates progress
Service URL: https://api.learningassistant.com/webservices/soap/user.cfc?wsdl
Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="http://api.learningassistant.com" xmlns:ns1="http://api.learningassistant.com">
<id type="xsd:string"> {ID} </id>
<uuid type="xsd:string"> {UUID} </uuid>
</authToken>
</soapenv:Header>
<soapenv:Body>
<ns1:GetProgress soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="https://api.learningassistant.com">
<CandidateUUID xsi:type="xsd:string"> {CandidateUUID} </CandidateUUID>
<CourseUUID xsi:type="xsd:string"> {CourseUUID} </CourseUUID>
<CourseTemplateUUID xsi:type="xsd:string"> {CourseTemplateUUID} </CourseTemplateUUID>
<QAN xsi:type="xsd:string"> {QAN} </QAN>
<UnitTemplateUUID xsi:type="xsd:string"> {UnitTemplateUUID} </UnitTemplateUUID>
</ns1:GetProgress>
</soapenv:Body>
</soapenv:Envelope>
Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="http://api.learningassistant.com" xmlns:ns1="http://api.learningassistant.com">
<id type="xsd:string"> {ID} </id>
<uuid type="xsd:string"> {UUID} </uuid>
</authToken>
</soapenv:Header>
<soapenv:Body>
<ns2:GetProgressResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
<GetProgressReturn soapenc:arrayType="ns3:Type_progress[0]" xmlns:ns3="http://user.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
<GetProgressReturn xsi:type="ns3:Type_progress">
<Appointments soapenc:arrayType="ns4:Type_appointmentFull[0]" xmlns:ns4="http://appointment.types.soap.webservices" xsi:type="soapenc:Array"> {Appointments} </Appointments>
<CandidateForename xsi:type="xsd:string"> {CandidateForename} </CandidateForename>
<CandidateSurname xsi:type="xsd:string"> {CandidateSurname} </CandidateSurname>
<CandidateUUID xsi:type="xsd:string"> {CandidateUUID} </CandidateUUID>
<CourseName xsi:type="xsd:string"> {CourseName} </CourseName>
<CourseTemplateUUID xsi:type="xsd:string"> {CourseTemplateUUID} </CourseTemplateUUID>
<CourseUUID xsi:type="xsd:string"> {CourseUUID} </CourseUUID>
<Units soapenc:arrayType="ns3:Type_progressUnit[1]" xsi:type="soapenc:Array">
<Units xsi:type="ns3:Type_progressUnit">
<Mandatory xsi:type="xsd:string"> {Mandatory} </Mandatory>
<Progress xsi:type="xsd:string"> {Progress} </Progress>
<QAN xsi:type="xsd:string"> {QAN} </QAN>
<UnitLabel xsi:type="xsd:string"> {UnitLabel} </UnitLabel>
<UnitName xsi:type="xsd:string"> {UnitName} </UnitName>
<UnitTemplateUUID xsi:type="xsd:string"> {UnitTemplateUUID} </UnitTemplateUUID>
<UnitUUID xsi:type="xsd:string"> {UnitUUID} </UnitUUID>
</Units>
</Units>
</GetProgressReturn>
</GetProgressReturn>
</ns2:GetProgressResponse>
</soapenv:Body>
</soapenv:Envelope>
Request Fields
-
GetProgress array
Required
Top level field for GetProgress method
-
CandidateUUID string
Required
Candidate uuid
-
CourseUUID string
Required
Source uuid
-
CourseTemplateUUID string
Required
Course template uuid
-
QAN string
Required
QAN
-
UnitTemplateUUID string
Required
Unit template uuid
Response Fields
-
GetProgressReturn array
Top level field for GetProgress method
-
Appointments string
Top level field for GetProgress method
-
CandidateForename string
Top level field for GetProgress method
-
CandidateSurname string
Top level field for GetProgress method
-
CandidateUUID string
Top level field for GetProgress method
-
CourseName string
Top level field for GetProgress method
-
CourseTemplateUUID string
Top level field for GetProgress method
-
CourseUUID string
Top level field for GetProgress method
-
Units array
Top level field for GetProgress method
-
Mandatory string
Top level field for GetProgress method
-
Progress string
Top level field for GetProgress method
-
QAN string
Top level field for GetProgress method
-
UnitLabel string
Top level field for GetProgress method
-
UnitName string
Top level field for GetProgress method
-
UnitTemplateUUID string
Top level field for GetProgress method
-
UnitUUID string
Top level field for GetProgress method