Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 4.1
edited by sonish
on 2017/04/03 16:45
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 -OC-API-04032017
1 +sonish-APIDocument-230317-1008-18
Content
... ... @@ -441,7 +441,6 @@
441 441  (% class="western" %)
442 442  There can be 6 types of questions:
443 443  
444 -(% class="wrapped" %)
445 445  |(((
446 446  (% class="western" align="center" %)
447 447  **Type**
... ... @@ -492,7 +492,6 @@
492 492  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.
493 493  )))
494 494  
495 -(% class="wrapped" %)
496 496  |(((
497 497  (% class="western" %)
498 498  **Method**
... ... @@ -565,7 +565,6 @@
565 565  (% class="western" %)
566 566  **GET method can be used to lookup questions.**
567 567  
568 -(% class="wrapped" %)
569 569  |(((
570 570  (% class="western" %)
571 571  **Request**
... ... @@ -596,7 +596,6 @@
596 596  Type: Look up the question type.
597 597  )))
598 598  
599 -(% class="wrapped" %)
600 600  |(((
601 601  (% class="western" %)
602 602  **Response**
... ... @@ -623,7 +623,6 @@
623 623  (% class="western" %)
624 624  **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).**
625 625  
626 -(% class="wrapped" %)
627 627  |(((
628 628  (% class="western" %)
629 629  **Request**
... ... @@ -645,7 +645,6 @@
645 645  This defines the question contents and possible responses.
646 646  )))
647 647  
648 -(% class="wrapped" %)
649 649  |(((
650 650  (% class="western" %)
651 651  **Response**
... ... @@ -672,7 +672,6 @@
672 672  (% class="western" %)
673 673  PUT method should be used to update question.
674 674  
675 -(% class="wrapped" %)
676 676  |(((
677 677  (% class="western" %)
678 678  **Request**
... ... @@ -694,7 +694,6 @@
694 694  This defines the question contents and responses.
695 695  )))
696 696  
697 -(% class="wrapped" %)
698 698  |(((
699 699  (% class="western" %)
700 700  **Response**
... ... @@ -800,7 +800,6 @@
800 800  (% class="western" %)
801 801  
802 802  
803 -(% class="wrapped" %)
804 804  |(((
805 805  (% class="western" %)
806 806  **Method**
... ... @@ -920,7 +920,6 @@
920 920  (% class="western" %)
921 921  **GET method should be used to lookup users.**
922 922  
923 -(% class="wrapped" %)
924 924  |(((
925 925  (% class="western" %)
926 926  **Request**
... ... @@ -952,7 +952,6 @@
952 952  
953 953  
954 954  
955 -(% class="wrapped" %)
956 956  |(((
957 957  (% class="western" %)
958 958  **Response**
... ... @@ -979,7 +979,6 @@
979 979  (% class="western" %)
980 980  **POST method should be used to create users.**
981 981  
982 -(% class="wrapped" %)
983 983  |(((
984 984  (% class="western" %)
985 985  **Request**
... ... @@ -1031,7 +1031,6 @@
1031 1031  CSV of ONEcount QuestionId's requested back in Users object in response.
1032 1032  )))
1033 1033  
1034 -(% class="wrapped" %)
1035 1035  |(((
1036 1036  (% class="western" %)
1037 1037  **Response**
... ... @@ -1058,7 +1058,6 @@
1058 1058  (% class="western" %)
1059 1059  **PUT method should be used to update users.**
1060 1060  
1061 -(% class="wrapped" %)
1062 1062  |(((
1063 1063  (% class="western" %)
1064 1064  **Request**
... ... @@ -1100,7 +1100,6 @@
1100 1100  RequestDate to use for the demo update. If not provided current date will be used.
1101 1101  )))
1102 1102  
1103 -(% class="wrapped" %)
1104 1104  |(((
1105 1105  (% class="western" %)
1106 1106  **Response**
... ... @@ -1139,7 +1139,6 @@
1139 1139  (% class="western" %)
1140 1140  This resource is for manipulating products resource. A product can be created, updated or searched.
1141 1141  
1142 -(% class="wrapped" %)
1143 1143  |(((
1144 1144  (% class="western" %)
1145 1145  **Method**
... ... @@ -1225,7 +1225,6 @@
1225 1225  (% class="western" %)
1226 1226  **GET method should be used to lookup products.**
1227 1227  
1228 -(% class="wrapped" %)
1229 1229  |(((
1230 1230  (% class="western" %)
1231 1231  **Request**
... ... @@ -1253,7 +1253,6 @@
1253 1253  Name: Name of the Product for lookup (String)
1254 1254  )))
1255 1255  
1256 -(% class="wrapped" %)
1257 1257  |(((
1258 1258  (% class="western" %)
1259 1259  **Response**
... ... @@ -1280,7 +1280,6 @@
1280 1280  (% class="western" %)
1281 1281  **POST method should be used to create products.**
1282 1282  
1283 -(% class="wrapped" %)
1284 1284  |(((
1285 1285  (% class="western" %)
1286 1286  **Request**
... ... @@ -1308,7 +1308,6 @@
1308 1308  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1309 1309  )))
1310 1310  
1311 -(% class="wrapped" %)
1312 1312  |(((
1313 1313  (% class="western" %)
1314 1314  **Response**
... ... @@ -1335,7 +1335,6 @@
1335 1335  (% class="western" %)
1336 1336  PUT method should be used to update an individual product given the product info.
1337 1337  
1338 -(% class="wrapped" %)
1339 1339  |(((
1340 1340  (% class="western" %)
1341 1341  **Request**
... ... @@ -1366,7 +1366,6 @@
1366 1366  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1367 1367  )))
1368 1368  
1369 -(% class="wrapped" %)
1370 1370  |(((
1371 1371  (% class="western" %)
1372 1372  **Response**
... ... @@ -1396,7 +1396,6 @@
1396 1396  (% class="western" %)
1397 1397  This resource is for manipulating terms resource. A term can be created, updated or searched.
1398 1398  
1399 -(% class="wrapped" %)
1400 1400  |(((
1401 1401  (% class="western" %)
1402 1402  **Method**
... ... @@ -1453,7 +1453,6 @@
1453 1453  (% class="western" %)
1454 1454  **GET method should be used to lookup products.**
1455 1455  
1456 -(% class="wrapped" %)
1457 1457  |(((
1458 1458  (% class="western" %)
1459 1459  **Request**
... ... @@ -1481,7 +1481,6 @@
1481 1481  Name: Name of the term for lookup (String)
1482 1482  )))
1483 1483  
1484 -(% class="wrapped" %)
1485 1485  |(((
1486 1486  (% class="western" %)
1487 1487  **Response**
... ... @@ -1508,7 +1508,6 @@
1508 1508  (% class="western" %)
1509 1509  **POST method should be used to create products.**
1510 1510  
1511 -(% class="wrapped" %)
1512 1512  |(((
1513 1513  (% class="western" %)
1514 1514  **Request**
... ... @@ -1539,7 +1539,6 @@
1539 1539  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1540 1540  )))
1541 1541  
1542 -(% class="wrapped" %)
1543 1543  |(((
1544 1544  (% class="western" %)
1545 1545  **Response**
... ... @@ -1566,7 +1566,6 @@
1566 1566  (% class="western" %)
1567 1567  PUT method should be used to update an individual term given the term info.
1568 1568  
1569 -(% class="wrapped" %)
1570 1570  |(((
1571 1571  (% class="western" %)
1572 1572  **Request**
... ... @@ -1597,7 +1597,6 @@
1597 1597  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1598 1598  )))
1599 1599  
1600 -(% class="wrapped" %)
1601 1601  |(((
1602 1602  (% class="western" %)
1603 1603  **Response**
... ... @@ -1627,7 +1627,6 @@
1627 1627  (% class="western" %)
1628 1628  This resource is for manipulating resources resource. A resource can be created, updated or searched.
1629 1629  
1630 -(% class="wrapped" %)
1631 1631  |(((
1632 1632  (% class="western" %)
1633 1633  **Method**
... ... @@ -1684,7 +1684,6 @@
1684 1684  (% class="western" %)
1685 1685  **GET method should be used to lookup products.**
1686 1686  
1687 -(% class="wrapped" %)
1688 1688  |(((
1689 1689  (% class="western" %)
1690 1690  **Request**
... ... @@ -1712,7 +1712,6 @@
1712 1712  Name: Name of the resource for lookup (String)
1713 1713  )))
1714 1714  
1715 -(% class="wrapped" %)
1716 1716  |(((
1717 1717  (% class="western" %)
1718 1718  **Response**
... ... @@ -1739,7 +1739,6 @@
1739 1739  (% class="western" %)
1740 1740  **POST method should be used to create products.**
1741 1741  
1742 -(% class="wrapped" %)
1743 1743  |(((
1744 1744  (% class="western" %)
1745 1745  **Request**
... ... @@ -1770,7 +1770,6 @@
1770 1770  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1771 1771  )))
1772 1772  
1773 -(% class="wrapped" %)
1774 1774  |(((
1775 1775  (% class="western" %)
1776 1776  **Response**
... ... @@ -1797,7 +1797,6 @@
1797 1797  (% class="western" %)
1798 1798  PUT method should be used to update an individual resource given the resource info.
1799 1799  
1800 -(% class="wrapped" %)
1801 1801  |(((
1802 1802  (% class="western" %)
1803 1803  **Request**
... ... @@ -1828,7 +1828,6 @@
1828 1828  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1829 1829  )))
1830 1830  
1831 -(% class="wrapped" %)
1832 1832  |(((
1833 1833  (% class="western" %)
1834 1834  **Response**
... ... @@ -1864,7 +1864,6 @@
1864 1864  (% class="western" %)
1865 1865  This resource is for manipulating sources resource. A source can be created, updated or searched.
1866 1866  
1867 -(% class="wrapped" %)
1868 1868  |(((
1869 1869  (% class="western" %)
1870 1870  **Method**
... ... @@ -1921,7 +1921,6 @@
1921 1921  (% class="western" %)
1922 1922  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
1923 1923  
1924 -(% class="wrapped" %)
1925 1925  |(((
1926 1926  (% class="western" %)
1927 1927  **Request**
... ... @@ -1949,7 +1949,6 @@
1949 1949  Source: Source value (String)
1950 1950  )))
1951 1951  
1952 -(% class="wrapped" %)
1953 1953  |(((
1954 1954  (% class="western" %)
1955 1955  **Response**
... ... @@ -1979,7 +1979,6 @@
1979 1979  (% class="western" %)
1980 1980  POST method should be used to create an individual source given the source parameters.
1981 1981  
1982 -(% class="wrapped" %)
1983 1983  |(((
1984 1984  (% class="western" %)
1985 1985  **Request**
... ... @@ -2001,7 +2001,6 @@
2001 2001  Defines the contents that makes up the source. Id parameters should not be set.
2002 2002  )))
2003 2003  
2004 -(% class="wrapped" %)
2005 2005  |(((
2006 2006  (% class="western" %)
2007 2007  **Response**
... ... @@ -2028,7 +2028,6 @@
2028 2028  (% class="western" %)
2029 2029  **PUT method can be used to update an individual source given the id.**
2030 2030  
2031 -(% class="wrapped" %)
2032 2032  |(((
2033 2033  (% class="western" %)
2034 2034  **Request**
... ... @@ -2050,7 +2050,6 @@
2050 2050  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.
2051 2051  )))
2052 2052  
2053 -(% class="wrapped" %)
2054 2054  |(((
2055 2055  (% class="western" %)
2056 2056  **Response**
... ... @@ -2083,7 +2083,6 @@
2083 2083  (% class="western" %)
2084 2084  This resource is for manipulating transactions resource. A transaction can be created or searched.
2085 2085  
2086 -(% class="wrapped" %)
2087 2087  |(((
2088 2088  (% class="western" %)
2089 2089  **Method**
... ... @@ -2133,7 +2133,6 @@
2133 2133  (% class="western" %)
2134 2134  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2135 2135  
2136 -(% class="wrapped" %)
2137 2137  |(((
2138 2138  (% class="western" %)
2139 2139  **Request**
... ... @@ -2171,7 +2171,6 @@
2171 2171  
2172 2172  
2173 2173  
2174 -(% class="wrapped" %)
2175 2175  |(((
2176 2176  (% class="western" %)
2177 2177  **Response**
... ... @@ -2198,7 +2198,6 @@
2198 2198  (% class="western" %)
2199 2199  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.
2200 2200  
2201 -(% class="wrapped" %)
2202 2202  |(((
2203 2203  (% class="western" %)
2204 2204  **Request**
... ... @@ -2220,7 +2220,6 @@
2220 2220  Contains fields that define a transaction. Id field should not be set.
2221 2221  )))
2222 2222  
2223 -(% class="wrapped" %)
2224 2224  |(((
2225 2225  (% class="western" %)
2226 2226  **Response**
... ... @@ -2272,7 +2272,6 @@
2272 2272  
2273 2273  This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2274 2274  
2275 -(% class="wrapped" %)
2276 2276  |(((
2277 2277  (% class="western" %)
2278 2278  **Method**
... ... @@ -2319,7 +2319,6 @@
2319 2319  (% class="western" %)
2320 2320  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.
2321 2321  
2322 -(% class="wrapped" %)
2323 2323  |(((
2324 2324  (% class="western" %)
2325 2325  **Request**
... ... @@ -2393,7 +2393,6 @@
2393 2393  
2394 2394  )))
2395 2395  
2396 -(% class="wrapped" %)
2397 2397  |(((
2398 2398  (% class="western" %)
2399 2399  **Response**
... ... @@ -2423,7 +2423,6 @@
2423 2423  (% class="western" %)
2424 2424  **Type: Questions**
2425 2425  
2426 -(% class="wrapped" %)
2427 2427  |(((
2428 2428  (% class="western" %)
2429 2429  **Property Name**
... ... @@ -2503,7 +2503,6 @@
2503 2503  (% class="western" %)
2504 2504  **Type: Choices**
2505 2505  
2506 -(% class="wrapped" %)
2507 2507  |(((
2508 2508  (% class="western" %)
2509 2509  **Property Name**
... ... @@ -2570,7 +2570,6 @@
2570 2570  (% class="western" %)
2571 2571  **Type: Users**
2572 2572  
2573 -(% class="wrapped" %)
2574 2574  |(((
2575 2575  (% class="western" %)
2576 2576  **Property Name**
... ... @@ -2627,7 +2627,6 @@
2627 2627  (% class="western" %)
2628 2628  **Type: Demo**
2629 2629  
2630 -(% class="wrapped" %)
2631 2631  |(((
2632 2632  (% class="western" %)
2633 2633  **Property Name**
... ... @@ -2674,7 +2674,6 @@
2674 2674  (% class="western" %)
2675 2675  **Type: Transactions**
2676 2676  
2677 -(% class="wrapped" %)
2678 2678  |(((
2679 2679  (% class="western" %)
2680 2680  **Property Name**
... ... @@ -2821,7 +2821,6 @@
2821 2821  (% class="western" %)
2822 2822  **Type: Sources**
2823 2823  
2824 -(% class="wrapped" %)
2825 2825  |(((
2826 2826  (% class="western" %)
2827 2827  **Property Name**
... ... @@ -2881,7 +2881,6 @@
2881 2881  (% class="western" %)
2882 2882  **Type: Products**
2883 2883  
2884 -(% class="wrapped" %)
2885 2885  |(((
2886 2886  (% class="western" %)
2887 2887  **Property Name**
... ... @@ -2938,7 +2938,6 @@
2938 2938  (% class="western" %)
2939 2939  **Type: Terms**
2940 2940  
2941 -(% class="wrapped" %)
2942 2942  |(((
2943 2943  (% class="western" %)
2944 2944  **Property Name**
... ... @@ -3025,7 +3025,6 @@
3025 3025  (% class="western" %)
3026 3026  **Type: Resources**
3027 3027  
3028 -(% class="wrapped" %)
3029 3029  |(((
3030 3030  (% class="western" %)
3031 3031  **Property Name**
... ... @@ -3123,7 +3123,6 @@
3123 3123  (% class="western" %)
3124 3124  **Type: Telemarketing**
3125 3125  
3126 -(% class="wrapped" %)
3127 3127  |(((
3128 3128  (% class="western" %)
3129 3129  **Property Name**
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539005
1 +3538998
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539005/OC-API-04032017
1 +https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18