Difference between revisions of "Outputs (Voting Pool Wallet API)"

From Open Transactions
Jump to navigation Jump to search
(outBailmentID is an object, not a string)
(hotlink to GitHub)
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
==Schema==
 
==Schema==
  
<code><pre>
+
<include src="https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/schema/outputlist-01.json" />
{
 
    "$schema": "http://json-schema.org/draft-04/schema#",
 
    "title": "Output list",
 
    "description": "A list of outputs to be created from a round of voting pool outBailment consensus",
 
    "type": "array",
 
    "items": {
 
        "type": "object",
 
        "properties": {
 
            "outBailmentID": {
 
                "$ref": "https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/schema/outbailmentid-01.json",
 
                "description": "the identifier of the originating nym's outBailment message"
 
            },
 
            "address": {
 
                "type": "string",
 
                "description": "the destination address for the outBailment"
 
            },
 
            "amount": {
 
                "type": "number",
 
                "description": "the monetary value of the outBailment, in fundamental units (satoshis for Bitcoin)",
 
                "minimum": 0,
 
                "exclusiveMinimum": true
 
            }
 
        },
 
        "required": [ "outBailmentID","address","amount" ]
 
    },
 
    "minItems": 1,
 
    "uniqueItems": true
 
}
 
</pre></code>
 
  
==Canonical Location==
+
==Example==
  
https://github.com/Open-Transactions/rfc/blob/draft/json/schema/outputlist-01.json
+
<include src="https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/data/outputlist-01.json" />
  
 
[[Category:Voting Pool Technical Specifications]]
 
[[Category:Voting Pool Technical Specifications]]

Latest revision as of 15:24, 26 September 2014

The startwithdrawal API call accepts a list of outputs to be created since voting pools process withdrawals in batches.

The list is formated as a JSON object.

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Output list",
    "description": "A list of outputs to be created from a round of voting pool outBailment consensus",
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "outBailmentID": {
                "$ref": "https://raw.githubusercontent.com/Open-Transactions/rfc/draft/json/schema/outbailmentid-01.json",
                "description": "the identifier of the originating nym's outBailment message"
            },
            "address": {
                "type": "string",
                "description": "the destination address for the outBailment"
            },
            "amount": {
                "type": "number",
                "description": "the monetary value of the outBailment, in fundamental units (satoshis for Bitcoin)",
                "minimum": 0,
                "exclusiveMinimum": true
            }
        },
        "required": [ "outBailmentID","address","amount" ]
    },
    "minItems": 1,
    "uniqueItems": true
}

Example

[
    {
        "outBailmentID": { "pool": "IFOC:a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d:0:57043", "server": "r1fUoHwJOWCuK3WBAAySjmKYqsG6G2TYIxdqY6YNuuG", "transaction": 42},
        "address": "12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX",
        "amount": 50
    },
    {
        "outBailmentID": { "pool": "IFOC:a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d:0:57043", "server": "r1fUoHwJOWCuK3WBAAySjmKYqsG6G2TYIxdqY6YNuuG", "transaction": 9001},
        "address": "1NEU779yvLaFk39k4Q3QdLjwpWTdWCbzqL",
        "amount": 25
    }
]