User Tools

Site Tools


annual_school_census_pdf_developer_manual

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

annual_school_census_pdf_developer_manual [2024/11/17 07:21] – created ghacheyannual_school_census_pdf_developer_manual [2025/01/27 23:33] (current) ghachey
Line 2: Line 2:
  
 More like notes for now. Technology for the new version of the PDF surveys are developed in iText C#. More like notes for now. Technology for the new version of the PDF surveys are developed in iText C#.
 +
 +===== REST API =====
 +
 +The REST interface has these methods, which are not authenticated yet, so you can use them directly from the browser address bar.
 + 
 +This repairs some structural issues in the older template of the PDF survey (i.e. 2024). This was executed ones and should never be needed again.
 +
 +<code>
 +/api/pdfSurvey/fix/<<year>>?version=<<SEC|PRI>>
 +</code>
 + 
 +The following one takes a survey, reload its data into the current version of the form. This was used to reload data into "fixed PDF templates.
 +
 +<note important>Will it retain other uses? Or does the generate version handle all future cases?</note>
 +
 +<code>
 +/api/pdfSurvey/reload/<<schno>>/<<surveyYear>>?TargetYear
 +</code>
 + 
 +Create a new survey using the school No and survey year template, reading the data from the database. Note the PDF survey template must be in ''C:\inetpubwww\<<context>>\assets\<<context>>''
 +
 +<code>
 +/api/pdfSurvey/generate/<<schno>>/<<surveyYear>>
 +</code>
  
 ===== Lookups Handling ===== ===== Lookups Handling =====
annual_school_census_pdf_developer_manual.1731828089.txt.gz · Last modified: 2024/11/17 07:21 by ghachey