This shows you the differences between two versions of the page.
— |
design2budget:webservice:modules:attachment [2015/11/27 14:09] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== design2budget Entwickler Webservice Dokumentation ====== | ||
+ | |||
+ | Zurück zur [[design2budget:webservice|Webservice Dokumentation Startseite]] | ||
+ | |||
+ | ====== Modul attachment ====== | ||
+ | |||
+ | Das Modul attachment ist die Abbildung der Attachments. | ||
+ | |||
+ | Jedes erstellte PDF (für Angebote, Aufträge, Rechnungen, Mahnungen) und jede hochgeladene Datei wird als Attachment Record abgelegt. Der Record beinhaltet Datei-Metadaten mit der Größe oder dem Dateinamen. | ||
+ | |||
+ | Das Schema kann unter https://server/tenant/s/attachment/schema/ abgefragt werden. | ||
+ | |||
+ | Jedes Modul bietet einige Basis-Operationen. Siehe [[design2budget:webservice|Webservice Dokumentation Startseite]]. | ||
+ | |||
+ | ^ action ^ Beschreibung ^ | ||
+ | | /a/ | download eines attachments | | ||
+ | |||
+ | ====== /a/ ====== | ||
+ | |||
+ | Dies ermöglicht den Download eines Attachments per GET Request. | ||
+ | |||
+ | ACHTUNG: Dies ist kein herkömmlicher JSON/XML Aufruf - es ist direkt der Downloadlink für das Attachment | ||
+ | |||
+ | ==== GET/URL ==== | ||
+ | |||
+ | https://server/tenant/a/filename?sid=sessionID&att=attachmentId | ||
+ | |||
+ | ^ Parameter ^ Beschreibung ^ | ||
+ | | filename | Dateiname des attachments (über Modul attachment Basisoperation [[design2budget:webservice:operation:get]] holen) | | ||
+ | | attachmentId | int attachment::id des attachments (z.B. per invoice::get Feld invoicepdf) | | ||
+ | |||
+ | Beispiel: | ||
+ | |||
+ | [[http://server/tenant/rh/a/invoice-r201502010-01.02.2015.pdf?att=321]] | ||
+ | |||
+ | ==== POST ==== | ||
+ | |||
+ | nicht notwendig. | ||
+ | |||
+ | ==== RETURN ==== | ||
+ | |||
+ | Download des Attachments direkt als File | ||
+ | |||
+ | |||