Group Enrolment - GroupEnrolment - Enrols a Candidate on a Course

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

Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.learningassistant.com" xmlns:types="https://api.learningassistant.com/encodedTypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header>
    <tns:authToken id="h_id1">
      <id xsi:type="xsi:string"> {id} </id>
      <uuid xsi:type="xsi:string"> {uuid} </uuid>
    </tns:authToken>
  </soap:Header>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:GroupEnrolment>
      <User href="#id1"/>
      <blnAssignEvaluationOnEnroll xsi:type="xsi:boolean"> {blnAssignEvaluationOnEnroll} </blnAssignEvaluationOnEnroll>
      <blnSendLoginDetailsOnEnroll xsi:type="xsi:boolean"> {blnSendLoginDetailsOnEnroll} </blnSendLoginDetailsOnEnroll>
    </tns:GroupEnrolment>
    <q1:Type_enrolmentUser id="id1" xmlns:q1="http://enrolment.types.soap.webservices" xsi:type="q1:Type_enrolmentUser">
      <Address href="#id2"/>
      <AwardingBodyRegistrationNo xsi:type="xsi:string"> {AwardingBodyRegistrationNo} </AwardingBodyRegistrationNo>
      <BirthDate xsi:type="xsd:string"> {BirthDate} </BirthDate>
      <CompanyUUID xsi:type="xsd:string"> {CompanyUUID} </CompanyUUID>
      <Course href="#id3"/>
      <Department xsi:type="xsd:string"> {Department} </Department>
      <EmailAddress xsi:type="xsd:string"> {EmailAddress} </EmailAddress>
      <EmployeeReferenceNumber xsi:type="xsd:string"> {EmployeeReferenceNumber} </EmployeeReferenceNumber>
      <EmploymentStatus xsi:type="xsd:string"> {EmploymentStatus} </EmploymentStatus>
      <EthnicityID xsi:type="xsd:string"> {EthnicityID} </EthnicityID>
      <Forename xsi:type="xsd:string"> {Forename} </Forename>
      <Gender xsi:type="xsd:string"> {Gender} </Gender>
      <JobTitle xsi:type="xsd:string"> {JobTitle} </JobTitle>
      <LineManager xsi:type="xsd:string"> {LineManager} </LineManager>
      <LineManagerEmailAddress xsi:type="xsd:string"> {LineManagerEmailAddress} </LineManagerEmailAddress>
      <LineManagerPhoneNumber xsi:type="xsd:string"> {LineManagerPhoneNumber} </LineManagerPhoneNumber>
      <MobileNumber xsi:type="xsd:string"> {MobileNumber} </MobileNumber>
      <NINumber xsi:type="xsd:string"> {NINumber} </NINumber>
      <NationalityID xsi:type="xsd:string"> {NationalityID} </NationalityID>
      <Password xsi:type="xsd:string"> {Password} </Password>
      <PhoneNumber xsi:type="xsd:string"> {PhoneNumber} </PhoneNumber>
      <PreferredNameOnCertificate xsi:type="xsd:string"> {PreferredNameOnCertificate} </PreferredNameOnCertificate>
      <SourceSystemLearnerUUID xsi:type="xsd:string"> {SourceSystemLearnerUUID} </SourceSystemLearnerUUID>
      <StudentULN xsi:type="xsd:string"> {StudentULN} </StudentULN>
      <Surname xsi:type="xsd:string"> {Surname} </Surname>
      <Title xsi:type="xsd:string"> {Title} </Title>
      <Units href="#id4"/>
      <Username xsi:type="xsd:string"> {Username} </Username>
    </q1:Type_enrolmentUser>
    <q2:Type_enrolmentAddress id="id2" xmlns:q2="http://enrolment.types.soap.webservices" xsi:type="q2:Type_enrolmentAddress">
      <Address1 xsi:type="xsd:string"> {Address1} </Address1>
      <Address2 xsi:type="xsd:string"> {Address2} </Address2>
      <Address3 xsi:type="xsd:string"> {Address3} </Address3>
      <Country xsi:type="xsd:string"> {Country} </Country>
      <County xsi:type="xsd:string"> {County} </County>
      <PostCode xsi:type="xsd:string"> {PostCode} </PostCode>
      <Town xsi:type="xsd:string"> {Town} </Town>
    </q2:Type_enrolmentAddress>
    <q3:Type_enrolmentCourse id="id3" xmlns:q3="http://enrolment.types.soap.webservices" xsi:type="q3:Type_enrolmentCourse">
      <ApprenticeshipPackageCode xsi:type="xsd:string"> {ApprenticeshipPackageCode} </ApprenticeshipPackageCode>
      <AwardingBodyUUID xsi:type="xsd:string"> {AwardingBodyUUID} </AwardingBodyUUID>
      <CentreNumber xsi:type="xsd:string"> {CentreNumber} </CentreNumber>
      <CourseQAN xsi:type="xsd:string"> {CourseQAN} </CourseQAN>
      <CourseTemplateUUID xsi:type="xsd:string"> {CourseTemplateUUID} </CourseTemplateUUID>
      <EndDate xsi:type="xsd:string"> {EndDate} </EndDate>
      <FundingBodyRegistrationDate xsi:type="xsd:string"> {FundingBodyRegistrationDate} </FundingBodyRegistrationDate>
      <PrimaryAssessorUUID xsi:type="xsd:string"> {PrimaryAssessorUUID} </PrimaryAssessorUUID>
      <PrimaryVerifierUUID xsi:type="xsd:string"> {PrimaryVerifierUUID} </PrimaryVerifierUUID>
      <PurchaseOrderReference xsi:type="xsd:string"> {PurchaseOrderReference} </PurchaseOrderReference>
      <StartDate xsi:type="xsd:string"> {StartDate} </StartDate>
      <<intContractMinutes xsi:type="xsd:string"> {intContractMinutes} </<intContractMinutes>
    </q3:Type_enrolmentCourse>
    <soapenc:Array id="id4" xmlns:q4="http://enrolment.types.soap.webservices" soapenc:arrayType="q4:Type_enrolmentUnit[2]">
      <Item href="#id5"/>
      <Item href="#id6"/>
    </soapenc:Array>
    <q5:Type_enrolmentUnit id="id5" xsi:type="q5:Type_enrolmentUnit" xmlns:q5="http://enrolment.types.soap.webservices">
      <EndDate xsi:type="xsi:string"> {EndDate} </EndDate>
      <StartDate xsi:type="xsi:string"> {StartDate} </StartDate>
      <UnitTemplateUUID xsi:type="xsi:string"> {UnitTemplateUUID} </UnitTemplateUUID>
      <szQAN xsi:type="xsi:string"> {szQAN} </szQAN>
    </q5:Type_enrolmentUnit>
    <q6:Type_enrolmentUnit id="id6" xsi:type="q6:Type_enrolmentUnit" xmlns:q6="http://enrolment.types.soap.webservices">
      <EndDate xsi:type="xsi:string"> {EndDate} </EndDate>
      <StartDate xsi:type="xsi:string"> {StartDate} </StartDate>
      <UnitTemplateUUID xsi:type="xsi:string"> {UnitTemplateUUID} </UnitTemplateUUID>
      <szQAN xsi:type="xsi:string"> {szQAN} </szQAN>
    </q6:Type_enrolmentUnit>
  </soap:Body>
