Einleitung
Der öffentliche Webservice für Verkaufsaufträge ermöglicht es, Drittsysteme an das Verkaufssystem ems anzuschliessen.
URL und Authentifizierung
Ziel URL:
xxx/Public/SaleSystem/Version10001.asmx
Der Benutzername und das Passwort für den Zugang wird Ihnen durch den Betreiber des Systems bekannt gegeben. Bei der ems-Cloud ist dies die SUBRIS GmbH.
Webservices für Gutscheine
Funktionen
CreateVoucher
Erstellen von Gutscheinen
CheckVoucher
Prüfen der Gutscheine auf Gültigkeit und den Gutscheinwert.
Auch können Gutscheincodes von Gutscheinkarten (EAN) abgefragt werden.
RedeemVoucher
Gutschein einlösen, nötigenfalls neuen Gutschein mit Restwert erstellen.
Rückgabe
Es wird ein standardisiertes Antwortobjekt zurückgegeben. Dieses enthält folgende Inhalte:
ErrorCode: 0 = Ohne Fehler, ansonsten den Fehlercode
VoucherCode: Gutscheincode (Einmalig gültig)
VoucherCardCode: EAN oder Nummer auf Gutscheinkarte
Value: Wert des Gutschein CurrencyCode: Währungscode, bspw. CHF
Eingabefelder
Username: Benutzername für die Anmeldung
Password: Passwort des Benutzers für die Anmeldung
PosID: Identifikation des Kassensystems
Fehlercodes
Die Fehlercodes werden im Antwortobjekt im Feld Errorcode zurückgegeben.
(0 entspricht keinem Fehler)
Errorcode 1
Ungekannter Fehler
Errorcode 1001
Benutzername oder Passwort falsch
Errorcode 1002
Benutzer nicht mehr oder noch nicht aktiv im System.
Errorcode 4001
Kassensystem-ID ist nicht gültig oder das Kassensystem ist nicht aktiv.
Errorcode 4031
Gutschein wurde nicht gefunden oder ist nicht gültig.
Errorcode 4032
Gutschein wurde bereits eingelöst.
Errorcode 4035
Ungültige Gutscheindaten (Betrag kleiner Null oder nicht zulässige Währung)
Errorcode 4036
Einzulösender Betrag ist grösser als der Gutscheinwert.
Erklärung der ems Webservices
Das ems System bietet über die Public WebServices die Option, Office-Dokumente zu automatisieren. Über die Webservices können Daten direkt abgerufen werden. Aus Sicherheitsgründen ist die Funktion jedoch nur möglich, sofern eine laufende Session (angemeldeter Benutzer) vorhanden ist. Ist kein Benutzer angemeldet, wird jeder Aufruf direkt an die Loginseite weitergeleitet.
Die Webservices ermöglichen nur den Abruf von Daten, jedoch nicht das Schreiben von Daten.
Webservice für Daten
Erreichbarkeit
Die Webservices sind über die folgende URL erreichbar:
[EMS-Web-URL]/start/OfficeAutomation.asmx
[EMS-Web-URL] enspricht dabei der URL des Kundensystems.
Funktionen
Im ems Webservice sind die nachfolgenden Funktionen verfügbar. Eine Liste der genauen Datentypen und erwarteten Parameter ist wie folgt abrufbar:
[EMS-Web-URL]/start/OfficeAutomation.asmx?WSDL
System_getVersion
Rückgabe der aktuellen Version des EMS Web Systems.
Rückgabe (String):
Rückgabe der aktuellen Version
Office_CompanyImageByCode_v001
Rückgabe des Logo (Bild) der Firma.
Parameter:
intS1pCode: Code der entsprechenden Bildposition.
Position 1 entspricht dem Logo, welches auf Reports verwendet wird.
Rückgabe (ByteArray):
Office_CostCenterListBySearchText_v001
Liste der Kostenstellen oder Organisationseinheiten anhand eines Suchtextes.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01 … 999 = Kostenstellen mit ;-getrennt
Pos. xx.00 = Status (nur bei Pos. 00)
Pos. xx.01 = FiCode
Pos. xx.02 = Kostenstelle
Pos. xx.03 = Kostenstellentext / Filialentext
Pos. xx.04 = Ortschaft
Office_CustomerAddressDataByKdCode_v001
Rückgabe einer Kundenadresse anhand des exakten Kundencodes. Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-20 = Kundendaten
Office_CustomerOpportunityDataByAsCode_v001
Rückgabe des Angebots mit den Adressdaten und Auftragsdaten.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-15 = Kundendaten
Pos. 16-30 = Objektdaten
Pos. 31-45 = Versandadresse
Pos. 46-60 = Planer
Pos. 61-70 = Angebotsdaten
Office_CustomerOrderDataByKaCode_v001
Rückgabe des Kundenauftrag mit den Adressdaten und Auftragsdaten.
Parameter:
intKaCode: Exakte Interne Kundenauftragsnummer (ohne KA)
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-15 = Kundendaten
Pos. 16-30 = Objektdaten
Pos. 31-45 = Versandadresse
Pos. 46-60 = Planer
Pos. 61-70 = Auftragsdaten
Office_CustomerReferenceImageByFiRoCode_v001
Rückgabe des Bild zu einer Kundenreferenz.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Bytearray mit dem Bild als JPG.
Office_CustomerReferenceListBySearchText_v001
Rückgabe einer Liste von Kundenreferenzen, die dem Suchbegriff entsprechen.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01 … 999 = Referenzobjekte mit ;-getrennt
Pos. xx.00 = Status (nur bei Pos. 00)
Pos. xx.01 = FiRo-Code
Pos. xx.02 = Titel
Pos. xx.03 = Fliesstext
Office_DocumentBarcodeFormTemplateList_v001
Rückgabe der Liste von möglichen Barcodearten in der Datenbank.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01 … 99 = Vorlage mit ;-getrennt
Pos. xx.00 = Status (nur bei Pos. 00)
Pos. xx.01 = Prefix
Pos. xx.02 = Dokumenten-Art
Pos. xx.03 = Dokumenten-Kategorie
Pos. xx.04 = Dokumentenbezeichnung
Office_EmployeeDataByMaPnr_v002
Rückgabe eines Mitarbeiter und der entsprechenden Daten des Mitarbeitenden.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-10 = Grunddaten des Mitarbeiters
Pos. 11-30 = Geschäftsdaten des Mitarbeiters
Pos. 31-60 = Liste von Ausbildungen
Office_EmployeeDataListBySearchText_v001
Rückgabe einer Liste von Mitarbeitenden, die dem Suchbegriff entsprechen.
Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Pos. 00 = Status
Pos. 01 … 999 = Mitarbeiter mit ;-getrennt
Pos. xx.00 = Status (nur bei Pos. 00)
Pos. xx.01 = Personalnr.
Pos. xx.02 = Name Vorname (Funktion)
Office_EmployeeImageByMaPnr_v001
Rückgabe des Bild zum Mitarbeitenden. Parameter:
strTemplateType: Typ der gewünschten Belegart bspw. KA für Kundenauftrag
Rückgabe (Array):
Bytearray mit dem Bild als JPG.
Office_ToolTypeByBmCode_v001
Rückgabe des Betriebsmittel und Betriebsmitteltypen anhand der exakten Betriebsmittelnummer.
Parameter:
intBmCode: Betriebsmittelnummer
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-10 = Typendaten
Pos. 11-20 = Betriebsmitteldaten
Pos. 21-30 = Aktive Zuteilung
Office_ToolTypeByBmFremdnr_v002
Rückgabe des Betriebsmittel und Betriebsmitteltypen anhand der Inventarnummer (Fremdnummer).
Parameter:
strFremdNr: Inventarnummer des Betriebsmittel (nicht BM-Code)
Rückgabe (Array):
Pos. 00 = Status
Pos. 01-10 = Typendaten
Pos. 11-20 = Betriebsmitteldaten
Pos. 21-30 = Aktive Zuteilung
Imagehandler für Bilder
Erreichbarkeit
Die Imagehandler sind über die folgende URL erreichbar:
[EMS-Web-URL]/start/OfficeAutomation.ashx
[EMS-Web-URL] enspricht dabei der URL des Kundensystems.
Funktionen
Der Imagehandler wird mit Parametern aufgerufen. Diese werden wie folgt an die URL angehängt: [EMS-Web-URL]/start/OfficeAutomation.asmx?mapnr=1234
Als Rückgabe wird direkt das Bild zurückgegeben.
Gültige Parameter
mapnr= [Personalnummer] ficode= [Organisationseinheit Code] firocode= [Referenzcode] s1pcode= [Bildcode von Reports]