Skip to content

Api documentation prod #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jhuang03 wants to merge 58 commits into
base: master
Choose a base branch
from
Open

Api documentation prod #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
f301381
Merge pull request #2 from hres/master
ahasangit Apr 17, 2018
e98be61
Merge pull request #3 from hres/api-documentation-dev
ahasangit Apr 17, 2018
35a2bdb
Merge pull request #4 from hres/master
ahasangit May 15, 2018
c465aa1
Merge pull request #5 from hres/api-documentation-dev
ahasangit May 15, 2018
b7bb6e1
Merge pull request #6 from hres/master
ahasangit Jun 6, 2018
e560f52
Merge pull request #7 from hres/api-documentation-dev
ahasangit Jun 7, 2018
10d210c
Merge pull request #8 from hres/master
ahasangit Jul 13, 2018
96fee9a
Merge pull request #9 from hres/api-documentation-dev
ahasangit Jul 13, 2018
8177dac
Merge pull request #10 from hres/master
ahasangit Jul 18, 2018
a0bfee9
Merge pull request #11 from hres/api-documentation-dev
ahasangit Jul 18, 2018
dd23057
Merge pull request #12 from hres/master
alexgagnon Nov 30, 2018
7fffa10
Merge pull request #13 from hres/master
alexgagnon Dec 5, 2018
e661a1c
Merge pull request #14 from hres/master
alexgagnon Dec 13, 2018
5d8424b
Merge pull request #15 from hres/api-documentation-dev
alexgagnon Dec 19, 2018
1a4da25
ADR1436-1920, add last_update_date to DrugProduct
linghanHC Apr 3, 2020
9419eec
Merge pull request #17 from hres/api-documentation-dev-ADR1436-1920
linghanHC Apr 6, 2020
382fb8b
Merge pull request #18 from hres/api-documentation-dev
linghanHC Apr 7, 2020
2deef0b
update sampe return for Medicinal Ingredient
linghanHC Apr 23, 2020
aef15ac
Merge pull request #19 from hres/api-documentation-dev-ADR1436-1920
linghanHC Apr 23, 2020
c0ba008
update sampe return for Product Dose
linghanHC Apr 30, 2020
f376f5a
Merge pull request #20 from hres/api-documentation-dev-ADR1436-1920
linghanHC Apr 30, 2020
b15e763
update cvp documentations
linghanHC May 14, 2020
891fb7f
Merge pull request #21 from hres/api-documentation-dev-ADR1436-1920
linghanHC May 14, 2020
85066b3
update noc documentations
linghanHC May 15, 2020
480aa2d
Merge pull request #22 from hres/api-documentation-dev-ADR1436-1920
linghanHC May 15, 2020
36d7199
update the sample response for lnhpd api paginated response
linghanHC Jun 15, 2020
de062d3
Merge pull request #23 from hres/api-documentation-dev-ADR1436-1920
linghanHC Jun 15, 2020
490cc41
Merge pull request #24 from hres/api-documentation-dev
linghanHC Dec 1, 2020
b10ff6a
remove the AHFS code and description from the Therapeutic endpoint fo…
linghanHC Feb 23, 2022
3f092f2
Merge pull request #25 from hres/api-documentation-wip
linghanHC Feb 23, 2022
828741a
update the AHFS code and description from the Therapeutic endpoint fo…
linghanHC Mar 7, 2022
cb97275
Revert "update the AHFS code and description from the Therapeutic end…
linghanHC Mar 7, 2022
6053287
update the AHFS code and description from the Therapeutic endpoint fo…
linghanHC Mar 7, 2022
05fdf19
Merge pull request #26 from hres/api-documentation-wip
linghanHC Mar 7, 2022
8550e4b
Merge pull request #27 from hres/api-documentation-dev
linghanHC Mar 8, 2022
1cfcd31
Replaced old template versions
dmiraflorhc Jun 26, 2023
c1e598d
Removed datasets + DHPR and MDEL
dmiraflorhc Jun 26, 2023
5f1b934
Removed datasets from other project files
dmiraflorhc Jun 26, 2023
1adb340
Removed base URI links and bolded instead
dmiraflorhc Jun 27, 2023
339d78b
Merge pull request #30 from dmiraflorhc/template-fixes-v2
linghanHC Jun 29, 2023
a124166
Merge pull request #31 from hres/api-documentation-wip
linghanHC Jun 29, 2023
e8c8908
French WET templates
dmiraflorhc Jun 29, 2023
5d09c35
Merge pull request #32 from dmiraflorhc/template-fixes-v2
linghanHC Jul 6, 2023
e1143e4
Merge pull request #34 from hres/api-documentation-wip
linghanHC Jul 6, 2023
f375457
LNHPDAPI-12. Removed JQuery anchors
dmiraflorhc Jul 17, 2023
9a31e62
Merge pull request #35 from dmiraflorhc/template-fixes-v2
dmiraflorhc Jul 17, 2023
344f433
Merge pull request #36 from hres/api-documentation-wip
AMckayHC Jul 17, 2023
849475d
Merge pull request #37 from hres/api-documentation-dev
AMckayHC Jul 17, 2023
a206b43
Changed web service links to be relative
AMckayHC May 15, 2024
35d45e8
add missed external status codes/descriptions that are available in DB
Sep 18, 2025
7fb5187
Merge pull request #39 from hres/dpd-status-work
AMckayHC Sep 22, 2025
b805f42
add missed external status codes 15 to dpd-docuementation
Oct 27, 2025
ec906a6
Merge pull request #40 from hres/dpd-status-work
AMckayHC Oct 27, 2025
4cbd70f
use lower case for external status codes 15 to dpd French docuementation
Oct 28, 2025
c820f7f
Merge pull request #41 from hres/dpd-status-work
AMckayHC Oct 28, 2025
5e6098b
add brackets to status 15 for DPD API English Documentation
Nov 6, 2025
8b56102
Merge pull request #42 from hres/dpd-status-work
AMckayHC Nov 6, 2025
f6404b3
Merge pull request #43 from hres/api-documentation-dev
AMckayHC Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions APIDocumentation/APIDocumentation.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,27 +99,13 @@
<Content Include="bin\APIDocumentation.pdb" />
<Content Include="cnf-documentation-en.html" />
<Content Include="cnf-documentation-fr.html" />
<Content Include="cta-dataset-fr.html" />
<Content Include="cta-dataset-en.html" />
<Content Include="cta-documentation-fr.html" />
<Content Include="cta-documentation-en.html" />
<Content Include="cvp-dataset-fr.html" />
<Content Include="cvp-documentation-fr.html" />
<Content Include="dhpr-dataset-fr.html" />
<Content Include="dhpr-dataset-en.html" />
<Content Include="cvp-documentation-en.html" />
<Content Include="dhpr-documentation-fr.html" />
<Content Include="dhpr-documentation-en.html" />
<Content Include="api-en.html" />
<Content Include="cvp-dataset-en.html" />
<Content Include="dpd-dataset-fr.html" />
<Content Include="dpd-dataset-en.html" />
<Content Include="dpd-documentation-fr.html" />
<Content Include="lnhpd-documentation-fr.html" />
<Content Include="mdel-dataset-en.html" />
<Content Include="mdel-dataset-fr.html" />
<Content Include="mdel-documentation-en.html" />
<Content Include="mdel-documentation-fr.html" />
<Content Include="StaticFallbackFiles\gcweb\footer-en.html" />
<Content Include="StaticFallbackFiles\gcweb\footer-fr.html" />
<Content Include="StaticFallbackFiles\gcweb\prefooter-en.html" />
Expand All @@ -137,17 +123,11 @@
<Content Include="StaticFallbackFiles\gcweb\transactFooter-fr.html" />
<Content Include="StaticFallbackFiles\gcweb\transactTop-en.html" />
<Content Include="StaticFallbackFiles\gcweb\transactTop-fr.html" />
<Content Include="lnhpd-dataset-fr.html" />
<Content Include="lnhpd-documentation-en.html" />
<Content Include="mdall-dataset-fr.html" />
<Content Include="mdall-documentation-fr.html" />
<Content Include="mdall-documentation-en.html" />
<Content Include="dpd-documentation-en.html" />
<Content Include="js\jquery.xdomainrequest.min.js" />
<Content Include="lnhpd-dataset-en.html" />
<Content Include="mdall-dataset-en.html" />
<Content Include="noc-dataset-fr.html" />
<Content Include="noc-dataset-en.html" />
<Content Include="noc-documentation-fr.html" />
<Content Include="noc-documentation-en.html" />
<Content Include="packages.config" />
Expand All @@ -159,8 +139,6 @@
</None>
</ItemGroup>
<ItemGroup>
<Content Include="summary-report-dataset-fr.html" />
<Content Include="summary-report-dataset-en.html" />
<Content Include="summary-report-documentation-fr.html" />
<Content Include="summary-report-documentation-en.html" />
<Content Include="Web.config" />
Expand Down
14 changes: 3 additions & 11 deletions APIDocumentation/api-en.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
<meta name="meta_date" content="" />

