Importing Historical Appointments

Liz Gehret -

Important Notes:

  • Appointments can only be created, they cannot be updated or deleted through the Importer so please be sure that your appointments are formatted correctly prior to submitting a file for processing.
  • Dates can be very finicky, so be sure to check out our help article on Date and Time Formatting.
  • The description is a field viewable by the student, so do not input private notes here.
  • If you'd like to upload appointment notes, these can be connected by using the unique import_identifier field. The import_identifier can be anything but it has to be totally unique, and you would create the identifier values yourself. We would recommend an identifier such as schoolhistoricalappt100, schoolhistoricalappt101, schoolhistoricalappt102, schoolhistoricalappt103.

Format appointments according to the following guidelines:

Header Required Notes

appointment_medium_name

Yes

The name of the appointment medium (location). Case sensitive, must be one of the configurable appointment mediums on your school.
appointment_type_name Yes The name of the appointment type. Case sensitive, must be one of the configurable appointment types on your school.
staff_member_email Yes The email of the staff member involved. Must be an existing staff member in Handshake, and their account must be confirmed.
student_email Yes The email of the student involved. Must be a student in the system.
start_date Yes The start date and time, must be formatted as:
  • yyyy-mm-ddThh:mm:ss 
 - Warning: This defaults to UTC. *Please see: Date and Time Formatting
end_date Yes The end date and time, must be formatted as:
  • yyyy-mm-ddThh:mm:ss 
- Warning: This defaults to UTC. *Please see: Date and Time Formatting
description Yes A description of the appointment - Warning: This is viewable by the student. Cannot be left blank.
status Yes

One of the following:

approved
cancelled
completed
no_show
rejected
requested
started

(CASE SENSITIVE)

walkin

No

 TRUE or FALSE

(CASE SENSITIVE)

import_identifier

Yes

This required identifier must be completely unique. This is used as the main identifier for the appointment by the Importer. If you are importing notes or labels on this appointment, the two import identifiers for the matching appointment and note/label must match. The import_identifier can be anything but it has to be totally unique, and you would create the identifier values yourself. We would recommend an identifier such as schoolhistoricalappt100, schoolhistoricalappt101, schoolhistoricalappt102, schoolhistoricalappt103.

 

Example File:

 

 

Once you've submitted your file...

And the file has passed all analyzers with no errors, click the "Submit and Request Run" button. One of our technical support team members will process this file within 24 hours of submission. 

Was this article helpful?
3 out of 6 found this helpful
Have more questions? Submit a request