REST API Client Concept Office

Der Webservice Client „Concept Office“ nutzt zur Übertragung von Bestellungen und Auftragsbestätigungen das nachfolgend beschriebene REST API.

Die Pfade gelten unterhalb des hinterlegten Endpunktes für den Service Host.

URI Methode Bemerkung Body Response
/CoEdiService/authentication POST Im Response wird ein Token zurück geliefert. Das ist in nachfolgenden Aufrufen immer im Header mit zugeben. „Authorization“, „token “ <authenticationToken> {„LoginName“: „<loginname>“,„Password“:„<password>“}„ {„LoginName“:„soft“,“Token„:„abc123“}
DELETE
/CoEdiService/filelist/{doctype} GET Liefert eine Liste der bereitstehenden Dateien. doctype =“Orders“
/CoEdiService/files/{doctype}/{filename} PUT Upload einer Datei doctype=“Orders“ Der Dateiinhalt wird als Bytestream im Body übergeben. {„ResultCode“: 0, „TranscationSuccessfull“: false, „Files“: [], „Committed“: false, „Rollbacked“: false}
GET Download einer Datei. doctype=“OrderResponse“. Rückmeldung der Datei als Bytestream.
DELETE Löschen einer Datei nach erfolgreichem Download. doctype=“OrderResponse“.
/CoEdiService/Version GET
allgemein/rest_api.txt · Zuletzt geändert: 2020/11/23 13:29 von Andrea Müller
CC Attribution-Noncommercial-Share Alike 3.0 Unported
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0