Users - GetProgressFull - Gets candidates progress (includes statuses and elements)

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:GetProgressFull 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>
      <UserUUIDs soapenc:arrayType="ns2:Type_progressUserUUID[0]" xmlns:ns2="http://user.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
        <UserUUIDs xsi:type="ns2:Type_progressUserUUID">
          <UserUUID xsi:type="xsd:string"> {UserUUID} </UserUUID>
        </UserUUIDs>
      </UserUUIDs>
    </ns1:GetProgressFull>
  </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:GetProgressFullResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
      <GetProgressFullReturn soapenc:arrayType="ns3:Type_progressFull[0]" xmlns:ns3="http://user.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
        <GetProgressFullReturn xsi:type="ns3:Type_progressFull">
          <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_progressFullUnit[0]" xsi:type="soapenc:Array">
            <Units xsi:type="ns3:Type_progressFullUnit">
              <Elements soapenc:arrayType="ns3:Type_progressFullElement[0]" xsi:type="soapenc:Array">
                <Elements xsi:type="ns3:Type_progressFullElement">
                  <ElementLabel xsi:type="xsd:string"> {ElementLabel} </ElementLabel>
                  <ElementName xsi:type="xsd:string"> {ElementName} </ElementName>
                  <ElementStatus xsi:type="xsd:string"> {ElementStatus} </ElementStatus>
                  <ElementStatusCode xsi:type="xsd:string"> {ElementStatusCode} </ElementStatusCode>
                  <ElementStatusID xsi:type="xsd:string"> {ElementStatusID} </ElementStatusID>
                  <ElementTemplateUUID xsi:type="xsd:string"> {ElementTemplateUUID} </ElementTemplateUUID>
                  <ElementUUID xsi:type="xsd:string"> {ElementUUID} </ElementUUID>
                  <Link xsi:type="xsd:string"> {Link} </Link>
                  <Mandatory xsi:type="xsd:string"> {Mandatory} </Mandatory>
                  <Progress xsi:type="xsd:string"> {Progress} </Progress>
                  <QAN xsi:type="xsd:string"> {QAN} </QAN>
                </Elements>
              </Elements>
              <Link xsi:type="xsd:string"> {Link} </Link>
              <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> 
              <UnitStatus xsi:type="xsd:string"> {UnitStatus} </UnitStatus>
              <UnitStatusCode xsi:type="xsd:string"> {UnitStatusCode} </UnitStatusCode>
              <UnitStatusID xsi:type="xsd:string"> {UnitStatusID} </UnitStatusID>
              <UnitTemplateUUID xsi:type="xsd:string"> {UnitTemplateUUID} </UnitTemplateUUID>
              <UnitUUID xsi:type="xsd:string"> {UnitUUID} </UnitUUID>
            </Units>
          </Units>
        </GetProgressFullReturn>
      </GetProgressFullReturn>
    </ns2:GetProgressFullResponse>
  </soapenv:Body>
</soapenv:Envelope> 
Request Fields
  • GetProgressFull array Required
    Top level field for GetProgressFull method
  • CandidateUUID string Required
    Candidate uuid
  • CourseUUID string Required
    Course uuid
  • CourseTemplateUUID string Required
    Course template uuid
  • QAN string Required
    QAN
  • UnitTemplateUUID string Required
    Unit template uuid
  • UserUUIDs array Required
    Array of user uuids
  • UserUUID string Required
    User uuid
Response Fields
  • GetProgressFullReturn array
    Top level field for GetProgressFull method
  • CandidateForename string
    Top level field for GetProgressFull method
  • CandidateSurname string
    Top level field for GetProgressFull method
  • CandidateUUID string
    Top level field for GetProgressFull method
  • CourseName string
    Top level field for GetProgressFull method
  • CourseTemplateUUID string
    Top level field for GetProgressFull method
  • CourseUUID string
    Top level field for GetProgressFull method
  • Units array
    Top level field for GetProgressFull method
  • Elements array
    Top level field for GetProgressFull method
  • ElementLabel string
    Top level field for GetProgressFull method
  • ElementName string
    Top level field for GetProgressFull method
  • ElementStatus string
    Top level field for GetProgressFull method
  • ElementStatusCode string
    Top level field for GetProgressFull method
  • ElementStatusID string
    Top level field for GetProgressFull method
  • ElementTemplateUUID string
    Top level field for GetProgressFull method
  • ElementUUID string
    Top level field for GetProgressFull method
  • Link string
    Top level field for GetProgressFull method
  • Mandatory string
    Top level field for GetProgressFull method
  • Progress string
    Top level field for GetProgressFull method
  • QAN string
    Top level field for GetProgressFull method
  • Link string
    Top level field for GetProgressFull method
  • Mandatory string
    Top level field for GetProgressFull method
  • Progress string
    Top level field for GetProgressFull method
  • QAN string
    Top level field for GetProgressFull method
  • UnitLabel string
    Top level field for GetProgressFull method
  • UnitName string
    Top level field for GetProgressFull method
  • UnitStatus string
    Top level field for GetProgressFull method
  • UnitStatusCode string
    Top level field for GetProgressFull method
  • UnitStatusID string
    Top level field for GetProgressFull method
  • UnitTemplateUUID string
    Top level field for GetProgressFull method
  • UnitUUID string
    Top level field for GetProgressFull method