<!-- Load closure template scripts -->
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/wet-en.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/plugins-en.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/wet-en.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/plugins-en.js"></script>

<!-- Load closure template scripts -->
<noscript>
Expand Down Expand Up @@ -87,21 +87,13 @@
<h1 property="name" id="wb-cont">APIs - Documentation</h1>

<p>APIs Documentation:</p>
<p><a href="cvp-dataset-en.html">Canada Vigilance (CVP) Dataset</a></p>
<p><a href="cvp-documentation-en.html">Canada Vigilance (CVP) API Documentation</a></p>
<p><a href="cta-dataset-en.html">Clinical Trials Database (CTA) Dataset</a></p>
<p><a href="cta-documentation-en.html">Clinical Trials Database (CTA) API Documentation</a></p>
<p><a href="dhpr-dataset-en.html">Drug and Health Products Register (DHPR) Dataset</a></p>
<p><a href="dhpr-documentation-en.html">Drug and Health Products Register (DHPR) API Documentation</a></p>
<p><a href="dpd-dataset-en.html">Drug Product Database (DPD) Dataset</a></p>
<p><a href="dpd-documentation-en.html">Drug Product Database (DPD) API Documentation</a></p>
<p><a href="lnhpd-dataset-en.html">Licenced Naturel Product Database (LNHPD) Dataset</a></p>
<p><a href="lnhpd-documentation-en.html">Licenced Naturel Product Database (LNHPD) API Documentation</a></p>
<p><a href="mdall-dataset-en.html">Medical Devices Active Licence Listing (MDALL) Dataset</a></p>
<p><a href="mdall-documentation-en.html">Medical Devices Active Licence Listing (MDALL) API Documentation</a></p>
<p><a href="noc-dataset-en.html">Notice of Compliance Database (NOC) Dataset</a></p>
<p><a href="noc-documentation-en.html">Notice of Compliance Database (NOC) API Documentation</a></p>
<p><a href="summary-report-dataset-en.html">Summary Report Dataset</a></p>
<p><a href="summary-report-documentation-en.html">Summary Report API Documentation</a></p>

