Withdrawal status - Revision history

Justusranvier: /* Status Codes */ department of redundancy department

2014-10-21T14:46:04Z

‎Status Codes: department of redundancy department

Justusranvier: /* Status Codes */

2014-10-21T14:44:18Z

‎Status Codes

Justusranvier: hotlink to github

2014-09-26T15:27:14Z

hotlink to github

Justusranvier: /* Schema */ fix validation errors

2014-09-15T08:45:14Z

‎Schema: fix validation errors

Justusranvier at 22:21, 9 September 2014

2014-09-09T22:21:32Z

Justusranvier: /* Schema */

2014-09-09T15:42:47Z

‎Schema

Justusranvier: Add status codes

2014-09-09T15:41:37Z

Add status codes

Justusranvier: /* Schema */

2014-09-09T15:29:46Z

‎Schema

Justusranvier: Initial page creation

2014-09-09T15:25:26Z

Initial page creation

New page

The [[startwithdrawal]] API call returns a list of accounting and status information corresponding to the transactions which it has created.

The list is formated as a JSON object.

==Schema==

<code><pre>
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Withdrawal status list",
"description": "Accounting and status information corresponding to a voting pool outBailment consensus round",
"type": "object",
"properties": {
"nextinputstart" {
"description": "The inputstart value to be used in the next consensus round as an address identifier",
"$ref": "TBD"
},
"nextchangestart" {
"description": "The changestart value to be used in the next consensus round as an address identifier",
"$ref": "TBD"
},
"fees" {
"type": "number",
"description": "Total transaction fees incurred by the transactions in this round",
"minimum": 0,
"exclusiveMinimum": false
},
"outputs" {
"type": "array",
"items": {
"type": "object",
"properties": {
"outBailmentID" {
"type": "string",
"description": "the identifier of the originating nym's outBailment message"
},
"status" {
"type": "string",
"description": "Status code for the outBailment"
},
"transactions" {
"type": "array",
"items": {
"type": "object",
"properties": {
"ntxid" {
"type": "string",
"description": "Normalized transaction id associated with the withdrawal"
}
"index" {
"type": "number",
"description": "Output index in transaction which satisfies this outBailmentID",
"minimum": 0,
"exclusiveMinimum": false
}
"amount" {
"type": "number",
"description": "Monetary value of the output given by the (ntxid,index), in fundamental units",
"minimum": 0,
"exclusiveMinimum": true
}
}
}
"minItems": 0,
"uniqueItems": true
},
"required": [ "outBailmentID","status" ]
}
}
"minItems": 1,
"uniqueItems": true
},
"required": [ "nextinputstart","nextchangestart","fees","outputs"]
}
}
</pre></code>

@@ Line 13: / Line 13: @@
 ==Status Codes==
-The following status codes for an <code>outputs</code> object are as follows:
+The status codes for an <code>outputs</code> object are as follows:
 ; success

@@ Line 13: / Line 13: @@
 ==Status Codes==
-The following status codes for an <code>outputs</code object are as follows:
+The following status codes for an <code>outputs</code> object are as follows:
 ; success

← Older revision		Revision as of 22:21, 9 September 2014
Line 94:		Line 94:
	; invalid		; invalid
	: The output address supplied by the outBailment is not valid.		: The output address supplied by the outBailment is not valid.
		+
		+
		+	[[Category:Voting Pool Technical Specifications]]

← Older revision		Revision as of 15:41, 9 September 2014
Line 81:		Line 81:
	}		}
	</pre></code>		</pre></code>
		+
		+	==Status Codes==
		+
		+	The following status codes for an <code>outputs</code object are as follows:
		+
		+	; success
		+	: The amount requested by the originating nym's outBailment message was completely satisfied using a single transaction
		+	; split
		+	: The amount requested by the originating nym's outBailment message was completely satisfied using two or more transaction
		+	; partial-<n>
		+	: The amount requested by the originating nym's outBailment message could not be completely satisfied due to a lack of hot inputs. Series up to <n> must be thawed to completely fulfil this outBailment. The transactions array for this entry may contain zero or more transactions.
		+	; invalid
		+	: The output address supplied by the outBailment is not valid.

@@ Line 5: / Line 5: @@
 ==Schema==
-<code><pre>
+<include src="https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/schema/withdrawalstatus-01.json" />
-−
-    "$schema": "http://json-schema.org/draft-04/schema#",
+==Example==
-    "title": "Withdrawal status list",
-    "description": "Accounting and status information corresponding to a voting pool outBailment consensus round",
+<include src="https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/data/withdrawalstatus-01.json" />
 ==Status Codes==

@@ Line 12: / Line 12: @@
      "type": "object",
      "properties": {
-         "roundID" {
+         "roundID": {
              "type": "number",
              "description": "A positive integer representing the consensus round for which the withdrawal is associated",
@@ Line 18: / Line 18: @@
              "exclusiveMinimum": false
          },
-         "nextinputstart" {
+         "nextinputstart": {
              "description": "The inputstart value to be used in the next consensus round as an address identifier",
-             "$ref": "TBD"
+             "$ref": "https://raw.githubusercontent.com/Open-Transactions/rfc/master/json/schema/addressid-01.json"
          },
-         "nextchangestart" {
+         "nextchangestart": {
              "description": "The changestart value to be used in the next consensus round as an address identifier",
-             "$ref": "TBD"
+             "$ref": "https://raw.githubusercontent.com/Open-Transactions/rfc/master/json/schema/addressid-01.json"
          },
-         "fees" {
+         "fees": {
              "type": "number",
              "description": "Total transaction fees incurred by the transactions in this round",
@@ Line 32: / Line 32: @@
              "exclusiveMinimum": false
          },
-         "outputs" {
+         "outputs": {
              "type": "array",
              "items": {
                  "type": "object",
                  "properties": {
-                     "outBailmentID" {
+                     "outBailmentID": {
                          "type": "string",
                          "description": "the identifier of the originating nym's outBailment message"
                      },
-                     "status" {
+                     "status": {
                          "type": "string",
                          "description": "Status code for the outBailment"
                      },
-                     "transactions" {
+                     "transactions": {
                          "type": "array",
                          "items": {
                              "type": "object",
                              "properties": {
-                                 "ntxid" {
+                                 "ntxid": {
                                      "type": "string",
                                      "description": "Normalized transaction id associated with the withdrawal"
+                                 },
-                                 "index" {
+                                 "index": {
                                      "type": "number",
                                      "description": "Output index in transaction which satisfies this outBailmentID",
                                      "minimum": 0,
                                      "exclusiveMinimum": false
+                                 },
-                                 "amount" {
+                                 "amount": {
                                      "type": "number",
                                      "description": "Monetary value of the output denoted by (ntxid,index), in fundamental units",
@@ Line 67: / Line 67: @@
+                                 }
+                             }
+                         },
                         "minItems": 0,
                         "uniqueItems": true
@@ Line 73: / Line 73: @@
                      "required": [ "outBailmentID","status" ]
+                 }
+             },
              "minItems": 1,
              "uniqueItems": true
@@ Line 79: / Line 79: @@
          "required": [ "nextinputstart","nextchangestart","fees","outputs"]
+     }
+}}
 </pre></code>