Erste Schritte mit der Flexi-API (3/6)

Konstruieren einer URL

Petr Pech avatar
Verfasst von Petr Pech
Vor über einer Woche aktualisiert

In

diesem Teil des Artikels gehen wir durch, wie man eine Flexi-URL erstellt.

Die URL-Struktur

ist wie folgt:

/c/<Unternehmenskennung>/<Datensatz>/<Datensatz-ID>.<Ausgabeformat>

  • <Firmenkennung> : eindeutige Identifikation der Firma

  • <record> : Typ des Datensatzes (Verzeichnis, Bestellung, Rechnung, ...); Liste der Datensätze, geben Sie den Wert des <recordPath>-Elements in der URL ein

  • <recordID> : DatensatzbezeichnerListe der Bezeichner: Datensatzbezeichner

  • <Ausgabeformat> : Ausgabeformat (XML, JSON, ...)

URL-Beispiele:

demo.flexibee.eu

- Adresse des Servers, in diesem Fall unsere Cloud (Demo-Instanz)

demo

- Firmenkennung (Sie finden sie in der URL zum Einloggen in die Weboberfläche)

Rechnung-ausgestellt

- Aufzeichnung der ausgestellten Rechnungen

15

- Datensatzbezeichner (zu finden im XML der Datensatz-Agenda - Element <id>, oder in der Anwendung nach Hinzufügen der ID-Spalte)

xml

- Datenformat

Diese URL zeigt uns also im XML-Format die Rechnung, die mit der ID 15 in der Firma "demo" unter demo.flexibee.eu ausgestellt wurde.

https://localhost:5434/c/testovaci/faktura-vydana/15.xml
  • Beispiel-URL für lokale Installation

https://93.170.19.14:xxxx/c/testovaci/faktura-vydana/15.xml
  • Beispiel-URL für einen benutzerdefinierten Server, die Port-Einstellungen liegen in der Hand Ihres Netzwerkadministrators

Für detailliertere Informationen über die URL-Struktur empfehlen wir Ihnen unsere Dokumentation: Aufbau von URLs


Für jeden Datensatz ist es auch möglich, eine Liste aller Attribute zu erhalten, die der Datensatz enthält.

Übersicht der Attribute für jeden Datensatz:

/c//eigenschaften

Sie werden als Attribute des Datensatzes im XML/JSON-Request verwendet, z. B.:

KOD

- der Datensatz wird den Code/die Abkürzung "KOD" enthalten

Erklärungen zu Spalten in Eigenschaften:

* - erforderliches Element (Interne Links können das Ausfüllen eines erforderlichen Elements überflüssig machen).

rw

- Element ist beschreibbar

ro

- schreibgeschützt

1

- Element ist Teil der 'id'-Liste

2

- Element ist Teil der Liste 'summary'

3

- Element ist Teil der Liste 'voll'

S - es ist möglich, nach Artikel zu sortieren oder zu filtern

Für jeden Datensatz ist es möglich, eine Liste der unterstützten Druckberichte zu erhalten:

/c/<Unternehmenskennung>/<Beweise>/Berichte

Exportieren eines bestimmten Berichts in PDF:

/c/unternehmen/invoice-issued/1.pdf?report-name=dodaciList

  • exportiert einen Druckbericht eines Lieferscheins nach PDF

Wenn Sie Ihre eigenen benutzerdefinierten Berichte erstellt haben, können Sie diese genau wie Standardberichte als PDF exportieren.

Exportieren Sie einen benutzerdefinierten Benutzerbericht als PDF:

/c/unternehmen/preisgestaltung/15.pdf?report-name=stitky

  • exportiert einen benutzerdefinierten Druckbericht mit dem Kürzel "Stiche" nach PDF

Ausführlichere Informationen darüber, wie Sie eine PDF-Datei eines Berichts über eine URL anzeigen können, finden Sie in unserer Dokumentation Exportieren in PDF

Sie können Datensätze auch anhand von URLs filtern:

/c/<Unternehmenskennung>/<Evidenz>/(<Filter>)

Beispiel:

  • filtert alle Rechnungen heraus, bei denen der Code mit 'FV' beginnt

Es ist natürlich möglich, logische Operatoren (und, oder, nicht) zu verwenden:

Beispiel 1:

  • filtert alle Rechnungen heraus, bei denen der Code mit "FV" beginnt und mit "P" endet

Beispiel 2:

  • filtert alle Rechnungen heraus, bei denen der Code mit 'FV' oder 'VF' beginnt

Für detailliertere Informationen zum Filtern von Datensätzen empfehlen wir die Lektüre unserer Dokumentation: Filtern

Detaillierungsgrad

Aus Geschwindigkeitsgründen werden nicht alle Details, die wir für einen Datensatz erfassen, standardmäßig angezeigt. Es ist daher möglich, den Detaillierungsgrad über die URL anzugeben.

Detailstufen:

Für weitere Informationen zu den Detailebenen empfehlen wir Ihnen die Lektüre unserer Dokumentation: Detailebenen

Paginierung

Um die Leistung von Webanwendungen zu verbessern, wird üblicherweise ein "Paging"-System verwendet. Die Liste ist in Seiten unterteilt, die dem Benutzer angezeigt werden, und er kann zwischen ihnen wechseln.

Paginierungsparameter:

  • limit - maximale Anzahl von Datensätzen, Standard ist 20

  • start - wie viele Datensätze übersprungen werden sollen, nicht abhängig vom Limit

Beispiel:

  • ab dem 10. Datensatz werden 25 Datensätze angezeigt (d. h. der 10. - 35. Datensatz)

Weitere Informationen zu Paginierungsparametern finden Sie in unserer Dokumentation: pagination

Überblick über die Sitzung/Unterveranstaltung:

Sie können die URL auch verwenden, um Informationen über Datensätze in Sitzungen abzurufen - indem Sie den Parameter ?relations an das Ende der URL anhängen.
Beispiel:

  • listet alle Verknüpfungen zur Rechnungs-ID 15 auf

Hat dies Ihre Frage beantwortet?