ConU Course Planner API

Our REST API

Under the hood, ConU Course Planner uses a set of HTTP web resources built for Concordia University useful for viewing individual courses' info & department-recommended course sequences, and validating/exporting user-defined course sequences.

This REST API is open to be used by anyone. If you find our tools useful, feel free to use this API to build an entirely separate application of your own!

Below lies a list of all of the endpoints (URLs) we provide, along with the expected request/response bodies. You can paste any of the curl commands from the examples into git bash on windows or the regular terminal on most linux distributions to test the API yourself. You could also use something like postman.

POST /api/courseinfo

By passing in a course code, you can get all of its relevant information such as its name, number of credits, pre-requisites, etc.

Request parameter(s):

code (required, string)

The course code whose info you want to retrieve
Must match the regex pattern: ^[A-Z]{4} [0-9]{3,4}$

Expected response format:

If the course does not exist, the server will respond with an empty object: {}
If the request succeeds, the response body will be an object containing many properties related to the course in question. We have defined the exact format of this object in a json-schema file which you can view here.

Example:

Request

curl -H "Content-Type: application/json" -X POST -d '{"code": "COMP 248"}' http://conucourseplanner.online/api/courseinfo

Response

{  
   "_id":"COMP 248",
   "code":"COMP 248",
   "name":"Object-Oriented Programming I",
   "credits":"3.5",
   "description":"Introduction to programming. Basic data types, variables, expressions, assignments, control flow. Classes, objects, methods. Information hiding, public vs. private visibility, data abstraction and encapsulation. References. Arrays. ",
   "lectureHours":"three hours per week",
   "tutorialHours":"two hours per week",
   "labHours":"one hour per week",
   "requirements":{  
      "prereqs":[],
      "coreqs":[  
         [  
            "MATH 204"
         ]
      ]
   }
}

POST /api/filtercoursecodes

By passing in a search query, you can get course codes in our course database which match the query.

Request parameter(s):

filter (required, string)

The search query you want to use to filter the course db
A given course will be a match if the its code string contains the filter value
Case insensitive, so passing lower-case letters is fine

Expected response format:

The server will limit the number of returned results to 25
If the filter returns no matches, the server will respond with an empty array: []
If the filter returns one or more matches, the course codes of the matches will be returned as an array
If you pass an empty filter, you will essentially get the first 25 courses in the db, sorted alphabetically.

Example 1 - regular search query:

Request

curl -H "Content-Type: application/json" -X POST -d '{"filter":"COMP 2"}' http://conucourseplanner.online/filtercoursecodes

Response

["COMP 201","COMP 208","COMP 218","COMP 228","COMP 232","COMP 233","COMP 248","COMP 249"]

Example 2 - inner substring:

Request

curl -H "Content-Type: application/json" -X POST -d '{"filter":"P 24"}' http://conucourseplanner.online/filtercoursecodes

Response

["COMP 248","COMP 249"]

Example 3 - empty filter:

Request

curl -H "Content-Type: application/json" -X POST -d '{"filter":""}' http://conucourseplanner.online/filtercoursecodes

Response

["ACCO 220","ACTU 256","ACTU 257","ACTU 286","ACTU 357","ACTU 386","ACTU 456","ACTU 457","ACTU 458","ACTU 459","ACTU 486","ADED 201","ADED 202","ADED 220","ADED 230","ADED 240","ADED 302","ADED 333","ADED 344","ADED 345","ADED 370","ADED 403","ADED 410","ADED 412","ADED 440"]

GET /api/allsequences

By performing a GET at this url, you can get the list of the IDs of every program supported by our API, in other words all the programs for which we have a recommended sequence.

Expected response format:

The response for this resource is a simple JSON array of strings, where each string is a sequence ID the likes of which you can pass to recommendedsequence as the value of the sequenceID request property.

Example:

Request

curl -H "Content-Type: application/json" http://conucourseplanner.online/api/allsequences

Response

