Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 5.1
edited by Admin
on 2017/04/05 10:32
Change comment: There is no comment for this version
To version 3.1
edited by sonish
on 2017/04/03 16:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ONEcount API Documentation
1 +sonish-APIDocument-230317-1008-18
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.sonish
Content
... ... @@ -1,8 +1,56 @@
1 +(% class="western" align="center" %)
2 +
3 +
4 +(% class="western" align="center" %)
5 +
6 +
7 +(% class="western" align="center" %)
8 +
9 +
10 +(% class="western" align="center" %)
11 +
12 +
13 +(% class="western" align="center" %)
14 +
15 +
16 +(% class="western" align="center" %)
17 +
18 +
19 +(% class="western" align="center" %)
20 +ONEcount REST API Developer's Guide
21 +
22 +(% class="western" align="center" %)
23 +Version 2.1
24 +
25 +(% class="western" align="center" %)
26 +
27 +
28 +(% class="western" align="center" %)
29 +
30 +
31 +(% class="western" align="center" %)
32 +
33 +
34 +(% class="western" align="center" %)
35 +
36 +
37 +(% class="western" align="center" %)
38 +
39 +
40 +(% class="western" align="center" %)
41 +
42 +
43 +(% class="western" align="center" %)
44 +
45 +
46 +(% class="western" align="center" %)
47 +
48 +
1 1  (% class="western" %)
2 2  **Introduction**
3 3  
4 4  (% class="western" %)
5 -ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. his API can be used to lookup, create and updated different ONEcount resources which are listed below.
53 +ONEcount REST API provides different functionality to accomplish many integration related tasks. This API can be used to lookup, create and updated different ONEcount resources which are listed below.
6 6  
7 7  (% class="western" %)
8 8  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
... ... @@ -10,11 +10,14 @@
10 10  1. (((
11 11  (% class="western" %)
12 12  **GET** - Used for lookup of resources
13 -)))
61 +
62 +* (((
14 14  1. (((
15 15  (% class="western" %)
16 16  **PUT** - Used to update a resource
17 17  )))
67 +)))
68 +)))
18 18  1. (((
19 19  (% class="western" %)
20 20  **POST** - Used to create a new resource
... ... @@ -21,7 +21,7 @@
21 21  )))
22 22  
23 23  (% class="western" %)
24 -Specifically, the ONEcount API provides following functionalities:
75 +ONEcount API provides following functionalities:
25 25  
26 26  1. (((
27 27  (% class="western" %)
... ... @@ -154,11 +154,17 @@
154 154  (% class="western" %)
155 155  ListSourceCodes
156 156  )))
157 -1. **Attach**
158 158  
159 -*
160 -** (((
161 161  (% class="western" %)
210 +
211 +
212 +1. (((
213 +(% class="western" %)
214 +**Attach**
215 +)))
216 +
217 +* (((
218 +(% class="western" %)
162 162  Attach resource to product
163 163  )))
164 164  
... ... @@ -166,19 +166,27 @@
166 166  
167 167  
168 168  (% class="western" %)
169 -**Accessing API**
226 +
170 170  
171 171  (% class="western" %)
172 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
229 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
173 173  
174 174  (% class="western" %)
175 -**Appkey**: THIS WILL BE PROVIDED TO YOU
232 +**Appkey**: THIS WILL BE PROVIDED
176 176  
177 177  (% class="western" %)
178 -**
179 -**
235 +
180 180  
181 181  (% class="western" %)
238 +**Function**
239 +
240 +(% class="western" %)
241 +The ONEcount REST API will be used to create, update & lookup users, transactions and questions e.t.c. in ONEcount hosted install of the client.
242 +
243 +(% class="western" %)
244 +**Accessing API**
245 +
246 +(% class="western" %)
182 182  Your HTTP requests to a REST API resource should contain the following information:
183 183  
184 184  * (((
... ... @@ -199,12 +199,9 @@
199 199  )))
200 200  
201 201  (% class="western" %)
202 -
267 +**Request**
203 203  
204 204  (% class="western" %)
205 -**API Usage**
206 -
207 -(% class="western" %)
208 208  The request data in POST (for create and update) will consist of request parameters required by each method in JSON format. Value of resource will determine which resource is being requested and the access method will determine whether you are trying to create, update or lookup that resource.
209 209  
210 210  (% class="western" %)
... ... @@ -333,18 +333,6 @@
333 333  
334 334  
335 335  (% class="western" %)
336 -**
337 -**
338 -
339 -(% class="western" %)
340 -**
341 -**
342 -
343 -(% class="western" %)
344 -**
345 -**
346 -
347 -(% class="western" %)
348 348  **Resources**
349 349  
350 350  (% class="western" %)
... ... @@ -391,7 +391,6 @@
391 391  (% class="western" %)
392 392  There can be 6 types of questions:
393 393  
394 -(% class="wrapped" %)
395 395  |(((
396 396  (% class="western" align="center" %)
397 397  **Type**
... ... @@ -442,7 +442,6 @@
442 442  Checkbox type question. This is a multiple choice, multi response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the checkbox question.
443 443  )))
444 444  
445 -(% class="wrapped" %)
446 446  |(((
447 447  (% class="western" %)
448 448  **Method**
... ... @@ -515,7 +515,6 @@
515 515  (% class="western" %)
516 516  **GET method can be used to lookup questions.**
517 517  
518 -(% class="wrapped" %)
519 519  |(((
520 520  (% class="western" %)
521 521  **Request**
... ... @@ -546,7 +546,6 @@
546 546  Type: Look up the question type.
547 547  )))
548 548  
549 -(% class="wrapped" %)
550 550  |(((
551 551  (% class="western" %)
552 552  **Response**
... ... @@ -573,7 +573,6 @@
573 573  (% class="western" %)
574 574  **POST method should be used to create questions. The data that is sent should be in JSON format and of type questions as described in references section. Questions object will only need a choices block if the question is a multiple choice question (type=4 or 5 or 6).**
575 575  
576 -(% class="wrapped" %)
577 577  |(((
578 578  (% class="western" %)
579 579  **Request**
... ... @@ -595,7 +595,6 @@
595 595  This defines the question contents and possible responses.
596 596  )))
597 597  
598 -(% class="wrapped" %)
599 599  |(((
600 600  (% class="western" %)
601 601  **Response**
... ... @@ -622,7 +622,6 @@
622 622  (% class="western" %)
623 623  PUT method should be used to update question.
624 624  
625 -(% class="wrapped" %)
626 626  |(((
627 627  (% class="western" %)
628 628  **Request**
... ... @@ -644,7 +644,6 @@
644 644  This defines the question contents and responses.
645 645  )))
646 646  
647 -(% class="wrapped" %)
648 648  |(((
649 649  (% class="western" %)
650 650  **Response**
... ... @@ -750,7 +750,6 @@
750 750  (% class="western" %)
751 751  
752 752  
753 -(% class="wrapped" %)
754 754  |(((
755 755  (% class="western" %)
756 756  **Method**
... ... @@ -870,7 +870,6 @@
870 870  (% class="western" %)
871 871  **GET method should be used to lookup users.**
872 872  
873 -(% class="wrapped" %)
874 874  |(((
875 875  (% class="western" %)
876 876  **Request**
... ... @@ -902,7 +902,6 @@
902 902  
903 903  
904 904  
905 -(% class="wrapped" %)
906 906  |(((
907 907  (% class="western" %)
908 908  **Response**
... ... @@ -929,7 +929,6 @@
929 929  (% class="western" %)
930 930  **POST method should be used to create users.**
931 931  
932 -(% class="wrapped" %)
933 933  |(((
934 934  (% class="western" %)
935 935  **Request**
... ... @@ -981,7 +981,6 @@
981 981  CSV of ONEcount QuestionId's requested back in Users object in response.
982 982  )))
983 983  
984 -(% class="wrapped" %)
985 985  |(((
986 986  (% class="western" %)
987 987  **Response**
... ... @@ -1008,7 +1008,6 @@
1008 1008  (% class="western" %)
1009 1009  **PUT method should be used to update users.**
1010 1010  
1011 -(% class="wrapped" %)
1012 1012  |(((
1013 1013  (% class="western" %)
1014 1014  **Request**
... ... @@ -1050,7 +1050,6 @@
1050 1050  RequestDate to use for the demo update. If not provided current date will be used.
1051 1051  )))
1052 1052  
1053 -(% class="wrapped" %)
1054 1054  |(((
1055 1055  (% class="western" %)
1056 1056  **Response**
... ... @@ -1089,7 +1089,6 @@
1089 1089  (% class="western" %)
1090 1090  This resource is for manipulating products resource. A product can be created, updated or searched.
1091 1091  
1092 -(% class="wrapped" %)
1093 1093  |(((
1094 1094  (% class="western" %)
1095 1095  **Method**
... ... @@ -1175,7 +1175,6 @@
1175 1175  (% class="western" %)
1176 1176  **GET method should be used to lookup products.**
1177 1177  
1178 -(% class="wrapped" %)
1179 1179  |(((
1180 1180  (% class="western" %)
1181 1181  **Request**
... ... @@ -1203,7 +1203,6 @@
1203 1203  Name: Name of the Product for lookup (String)
1204 1204  )))
1205 1205  
1206 -(% class="wrapped" %)
1207 1207  |(((
1208 1208  (% class="western" %)
1209 1209  **Response**
... ... @@ -1230,7 +1230,6 @@
1230 1230  (% class="western" %)
1231 1231  **POST method should be used to create products.**
1232 1232  
1233 -(% class="wrapped" %)
1234 1234  |(((
1235 1235  (% class="western" %)
1236 1236  **Request**
... ... @@ -1258,7 +1258,6 @@
1258 1258  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1259 1259  )))
1260 1260  
1261 -(% class="wrapped" %)
1262 1262  |(((
1263 1263  (% class="western" %)
1264 1264  **Response**
... ... @@ -1285,7 +1285,6 @@
1285 1285  (% class="western" %)
1286 1286  PUT method should be used to update an individual product given the product info.
1287 1287  
1288 -(% class="wrapped" %)
1289 1289  |(((
1290 1290  (% class="western" %)
1291 1291  **Request**
... ... @@ -1316,7 +1316,6 @@
1316 1316  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1317 1317  )))
1318 1318  
1319 -(% class="wrapped" %)
1320 1320  |(((
1321 1321  (% class="western" %)
1322 1322  **Response**
... ... @@ -1346,7 +1346,6 @@
1346 1346  (% class="western" %)
1347 1347  This resource is for manipulating terms resource. A term can be created, updated or searched.
1348 1348  
1349 -(% class="wrapped" %)
1350 1350  |(((
1351 1351  (% class="western" %)
1352 1352  **Method**
... ... @@ -1403,7 +1403,6 @@
1403 1403  (% class="western" %)
1404 1404  **GET method should be used to lookup products.**
1405 1405  
1406 -(% class="wrapped" %)
1407 1407  |(((
1408 1408  (% class="western" %)
1409 1409  **Request**
... ... @@ -1431,7 +1431,6 @@
1431 1431  Name: Name of the term for lookup (String)
1432 1432  )))
1433 1433  
1434 -(% class="wrapped" %)
1435 1435  |(((
1436 1436  (% class="western" %)
1437 1437  **Response**
... ... @@ -1458,7 +1458,6 @@
1458 1458  (% class="western" %)
1459 1459  **POST method should be used to create products.**
1460 1460  
1461 -(% class="wrapped" %)
1462 1462  |(((
1463 1463  (% class="western" %)
1464 1464  **Request**
... ... @@ -1489,7 +1489,6 @@
1489 1489  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1490 1490  )))
1491 1491  
1492 -(% class="wrapped" %)
1493 1493  |(((
1494 1494  (% class="western" %)
1495 1495  **Response**
... ... @@ -1516,7 +1516,6 @@
1516 1516  (% class="western" %)
1517 1517  PUT method should be used to update an individual term given the term info.
1518 1518  
1519 -(% class="wrapped" %)
1520 1520  |(((
1521 1521  (% class="western" %)
1522 1522  **Request**
... ... @@ -1547,7 +1547,6 @@
1547 1547  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1548 1548  )))
1549 1549  
1550 -(% class="wrapped" %)
1551 1551  |(((
1552 1552  (% class="western" %)
1553 1553  **Response**
... ... @@ -1577,7 +1577,6 @@
1577 1577  (% class="western" %)
1578 1578  This resource is for manipulating resources resource. A resource can be created, updated or searched.
1579 1579  
1580 -(% class="wrapped" %)
1581 1581  |(((
1582 1582  (% class="western" %)
1583 1583  **Method**
... ... @@ -1634,7 +1634,6 @@
1634 1634  (% class="western" %)
1635 1635  **GET method should be used to lookup products.**
1636 1636  
1637 -(% class="wrapped" %)
1638 1638  |(((
1639 1639  (% class="western" %)
1640 1640  **Request**
... ... @@ -1662,7 +1662,6 @@
1662 1662  Name: Name of the resource for lookup (String)
1663 1663  )))
1664 1664  
1665 -(% class="wrapped" %)
1666 1666  |(((
1667 1667  (% class="western" %)
1668 1668  **Response**
... ... @@ -1689,7 +1689,6 @@
1689 1689  (% class="western" %)
1690 1690  **POST method should be used to create products.**
1691 1691  
1692 -(% class="wrapped" %)
1693 1693  |(((
1694 1694  (% class="western" %)
1695 1695  **Request**
... ... @@ -1720,7 +1720,6 @@
1720 1720  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1721 1721  )))
1722 1722  
1723 -(% class="wrapped" %)
1724 1724  |(((
1725 1725  (% class="western" %)
1726 1726  **Response**
... ... @@ -1747,7 +1747,6 @@
1747 1747  (% class="western" %)
1748 1748  PUT method should be used to update an individual resource given the resource info.
1749 1749  
1750 -(% class="wrapped" %)
1751 1751  |(((
1752 1752  (% class="western" %)
1753 1753  **Request**
... ... @@ -1778,7 +1778,6 @@
1778 1778  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1779 1779  )))
1780 1780  
1781 -(% class="wrapped" %)
1782 1782  |(((
1783 1783  (% class="western" %)
1784 1784  **Response**
... ... @@ -1814,7 +1814,6 @@
1814 1814  (% class="western" %)
1815 1815  This resource is for manipulating sources resource. A source can be created, updated or searched.
1816 1816  
1817 -(% class="wrapped" %)
1818 1818  |(((
1819 1819  (% class="western" %)
1820 1820  **Method**
... ... @@ -1871,7 +1871,6 @@
1871 1871  (% class="western" %)
1872 1872  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
1873 1873  
1874 -(% class="wrapped" %)
1875 1875  |(((
1876 1876  (% class="western" %)
1877 1877  **Request**
... ... @@ -1899,7 +1899,6 @@
1899 1899  Source: Source value (String)
1900 1900  )))
1901 1901  
1902 -(% class="wrapped" %)
1903 1903  |(((
1904 1904  (% class="western" %)
1905 1905  **Response**
... ... @@ -1929,7 +1929,6 @@
1929 1929  (% class="western" %)
1930 1930  POST method should be used to create an individual source given the source parameters.
1931 1931  
1932 -(% class="wrapped" %)
1933 1933  |(((
1934 1934  (% class="western" %)
1935 1935  **Request**
... ... @@ -1951,7 +1951,6 @@
1951 1951  Defines the contents that makes up the source. Id parameters should not be set.
1952 1952  )))
1953 1953  
1954 -(% class="wrapped" %)
1955 1955  |(((
1956 1956  (% class="western" %)
1957 1957  **Response**
... ... @@ -1978,7 +1978,6 @@
1978 1978  (% class="western" %)
1979 1979  **PUT method can be used to update an individual source given the id.**
1980 1980  
1981 -(% class="wrapped" %)
1982 1982  |(((
1983 1983  (% class="western" %)
1984 1984  **Request**
... ... @@ -2000,7 +2000,6 @@
2000 2000  Defines the contents that makes up the source. The id parameter needs to be set which will identify the id of the source to be updated.
2001 2001  )))
2002 2002  
2003 -(% class="wrapped" %)
2004 2004  |(((
2005 2005  (% class="western" %)
2006 2006  **Response**
... ... @@ -2033,7 +2033,6 @@
2033 2033  (% class="western" %)
2034 2034  This resource is for manipulating transactions resource. A transaction can be created or searched.
2035 2035  
2036 -(% class="wrapped" %)
2037 2037  |(((
2038 2038  (% class="western" %)
2039 2039  **Method**
... ... @@ -2083,7 +2083,6 @@
2083 2083  (% class="western" %)
2084 2084  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2085 2085  
2086 -(% class="wrapped" %)
2087 2087  |(((
2088 2088  (% class="western" %)
2089 2089  **Request**
... ... @@ -2121,7 +2121,6 @@
2121 2121  
2122 2122  
2123 2123  
2124 -(% class="wrapped" %)
2125 2125  |(((
2126 2126  (% class="western" %)
2127 2127  **Response**
... ... @@ -2148,7 +2148,6 @@
2148 2148  (% class="western" %)
2149 2149  POST method can be used to create user transaction. Transaction info needs to be sent as request and a TransactionId will be returned when the transaction is created.
2150 2150  
2151 -(% class="wrapped" %)
2152 2152  |(((
2153 2153  (% class="western" %)
2154 2154  **Request**
... ... @@ -2170,7 +2170,6 @@
2170 2170  Contains fields that define a transaction. Id field should not be set.
2171 2171  )))
2172 2172  
2173 -(% class="wrapped" %)
2174 2174  |(((
2175 2175  (% class="western" %)
2176 2176  **Response**
... ... @@ -2194,14 +2194,6 @@
2194 2194  
2195 2195  
2196 2196  
2197 -
2198 -
2199 -
2200 -
2201 -
2202 -
2203 -
2204 -
2205 2205  (% class="western" %)
2206 2206  **Stats**
2207 2207  
... ... @@ -2230,7 +2230,6 @@
2230 2230  
2231 2231  This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2232 2232  
2233 -(% class="wrapped" %)
2234 2234  |(((
2235 2235  (% class="western" %)
2236 2236  **Method**
... ... @@ -2277,7 +2277,6 @@
2277 2277  (% class="western" %)
2278 2278  POST method can be used to create telemarketing stat. Telemarketing info needs to be sent as request and an Id will be returned when the transaction is created.
2279 2279  
2280 -(% class="wrapped" %)
2281 2281  |(((
2282 2282  (% class="western" %)
2283 2283  **Request**
... ... @@ -2351,7 +2351,6 @@
2351 2351  
2352 2352  )))
2353 2353  
2354 -(% class="wrapped" %)
2355 2355  |(((
2356 2356  (% class="western" %)
2357 2357  **Response**
... ... @@ -2375,14 +2375,6 @@
2375 2375  
2376 2376  
2377 2377  
2378 -
2379 -
2380 -
2381 -
2382 -
2383 -
2384 -
2385 -
2386 2386  (% class="western" %)
2387 2387  **Reference**
2388 2388  
... ... @@ -2389,7 +2389,6 @@
2389 2389  (% class="western" %)
2390 2390  **Type: Questions**
2391 2391  
2392 -(% class="wrapped" %)
2393 2393  |(((
2394 2394  (% class="western" %)
2395 2395  **Property Name**
... ... @@ -2469,7 +2469,6 @@
2469 2469  (% class="western" %)
2470 2470  **Type: Choices**
2471 2471  
2472 -(% class="wrapped" %)
2473 2473  |(((
2474 2474  (% class="western" %)
2475 2475  **Property Name**
... ... @@ -2536,7 +2536,6 @@
2536 2536  (% class="western" %)
2537 2537  **Type: Users**
2538 2538  
2539 -(% class="wrapped" %)
2540 2540  |(((
2541 2541  (% class="western" %)
2542 2542  **Property Name**
... ... @@ -2593,7 +2593,6 @@
2593 2593  (% class="western" %)
2594 2594  **Type: Demo**
2595 2595  
2596 -(% class="wrapped" %)
2597 2597  |(((
2598 2598  (% class="western" %)
2599 2599  **Property Name**
... ... @@ -2640,7 +2640,6 @@
2640 2640  (% class="western" %)
2641 2641  **Type: Transactions**
2642 2642  
2643 -(% class="wrapped" %)
2644 2644  |(((
2645 2645  (% class="western" %)
2646 2646  **Property Name**
... ... @@ -2787,7 +2787,6 @@
2787 2787  (% class="western" %)
2788 2788  **Type: Sources**
2789 2789  
2790 -(% class="wrapped" %)
2791 2791  |(((
2792 2792  (% class="western" %)
2793 2793  **Property Name**
... ... @@ -2847,7 +2847,6 @@
2847 2847  (% class="western" %)
2848 2848  **Type: Products**
2849 2849  
2850 -(% class="wrapped" %)
2851 2851  |(((
2852 2852  (% class="western" %)
2853 2853  **Property Name**
... ... @@ -2904,7 +2904,6 @@
2904 2904  (% class="western" %)
2905 2905  **Type: Terms**
2906 2906  
2907 -(% class="wrapped" %)
2908 2908  |(((
2909 2909  (% class="western" %)
2910 2910  **Property Name**
... ... @@ -2991,7 +2991,6 @@
2991 2991  (% class="western" %)
2992 2992  **Type: Resources**
2993 2993  
2994 -(% class="wrapped" %)
2995 2995  |(((
2996 2996  (% class="western" %)
2997 2997  **Property Name**
... ... @@ -3089,7 +3089,6 @@
3089 3089  (% class="western" %)
3090 3090  **Type: Telemarketing**
3091 3091  
3092 -(% class="wrapped" %)
3093 3093  |(((
3094 3094  (% class="western" %)
3095 3095  **Property Name**
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539007
1 +3538998
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539007/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18