PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Deployed 50f28f6 to next with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
CI 2026-03-11 21:22:47 +00:00
parent 4ea77e7175
commit 2deb699794
36 changed files with 2606 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
next/404.html
View File

@ -433,6 +433,34 @@
<li class="md-nav__item">
<a href="/Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/Docs/Parcel/" class="md-nav__link">

28
next/Docs/Address/index.html
View File

@ -454,6 +454,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Docs/Carrier_Service/index.html
View File

@ -513,6 +513,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Docs/Database/index.html
View File

@ -524,6 +524,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Docs/Events/index.html
View File

@ -563,6 +563,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

30
next/Docs/FormPS1583/index.html
View File

@ -12,7 +12,7 @@
<link rel="prev" href="../Events/">
<link rel="next" href="../Parcel/">
<link rel="next" href="../HTTP_API_Server/">
@ -454,6 +454,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

1587
next/Docs/HTTP_API_Server/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

30
next/Docs/Parcel/index.html
View File

@ -9,7 +9,7 @@
<link rel="prev" href="../FormPS1583/">
<link rel="prev" href="../HTTP_API_Server/">
<link rel="next" href="../Receipt/">
@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>

28
next/Docs/Receipt/index.html
View File

@ -444,6 +444,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Docs/ReceiptPrinter/index.html
View File

@ -444,6 +444,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Docs/TrackingBarcode/index.html
View File

@ -444,6 +444,34 @@
<li class="md-nav__item">
<a href="../HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

28
next/Examples/01Minimal/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Examples/02Basic/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Examples/03Shipping/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Examples/04CardProcessor/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Examples/05CryptoProcessor/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/barcode/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/database/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/fs/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/global functions/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/graphics/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

93
next/Plugin API/httpserver/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">
@ -1043,6 +1071,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#httpserversendrequesttoremotedata-endpointid-serveraddress-serverport-promiseobject" class="md-nav__link">
<span class="md-ellipsis">
httpserver.sendRequestToRemote(data, endpointID, serverAddress, serverPort) ⇒ Promise.&lt;Object&gt;
</span>
</a>
</li>
</ul>
@ -1469,6 +1508,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#httpserversendrequesttoremotedata-endpointid-serveraddress-serverport-promiseobject" class="md-nav__link">
<span class="md-ellipsis">
httpserver.sendRequestToRemote(data, endpointID, serverAddress, serverPort) ⇒ Promise.&lt;Object&gt;
</span>
</a>
</li>
</ul>
@ -1504,6 +1554,7 @@
<li><a href="#httpserver.addEndpoint">.addEndpoint(id, onCall)</a></li>
<li><a href="#httpserver.getServerPort">.getServerPort()</a> ⇒ <code>number</code></li>
<li><a href="#httpserver.getClientKey">.getClientKey()</a> ⇒ <code>string</code></li>
<li><a href="#httpserver.sendRequestToRemote">.sendRequestToRemote(data, endpointID, serverAddress, serverPort)</a> ⇒ <code>Promise.&lt;Object&gt;</code></li>
</ul>
</li>
</ul>
@ -1551,7 +1602,47 @@ PostalPoint. Requests must be POSTed and contain a JSON body (or empty body, wh
<h3 id="httpservergetclientkey-string">httpserver.getClientKey() ⇒ <code>string</code></h3>
<p>Get the local machine's HTTP client key it uses to authenticate with other
installations of PostalPoint on the LAN.</p>
<p><strong>Kind</strong>: static method of <a href="#httpserver"><code>httpserver</code></a> </p>
<p><strong>Kind</strong>: static method of <a href="#httpserver"><code>httpserver</code></a><br />
<a name="httpserver.sendRequestToRemote"></a></p>
<h3 id="httpserversendrequesttoremotedata-endpointid-serveraddress-serverport-promiseobject">httpserver.sendRequestToRemote(data, endpointID, serverAddress, serverPort) ⇒ <code>Promise.&lt;Object&gt;</code></h3>
<p>Send a HTTP request to another PostalPoint installation on the local network.</p>
<p><strong>Kind</strong>: static method of <a href="#httpserver"><code>httpserver</code></a><br />
<strong>Returns</strong>: <code>Promise.&lt;Object&gt;</code> - - The JSON reply.<br />
<strong>Throws</strong>:</p>
<ul>
<li><code>Error</code> When there's a network or other unrecoverable error while completing the request. Error message is a human-readable description of the problem.</li>
</ul>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td><code>Object</code></td>
<td>Data to encode as JSON in the request body.</td>
</tr>
<tr>
<td>endpointID</td>
<td><code>string</code></td>
<td>Endpoint to call.</td>
</tr>
<tr>
<td>serverAddress</td>
<td><code>string</code> | <code>undefined</code></td>
<td>Address of the PostalPoint server. If undefined, uses the host address configured in PostalPoint's Databases settings.</td>
</tr>
<tr>
<td>serverPort</td>
<td><code>number</code> | <code>undefined</code></td>
<td>Port of the PostalPoint server. If undefined, the default PostalPoint port number is used.</td>
</tr>
</tbody>
</table>

28
next/Plugin API/i18n/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/kiosk/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/mailboxes/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/pos/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/print/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/reports/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/settings/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/shipping/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/storage/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/ui/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/user/index.html
View File

@ -442,6 +442,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/Plugin API/util/index.html
View File

@ -440,6 +440,34 @@
<li class="md-nav__item">
<a href="../../Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

28
next/index.html
View File

@ -553,6 +553,34 @@
<li class="md-nav__item">
<a href="Docs/HTTP_API_Server/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="Docs/Parcel/" class="md-nav__link">

2
next/search/search_index.json
View File

File diff suppressed because one or more lines are too long