["BLDG-Coop","BLDG-Jan","BLDG-Sept","CIVI-Coop","CIVI-Jan","CIVI-Sept","COEN-Avionics-Coop","COEN-Avionics-Jan","COEN-Avionics-Sept","COEN-NoOption-Coop","COEN-NoOption-Jan","COEN-NoOption-Sept","COMP-Apps-Coop","COMP-Apps-Jan","COMP-Apps-Sept","COMP-CompArts-Sept","COMP-CompSys-Coop","COMP-CompSys-Jan","COMP-CompSys-Sept","COMP-Games-Coop","COMP-Games-Jan","COMP-Games-Sept","COMP-General-Coop","COMP-General-Jan","COMP-General-Sept","COMP-InfoSys-Coop","COMP-InfoSys-Jan","COMP-InfoSys-Sept","COMP-SoftSys-Coop","COMP-SoftSys-Jan","COMP-SoftSys-Sept","COMP-Stats-Jan","COMP-Stats-Sept","COMP-Web-Coop","COMP-Web-Jan","COMP-Web-Sept","ELEC-Avionics-Coop","ELEC-Avionics-Jan","ELEC-Avionics-Sept","ELEC-Electronics-Coop","ELEC-Electronics-Jan","ELEC-Electronics-Sept","ELEC-NoOption-Coop","ELEC-NoOption-Jan","ELEC-NoOption-Sept","ELEC-Power-Coop","ELEC-Power-Jan","ELEC-Power-Sept","ELEC-Tele-Coop","ELEC-Tele-Jan","ELEC-Tele-Sept","INDU-Coop","INDU-Jan","INDU-Sept","MECH-Coop","MECH-Jan","MECH-Sept","SOEN-Games-Coop","SOEN-Games-Jan","SOEN-Games-Sept","SOEN-General-Coop","SOEN-General-Jan","SOEN-General-Sept","SOEN-Realtime-Coop","SOEN-Realtime-Jan","SOEN-Realtime-Sept","SOEN-Web-Coop","SOEN-Web-Jan","SOEN-Web-Sept"]

Please paste the raw json into a beautifier for optimal viewing.

POST /api/recommendedsequence

By passing in the ID of one of our supported programs (see allsequences), you can get the recommended sequence associated with that program filled with the complete course info for each contained course.

Request parameter(s):

sequenceID (required, string)

The ID of the sequence whose recommended sequence you want to retrieve.
The value of this string must correspond to one of the array entries returned by allsequences

Expected response format:

If the request succeeds, it will return an object with one property: courseSequenceObject
If the sequence does not exist, the courseSequenceObject property will be an empty object: {}
If the sequence exists, the courseSequenceObject property will be an object containing the recommended sequence of courses. We have defined the format of this object in a json-schema file which you can view here. There is an important difference with this object though, which is that all the contained course objects will actually be filled with all of their respective info, corresponding to our course info json schema spec.

Example 1 - invalid `sequenceID`:

Request

curl -H "Content-Type: application/json" -X POST -d '{"sequenceID": "NON_EXISTANT_SEQUENCE"}' http://conucourseplanner.online/api/recommendedsequence

Response

{"courseSequenceObject": {}}

Example 2 - valid `sequenceID`:

Request

curl -H "Content-Type: application/json" -X POST -d '{"sequenceID": "SOEN-General-Coop"}' http://conucourseplanner.online/api/recommendedsequence

Response

