API

Common

Getting Started

User

Register New User
Login
Logout
Refresh Access Token
Get User Profile
Update Profile
Upload Avatar
Delete User
Reset Password
Reset Password by ID

User Token

List User Tokens
Add User Token
Update Default User Token
Delete User Token
Verify User Token
Reset Verification Code

User vAtom

Get vAtom
Get vAtoms by Ids
Get vAtom Inventory
Search vAtoms
Geo Discover Groups
Geo Discover vAtoms
Update vAtoms
Perform Action
Trash vAtom

User Activity

Get My Threads
Get My Thread Messages

Template

List Templates
Get Template
Create Template
Update Template
Delete Template

Template Variation

List Variations
Get Variation
Create Variation
Update Variation
Delete Variation

vAtom

Emit vAtom

Template Action

List Actions
Get Action
Register Action Handler
Register Action
Update Action
Delete Action

Template Face

List Faces
Register Face
Update Face
Delete Face

Asset

Upload Assets
Get Assets
Delete Assets

Get Template

GET
https://api.blockv.io/v1/templates/:template-name

Overview

Returns a single template.

Get Template Request

HTTP Headers

Content-Type: application/x-www-form-urlencoded App-Id: {app_id}

Sample Request

Body intentionally left blank.

Get Template Response

Return & Error Codes

ErrorTypeDescription
200httpEverything is OK
403httpNot Authorized
404httpTemplate not found

payload object

Payload object represents the User.

NameTypeDescription
namestringThe templates unique name.
publicboolFlag to indicate if the template is visible for other publishers.
metaobjectThe objects meta information (for example the creation timestamp).
propertiesobjectThe properties of the template object.

Sample Response

{
    "payload": {
        "name": "publisher_fqdn::v1::vAtom::Template",
        "public": false,
        "meta": {
            "created_by": "29828993-c2b4-4f6b-a289-f4bdd965d068",
            "when_created": "0001-01-01T00:00:00Z",
            "modified_by": "",
            "when_modified": "0001-01-01T00:00:00Z",
            "data_type": "vAtom::vAtomTemplateType",
            "in_sync": false,
            "when_synced": "",
            "is_syncing": false
        },
        "properties": {
            "publisher_fqdn": "publisher_fqdn",
            "template": {
                "vAtom::vAtomType": {
                    "parent_id": ".",
                    "publisher_fqdn": "publisher_fqdn",
                    "root_type": "vAtom::vAtomType",
                    "owner": "29828993-c2b4-4f6b-a289-f4bdd965d068",
                    "author": "29828993-c2b4-4f6b-a289-f4bdd965d068",
                    "template": "publisher_fqdn::v1::vAtom::Template",
                    "template_variation": "",
                    "notify_msg": "",
                    "title": "My template",
                    "description": "",
                    "disabled": false,
                    "category": "",
                    "tags": [],
                    "transferable": true,
                    "acquirable": false,
                    "tradeable": false,
                    "transferred_by": "",
                    "cloned_from": "",
                    "cloning_score": 0,
                    "in_contract": false,
                    "redeemable": false,
                    "in_contract_with": "",
                    "commerce": {
                        "pricing": {
                            "pricingType": "",
                            "value": {
                                "currency": "",
                                "price": "",
                                "valid_from": "",
                                "valid_through": "",
                                "vat_included": false
                            }
                        }
                    },
                    "states": [],
                    "resources": [],
                    "visibility": {
                        "type": "owner",
                        "value": "*"
                    },
                    "num_direct_clones": 0,
                    "geo_pos": {
                        "$reql_type$": "GEOMETRY",
                        "coordinates": [
                            0,
                            0
                        ],
                        "type": "Point"
                    },
                    "dropped": false
                },
                "private": {},
                "in_sync": false,
                "is_syncing": false,
                "version": ""
            },
            "cloneable": false,
            "unpublished": false
        }
    }
}
©2020 BLOCKv
Info