</soap:Envelope>

Response

<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:Body>
    <ns3:GroupEnrolmentResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns3="https://api.learningassistant.com">
      <GroupEnrolmentReturn xsi:type="ns4:webservices.soap.types.enrolment.Type_enrolmentUserReturn" xmlns:ns4="http://rpc.xml.coldfusion">
        <candidateCreated xsi:type="soapenc:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateCreated} </candidateCreated>
        <candidateUUID xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateUUID} </candidateUUID>
        <courseUUID xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {courseUUID} </courseUUID>
        <messageList soapenc:arrayType="xsd:anyType[2]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
          <messageList xsi:type="ns4:webservices.soap.types.standard.Type_ErrorMessage">
            <errorCode xsi:type="soapenc:string"> {errorCode} </errorCode>
            <errorMessage xsi:type="soapenc:string"> {errorMessage} </errorMessage>
          </messageList>
          <messageList xsi:type="ns4:webservices.soap.types.standard.Type_ErrorMessage">
            <errorCode xsi:type="soapenc:string"> {errorCode} </errorCode>
            <errorMessage xsi:type="soapenc:string"> {errorMessage} </errorMessage>
          </messageList>
        </messageList>
        <sourceSystemLearnerUUID xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {sourceSystemLearnerUUID} </sourceSystemLearnerUUID>
        <studentULN xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {studentULN} </studentULN>
      </GroupEnrolmentReturn>
    </ns3:GroupEnrolmentResponse>
  </soapenv:Body>
