Differences

This shows you the differences between two versions of the page.

--- cli:franke:factory_4_0_peschiera:sap-nis-agv-api [2022/10/10 16:09]
n.bergantino
+++ cli:franke:factory_4_0_peschiera:sap-nis-agv-api [2022/11/14 17:11] (current)
n.bergantino
@@ Line 8: / Line 8: @@
   - **rueck**: is the rueck related to the product unit stocket in the specific machine entry position
 After that, NIS will download all the required information using the existing web service protocol. The following use case diagram describes the scenario. \\ \\
-{{ :cli:franke:factory_4_0_peschiera:franke-agv-sap.png?700 |}}
+{{ :cli:franke:factory_4_0_peschiera:franke-agv-sap.png?700 |}} \\ \\
+NIS will provide a REST server API with the following properties:
+  * IP:PORT => 255.255.255.255:9999 (to be defined, 10.100.145.19:5599 on the test server)
+  * Protocol HTTP with method POST
+<code javascript>
+http://255.255.255.255:98999/iaf/tell/rueckmng
+(http://10.100.145.19:5599/iaf/tell/rueckmng on the test server)
+</code>
+  * BODY as json text:
+<code javascript>
+{"request":"pustock","p1":{"werks":"xxx","entrypos":"XXXXXXX","rueck":"99999999","qty":"100"}}
+</code>
+In the following there is the description of the json fields
+  * request: is a static string value containing "pustock"
+  * p1: is the data object, where
+    * entrypos: is the unique identifier of the machine entry position
+    * rueck: is the related rueck
+    * werks: plant code in SAP
+    * qty: number of items in the pallet (pallet quantity)
+The Rest server will answer through the following json object:
+    * {"rv":"1"} if the operation is done with success
+    * {"rv":"0"} if the operation is done without success
+In the following there is an example using the **curl** command on the test server:
+<code bash>
+curl --request POST 'http://10.100.145.19:5599/iaf/tell/rueckmng' --header 'Content-Type: application/json' --data-raw '{"request":"pustock","p1":{"werks":"xxx","entrypos":"XXXXXXX","rueck":"99999999"}}'
+</code>