</div>
Expand Down
14 changes: 3 additions & 11 deletions APIDocumentation/api-fr.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
<meta name="meta_date" content="" />

<!-- Load closure template scripts -->
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/wet-fr.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/plugins-fr.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/wet-fr.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/plugins-fr.js"></script>

<!-- Load closure template scripts -->
<noscript>
Expand Down Expand Up @@ -87,21 +87,13 @@
<div class="wb-frmvld">
<h1 property="name" id="wb-cont">APIs - Documentation</h1>
<p>APIs Documentation:</p>
<p><a href="cvp-dataset-fr.html">Dataset - Base de données en ligne des effets indésirables de Canada Vigilance (BDEI)</a></p>
<p><a href="cvp-documentation-fr.html">Guide API - Base de données en ligne des effets indésirables de Canada Vigilance (BDEI)</a></p>
<p><a href="cta-dataset-fr.html">Dataset - Base de données des essais cliniques (BDEC)</a></p>
<p><a href="cta-documentation-fr.html">Guide API - Base de données des essais cliniques (BDEC)</a></p>
<p><a href="dhpr-dataset-fr.html">Dataset - Registre des médicaments et des produits de santé (RMPS)</a></p>
<p><a href="dhpr-documentation-fr.html">Guide API - Registre des médicaments et des produits de santé (RMPS)</a></p>
<p><a href="dpd-dataset-fr.html">Dataset API - Base de données sur les produits pharmaceutiques (BDPP)</a></p>
<p><a href="dpd-documentation-fr.html">Guide API - Base de données sur les produits pharmaceutiques (BDPP)</a></p>
<p><a href="lnhpd-dataset-fr.html">Dataset API - Base de donnée de produits de santé naturels homologués (BDPSNH)</a></p>
<p><a href="lnhpd-documentation-fr.html">Guide API - Base de donnée de produits de santé naturels homologués (BDPSNH)</a></p>
<p><a href="mdall-dataset-fr.html">Dataset - Liste des instruments médicaux homologués en vigueur (MDALL)</a></p>
<p><a href="mdall-documentation-fr.html">Guide API - Liste des instruments médicaux homologués en vigueur (MDALL)</a></p>
<p><a href="noc-dataset-fr.html">Dataset - Avis de conformité (AC)</a></p>
<p><a href="noc-documentation-fr.html">Guide API - Avis de conformité (AC)</a></p>
<p><a href="summary-report-dataset-fr.html">Dataset - Rapports sommaires</a></p>
<p><a href="summary-report-documentation-fr.html">Guide API - Rapports sommaires</a></p>
</div>
<!-- prefooter-en.html-Start-->
Expand Down
8 changes: 4 additions & 4 deletions APIDocumentation/cnf-documentation-en.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
<meta name="meta_date" content="" />