{ "courseSequenceObject": {"minTotalCredits":"120","_id":"SOEN-General-Coop","yearList":[{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","labHours":"one hour per week","_id":"COMP 249","electiveType":"","description":"Design of classes. Inheritance. Polymorphism. Static and dynamic binding. Abstract classes. Exception handling. File I/O. Recursion. Interfaces and inner classes. Graphical user interfaces. Generics. Collections and iterators. ","name":"Object-Oriented Programming II","credits":"3.5","tutorialHours":"two hours per week","code":"COMP 249","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 248"],["MATH 203"]],"coreqs":[["MATH 205"]]}},{"isElective":"false","_id":"ENGR 233","electiveType":"","description":"This course introduces Engineering students to the theory and application of advanced calculus. Functions of several variables, partial derivatives, total and exact differentials, approximations with differentials. Tangent plane and normal line to a surface, directional derivatives, gradient. Double and triple integrals. Polar, cylindrical, and spherical coordinates. Change of variables in double and triple integrals. Vector differential calculus; divergence, curl, curvature, line integrals, Green\u2019s theorem, surface integrals, divergence theorem, applications of divergence theorem, Stokes\u2019 theorem. ","name":"Applied Advanced Calculus","credits":"3","tutorialHours":"two hours per week","code":"ENGR 233","lectureHours":"three hours per week","requirements":{"prereqs":[["MATH 204"],["MATH 205"]],"coreqs":[]}},{"isElective":"false","labHours":"two hours per week","_id":"SOEN 228","electiveType":"","description":"Processor structure, Data and Instructions, Instruction Set Processor (ISP) level view of computer hardware, assembly language level use. Memory systems \u2014 RAM and disks, hierarchy of memories. I/O organization, I/O devices and their diversity, their interconnection to CPU and Memory. Communication between computers at the physical level. Networks and computers. ","name":"System Hardware","credits":"4","tutorialHours":"two hours per week","code":"SOEN 228","lectureHours":"three hours per week","requirements":{"prereqs":[["MATH 203"],["MATH 204"]],"coreqs":[]},"note":"Students who have received credit for COMP 228 may not take this course for credit."},{"isElective":"false","_id":"SOEN 287","electiveType":"","description":"Internet architecture and protocols. Web applications through clients and servers. Markup languages. Client-side programming using scripting languages. Static website contents and dynamic page generation through server-side programming. Preserving state (client-side) in web applications. ","name":"Web Programming","credits":"3","tutorialHours":"two hours per week","code":"SOEN 287","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 248"]],"coreqs":[]}},{"isElective":"true","electiveType":"Science","code":""}]},"fall":{"isWorkTerm":"false","courseList":[{"isElective":"false","_id":"COMP 232","electiveType":"","description":"Sets. Propositional logic and predicate calculus. Functions and relations. Elements of number theory. Mathematical reasoning. Proof techniques: direct proof, indirect proof, proof by contradiction, proof by induction. ","name":"Mathematics for Computer Science","credits":"3","tutorialHours":"two hours per week","code":"COMP 232","lectureHours":"three hours per week","requirements":{"prereqs":[["MATH 203"],["MATH 204"]],"coreqs":[]},"note":"Students who have received credit for COMP 238 or COEN 231 may not take this course for credit."},{"isElective":"false","labHours":"one hour per week","_id":"COMP 248","electiveType":"","description":"Introduction to programming. Basic data types, variables, expressions, assignments, control flow. Classes, objects, methods. Information hiding, public vs. private visibility, data abstraction and encapsulation. References. Arrays. ","name":"Object-Oriented Programming I","credits":"3.5","tutorialHours":"two hours per week","code":"COMP 248","lectureHours":"three hours per week","requirements":{"prereqs":[],"coreqs":[["MATH 204"]]}},{"isElective":"false","_id":"ENGR 201","electiveType":"","description":"Health and safety issues for engineering projects: Quebec and Canadian legislation; safe work practices; general laboratory safety common to all engineering disciplines, and specific laboratory safety pertaining to particular engineering disciplines. Review of the legal framework in Quebec, particularly the Professional Code and the Engineers Act, as well as professional ethics. ","name":"Professional Practice and Responsibility","credits":"1.5","tutorialHours":"one hour per week, alternate weeks","code":"ENGR 201","lectureHours":"one and a half hours per week","requirements":{"prereqs":[],"coreqs":[]}},{"isElective":"false","_id":"ENGR 213","electiveType":"","description":"This course introduces Engineering students to the theory and application of ordinary differential equations. Definition and terminology, initial-value problems, separable differential equations, linear equations, exact equations, solutions by substitution, linear models, orthogonal trajectories, complex numbers, form of complex numbers: powers and roots, theory: linear equations, homogeneous linear equations with constant coefficients, undetermined coefficients, variation of parameters, Cauchy-Euler equation, reduction of order, linear models: initial value, review of power series, power series solutions, theory, homogeneous linear systems, solution by diagonalisation, non-homogeneous linear systems. Eigenvalues and eigenvectors. ","name":"Applied Ordinary Differential Equations","credits":"3","tutorialHours":"two hours per week","code":"ENGR 213","lectureHours":"three hours per week","requirements":{"prereqs":[["MATH 205"]],"coreqs":[["MATH 204"]]}},{"isElective":"true","electiveType":"Science","code":""}]},"summer":{"isWorkTerm":"false","courseList":[{"isElective":"false","_id":"COMP 348","electiveType":"","description":"Survey of programming paradigms: Imperative, functional, and logic programming. Issues in the design and implementation of programming languages. Declaration models: binding, visibility, and scope. Type systems, including static and dynamic typing. Parameter passing mechanisms. Hybrid language design. ","name":"Principles of Programming Languages","credits":"3","tutorialHours":"one hour per week","code":"COMP 348","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 249"]],"coreqs":[]}},{"isElective":"false","_id":"COMP 352","electiveType":"","description":"Abstract data types: stacks and queues, trees, priority queues, dictionaries. Data structures: arrays, linked lists, heaps, hash tables, search trees. Design and analysis of algorithms: asymptotic notation, recursive algorithms, searching and sorting, tree traversal, graph algorithms. ","name":"Data Structures and Algorithms","credits":"3","tutorialHours":"one hour per week","code":"COMP 352","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 249"]],"coreqs":[["COMP 232"]]},"note":"Students who have received credit for COEN 352 may not take this course for credit."},{"isElective":"false","_id":"ENCS 282","electiveType":"","description":"§71.20.7 by passing the Engineering Writing Test (EWT), or by passing ENCS 272 with a grade of C- or higher. Technical writing form and style. Technical and scientific papers, abstracts, reports. Library research and referencing methods for engineers and computer scientists. Technical communication using information technology: document processing software, computer-assisted presentation, analysis and design of web presentation, choice and use of appropriate tools. Students will prepare an individual major report and make an oral presentation. ","name":"Technical Writing and Communication","credits":"3","tutorialHours":"two hours per week","code":"ENCS 282","lectureHours":"three hours per week","requirements":{"prereqs":[],"coreqs":[]}},{"isElective":"false","_id":"ENGR 202","electiveType":"","description":"Introduction to the concept of sustainable development and the approaches for achieving it. Relationships with economic, social, and technological development. Methods for evaluating sustainability of engineering projects, including utilization of relevant databases and software. Impact of engineering design and industrial development on the environment. Case studies. ","name":"Sustainable Development and Environmental Stewardship","credits":"1.5","code":"ENGR 202","lectureHours":"one and a half hours per week","requirements":{"prereqs":[],"coreqs":[]}},{"isElective":"true","electiveType":"General","code":""}]}},{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","labHours":"two hours per week","_id":"COMP 346","electiveType":"","description":"Fundamentals of operating system functionalities, design and implementation. Multiprogramming: processes and threads, context switching, queuing models and scheduling. Interprocess communication and synchronization. Principles of concurrency. Synchronization primitives. Deadlock detection and recovery, prevention and avoidance schemes. Memory management. Device management. File systems. Protection models and schemes. ","name":"Operating Systems","credits":"4","tutorialHours":"one hour per week","code":"COMP 346","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 228","SOEN 228"],["COMP 352"]],"coreqs":[]},"note":"Students who have received credit for COEN 346 may not take this course for credit."},{"isElective":"false","labHours":"15 hours total","_id":"ELEC 275","electiveType":"","description":"Fundamentals of electric circuits: Kirchoff\u2019s laws, voltage and current sources, Ohm\u2019s law, series and parallel circuits. Nodal and mesh analysis of DC circuits. Superposition theorem, Thevenin and Norton Equivalents. Use of operational amplifiers. Transient analysis of simple RC, RL and RLC circuits. Steady state analysis: Phasors and impedances, power and power factor. Single and three phase circuits. Magnetic circuits and transformers. Power generation and distribution. ","name":"Principles of Electrical Engineering","credits":"3.5","tutorialHours":"two hours per week","code":"ELEC 275","lectureHours":"three hours per week","requirements":{"prereqs":[["PHYS 205"]],"coreqs":[["ENGR 213"]]}},{"isElective":"false","_id":"ENGR 371","electiveType":"","description":"Axioms of probability theory. Events. Conditional probability. Bayes theorem. Random variables. Mathematical expectation. Discrete and continuous probability density functions. Transformation of variables. Probabilistic models, statistics, and elements of hypothesis testing (sampling distributions and interval estimation). Introduction to statistical quality control. Applications to engineering problems. ","name":"Probability and Statistics in Engineering","credits":"3","tutorialHours":"one hour per week","code":"ENGR 371","lectureHours":"three hours per week","requirements":{"prereqs":[["ENGR 213"],["ENGR 233"]],"coreqs":[]}},{"isElective":"false","_id":"SOEN 331","electiveType":"","description":"Assertions. Static and dynamic checking. Method specification using preconditions and postconditions. Strengthening and weakening. Design by contract. Hoare logic. Invariants. Class specification using invariants. Software tools for assertion checking and verification. Reliable software development. ","name":"Introduction to Formal Methods for Software Engineering","credits":"3","tutorialHours":"two hours per week","code":"SOEN 331","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 232"],["COMP 249"]],"coreqs":[]}},{"isElective":"false","_id":"SOEN 341","electiveType":"","description":"Basic principles of software engineering. Introduction to software process models. Activities in each phase, including review activities. Working in teams: organization; stages of formation; roles; conflict resolution. Notations used in software documentation. How to review, revise, and improve software documentation. ","name":"Software Process","credits":"3","tutorialHours":"one hour per week","code":"SOEN 341","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 352","COEN 352"]],"coreqs":[["ENCS 282"]]},"note":"Students who have received credit for COMP 354 may not take this course for credit."}]},"fall":{"isWorkTerm":"true","courseList":[]},"summer":{"isWorkTerm":"true","courseList":[]}},{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","_id":"SOEN 344","electiveType":"","description":"Architectural activities, roles, and deliverables. Architectural view models. Architectural styles (including client-server, layered, pipes-and-filters, event-based, process control) and frameworks. Architectural analysis and the interplay with requirements elicitation. Notations for expressing architectural designs, structural and behavioural specifications. From architectural design to detailed design. Domain specific architectures and design patterns. Evaluation and performance estimation of designs. Advanced object-oriented design patterns and idioms. ","name":"Software Architecture and Design II","credits":"3","tutorialHours":"one hour per week","code":"SOEN 344","lectureHours":"three hours per week","requirements":{"prereqs":[["SOEN 343"]],"coreqs":[]}},{"isElective":"false","_id":"SOEN 345","electiveType":"","description":"Testing strategies. Specification-based vs. code-based, black-box vs. white-box, functional vs. structural testing; unit, integration, system, acceptance, and regression testing. Verification vs. validation. Test planning, design and artifacts. Introduction to software reliability and quality assurance. Formal verification methods, oracles; static and dynamic program verification. ","name":"Software Testing, Verification and Quality Assurance","credits":"3","tutorialHours":"one hour per week","code":"SOEN 345","lectureHours":"three hours per week","requirements":{"prereqs":[],"coreqs":[["SOEN 343"]]}},{"isElective":"false","_id":"SOEN 357","electiveType":"","description":"The human side: I/O; memory; and information processing. Interaction: mental models; human error; interaction frameworks and paradigms. Direct manipulation. User interface design: principles; standards; and guidelines. User-centred design: standards and design rationale; heuristic evaluation; iterative design; and prototyping. Task-centred design. Rationalized design: usability engineering; dialogue notations; user models; diagrammatic notations; and textual notations. Evaluation: with the user; without the user; quantitative; and qualitative. Implementation support. Help and documentation. ","name":"User Interface Design","credits":"3","tutorialHours":"one hour per week","code":"SOEN 357","lectureHours":"three hours per week","requirements":{"prereqs":[["SOEN 341"]],"coreqs":[]}},{"isElective":"false","labHours":"three hours per week","_id":"SOEN 390","electiveType":"","description":"Students work in teams to design and implement a software project from requirements provided by the coordinator. Each team will demonstrate the software and prepare adequate documentation for it. In addition, each student will write an individual report. ","name":"Software Engineering Team Design Project","credits":"3.5","tutorialHours":"one hour per week","code":"SOEN 390","lectureHours":"two hours per week","requirements":{"prereqs":[],"coreqs":[["SOEN 344"]]}},{"isElective":"true","electiveType":"Program","code":""}]},"fall":{"isWorkTerm":"false","courseList":[{"isElective":"false","_id":"COMP 335","electiveType":"","description":"Finite state automata and regular languages. Push-down automata and context-free languages. Pumping lemmas. Applications to parsing. Turing machines. Undecidability and decidability. ","name":"Introduction to Theoretical Computer Science","credits":"3","tutorialHours":"one hour per week","code":"COMP 335","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 232","COEN 231"],["COMP 249","COEN 244"]],"coreqs":[]}},{"isElective":"false","_id":"SOEN 342","electiveType":"","description":"Requirements engineering. Functional and non-functional requirements. Traceability. Test generation. Formal and informal specifications. Formal specification languages. Reasoning with specifications. Correctness issues. Verification. ","name":"Software Requirements and Specifications","credits":"3","tutorialHours":"one hour per week","code":"SOEN 342","lectureHours":"three hours per week","requirements":{"prereqs":[["SOEN 341"]],"coreqs":[]}},{"isElective":"false","_id":"SOEN 343","electiveType":"","description":"From requirements to design to implementation. Planned vs. evolutionary design and refactoring. Model-driven design and Unified Modelling Language (UML). Structural and behavioural design descriptions and specifications. General and domain-specific design principles, patterns and idioms. Object-oriented design concepts such as interfaces vs. abstract types, polymorphism, generics, and delegation vs. subclassing. Introduction to software architecture (styles and view models). Design quality. Design rationale. Design methodologies (e.g. based on responsibility assignment). Test-driven development. ","name":"Software Architecture and Design I","credits":"3","tutorialHours":"one hour per week","code":"SOEN 343","lectureHours":"three hours per week","requirements":{"prereqs":[["SOEN 341"]],"coreqs":[["SOEN 342"]]}},{"isElective":"false","_id":"SOEN 384","electiveType":"","description":"Organization of large software development. Roles of team members, leaders, managers, stakeholders, and users. Tools for monitoring and controlling a schedule. Financial, organizational, human, and computational resources allocation and control. Project and quality reviews, inspections, and walkthroughs. Risk management. Communication and collaboration. Cause and effects of project failure. Project management via the Internet. Quality assurance and control. ","name":"Management, Measurement and Quality Control","credits":"3","tutorialHours":"one hour per week","code":"SOEN 384","lectureHours":"three hours per week","requirements":{"prereqs":[["ENCS 282"],["SOEN 341"]],"coreqs":[]}},{"isElective":"false","_id":"ENGR 391","electiveType":"","description":"Roots of algebraic and transcendental equations; function approximation; numerical differentiation; numerical integration; solution of simultaneous algebraic equations; numerical integration of ordinary differential equations. ","name":"Numerical Methods in Engineering","credits":"3","tutorialHours":"one hour per week","code":"ENGR 391","lectureHours":"three hours per week","requirements":{"prereqs":[["ENGR 213"],["ENGR 233"],["COMP 248","COEN 243","MECH 215","BCEE 231"]],"coreqs":[]}}]},"summer":{"isWorkTerm":"true","courseList":[]}},{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","_id":"SOEN 385","electiveType":"","description":"Mathematical modelling of dynamical systems; block diagrams; feedback; open and closed loops. Linear differential equations; time domain analysis; free, forced, and total response; steady state and transient response. Laplace transform and inverse transform; second order systems. Transfer functions and stability. Control system design: PID and root locus techniques. Computer simulation of control systems. Applications. ","name":"Control Systems and Applications","credits":"3","tutorialHours":"one hour per week","code":"SOEN 385","lectureHours":"three hours per week","requirements":{"prereqs":[["ENGR 213"],["ENGR 233"]],"coreqs":[]}},{"isElective":"false","_id":"ENGR 392","electiveType":"","description":"Social history of technology and of science including the industrial revolution and modern times. Engineering and scientific creativity, social and environmental problems created by uncontrolled technology, appropriate technology. ","name":"Impact of Technology on Society","credits":"3","code":"ENGR 392","lectureHours":"three hours per week","requirements":{"prereqs":[["ENCS 282"],["ENGR 201"],["ENGR 202"]],"coreqs":[]}},{"isElective":"false","labHours":"two hours per week","_id":"SOEN 490","electiveType":"","description":"Students work in teams of at least four members to construct a significant software application. The class meets at regular intervals. Team members will give a presentation of their contribution to the project. ","name":"Capstone Software Engineering Design Project","credits":"4","code":"SOEN 490","lectureHours":"one hour per week","requirements":{"prereqs":[["SOEN 390"]],"coreqs":[]}},{"isElective":"true","electiveType":"Program","code":""},{"isElective":"true","electiveType":"Program","code":""}]},"fall":{"isWorkTerm":"false","courseList":[{"isElective":"false","labHours":"two hours per week","_id":"SOEN 490","electiveType":"","description":"Students work in teams of at least four members to construct a significant software application. The class meets at regular intervals. Team members will give a presentation of their contribution to the project. ","name":"Capstone Software Engineering Design Project","credits":"4","code":"SOEN 490","lectureHours":"one hour per week","requirements":{"prereqs":[["SOEN 390"]],"coreqs":[]}},{"isElective":"false","_id":"ENGR 301","electiveType":"","description":"Introduction to project delivery systems. Principles of project management; role and activity of a manager; enterprise organizational charts; cost estimating; planning and control. Company finances; interest and time value of money; discounted cash flow; evaluation of projects in private and public sectors; depreciation methods; business tax regulations; decision tree; sensitivity analysis. ","name":"Engineering Management Principles and Economics","credits":"3","tutorialHours":"one hour per week","code":"ENGR 301","lectureHours":"three hours per week","requirements":{"prereqs":[],"coreqs":[]}},{"isElective":"false","_id":"SOEN 321","electiveType":"","description":"Protocol layers and security protocols. Intranets and extranets. Mobile computing. Electronic commerce. Security architectures in open-network environments. Cryptographic security protocols. Threats, attacks, and vulnerabilities. Security services: confidentiality; authentication; integrity; access control; non-repudiation; and availability. Security mechanisms: encryption; data-integrity mechanisms; digital signatures; keyed hashes; access-control mechanisms; challenge-response authentication; traffic padding; routing control; and notarization. Key-management principles. Distributed and embedded firewalls. Security zones. ","name":"Information Systems Security","credits":"3","tutorialHours":"one hour per week","code":"SOEN 321","lectureHours":"three hours per week","requirements":{"prereqs":[["COMP 346"]],"coreqs":[]}},{"isElective":"true","electiveType":"Program","code":""},{"isElective":"true","electiveType":"Program","code":""}]},"summer":{"isWorkTerm":"false","courseList":[]}}],"sourceUrl":"https://www.concordia.ca/encs/computer-science-software-engineering/students/course-sequences/co-op-soen-general.html","prettyName":"Software Engineering, General Program option, Coop September entry"}}

