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.

Overview

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.

Filename schema

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:

final_declined_offers_<sis_term_id>.csv

Where <sis_term_id> is the institution's SIS identifier for the term.

File format

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`).

File contents

The contents of the Final Declined Offers feed has the following schema.

Field nameData typeDescription
sis_student_idTextThe 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_nameTextThe student's first name, per the institution's data integration with Order Tool.
student_last_nameTextThe student's last name, per the institution's data integration with Order Tool.
student_email_addressTextThe student's email address, per the institution's data integration with Order Tool.
sis_term_idTextThe SIS identifier of the academic term corresponding to the course and section in which the student declined to purchase the course material.
term_nameTextThe name of the academic term corresponding to the sis_term_id.
sis_course_idTextThe SIS identifier of the course corresponding to the section in which the student declined the offer to purchase the course material.
course_subjectTextThe course subject corresponding to the sis_course_id.
course_numberTextThe course number corresponding to the sis_course_id.
course_titleTextThe course title corresponding to the sis_course_id.

sis_section_id

TextThe SIS identifier of the section in which the student declined the offer to purchase the course material.
section_lms_idTextThe lms_id corresponding to the section. 
section_labelTextThe section label corresponding to the sis_section_id.
content_idTextThe Unizin identifier for the digital course material that the student declined to purchase.
content_slugTextThe Unizin slug corresponding to the content_id.
content_titleTextThe course material title corresponding to the content_id.
content_list_priceNumberThe list price corresponding to the content_id.
content_offer_priceNumberThe Unizin offer price, which is the price a student would pay, corresponding to the content_id.
offer_declined_reasonTextThe reason, asserted by the student, why they declined to purchase the digital course material.
student_choice_end_dateDateThe 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.