amatino-http-docs/units_list.json at master · amatino-code/amatino-http-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
{
    "title": "Global Unit List",
    "category": "ancillary",
    "docpath": "global_unit_list",
    "introduction": [
        "<a class=\"link\" href=\"/documentation/global_units\">Global Units</a> are units of account available by default in all <a class=\"link\" href=\"/documentation/entities\">Entities</a>.",
        "The Global Unit List contains all available Global Units."
    ],
    "object": {
        "name": "Global Unit List",
        "exposition": "Amatino will return Global Unit objects to you with the following structure",
        "form": {
            "root": "list",
            "components": [
                {
                    "key": {
                        "value": "\"global_unit_id\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON Number",
                        "mono": false
                    },
                    "description": {
                        "value": "The unique integer identifier of this Global Unit",
                        "mono": false
                    },
                    "example": {
                        "value": "5",
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"code\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON String",
                        "mono": false
                    },
                    "description": {
                        "value": "The unique shorthand identifier of this Global Unit",
                        "mono": false
                    },
                    "example": {
                        "value": "\"usd\"",
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"name\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON String",
                        "mono": false
                    },
                    "description": {
                        "value": "A friendly long form name",
                        "mono": false
                    },
                    "example": {
                        "value": "\"United States Dollar\"",
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"priority\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON Number",
                        "mono": false
                    },
                    "description": {
                        "value": "A sorting hint for GUI's displaying lists of Global Units",
                        "mono": false
                    },
                    "example": {
                        "value": 0,
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"description\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON String",
                        "mono": false
                    },
                    "description": {
                        "value": "A long-form description",
                        "mono": false
                    },
                    "example": {
                        "value": "\"United States Dollar\"",
                        "mono": true
                    }
                },
                {
                    "key": {
                        "value": "\"exponent\"",
                        "mono": true
                    },
                    "type": {
                        "value": "JSON Number",
                        "mono": false
                    },
                    "description": {
                        "value": "The number of digits after the decimal point required to describe the smallest fraction of this Global Unit",
                        "mono": false
                    },
                    "example": {
                        "value": 2,
                        "mono": true
                    }
                }
            ]
        }
    },
    "actions": [
        {
            "name": "Retrieve",
            "method": "GET",
            "path": "/units/list",
            "description": "Retrieve a list of all Global Units.",
            "return_root_type": "JSON Array",
            "required_json_data": null,
            "required_headers": [
                {
                    "key": "X-Signature",
                    "content": "Your <a class=\"link\" href=\"/documentation/sessions\">Session</a> signature",
                    "example": "\"yxATCPRKAAXHNiPctNQPHEGGVJF\"..."
                },
                {
                    "key": "X-Session-ID",
                    "content": "An an integer <a class=\"link\" href=\"/documentation/sessions\">Session</a> ID",
                    "example": 7449059267091272858
                }
            ],
            "required_url_parameters": null,
            "returns": {
                "root": "list",
                "components": {
                    "object": "global unit"
                }
            }
        }
    ]
}