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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -sonish-APIDocument-230317-1008-18
1 +ONEcount API Documentation
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sonish
1 +XWiki.Admin
Content
... ... @@ -1,56 +49,8 @@
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 -
49 49  (% class="western" %)
50 50  **Introduction**
51 51  
52 52  (% class="western" %)
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.
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.
54 54  
55 55  (% class="western" %)
56 56  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
... ... @@ -58,14 +58,11 @@
58 58  1. (((
59 59  (% class="western" %)
60 60  **GET** - Used for lookup of resources
61 -
62 -* (((
13 +)))
63 63  1. (((
64 64  (% class="western" %)
65 65  **PUT** - Used to update a resource
66 66  )))
67 -)))
68 -)))
69 69  1. (((
70 70  (% class="western" %)
71 71  **POST** - Used to create a new resource
... ... @@ -72,7 +72,7 @@
72 72  )))
73 73  
74 74  (% class="western" %)
75 -ONEcount API provides following functionalities:
24 +Specifically, the ONEcount API provides following functionalities:
76 76  
77 77  1. (((
78 78  (% class="western" %)
... ... @@ -205,17 +205,11 @@
205 205  (% class="western" %)
206 206  ListSourceCodes
207 207  )))
157 +1. **Attach**
208 208  
159 +*
160 +** (((
209 209  (% class="western" %)
210 -
211 -
212 -1. (((
213 -(% class="western" %)
214 -**Attach**
215 -)))
216 -
217 -* (((
218 -(% class="western" %)
219 219  Attach resource to product
220 220  )))
221 221  
... ... @@ -223,27 +223,19 @@
223 223  
224 224  
225 225  (% class="western" %)
226 -
169 +**Accessing API**
227 227  
228 228  (% class="western" %)
229 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
172 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
230 230  
231 231  (% class="western" %)
232 -**Appkey**: THIS WILL BE PROVIDED
175 +**Appkey**: THIS WILL BE PROVIDED TO YOU
233 233  
234 234  (% class="western" %)
235 -
178 +**
179 +**
236 236  
237 237  (% 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" %)
247 247  Your HTTP requests to a REST API resource should contain the following information:
248 248  
249 249  * (((
... ... @@ -264,9 +264,12 @@
264 264  )))
265 265  
266 266  (% class="western" %)
267 -**Request**
202 +
268 268  
269 269  (% class="western" %)
205 +**API Usage**
206 +
207 +(% class="western" %)
270 270  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.
271 271  
272 272  (% class="western" %)
... ... @@ -395,6 +395,18 @@
395 395  
396 396  
397 397  (% class="western" %)
336 +**
337 +**
338 +
339 +(% class="western" %)
340 +**
341 +**
342 +
343 +(% class="western" %)
344 +**
345 +**
346 +
347 +(% class="western" %)
398 398  **Resources**
399 399  
400 400  (% class="western" %)
... ... @@ -441,6 +441,7 @@
441 441  (% class="western" %)
442 442  There can be 6 types of questions:
443 443  
394 +(% class="wrapped" %)
444 444  |(((
445 445  (% class="western" align="center" %)
446 446  **Type**
... ... @@ -491,6 +491,7 @@
491 491  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.
492 492  )))
493 493  
445 +(% class="wrapped" %)
494 494  |(((
495 495  (% class="western" %)
496 496  **Method**
... ... @@ -563,6 +563,7 @@
563 563  (% class="western" %)
564 564  **GET method can be used to lookup questions.**
565 565  
518 +(% class="wrapped" %)
566 566  |(((
567 567  (% class="western" %)
568 568  **Request**
... ... @@ -593,6 +593,7 @@
593 593  Type: Look up the question type.
594 594  )))
595 595  
549 +(% class="wrapped" %)
596 596  |(((
597 597  (% class="western" %)
598 598  **Response**
... ... @@ -619,6 +619,7 @@
619 619  (% class="western" %)
620 620  **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).**
621 621  
576 +(% class="wrapped" %)
622 622  |(((
623 623  (% class="western" %)
624 624  **Request**
... ... @@ -640,6 +640,7 @@
640 640  This defines the question contents and possible responses.
641 641  )))
642 642  
598 +(% class="wrapped" %)
643 643  |(((
644 644  (% class="western" %)
645 645  **Response**
... ... @@ -666,6 +666,7 @@
666 666  (% class="western" %)
667 667  PUT method should be used to update question.
668 668  
625 +(% class="wrapped" %)
669 669  |(((
670 670  (% class="western" %)
671 671  **Request**
... ... @@ -687,6 +687,7 @@
687 687  This defines the question contents and responses.
688 688  )))
689 689  
647 +(% class="wrapped" %)
690 690  |(((
691 691  (% class="western" %)
692 692  **Response**
... ... @@ -792,6 +792,7 @@
792 792  (% class="western" %)
793 793  
794 794  
753 +(% class="wrapped" %)
795 795  |(((
796 796  (% class="western" %)
797 797  **Method**
... ... @@ -911,6 +911,7 @@
911 911  (% class="western" %)
912 912  **GET method should be used to lookup users.**
913 913  
873 +(% class="wrapped" %)
914 914  |(((
915 915  (% class="western" %)
916 916  **Request**
... ... @@ -942,6 +942,7 @@
942 942  
943 943  
944 944  
905 +(% class="wrapped" %)
945 945  |(((
946 946  (% class="western" %)
947 947  **Response**
... ... @@ -968,6 +968,7 @@
968 968  (% class="western" %)
969 969  **POST method should be used to create users.**
970 970  
932 +(% class="wrapped" %)
971 971  |(((
972 972  (% class="western" %)
973 973  **Request**
... ... @@ -1019,6 +1019,7 @@
1019 1019  CSV of ONEcount QuestionId's requested back in Users object in response.
1020 1020  )))
1021 1021  
984 +(% class="wrapped" %)
1022 1022  |(((
1023 1023  (% class="western" %)
1024 1024  **Response**
... ... @@ -1045,6 +1045,7 @@
1045 1045  (% class="western" %)
1046 1046  **PUT method should be used to update users.**
1047 1047  
1011 +(% class="wrapped" %)
1048 1048  |(((
1049 1049  (% class="western" %)
1050 1050  **Request**
... ... @@ -1086,6 +1086,7 @@
1086 1086  RequestDate to use for the demo update. If not provided current date will be used.
1087 1087  )))
1088 1088  
1053 +(% class="wrapped" %)
1089 1089  |(((
1090 1090  (% class="western" %)
1091 1091  **Response**
... ... @@ -1124,6 +1124,7 @@
1124 1124  (% class="western" %)
1125 1125  This resource is for manipulating products resource. A product can be created, updated or searched.
1126 1126  
1092 +(% class="wrapped" %)
1127 1127  |(((
1128 1128  (% class="western" %)
1129 1129  **Method**
... ... @@ -1209,6 +1209,7 @@
1209 1209  (% class="western" %)
1210 1210  **GET method should be used to lookup products.**
1211 1211  
1178 +(% class="wrapped" %)
1212 1212  |(((
1213 1213  (% class="western" %)
1214 1214  **Request**
... ... @@ -1236,6 +1236,7 @@
1236 1236  Name: Name of the Product for lookup (String)
1237 1237  )))
1238 1238  
1206 +(% class="wrapped" %)
1239 1239  |(((
1240 1240  (% class="western" %)
1241 1241  **Response**
... ... @@ -1262,6 +1262,7 @@
1262 1262  (% class="western" %)
1263 1263  **POST method should be used to create products.**
1264 1264  
1233 +(% class="wrapped" %)
1265 1265  |(((
1266 1266  (% class="western" %)
1267 1267  **Request**
... ... @@ -1289,6 +1289,7 @@
1289 1289  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1290 1290  )))
1291 1291  
1261 +(% class="wrapped" %)
1292 1292  |(((
1293 1293  (% class="western" %)
1294 1294  **Response**
... ... @@ -1315,6 +1315,7 @@
1315 1315  (% class="western" %)
1316 1316  PUT method should be used to update an individual product given the product info.
1317 1317  
1288 +(% class="wrapped" %)
1318 1318  |(((
1319 1319  (% class="western" %)
1320 1320  **Request**
... ... @@ -1345,6 +1345,7 @@
1345 1345  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1346 1346  )))
1347 1347  
1319 +(% class="wrapped" %)
1348 1348  |(((
1349 1349  (% class="western" %)
1350 1350  **Response**
... ... @@ -1374,6 +1374,7 @@
1374 1374  (% class="western" %)
1375 1375  This resource is for manipulating terms resource. A term can be created, updated or searched.
1376 1376  
1349 +(% class="wrapped" %)
1377 1377  |(((
1378 1378  (% class="western" %)
1379 1379  **Method**
... ... @@ -1430,6 +1430,7 @@
1430 1430  (% class="western" %)
1431 1431  **GET method should be used to lookup products.**
1432 1432  
1406 +(% class="wrapped" %)
1433 1433  |(((
1434 1434  (% class="western" %)
1435 1435  **Request**
... ... @@ -1457,6 +1457,7 @@
1457 1457  Name: Name of the term for lookup (String)
1458 1458  )))
1459 1459  
1434 +(% class="wrapped" %)
1460 1460  |(((
1461 1461  (% class="western" %)
1462 1462  **Response**
... ... @@ -1483,6 +1483,7 @@
1483 1483  (% class="western" %)
1484 1484  **POST method should be used to create products.**
1485 1485  
1461 +(% class="wrapped" %)
1486 1486  |(((
1487 1487  (% class="western" %)
1488 1488  **Request**
... ... @@ -1513,6 +1513,7 @@
1513 1513  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1514 1514  )))
1515 1515  
1492 +(% class="wrapped" %)
1516 1516  |(((
1517 1517  (% class="western" %)
1518 1518  **Response**
... ... @@ -1539,6 +1539,7 @@
1539 1539  (% class="western" %)
1540 1540  PUT method should be used to update an individual term given the term info.
1541 1541  
1519 +(% class="wrapped" %)
1542 1542  |(((
1543 1543  (% class="western" %)
1544 1544  **Request**
... ... @@ -1569,6 +1569,7 @@
1569 1569  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1570 1570  )))
1571 1571  
1550 +(% class="wrapped" %)
1572 1572  |(((
1573 1573  (% class="western" %)
1574 1574  **Response**
... ... @@ -1598,6 +1598,7 @@
1598 1598  (% class="western" %)
1599 1599  This resource is for manipulating resources resource. A resource can be created, updated or searched.
1600 1600  
1580 +(% class="wrapped" %)
1601 1601  |(((
1602 1602  (% class="western" %)
1603 1603  **Method**
... ... @@ -1654,6 +1654,7 @@
1654 1654  (% class="western" %)
1655 1655  **GET method should be used to lookup products.**
1656 1656  
1637 +(% class="wrapped" %)
1657 1657  |(((
1658 1658  (% class="western" %)
1659 1659  **Request**
... ... @@ -1681,6 +1681,7 @@
1681 1681  Name: Name of the resource for lookup (String)
1682 1682  )))
1683 1683  
1665 +(% class="wrapped" %)
1684 1684  |(((
1685 1685  (% class="western" %)
1686 1686  **Response**
... ... @@ -1707,6 +1707,7 @@
1707 1707  (% class="western" %)
1708 1708  **POST method should be used to create products.**
1709 1709  
1692 +(% class="wrapped" %)
1710 1710  |(((
1711 1711  (% class="western" %)
1712 1712  **Request**
... ... @@ -1737,6 +1737,7 @@
1737 1737  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1738 1738  )))
1739 1739  
1723 +(% class="wrapped" %)
1740 1740  |(((
1741 1741  (% class="western" %)
1742 1742  **Response**
... ... @@ -1763,6 +1763,7 @@
1763 1763  (% class="western" %)
1764 1764  PUT method should be used to update an individual resource given the resource info.
1765 1765  
1750 +(% class="wrapped" %)
1766 1766  |(((
1767 1767  (% class="western" %)
1768 1768  **Request**
... ... @@ -1793,6 +1793,7 @@
1793 1793  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1794 1794  )))
1795 1795  
1781 +(% class="wrapped" %)
1796 1796  |(((
1797 1797  (% class="western" %)
1798 1798  **Response**
... ... @@ -1828,6 +1828,7 @@
1828 1828  (% class="western" %)
1829 1829  This resource is for manipulating sources resource. A source can be created, updated or searched.
1830 1830  
1817 +(% class="wrapped" %)
1831 1831  |(((
1832 1832  (% class="western" %)
1833 1833  **Method**
... ... @@ -1884,6 +1884,7 @@
1884 1884  (% class="western" %)
1885 1885  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
1886 1886  
1874 +(% class="wrapped" %)
1887 1887  |(((
1888 1888  (% class="western" %)
1889 1889  **Request**
... ... @@ -1911,6 +1911,7 @@
1911 1911  Source: Source value (String)
1912 1912  )))
1913 1913  
1902 +(% class="wrapped" %)
1914 1914  |(((
1915 1915  (% class="western" %)
1916 1916  **Response**
... ... @@ -1940,6 +1940,7 @@
1940 1940  (% class="western" %)
1941 1941  POST method should be used to create an individual source given the source parameters.
1942 1942  
1932 +(% class="wrapped" %)
1943 1943  |(((
1944 1944  (% class="western" %)
1945 1945  **Request**
... ... @@ -1961,6 +1961,7 @@
1961 1961  Defines the contents that makes up the source. Id parameters should not be set.
1962 1962  )))
1963 1963  
1954 +(% class="wrapped" %)
1964 1964  |(((
1965 1965  (% class="western" %)
1966 1966  **Response**
... ... @@ -1987,6 +1987,7 @@
1987 1987  (% class="western" %)
1988 1988  **PUT method can be used to update an individual source given the id.**
1989 1989  
1981 +(% class="wrapped" %)
1990 1990  |(((
1991 1991  (% class="western" %)
1992 1992  **Request**
... ... @@ -2008,6 +2008,7 @@
2008 2008  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.
2009 2009  )))
2010 2010  
2003 +(% class="wrapped" %)
2011 2011  |(((
2012 2012  (% class="western" %)
2013 2013  **Response**
... ... @@ -2040,6 +2040,7 @@
2040 2040  (% class="western" %)
2041 2041  This resource is for manipulating transactions resource. A transaction can be created or searched.
2042 2042  
2036 +(% class="wrapped" %)
2043 2043  |(((
2044 2044  (% class="western" %)
2045 2045  **Method**
... ... @@ -2089,6 +2089,7 @@
2089 2089  (% class="western" %)
2090 2090  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2091 2091  
2086 +(% class="wrapped" %)
2092 2092  |(((
2093 2093  (% class="western" %)
2094 2094  **Request**
... ... @@ -2126,6 +2126,7 @@
2126 2126  
2127 2127  
2128 2128  
2124 +(% class="wrapped" %)
2129 2129  |(((
2130 2130  (% class="western" %)
2131 2131  **Response**
... ... @@ -2152,6 +2152,7 @@
2152 2152  (% class="western" %)
2153 2153  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.
2154 2154  
2151 +(% class="wrapped" %)
2155 2155  |(((
2156 2156  (% class="western" %)
2157 2157  **Request**
... ... @@ -2173,6 +2173,7 @@
2173 2173  Contains fields that define a transaction. Id field should not be set.
2174 2174  )))
2175 2175  
2173 +(% class="wrapped" %)
2176 2176  |(((
2177 2177  (% class="western" %)
2178 2178  **Response**
... ... @@ -2196,6 +2196,14 @@
2196 2196  
2197 2197  
2198 2198  
2197 +
2198 +
2199 +
2200 +
2201 +
2202 +
2203 +
2204 +
2199 2199  (% class="western" %)
2200 2200  **Stats**
2201 2201  
... ... @@ -2224,6 +2224,7 @@
2224 2224  
2225 2225  This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2226 2226  
2233 +(% class="wrapped" %)
2227 2227  |(((
2228 2228  (% class="western" %)
2229 2229  **Method**
... ... @@ -2270,6 +2270,7 @@
2270 2270  (% class="western" %)
2271 2271  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.
2272 2272  
2280 +(% class="wrapped" %)
2273 2273  |(((
2274 2274  (% class="western" %)
2275 2275  **Request**
... ... @@ -2343,6 +2343,7 @@
2343 2343  
2344 2344  )))
2345 2345  
2354 +(% class="wrapped" %)
2346 2346  |(((
2347 2347  (% class="western" %)
2348 2348  **Response**
... ... @@ -2366,6 +2366,14 @@
2366 2366  
2367 2367  
2368 2368  
2378 +
2379 +
2380 +
2381 +
2382 +
2383 +
2384 +
2385 +
2369 2369  (% class="western" %)
2370 2370  **Reference**
2371 2371  
... ... @@ -2372,6 +2372,7 @@
2372 2372  (% class="western" %)
2373 2373  **Type: Questions**
2374 2374  
2392 +(% class="wrapped" %)
2375 2375  |(((
2376 2376  (% class="western" %)
2377 2377  **Property Name**
... ... @@ -2451,6 +2451,7 @@
2451 2451  (% class="western" %)
2452 2452  **Type: Choices**
2453 2453  
2472 +(% class="wrapped" %)
2454 2454  |(((
2455 2455  (% class="western" %)
2456 2456  **Property Name**
... ... @@ -2517,6 +2517,7 @@
2517 2517  (% class="western" %)
2518 2518  **Type: Users**
2519 2519  
2539 +(% class="wrapped" %)
2520 2520  |(((
2521 2521  (% class="western" %)
2522 2522  **Property Name**
... ... @@ -2573,6 +2573,7 @@
2573 2573  (% class="western" %)
2574 2574  **Type: Demo**
2575 2575  
2596 +(% class="wrapped" %)
2576 2576  |(((
2577 2577  (% class="western" %)
2578 2578  **Property Name**
... ... @@ -2619,6 +2619,7 @@
2619 2619  (% class="western" %)
2620 2620  **Type: Transactions**
2621 2621  
2643 +(% class="wrapped" %)
2622 2622  |(((
2623 2623  (% class="western" %)
2624 2624  **Property Name**
... ... @@ -2765,6 +2765,7 @@
2765 2765  (% class="western" %)
2766 2766  **Type: Sources**
2767 2767  
2790 +(% class="wrapped" %)
2768 2768  |(((
2769 2769  (% class="western" %)
2770 2770  **Property Name**
... ... @@ -2824,6 +2824,7 @@
2824 2824  (% class="western" %)
2825 2825  **Type: Products**
2826 2826  
2850 +(% class="wrapped" %)
2827 2827  |(((
2828 2828  (% class="western" %)
2829 2829  **Property Name**
... ... @@ -2880,6 +2880,7 @@
2880 2880  (% class="western" %)
2881 2881  **Type: Terms**
2882 2882  
2907 +(% class="wrapped" %)
2883 2883  |(((
2884 2884  (% class="western" %)
2885 2885  **Property Name**
... ... @@ -2966,6 +2966,7 @@
2966 2966  (% class="western" %)
2967 2967  **Type: Resources**
2968 2968  
2994 +(% class="wrapped" %)
2969 2969  |(((
2970 2970  (% class="western" %)
2971 2971  **Property Name**
... ... @@ -3063,6 +3063,7 @@
3063 3063  (% class="western" %)
3064 3064  **Type: Telemarketing**
3065 3065  
3092 +(% class="wrapped" %)
3066 3066  |(((
3067 3067  (% class="western" %)
3068 3068  **Property Name**
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3538998
1 +3539007
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18
1 +https://info.onecount.net//wiki/spaces/OD/pages/3539007/ONEcount API Documentation