Appointments - CreateAppointments - Create an appointment/review against a candidate

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:CreateAppointments xmlns:ns1="https://api.learningassistant.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <Appointments xmlns:ns2="http://appointments.types.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" soapenc:arrayType="ns2:Create[1]" xsi:type="soapenc:Array">
        <Appointments xsi:type="ns2:Create">
          <dtActual xsi:type="xsd:string"> {dtActual} </dtActual>
          <dtEndTime xsi:type="xsd:string"> {dtEndTime} </dtEndTime>
          <dtStartTime xsi:type="xsd:string"> {dtStartTime} </dtStartTime>
          <szCompanyName xsi:type="xsd:string"> {szCompanyName} </szCompanyName>
          <szDescription xsi:type="xsd:string"> {szDescription} </szDescription>
          <szLocation xsi:type="xsd:string"> {szLocation} </szLocation>
          <szTitle xsi:type="xsd:string"> {szTitle} </szTitle>
          <uuidCandidate xsi:type="xsd:string"> {uuidCandidate} </uuidCandidate>
          <uuidCategory xsi:type="xsd:string"> {uuidCategory} </uuidCategory>
          <uuidCourse xsi:type="xsd:string"> {uuidCourse} </uuidCourse>
          <uuidStatus xsi:type="xsd:string"> {uuidStatus} </uuidStatus>
          <uuidUser xsi:type="xsd:string"> {uuidUser} </uuidUser>
        </Appointments>
      </Appointments>
    </ns1:CreateAppointments>
  </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:CreateAppointmentsResponse xmlns:ns2="https://api.learningassistant.com" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <CreateAppointmentsReturn xmlns:ns3="http://appointments.types.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" soapenc:arrayType="ns3:Create_return[1]" xsi:type="soapenc:Array">
        <CreateAppointmentsReturn xsi:type="ns3:Create_return">
          <AppointmentCreated xsi:type="xsd:boolean"> {AppointmentCreated} </AppointmentCreated>
          <MessageList xmlns:ns4="http://standard.types.soap.webservices" soapenc:arrayType="ns4:Type_ErrorMessage[0]" xsi:type="soapenc:Array" />
          <uuidAppointment xsi:type="xsd:string"> {uuidAppointment} </uuidAppointment>
        </CreateAppointmentsReturn>
      </CreateAppointmentsReturn>
    </ns2:CreateAppointmentsResponse>
  </soapenv:Body>
</soapenv:Envelope>
Request Fields
  • authToken struct Required
    The header authtoken.
  • id string Required
    You webservice user ID.
  • uuid string Required
    You webservice session token UUID.
  • Appointments struct Required
    Your appointment struct
  • uuidUser string Required
    The trainer's UUID that this appointment belongs to.
  • uuidCandidate string
    Candidates UUID (if you wish to map the appointment to the candidate).
  • uuidCourse string
    Candidates Course UUID (if you wish to map the appointment to the candidate) Note: this is required if CandidateUUID is provided.
  • uuidCategory string Required
    Category UUID for the appoint, use GetAppointmentCategories for a list of valid categories.
  • uuidStatus string
    Status UUID for the appoint, use GetAppointmentStatuses for a list of valid statuses.
  • dtStartTime string (date format) Required
    Start time for the appointment. Must be in date format: 'yyyy/mm/dd hh:mm:ss' and the minutes must be in a 5 minute increment (00,05,10,15 etc).
  • dtEndTime string (date format) Required
    End time for the appointment. Must be in date format: 'yyyy/mm/dd hh:mm:ss' and the minutes must be in a 5 minute increment (00,05,10,15 etc).
  • dtActual string (date format)
    Actual time for the appointment. Must be in date format: 'yyyy/mm/dd hh:mm:ss' and the minutes must be in a 5 minute increment (00,05,10,15 etc).
  • szTitle string Required
    Title for the appointment
  • szCompanyName string Required
    Company name for the appointment
  • szCompanyName string Required
    Company name for the appointment
  • szLocation string
    Location for the appointment
  • szDescription string
    Description/Notes for the appointment.
  • szLocation string
    Location for the appointment
  • szCompanyName string Required
    Company name for the appointment
Response Fields
  • CreateAppointmentsReturn struct
  • AppointmentCreated boolean
  • uuidAppointment string