Documenting contracts/search output (#2940)

digital-asset · Sep 17, 2019 · 035bcf7 · 035bcf7
1 parent 11f1735
commit 035bcf7
Showing 1 changed file with 74 additions and 0 deletions.
diff --git a/ledger-service/http-json/README.md b/ledger-service/http-json/README.md
@@ -73,6 +73,80 @@ application/json body:
 ```
 {"%templates": [{"moduleName": "Iou", "entityName": "Iou"}]}
 ```
+empty output:
+```
+{
+    "status": 200,
+    "result": [
+        {
+            "offset": "130",
+            "activeContracts": []
+        }
+    ]
+}
+```
+output:
+```
+{
+    "status": 200,
+    "result": [
+        {
+            "offset": "",
+            "workflowId": "Alice Workflow",
+            "activeContracts": [
+                {
+                    "agreementText": "",
+                    "contractId": "#221:0",
+                    "templateId": {
+                        "packageId": "ac3a64908d9f6b4453329b3d7d8ddea44c83f4f5469de5f7ae19158c69bf8473",
+                        "moduleName": "Iou",
+                        "entityName": "Iou"
+                    },
+                    "witnessParties": [
+                        "Alice"
+                    ],
+                    "argument": {
+                        "observers": [],
+                        "issuer": "Alice",
+                        "amount": "999.99",
+                        "currency": "USD",
+                        "owner": "Alice"
+                    }
+                }
+            ]
+        },
+        {
+            "offset": "",
+            "workflowId": "Alice Workflow",
+            "activeContracts": [
+                {
+                    "agreementText": "",
+                    "contractId": "#224:0",
+                    "templateId": {
+                        "packageId": "ac3a64908d9f6b4453329b3d7d8ddea44c83f4f5469de5f7ae19158c69bf8473",
+                        "moduleName": "Iou",
+                        "entityName": "Iou"
+                    },
+                    "witnessParties": [
+                        "Alice"
+                    ],
+                    "argument": {
+                        "observers": [],
+                        "issuer": "Alice",
+                        "amount": "999.99",
+                        "currency": "USD",
+                        "owner": "Alice"
+                    }
+                }
+            ]
+        },
+        {
+            "offset": "227",
+            "activeContracts": []
+        }
+    ]
+}
+```
 
 ### POST http://localhost:7575/command/create
 application/json body: