Introduction #
The public web service for sales orders makes it possible to connect third-party systems to the ems sales system.
URL and authentication #
Target URL:
xxx/Public/SaleSystem/Version10001.asmx
The user name and password for access will be provided to you by the operator of the system. In the case of the ems cloud, this is SUBRIS GmbH.
Web services for vouchers #
Functions #
CreateVoucher #
Create vouchers
CheckVoucher #
Check vouchers for validity and voucher value.
Voucher codes from voucher cards (EAN) can also be queried.
RedeemVoucher #
Redeem voucher, create new voucher with residual value if necessary.
Return #
A standardized response object is returned. This contains the following content:
ErrorCode: 0 = No error, otherwise the error code
VoucherCode: Voucher code (valid once)
VoucherCardCode: EAN or number on voucher card
Value: Value of the voucher CurrencyCode: Currency code, e.g. CHF
Input fields #
Username: User name for logging in
Password: User password for logging in
PosID: Identification of the POS system
Error codes #
The error codes are returned in the response object in the Errorcode field.
(0 corresponds to no error)
Error code 1 #
Unrecognized error
Error code 1001 #
Username or password incorrect
Error code 1002 #
User no longer or not yet active in the system.
Error code 4001 #
POS system ID is not valid or the POS system is not active.
Error code 4031 #
Voucher was not found or is not valid.
Error code 4032 #
Voucher has already been redeemed.
Error code 4035 #
Invalid voucher data (amount less than zero or invalid currency)
Error code 4036 #
Amount to be redeemed is greater than the voucher value.
Explanation of ems web services #
The ems system offers the option of automating Office documents via the Public WebServices. Data can be retrieved directly via the web services. For security reasons, however, this function is only possible if a running session (logged-in user) is available. If no user is logged in, every call is forwarded directly to the login page.
The web services only allow data to be retrieved, not written.
Web service for data #
Accessibility #
The web services can be accessed via the following URL:
[EMS-Web-URL]/start/OfficeAutomation.asmx
[EMS-Web-URL] corresponds to the URL of the customer system.
Functions #
The following functions are available in the ems web service. A list of the exact data types and expected parameters can be called up as follows:
[EMS-Web-URL]/start/OfficeAutomation.asmx?WSDL
System_getVersion #
Return of the current version of the EMS Web System.
Return (string):
Return of the current version
Office_CompanyImageByCode_v001 #
Returns the logo (image) of the company.
Parameter:
intS1pCode: Code of the corresponding image position.
Position 1 corresponds to the logo used on reports.
Return (ByteArray):
Office_CostCenterListBySearchText_v001 #
List of cost centers or organizational units based on a search text.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01 … 999 = Cost centers with ;-separated
Pos. xx.00 = Status (only for Pos. 00)
Pos. xx.01 = FiCode
Pos. xx.02 = Cost center
Pos. xx.03 = Cost center text / branch text
Pos. xx.04 = Location
Office_CustomerAddressDataByKdCode_v001 #
Returns a customer address based on the exact customer code. Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01-20 = Customer data
Office_CustomerOpportunityDataByAsCode_v001 #
Return of the offer with the address data and order data.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01-15 = Customer data
Pos. 16-30 = Object data
Pos. 31-45 = Shipping address
Pos. 46-60 = Planner
Pos. 61-70 = Quotation data
Office_CustomerOrderDataByKaCode_v001 #
Return of the customer order with the address data and order data.
Parameter:
intKaCode: Exact internal customer order number (without KA)
Return (array):
Pos. 00 = Status
Pos. 01-15 = Customer data
Pos. 16-30 = Object data
Pos. 31-45 = Shipping address
Pos. 46-60 = Planner
Pos. 61-70 = Order data
Office_CustomerReferenceImageByFiRoCode_v001 #
Return of the image to a customer reference.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Byte array with the image as a JPG.
Office_CustomerReferenceListBySearchText_v001 #
Returns a list of customer references that match the search term.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01 … 999 = Reference objects with ;-separated
Pos. xx.00 = Status (only for Pos. 00)
Pos. xx.01 = FiRo code
Pos. xx.02 = Title
Pos. xx.03 = Continuous text
Office_DocumentBarcodeFormTemplateList_v001 #
Returns the list of possible barcode types in the database.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01 … 99 = Template with ;-separated
Pos. xx.00 = Status (only for Pos. 00)
Pos. xx.01 = Prefix
Pos. xx.02 = Document type
Pos. xx.03 = Document category
Pos. xx.04 = Document description
Office_EmployeeDataByMaPnr_v002 #
Return of an employee and the corresponding employee data.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01-10 = Employee’s basic data
Pos. 11-30 = Employee’s business data
Pos. 31-60 = List of training courses
Office_EmployeeDataListBySearchText_v001 #
Returns a list of employees who match the search term.
Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Pos. 00 = Status
Pos. 01 … 999 = employee with ;-separated
Pos. xx.00 = status (only for Pos. 00)
Pos. xx.01 = personnel no.
Pos. xx.02 = surname first name (function)
Office_EmployeeImageByMaPnr_v001 #
Return of the screen for the employee. Parameter:
strTemplateType: Type of the desired document type, e.g. KA for sales order
Return (array):
Byte array with the image as a JPG.
Office_ToolTypeByBmCode_v001 #
Return of the equipment and equipment types based on the exact equipment number.
Parameter:
intBmCode: Equipment number
Return (array):
Pos. 00 = Status
Pos. 01-10 = Type data
Pos. 11-20 = Equipment data
Pos. 21-30 = Active allocation
Office_ToolTypeByBmFremdnr_v002 #
Return of the equipment and equipment types based on the inventory number (external number).
Parameter:
strFremdNr: Inventory number of the equipment (not BM code)
Return (array):
Pos. 00 = Status
Pos. 01-10 = Type data
Pos. 11-20 = Equipment data
Pos. 21-30 = Active allocation
Image handler for images #
Accessibility #
The image handlers can be accessed via the following URL:
[EMS-Web-URL]/start/OfficeAutomation.ashx
[EMS-Web-URL] corresponds to the URL of the customer system.
Functions #
The image handler is called with parameters. These are appended to the URL as follows: [EMS-Web-URL]/start/OfficeAutomation.asmx?mapnr=1234
The image is returned directly.
Valid parameters #
mapnr= [Personnel number] ficode= [Organizational unit code] firocode= [Reference code] s1pcode= [Image code of reports]