Format and content - WS-Anfragedaten (EN)
- Jennifer Pusch
- vTranslator
- Rainer Biedermann
General
This documentation describes the format and content of requests sent by the customer via a shop form
In WEBSALE shops INQUIRY4 is used as a universal form program, which can be used to operate any request form in a simple way. INQUIRY4 processes, checks and sends the input via e-mail to a form recipient. In addition, the requests are provided in an XML format for ERP systems.
A detailed description of INQUIRY4 can be found in the separate documentation:
Transfer of the inquiries
The request data described below is fetched from the shop via SOAP. The transfer is described in the separate documentation "SOAP-from-Shop (EN)":
If SOAP cannot be implemented on your system, you can alternatively export request data using WEBSALE-OrderManager (WSOM). See separate documentation "WSOM-from-Shop (EN)":
WSOM-from-Shop (previous version) (EN)
Description of sections and parameters
Input fields
Any input fields can be queried for each form. The designer determines
which input fields are queried,
which input fields are required and
which input fields are optional.
For each input field 3 parameters are output in a section <Item>....<Item>.
The parameters are:
Name: technical ID (language independent) of the input field
Descr: language dependent name of the input field
Value: value of the input field
Example:
<Item>
<Name>LastName</Name>
<Descr>Last name</Descr>
<Value>Müller</Value>
</Item>Multi-line values with the maximum length of 4000 characters can also be passed.
<Item>
<Name>Remark</Name>
<Descr>Wishes and comments</Descr>
<Value>
... Line 1
... Line 2
... Line 3
</Value>
</Item>A designer can determine for each input field the maximum input length for which the ERP system can process the data.
It is also possible to set whether empty input fields are passed or omitted in the XML data.
Section: Header (General Information)
This section is always present.
Parameter | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
FormatID | X | 32 | Identifier of the data format |
Generator | X | 32 | Identifier of the generating program |
Copyright(c) | X | Â | Copyright of WEBSALE for this data format |
Remark | X | Â | Unchanged value |
Referer | Â | 128 | Call reference where the request was called from |
Subreferer | Â | 128 | Sub call reference where the request was called from |
Example:
<Header>
<FormatID>INQUIRY-4</FormatID>
<Generator>INQUIRY-4</Generator>
<Copyrightc>WEBSALE AG, www.websale.de</Copyrightc>
<Remark>This File-Format is protected by international copyright laws.</Remark>
<Remark>Use only with expressed written allowance of WEBSALE AG.</Remark>
<Referer></Referer>
<SubReferer></SubReferer>
</Header>Section: ID (header data of a request)
This section is always present.
Parameter | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
MallID | X | Â | The MallID of a shop. All production shops are located in the mall "websale". Test shops are located in the "test" mall and partner shops are located in the "partner" mall. |
ShopID | X | Â | A unique ID of your shop. |
INI | X | Â | Name of the configuration file |
InquiryNumber | X | 32 | Unique inquiry number. Can be used for unique referencing. Analogous to an order number. |
Subject | X | Â | Name of the request |
Date | X | 8 | Date of the request in the format DD.MM.YYYY e.g. 29.01.2015 |
Time | X | 8 | Time of the order in the format HH:MM e.g. 19:02 |
IPAdress | X | 15 | IP address of the user |
ExtIPAddress | Â | 15 | IP address of the shop, if Inquiry was integrated into the shop via "ExternInclude |
ExtIPAddressTime | Â | 21 | Timestamp of the external IP address in the format YYYY-MM-DD / HH:MM:SS e.g. 2015-02-04 / 10:42:12 |
ExtSessionID | Â | 64 | SessionID of the shop, if Inquiry was integrated via "ExternInclude" into the shop |
Example:
Section: CustomerAddress (Billing Address)
This section is present when data of the billing address is requested.
The following parameters are passed for each input field:
Parameter | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
Name | x | Â | Technical ID of the input field |
Descr | x | Â | Language dependent name of the input field |
Value | Â | 4000 | Value of the input field |
Example:
Section: DeliveryAddress
This section is present when delivery address data is requested.
The following parameters are passed for each input field:
Parameter | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
Name | x | Â | Technical ID of the input field |
Descr | x | Â | Language dependent name of the input field |
Value | Â | 4000 | Value of the input field |
Example:
Section: Inquiry
This section is present if at least one inquiry has been entered.
The following parameters are passed for each input field:
Parameter | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
Name | x | Â | Technical ID of the input field |
Descr | x | Â | Language dependent name of the input field |
Value | Â | 4000 | Value of the input field |
Example:
Section: InquiryUpload (file upload)
For an inquiry the user can upload one or more files to the shop server. The ERP system can access the upload files via SFTP. A unique UploadID is generated for each upload, which corresponds to a subdirectory of the SFTP account.
Example:
3 files are uploaded:
File1.jpg
File2.jpg
File3.jpg
Let the UploadID be "11AABBCC".
Directory structure:
SFTP root
11AABBCC (Upload-ID)
File1.jpg
File2.jpg
File3.jpg
Parameters | Required field | Max. Length <>255 characters | Comment |
|---|---|---|---|
UploadID | x | 64 | UploadID |
FileName | x | Â | Name of the upload file |
Example: