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:29]
n.bergantino
+++ cli:franke:factory_4_0_peschiera:sap-nis-agv-api [2022/11/14 17:11] (current)
n.bergantino
@@ Line 11: / Line 11: @@
 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
+  * Protocol HTTP with method POST
-  * Method POST: http://255.255.255.255:98999/iaf/tell/rueckmng (http://10.100.145.19:5599/iaf/tell/rueckmng on the test server)
+<code javascript>
-  * BODY as json text:// {"request":"pustock","p1":**{"entrypos":"XXXXXXX","rueck":"99999999"}**}// where
+http://255.255.255.255:98999/iaf/tell/rueckmng
-    * request: is a static string value containing "pustock"
+(http://10.100.145.19:5599/iaf/tell/rueckmng on the test server)
-    * p1: is the data object, where
+</code>
-      * entrypos: is the unique identifier of the machine entry position
+  * BODY as json text:
-      * rueck: is the related rueck
+<code javascript>
-  * The answer will be a JSON object as the same:
+{"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 an example using the **curl** command:
+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":{"entrypos":"XXXXXXX","rueck":"99999999"}}'
+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>