<!-- Load closure template scripts -->
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/wet-en.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/plugins-en.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/wet-en.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/plugins-en.js"></script>

<!-- Load closure template scripts -->
<noscript>
Expand Down Expand Up @@ -179,7 +179,7 @@ <h2 id="a">Table of contents</h2>
<h2 id="a1">Introduction</h2>
<p>The Canadian Nutrient File (CNF) is the standard reference food composition database reporting the amount of nutrients in foods commonly consumed in Canada.</p>
<p>This Application Programming Interface (API) allows developers to access that information in JSON and XML format for reuse in their own applications.
The base URI for the Canadian Nutrient File Database is&nbsp;<a href="https://food-nutrition.canada.ca/api/canadian-nutrient-file/">https://food-nutrition.canada.ca/api/canadian-nutrient-file/</a> and you can add parameters to it. Any requests are made relative to this URI.</p>
The base URI for the Canadian Nutrient File Database is <strong>https://food-nutrition.canada.ca/api/canadian-nutrient-file/</strong> and you can add parameters to it. Any requests are made relative to this URI.</p>
</section>
<section>
<!-- Remove Food Group section Jan 25
Expand Down
8 changes: 4 additions & 4 deletions APIDocumentation/cnf-documentation-fr.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
<meta name="meta_date" content="" />

<!-- Load closure template scripts -->
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/wet-fr.js"></script>
<script type="text/javascript" src="https://ssl-templates.services.gc.ca/app/cls/wet/gcweb/v4_0_21/js/compiled/plugins-fr.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/soyutils.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/wet-fr.js"></script>
<script type="text/javascript" src="https://www.canada.ca/etc/designs/canada/cdts/gcweb/v4_0_28/cdts/compiled/plugins-fr.js"></script>
<!-- Load closure template scripts -->
<noscript>
<link rel="import" href="./StaticFallbackFiles/gcweb/refTop.html">
Expand Down Expand Up @@ -179,7 +179,7 @@ <h2 id="a">Table des matières</h2>
<h2 id="a1">Introduction</h2>
<p>Le Fichier canadien sur les éléments nutritifs (FCÉN) est la base de données de référence sur la composition des aliments qui nous informe de la quantité des éléments nutritifs dans les aliments couramment consommés au Canada.</p>
<p>Cette interface de programmation d'applications (API) permet aux concepteurs d'accéder à ces renseignements en format JSON et XML afin de les utiliser dans leurs propres applications.
L'adresse URI de base sur le Fichier canadien sur les éléments nutritifs est &nbsp;<a href="https://aliments-nutrition.canada.ca/api/fichier-canadien-elements-nutritifs/">https://aliments-nutrition.canada.ca/api/fichier-canadien-elements-nutritifs/</a> et vous pouvez y ajouter des paramètres. Toute requête est effectuée par l'entremise de cette adresse URI.</p>
L'adresse URI de base sur le Fichier canadien sur les éléments nutritifs est <strong>https://aliments-nutrition.canada.ca/api/fichier-canadien-elements-nutritifs/</strong> et vous pouvez y ajouter des paramètres. Toute requête est effectuée par l'entremise de cette adresse URI.</p>
</section>
<section>
<!--Food Group-section-remove Jan 25 no food group link data
Expand Down
Loading