Create election

It creates an election on the Vochain.

To use this endpoint, you will need to provide a signed transaction that has been encoded on the client side using the Vocdoni SDK. This transaction, referred to as txPayload, must include the IPFS CID-formatted hash of the metadata for the election.

The metadata for the election is optional and is provided as a base64-encoded JSON object. This object should follow the Entity metadata specification and includes information about the election, such as the list of candidates and the election's description. This metadata is stored within IPFS so that participants can access it.

The API endpoint will verify that the hash in the txPayload transaction matches the uploaded metadata. If these do not match, the API will return an error.

Example of election metadata object:

{
    "version": "1.0",
    "title": {"default": "Best pasta!", "en": "Best pasta!", "es": "La mejor pasta!"},
    "description": {"default": "Decide what is the best pasta", "en": "Decide what is the best pasta", "es": "Decide cual es la mejor pasta"},
    // Following fields are optional
    "media": {
    "header": "url to an image"
    "streamUri": "url to a stream resource"
    },
    "questions": [
    {
        "choices": [ 
        { 
            "title": {"default": "Macarroni", "en": "Macarroni", "es": "Macarrones"},
            "value": 0
        } 
        { 
            "title": {"default": "Spaghetti", "en": "Spaghetti", "es": "Espaguetis"},
            "value": 1
        } 
        ], 
        "description": {"default": "Choice one of theme", "en": "Choice one of theme", "es": "Elije una de ellas"},
        "title": {"default": "Macarroni or Spaghetti", "en": "Macarroni or Spaghetti", "es": "Macarrones o Espaguetis"}
    }
    ]
}

Read more about process creation

application/json

Request Body required

Uses txPayload protobuf signed transaction, and the metadata base64-encoded JSON object

• signature integer[]

  The signature for the tx bytes. signature is only required in those transactions that actually need signature. I.e zk-Snarks based transactions won't needed, however the transaction should use this message type in order to preserve consistency on the Vochain

• tx integer[]

  The bytes produced by Marshaling a Tx{} message

Responses

• 200

---

It return txId, electionId and the metadataURL for the newly created election. If metadataURL is returned empty, means that there is some issue with the storage provider.

application/json

• Schema
• Example (from schema)

---

Schema

• electionID string
• metadata integer[]
• metadataURL string
• txHash string
• txPayload integer[]

{
  "electionID": "string",
  "metadata": [
    0
  ],
  "metadataURL": "string",
  "txHash": "string",
  "txPayload": [
    0
  ]
}

Loading...