Appointments - GetAppointments - Get a list of appointments, optionally filtered by trainer, candidate, course etc.

Service URL: https://api.learningassistant.com/webservices/soap/appointments.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 xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com" loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0">
      <id type="xsd:string"> {id} </id>
      <uuid type="xsd:string"> {uuid} </uuid>
    </authToken>
  </soapenv:Header>
  <soapenv:Body>
    <ns1:GetAppointments xmlns:ns1="https://api.learningassistant.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <AppointmentUUID xsi:type="xsd:string"> {AppointmentUUID} </AppointmentUUID>
      <TrainerUUID xsi:type="xsd:string"> {TrainerUUID} </TrainerUUID>
      <CandidateUUID xsi:type="xsd:string"> {CandidateUUID} </CandidateUUID>
      <CourseUUID xsi:type="xsd:string"> {CourseUUID} </CourseUUID>
    </ns1:GetAppointments>
  </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 xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com" loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0">
      <id type="xsd:string"> {id} </id>
      <uuid type="xsd:string"> {uuid} </uuid>
    </authToken>
  </soapenv:Header>
  <soapenv:Body>
    <ns2:GetAppointmentsResponse xmlns:ns2="https://api.learningassistant.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <GetAppointmentsReturn xmlns:ns3="http://appointments.types.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" soapenc:arrayType="ns3:Appointment[0]" xsi:type="soapenc:Array">
        <GetAppointmentsReturn xsi:type="ns3:Appointment">
          <dtActual xsi:type="xsd:string"> {dtActual} </dtActual>
          <dtEndTime xsi:type="xsd:string"> {dtEndTime} </dtEndTime>
          <dtStartTime xsi:type="xsd:string"> {dtStartTime} </dtStartTime>
          <szAssessorName xsi:type="xsd:string"> {szAssessorName} </szAssessorName>
          <szCandidateName xsi:type="xsd:string"> {szCandidateName} </szCandidateName>
          <szCategoryName xsi:type="xsd:string"> {szCategoryName} </szCategoryName>
          <szCompanyName xsi:type="xsd:string"> {szCompanyName} </szCompanyName>
          <szCourseName xsi:type="xsd:string"> {szCourseName} </szCourseName>
          <szDescription xsi:type="xsd:string"> {szDescription} </szDescription>
          <szLocation xsi:type="xsd:string"> {szLocation} </szLocation>
          <szStatusName xsi:type="xsd:string"> {szStatusName} </szStatusName>
          <szStatusRef xsi:type="xsd:string"> {szStatusRef} </szStatusRef>
          <szTitle xsi:type="xsd:string"> {szTitle} </szTitle>
          <uuidAppointment xsi:type="xsd:string"> {uuidAppointment} </uuidAppointment>
          <uuidCandidate xsi:type="xsd:string"> {uuidCandidate} </uuidCandidate>
          <uuidCategory xsi:type="xsd:string"> {uuidCategory} </uuidCategory>
          <uuidCourse xsi:type="xsd:string"> {uuidCourse} </uuidCourse>
          <uuidCourseTemplate xsi:type="xsd:string"> {uuidCourseTemplate} </uuidCourseTemplate>
          <uuidStatus xsi:type="xsd:string"> {uuidStatus} </uuidStatus>
          <uuidUser xsi:type="xsd:string"> {uuidUser} </uuidUser>
        </GetAppointmentsReturn>
      </GetAppointmentsReturn>
    </ns2:GetAppointmentsResponse>
  </soapenv:Body>
</soapenv:Envelope>
Request Fields
  • GetAppointments struct Required
  • AppointmentUUID string
  • TrainerUUID string
  • CandidateUUID string
  • CourseUUID string
Response Fields
  • GetAppointmentsReturn array
  • dtActual string
  • dtEndTime string
  • dtStartTime string
  • szAssessorName string
  • szCandidateName string
  • szCategoryName string
  • szCompanyName string
  • szCourseName string
  • szDescription string
  • szLocation string
  • szStatusRef string
  • szTitle string
  • uuidAppointment string
  • uuidCandidate string
  • uuidCategory string
  • uuidCourse string
  • uuidCourseTemplate string
  • uuidStatus string
  • uuidUser string