</soapenv:Envelope>

Request Fields

authToken struct Required
id string Required
uuid string Required
GroupEnrolment struct Required
Top level field for GroupEnrolment method
User struct Required
BirthDate string (date format) Required
Birth Date must be in date format: 'yyyy/mm/dd'
CompanyUUID string Required
Must match to a valid company within your Learning Assistant instance (please use the GetCompanies method)
Course struct Required
CourseQAN string Required
Required IF CourseTemplateUUID is not present. (CourseTemplateUUID will take precedence if both are supplied)
CourseTemplateUUID string Required
Required IF CourseQAN is not present. (CourseTemplateUUID will take precedence if both are supplied)
EndDate string (date format)
End Date must be in date format: 'yyyy/mm/dd'
PrimaryAssessorUUID string Required
Must be a valid UUID for an assessor that is assigned to that course template. (Please use the GetTrainers method)
PrimaryVerifierUUID string Required
Must be a valid UUID for a verifier that is assigned to that course template. (Please use the GetTrainers method)
StartDate string (date format)
Start Date must be in date format: 'yyyy/mm/dd'
AwardingBodyUUID DEPRECATED
AwardingBodyUUID is now pulled directly from the course template.
Department string
EmailAddress string
EmployeeReferenceNumber string
EmploymentStatus string
EthnicityID string
Will be ignored if the ID does not match to one found in the GetEthnicities method.
Forename string Required
Gender string Required
By default, must be one of: Bigender, Cisgender, F, Female, M, Male, Neutral, Non-binary, Non-conforming, Transgender, U, Rather not say (Genders can be added to or removed from this list, in individual instances.)
JobTitle string
LineManager string
LineManagerEmailAddress string
LineManagerPhoneNumber string
MobileNumber string
NINumber string
NationalityID string
Will be ignored if the ID does not match to one found in the GetNationalities method.
Password string
If the password is not provided, a random one will be generated.
PhoneNumber string
PreferredNameOnCertificate string
Units array
EndDate string
End Date must be in date format: 'yyyy/mm/dd'
StartDate string
Start Date must be in date format: 'yyyy/mm/dd'
UnitTemplateUUID string
szQAN string
Address struct
Address1 string
Address2 string
Address3 string
Country string
County string
PostCode string
Town string
Username string
If the username is not provided, one will be provided in the format of 'Firstname.Surname'. If that username is taken, it will try and create a unique one (Firstname.Surname1) etc.
Surname string Required
Title string Required
By default, must be one of: Dr, Miss, Mr, Mrs, Ms, Mx, N/A, - (Titles can be added to or removed from this list, in individual instances.)
blnAssignEvaluationOnEnroll boolean Required
If true, the user will automatically be assign the evaluation form to the candidate.
blnSendLoginDetailsOnEnroll boolean Required
If true, the candidate will automatically be sent a welcome/login details email containing their username and password. Note: This would not be sent if the optional email address was left blank or an invalid email address.

Response Fields

GroupEnrolmentReturn struct
CandidateCreated boolean
CandidateUUID string
SourceSystemLearnerUUID string
StudentULN string
CourseUUID string