Order Tool's Final Declined Offers feed provides institutions with a complete list of course materials that students have declined to use in a particular term. That is, the Final Declined Offers feed presents, based on student opt-outs per the student choice policy, the list of students who should not be charged for particular course materials.
The Final Declined Offers feed is formatted as a comma-separated value (CSV) file. Order Tool outputs this file to the FTP server for the institution to pull down.
Every Final Declined Offers feed file is term-specific; therefore, multiple Final Declined Offers feed files may be reported to an institution on any given day.
For each term, Order Tool will generate the Final Declined Offers feed during the following period:
- Starting one day after the first student choice end date of that term
- Ending one month after the last student choice end date of that term
During this period, the Final Declined Offers feed is generated daily at 8:00 am UTC and immediately uploaded to the FTP server.
Please note that, while generated daily, the Final Declined Offers feed captures all declined offers for all time in a given term. In other words, each file is a full accounting of all declined course material offers by students, for a particular term, at that point in time.
Final Declined Offers feeds are generated for both the production (PROD) and user acceptance testing (UAT) environments. Institutions may use the same FTP server credentials they use to push their data integration for Order Tool in the PROD and UAT environments.
The Final Declined Offers feed is a single CSV file reported for each term. This feed reports on all declined offers by students for the term. Consequently, the file's contents will only grow over time. The filename format of the Final Declined Offers feed is as follows:
Where <sis_term_id> is the institution's SIS identifier for the term.
The Final declined offers feed is formatted as a CSV file with the following properties:
All values are in double-quotes.
If no value is required or available for a field, the string "null" is the value, not a blank.
All lines are terminated with a UTF-8 Unix style newline.
The escape character is a backslash (\\).
Timestamps are in ISO 8601 format and must include the time (e.g., `2020-12-15 04:35`).
The contents of the Final Declined Offers feed has the following schema.
|Field name||Data type||Description|
|sis_student_id||Text||The SIS identifier for the student who declined the offer and therefore should not be billed, per the institution's data integration with Order Tool.|
|student_first_name||Text||The student's first name, per the institution's data integration with Order Tool.|
|student_last_name||Text||The student's last name, per the institution's data integration with Order Tool.|
|student_email_address||Text||The student's email address, per the institution's data integration with Order Tool.|
|sis_term_id||Text||The SIS identifier of the academic term corresponding to the course and section in which the student declined to purchase the course material.|
|term_name||Text||The name of the academic term corresponding to the sis_term_id.|
|sis_course_id||Text||The SIS identifier of the course corresponding to the section in which the student declined the offer to purchase the course material.|
|course_subject||Text||The course subject corresponding to the sis_course_id.|
|course_number||Text||The course number corresponding to the sis_course_id.|
|course_title||Text||The course title corresponding to the sis_course_id.|
|Text||The SIS identifier of the section in which the student declined the offer to purchase the course material.|
|section_lms_id||Text||The lms_id corresponding to the section.|
|section_label||Text||The section label corresponding to the sis_section_id.|
|content_id||Text||The Unizin identifier for the digital course material that the student declined to purchase.|
|content_slug||Text||The Unizin slug corresponding to the content_id.|
|content_title||Text||The course material title corresponding to the content_id.|
|content_list_price||Number||The list price corresponding to the content_id.|
|content_offer_price||Number||The Unizin offer price, which is the price a student would pay, corresponding to the content_id.|
|offer_declined_reason||Text||The reason, asserted by the student, why they declined to purchase the digital course material.|
|student_choice_end_date||Date||The date (YYYY-MM-DD) when the student choice period ended for the section in which this student declined to purchase the digital course material.|
Processing the feed
The Final Declined Offers feed contains all declined offers for all time in a given term. It is a full accounting of all declined course materials. Given that there likely are multiple student choice periods in an academic term, it is recommended that institutions process the feed daily to properly charge students for their course material usage. Also, institutions must ensure they are only processing records not yet received in the file; that is, new records only.