Users - GetCandidates - Gets a list of candidates

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:GetCandidates soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="https://api.learningassistant.com">
      <CourseQAN xsi:type="xsd:string"> {CourseQAN} </CourseQAN>
      <blnActive xsi:type="xsd:boolean"> {blnActive} </blnActive>
      <blnCompleted xsi:type="xsd:boolean"> {blnCompleted} </blnCompleted>
      <blnTest xsi:type="xsd:boolean"> {blnTest} </blnTest>
    </ns1:GetCandidates>
  </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:GetCandidatesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
      <GetCandidatesReturn soapenc:arrayType="ns3:Type_candidate[0]" xmlns:ns3="http://user.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
        <GetCandidatesReturn xsi:type="ns3:Type_candidate">
          <AnticipatedEndDate xsi:type="xsd:string"> {AnticipatedEndDate} </AnticipatedEndDate>
          <CandidateUUID xsi:type="xsd:string"> {CandidateUUID} </CandidateUUID>
          <CompanyUUID xsi:type="xsd:string"> {CompanyUUID} </CompanyUUID>
          <CourseName xsi:type="xsd:string"> {CourseName} </CourseName>
          <CourseProgress xsi:type="xsd:string"> {CourseProgress} </CourseProgress>
          <CourseShortName xsi:type="xsd:string"> {CourseShortName} </CourseShortName>
          <CourseTemplateUUID xsi:type="xsd:string"> {CourseTemplateUUID} </CourseTemplateUUID>
          <CourseUUID xsi:type="xsd:string"> {CourseUUID} </CourseUUID>
          <DateOfBirth xsi:type="xsd:string"> {DateOfBirth} </DateOfBirth>
          <EDRS xsi:type="xsd:string"> {EDRS} </EDRS>
          <EmailAddress xsi:type="xsd:string"> {EmailAddress} </EmailAddress>
          <Forename xsi:type="xsd:string"> {Forename} </Forename>
          <Gender xsi:type="xsd:string"> {Gender} </Gender>
          <OfficialStartDate xsi:type="xsd:string"> {OfficialStartDate} </OfficialStartDate>
          <QAN xsi:type="xsd:string"> {QAN} </QAN>
          <Surname xsi:type="xsd:string"> {Surname} </Surname>
          <ULN xsi:type="xsd:string"> {ULN} </ULN>
          <Username xsi:type="xsd:string"> {Username} </Username>
        </GetCandidatesReturn>
      </GetCandidatesReturn>
    </ns2:GetCandidatesResponse>
  </soapenv:Body>
</soapenv:Envelope>
Request Fields
  • GetCandidates array Required
    Top level field for GetCandidates method.
  • CourseQAN string Required
    Course QAN
  • blnActive boolean Required
    Active or not
  • blnCompleted boolean Required
    Completed or not
  • blnTest boolean Required
    Test or not
Response Fields
  • GetCandidatesReturn array
    Top level field for GetCandidates method.
  • AnticipatedEndDate string
    Top level field for GetCandidates method.
  • CandidateUUID string
    Top level field for GetCandidates method.
  • CompanyUUID string
    Top level field for GetCandidates method.
  • CourseName string
    Top level field for GetCandidates method.
  • CourseProgress string
    Top level field for GetCandidates method.
  • CourseShortName string
    Top level field for GetCandidates method.
  • CourseTemplateUUID string
    Top level field for GetCandidates method.
  • CourseUUID string
    Top level field for GetCandidates method.
  • DateOfBirth string
    Top level field for GetCandidates method.
  • EDRS string
    Top level field for GetCandidates method.
  • EmailAddress string
    Top level field for GetCandidates method.
  • Forename string
    Top level field for GetCandidates method.
  • Gender string
    Top level field for GetCandidates method.
  • OfficialStartDate string
    Top level field for GetCandidates method.
  • QAN string
    Top level field for GetCandidates method.
  • Surname string
    Top level field for GetCandidates method.
  • ULN string
    Top level field for GetCandidates method.
  • Username string
    Top level field for GetCandidates method.