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

From Open Transactions
Jump to navigation Jump to search
m
m (Schema: fix validation errors)
Line 14: Line 14:
 
         "type": "object",
 
         "type": "object",
 
         "properties": {
 
         "properties": {
             "outBailmentID" {
+
             "outBailmentID": {
                 "type": string,
+
                 "type": "string",
 
                 "description": "the identifier of the originating nym's outBailment message"
 
                 "description": "the identifier of the originating nym's outBailment message"
 
             },
 
             },
             "address" {
+
             "address": {
                 "type": string,
+
                 "type": "string",
                 "description": "the destination address for the outBailment",
+
                 "description": "the destination address for the outBailment"
             }
+
             },
             "amount" {
+
             "amount": {
                 "type": number,
+
                 "type": "number",
 
                 "description": "the monetary value of the outBailment, in fundamental units (satoshis for Bitcoin)",
 
                 "description": "the monetary value of the outBailment, in fundamental units (satoshis for Bitcoin)",
 
                 "minimum": 0,
 
                 "minimum": 0,
Line 30: Line 30:
 
         },
 
         },
 
         "required": [ "outBailmentID","address","amount" ]
 
         "required": [ "outBailmentID","address","amount" ]
     }
+
     },
 
     "minItems": 1,
 
     "minItems": 1,
 
     "uniqueItems": true
 
     "uniqueItems": true

Revision as of 08:42, 15 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": {
                "type": "string",
                "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
}