Click here for a pretty version of this json content.

POST /api/validate

TBD

Request parameter(s):

TBD

Expected response format:

TBD

Example:

TBD

POST /api/export

By passing in a course sequence object, you can get a downloadable link to an exported, human-readable version of it. We currently support two types of exports: table and list.

Request parameter(s):

courseSequenceObject (required, object)

The course sequence you want to export
We have defined the format of a course sequence object in a json-schema file which you can view here. An important difference to note is that each course object should contain the properties defined in the schema as well as name and credits properties. In the case that the entry is not a course, but is an orList (see courseSequenceSchema.json#definitions/orList), only courses inside this orList which have the isSelected property set to true will be put into the exported version of the sequence.
Any extra properties in the courseSequenceObject will be ignored.

exportType (required, string)

The type of export you want to perform.
Two possible values: list or table. Choosing the list option will format the resulting pdf as a list and generate a markdown (.md) file with the same name as the pdf. Choosing the table option will format it as a table and generate an html (.html) file with the same name as the pdf.

programName (optional, string)

The name of the program associated with the sequence you're currently exporting
If present, will be added in bold to the top of the exported page, regardless of the chosen exportType.

Expected response format:

If the request succeeds, the response body will be an object containing the following property:

exportPath (string)

Url from which the PDF version of the sequence can be exported. By replacing the file extension in the url from .pdf to .md (list) or .html (table), the url can be used to alternatively download a markdown or html version of the sequence, respectively.

Example 1 - export as list:

Request

curl -H "Content-Type: application/json" -X POST -d '{"exportType":"list","programName":"Software Engineering","courseSequenceObject":{"yearList":[{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Object-Oriented Programming II","credits":"3.5","code":"COMP 249"},{"isElective":"true","electiveType":"Science","code":""}]},"fall":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Object-Oriented Programming I","credits":"3.5","code":"COMP 248"},{"isElective":"false","electiveType":"","name":"Professional Practice and Responsibility","credits":"1.5","code":"ENGR 201"}]},"summer":{"isWorkTerm":"true","courseList":[]}},{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Capstone Software Engineering Design Project","credits":"4","code":"SOEN 490"},[{"isElective":"false","electiveType":"","name":"Advanced Game Development","credits":"4","code":"COMP 476","isSelected":false},{"isElective":"false","electiveType":"","name":"Advanced Program Design with C++","credits":"4","code":"COMP 345","isSelected":true},{"isElective":"true","electiveType":"Program","code":"","isSelected":false}]]},"fall":{"isWorkTerm":"false","courseList":[]},"summer":{"isWorkTerm":"false","courseList":[]}}]}}' http://conucourseplanner.online/api/export

Click here for a pretty version of this json content.

Response

{"exportPath":"exports/1508362359876-152.pdf"}

Note that when you actually perform the request, the generated pdf name will be different

After receiving this response, visiting the url http://www.conucourseplanner.online/exports/1508362359876-152.pdf will give you the pdf version of the exported sequence. Alternatively, replacing the url suffix from .pdf to .md and then visiting this new url (http://www.conucourseplanner.online/exports/1508362359876-152.md) yields the following text:

# My Course Sequence

## Software Engineering

### Fall 1

- COMP 248, Object-Oriented Programming I, 3.5 Credits
- ENGR 201, Professional Practice and Responsibility, 1.5 Credits

### Winter 1

- COMP 249, Object-Oriented Programming II, 3.5 Credits
- Science Elective

### Summer 1 (Work Term)

- No Courses

### Fall 2

- No Courses

### Winter 2

- SOEN 490, Capstone Software Engineering Design Project, 4 Credits
- COMP 345, Advanced Program Design with C++, 4 Credits

### Summer 2

- No Courses

Example 2 - export as table:

Request (same as example 1, but changed exportType to table)

curl -H "Content-Type: application/json" -X POST -d '{"exportType":"table","programName":"Software Engineering","courseSequenceObject":{"yearList":[{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Object-Oriented Programming II","credits":"3.5","code":"COMP 249"},{"isElective":"true","electiveType":"Science","code":""}]},"fall":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Object-Oriented Programming I","credits":"3.5","code":"COMP 248"},{"isElective":"false","electiveType":"","name":"Professional Practice and Responsibility","credits":"1.5","code":"ENGR 201"}]},"summer":{"isWorkTerm":"true","courseList":[]}},{"winter":{"isWorkTerm":"false","courseList":[{"isElective":"false","electiveType":"","name":"Capstone Software Engineering Design Project","credits":"4","code":"SOEN 490"},[{"isElective":"false","electiveType":"","name":"Advanced Game Development","credits":"4","code":"COMP 476","isSelected":false},{"isElective":"false","electiveType":"","name":"Advanced Program Design with C++","credits":"4","code":"COMP 345","isSelected":true},{"isElective":"true","electiveType":"Program","code":"","isSelected":false}]]},"fall":{"isWorkTerm":"false","courseList":[]},"summer":{"isWorkTerm":"false","courseList":[]}}]}}' http://conucourseplanner.online/api/export

Click here for a pretty version of this json content.

Response

{"exportPath":"exports/1508362359876-152.pdf"}

Note that when you actually perform the request, the generated pdf name will be different

The downloadable url of the pdf can be formed the same way as in example 1, but instead of replacing the suffix with .md, you replace it with .html to yield the following text:

<!DOCTYPE html>
<html lang="en">
    <head>
        <style>
            table {
                font-size: 20px;
                width: 100%;
                border: 1px solid black;
                border-collapse: collapse;
            }
            tr > td:first-of-type {
                font-weight: bold;
            }
            ol {
                padding-left: 40px;
            }
            td, th {
                border: 1px solid black;
                text-align: center;
            }
            h2, h3 {
                text-align: center;
            }
            p {
                font-size: 20px;
                font-weight: bold;
                text-align: center;
                padding: 6px;
            }
        </style>
    </head>
    <body>
        <h2>My Proposed Sequence</h2>
        <h3>Software Engineering</h3>

        <table>
            <thead>
                <tr>
                    <th></th>
                    <th>Fall</th>
                    <th>Winter</th>
                    <th>Summer</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td>Year 1</td>
                    <td>
                        <ol>
                            <li>COMP 248</li>
                            <li>ENGR 201</li>
                        </ol>
                    </td>
                    <td>
                        <ol>
                            <li>COMP 249</li>
                            <li>Science Elective</li>
                        </ol>
                    </td>
                    <td>
                        (Work Term)
                        <br/>No Courses
                    </td>
                </tr>
                <tr>
                    <td>Year 2</td>
                    <td>
                        <br/>No Courses
                    </td>
                    <td>
                        <ol>
                            <li>SOEN 490</li>
                            <li>COMP 345</li>
                        </ol>
                    </td>
                    <td>
                        <br/>No Courses
                    </td>
                </tr>

            </tbody>
        </table>
        <p>Approved by: ____________________________________________</p>
        <p>Signature:____________________________&nbsp;&nbsp;Date: ______________</p>
    </body>
</html>

General Project Docs
Deployment Guide
Local Frontend Testing Guide
REST API Spec
Dev Tips/Miscellaneous
- windows line endings in git

ConU Course Planner API

Table of contents:

Our REST API

POST /api/courseinfo

Request parameter(s):

code (required, string)

Expected response format:

Example:

POST /api/filtercoursecodes

Request parameter(s):

filter (required, string)

Expected response format:

Example 1 - regular search query:

Example 2 - inner substring:

Example 3 - empty filter:

GET /api/allsequences

Expected response format:

Example:

POST /api/recommendedsequence

Request parameter(s):

sequenceID (required, string)

Expected response format:

Example 1 - invalid sequenceID:

Example 2 - valid sequenceID:

POST /api/validate

Request parameter(s):

Expected response format:

Example:

POST /api/export

Request parameter(s):

courseSequenceObject (required, object)

exportType (required, string)

programName (optional, string)

Expected response format:

exportPath (string)

Example 1 - export as list:

Example 2 - export as table:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally

Example 1 - invalid `sequenceID`:

Example 2 - valid `sequenceID`: