Group Enrolment - Update - UpdateEnrolment - Updates a Candidate Enrolment

Service URL: https://api.learningassistant.com/webservices/soap/enrolment_update.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-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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:UpdateEnrolment>
      <User href="#id1"/>
    </tns:UpdateEnrolment>
    <q1:Type_enrolmentUserUpdate id="id1" xsi:type="q1:Type_enrolmentUserUpdate" xmlns:q1="http://enrolment.types.soap.webservices">
      <Address href="#id2"/>
      <AwardingBodyRegistrationNo xsi:type="xsi:string"> {AwardingBodyRegistrationNo} </AwardingBodyRegistrationNo>
      <CandidateUUID xsi:type="xsd:string"> {CandidateUUID} </CandidateUUID>
      <CompanyUUID xsi:type="xsd:string"> {CompanyUUID} </CompanyUUID>
      <Course href="#id3"/>
      <CourseUUID xsi:type="xsd:string"> {CourseUUID} </CourseUUID>
      <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>
      <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>
      <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>
      <Units href="#id4"/>
    </q1:Type_enrolmentUserUpdate>
    <q2:Type_enrolmentAddress id="id2" xsi:type="q2:Type_enrolmentAddress" xmlns:q2="http://enrolment.types.soap.webservices">
      <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_enrolmentCourseUpdate id="id3" xsi:type="q3:Type_enrolmentCourseUpdate" xmlns:q3="http://enrolment.types.soap.webservices">
      <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>
      <StartDate xsi:type="xsd:string"> {StartDate} </StartDate>
    </q3:Type_enrolmentCourseUpdate>
    <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:UpdateEnrolmentResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns3="https://api.learningassistant.com">
      <UpdateEnrolmentReturn xsi:type="ns4:webservices.soap.types.enrolment.Type_enrolmentUserUpdateReturn" xmlns:ns4="http://rpc.xml.coldfusion">
        <candidateCompanyMappingUpdated xsi:type="soapenc:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateCompanyMappingUpdated} </candidateCompanyMappingUpdated>
        <candidateCourseRegistrationUpdated xsi:type="soapenc:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateCourseRegistrationUpdated} </candidateCourseRegistrationUpdated>
        <candidateUUID xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateUUID} </candidateUUID>
        <candidateUpdated xsi:type="soapenc:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateUpdated} </candidateUpdated>
        <candidateUserRegistrationUpdated xsi:type="soapenc:boolean" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> {candidateUserRegistrationUpdated} </candidateUserRegistrationUpdated>
        <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>
      </UpdateEnrolmentReturn>
    </ns3:UpdateEnrolmentResponse>
  </soapenv:Body>
</soapenv:Envelope>

Request Fields

authToken struct Required
uuid string Required
id string Required
UpdateEnrolment struct Required
Top level field for UpdateEnrolment method
User struct Required
PhoneNumber string
NationalityID string
Will be ignored if the ID does not match to one found in the GetNationalities method.
PreferredNameOnCertificate string
EmployeeReferenceNumber string
LineManagerPhoneNumber string
LineManagerEmailAddress string
EmailAddress string
Department string
NINumber string
EmploymentStatus 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'
szQAN string
UnitTemplateUUID string
LineManager string
Course struct Required
PrimaryAssessorUUID string Required
Must be a valid UUID for an assessor that is assigned to that course template. (Please use the GetTrainers method)
EndDate string (date format)
End Date must be in date format: 'yyyy/mm/dd'
CourseQAN string Required
Required IF CourseTemplateUUID is not present. (CourseTemplateUUID will take precedence if both are supplied)
PrimaryVerifierUUID string Required
Must be a valid UUID for a verifier that is assigned to that course template. (Please use the GetTrainers method)
CourseTemplateUUID string Required
Required IF CourseQAN is not present. (CourseTemplateUUID will take precedence if both are supplied)
StartDate string (date format)
Start 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)
EthnicityID string
Will be ignored if the ID does not match to one found in the GetEthnicities method.
Address struct
PostCode string
Country string
Address2 string
County string
Address3 string
Address1 string
Town string
JobTitle string
MobileNumber string

Response Fields

UpdateEnrolmentReturn struct
CourseUUID string
candidateCompanyMappingUpdated boolean
CandidateUserRegistrationUpdated boolean
SourceSystemLearnerUUID string
CandidateCourseRegistrationUpdated boolean
CandidateUUID string
CandidateUpdated boolean
StudentULN string