deploy: fb96486

GallagherSecurity · Oct 12, 2023 · 3392ef8 · 3392ef8
commit 3392ef8
Show file tree

Hide file tree

Showing 42 changed files with 76,860 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Gallagher Command Centre REST API
+
+In 2020 this Github repository became the authoritative source of the reference documentation for
+Command Centre's REST API.
+
+The `ref` folder of this repository contains the documentation in HTML form.  You can browse it
+online at [github.io].
+
+We use [Spectacle](https://github.com/sourcey/spectacle) to generate that HTML from OpenAPI/Swagger
+2.0 files in the `swagger` folder.  Generating good-looking HTML is the sole purpose of those
+Swagger files:  we do not use them for code generation or API testing.  Therefore they do not follow
+OpenAPI guidelines where doing so would compromise the readability of the documentation.
+
+To download the HTML and YAML in a zip file use the Code button on
+[Github.com](https://github.com/GallagherSecurity/cc-rest-docs).  However, to benefit from our
+regular improvements to that documentation we suggest you browse [the HTML][github.io] whenever
+possible.
+
+[github.io]: https://gallaghersecurity.github.io/cc-rest-docs/ref
diff --git a/api-licensing-860.html b/api-licensing-860.html
diff --git a/ref/.gitignore b/ref/.gitignore
@@ -0,0 +1,9 @@
+
+# Ony use minified Javascript and stylesheets.
+
+javascripts/*
+!javascripts/*.min.js
+
+stylesheets/*
+!stylesheets/*.min.css
+
diff --git a/ref/cardholders.html b/ref/cardholders.html
diff --git a/ref/events.html b/ref/events.html
diff --git a/ref/images/gallagher.png b/ref/images/gallagher.png
diff --git a/ref/index.html b/ref/index.html
@@ -0,0 +1,109 @@
+<!doctype html>
+<html class="no-js" lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Command Centre REST API | API Reference</title>
+    <link rel="stylesheet" href="stylesheets/foundation.min.css" />
+    <link rel="stylesheet" href="stylesheets/spectacle.min.css" />
+    <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
+    <!-- <script src="javascripts/foundation.js"></script> -->
+    <script src="javascripts/spectacle.min.js"></script>
+  </head>
+  <body id="spectacle">
+    <div id="page" class="drawer-layout drawer-slide-right-large">
+      <div id="sidebar">
+        <button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
+          <span aria-hidden="true">×</span>
+        </button>
+        <nav id="nav" role="navigation">
+          <h5>Topics</h5>
+          <a href="#introduction">Introduction</a>
+          <a href="#topic-Documentation-suite">Documentation suite</a>
+          <h5>Paths</h5>
+          <h5>Schema Definitions</h5>
+        </nav>
+      </div>
+      <div id="docs" class="row collapse expanded drawer" data-drawer>
+        <button class="floating-menu-icon" type="button" data-drawer-slide="right">
+          <span class="hamburger"></span>
+        </button>
+        <div class="example-box doc-content">
+          <div id="logo">
+            <img src="images/gallagher.png" title="Command Centre REST API" /> </div>
+        </div>
+        <article>
+          <h1 class="doc-title">Command Centre REST API
+            <span>API Reference</span>
+          </h1>
+          <div id="introduction" data-traverse-target="introduction">
+            <div class="doc-row">
+              <div class="doc-copy">
+                <p>Welcome to the developer documentation for the Command Centre REST interface.</p>
+                <p>The files linked from here show you how you can manage Command Centre using HTTP requests. Each file contains an introduction to its particular area of the API, instructions on authenticating to the server, and tips on how to accomplish common tasks, as well as the usual reference information for paths and data.</p>
+                <p>They do not show how to set up the Command Centre server to answer your REST calls. To do that, search the Configuration Client&#39;s online help for &#39;REST&#39;.</p>
+                <p>You could also look at the sample code shipped with Command Centre, on the install media alongside this documentation in the &#39;Utilities/REST API&#39; folder. There are several Visual Studio projects that compile into .NET applications you could observe making HTTP requests against your own server (in a development environment, of course).</p>
+              </div>
+              <div class="doc-examples">
+                <section>
+                  <h5>Version:
+                    <span>1.0.0</span>
+                  </h5>
+                </section>
+              </div>
+            </div>
+          </div>
+          <h1 id="topic-Documentation-suite" data-traverse-target="topic-Documentation-suite">Documentation suite</h1>
+          <div class="panel">
+            <div class="doc-row">
+              <div class="doc-copy">
+                <p>The API&#39;s reference documentation divides into:</p>
+                <table>
+                  <tr>
+                    <td valign=top>
+                      <a href=events.html>Alarms, events, and non-cardholder items</a>
+                    </td>
+                    <td>
+                      <p> The alarms and events APIs let you download, monitor, and create events, and download, monitor, and manage alarms.</p>
+                      <p> The alarms and events documentation also covers API calls that support divisions and items as they relate to events, as well as bulk status monitoring.</p>
+                    </td>
+                  </tr>
+                  <tr>
+                    <td valign=top>
+                      <a href=cardholders.html>Cardholders and related items</a>
+                    </td>
+                    <td> The cardholder parts of the API let you manage your users, their personal data and credentials (cards), and their links to associated items such as access groups, roles, operator groups, competencies, and lockers. </td>
+                  </tr>
+                  <tr>
+                    <td valign=top>
+                      <a href=rest.html>Status and overrides</a>
+                    </td>
+                    <td>
+                      <p> These functions let you monitor and override the types of Command Centre items that have their own status, including access zones, alarm zones, doors, fence zones, inputs, outputs, macros, elevator groups, interlock groups, and schedules.</p>
+                      <p> Despite its name this section does not cover
+                        <a href="events.html#status-subscriptions">mass-monitoring item status</a>. </td>
+                    </p>
+                  </tr>
+                  <tr>
+                    <td valign=top>
+                      <a href=piv.html>PIV cards</a>
+                    </td>
+                    <td> This supplement describes how to work with PIV and PIV-I cards. It is separate from the main cardholder documentation in the interest of brevity. </td>
+                  </tr>
+                </table>
+              </div>
+            </div>
+          </div>
+          <h1>Paths</h1>
+          <div class="doc-row no-margin">
+            <div class="doc-copy doc-separator">
+              <a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
+                <span>Spectacle</span>
+              </a>
+            </div>
+          </div>
+        </article>
+      </div>
+    </div>
+  </body>
+</html>
diff --git a/ref/javascripts/spectacle.min.js b/ref/javascripts/spectacle.min.js