Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 18.1
edited by santosh
on 2022/04/25 17:32
Change comment: There is no comment for this version
To version 14.1
edited by ayush
on 2017/05/01 13:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.santosh
1 +XWiki.ayush
Content
... ... @@ -90,7 +90,7 @@
90 90  )))
91 91  
92 92  (% class="western" %)
93 -\\
93 +
94 94  
95 95  (% class="western" %)
96 96  **General API Usage**
... ... @@ -102,7 +102,7 @@
102 102  For lookup, the parameter list will be part of the request url.
103 103  
104 104  (% class="western" %)
105 -\\
105 +
106 106  
107 107  (% class="western" %)
108 108  **Response**
... ... @@ -165,7 +165,7 @@
165 165  The result of the api request will be determined by the value of the success property of result object. Here the value of success will either be 1 (true) or 0 (false) depending on whether the requested action succeed.
166 166  
167 167  (% class="western" %)
168 -\\
168 +
169 169  
170 170  (% class="western" %)
171 171  If value of success is 0 then an error will be generated inside the result object. Code property will have an error code. message property will have the details about the error. This value might be used to display the error in the client application. The response will always have a result object in it plus the individual response listed for each method.
... ... @@ -221,7 +221,7 @@
221 221   ]}]}}}}
222 222  
223 223  (% class="western" %)
224 -\\
224 +
225 225  
226 226  (% class="western" %)
227 227  **
... ... @@ -247,7 +247,7 @@
247 247  (% class="western" %)
248 248  Return is an optional parameter in request. If return is not requested then by default, only UserId (which is ONEcount ID) will be returned in the Users object.
249 249  
250 -\\
250 +
251 251  
252 252  (% class="wrapped" %)
253 253  |(((
... ... @@ -275,7 +275,7 @@
275 275  GET
276 276  )))|(((
277 277  (% class="western" %)
278 -/users/<ocid or ocid_hash>
278 +/users/1
279 279  )))|(((
280 280  (% class="western" %)
281 281  Get data for user id 1. The user id can be a numeric value or a hash
... ... @@ -364,7 +364,7 @@
364 364  **OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
365 365  )))
366 366  
367 -\\
367 +
368 368  
369 369  (% class="western" %)
370 370  **GET method should be used to lookup users.**
... ... @@ -395,14 +395,11 @@
395 395  
396 396  (% class="western" %)
397 397  return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
398 -
399 -(% class="western" %)
400 -If return is not provided, all the demographics will be returned.
401 401  )))
402 402  
403 -\\
400 +
404 404  
405 -\\
402 +
406 406  
407 407  (% class="wrapped" %)
408 408  |(((
... ... @@ -423,37 +423,11 @@
423 423  Users
424 424  )))|(((
425 425  (% class="western" %)
426 -Found users returned with the demo field requested in return parameter in json format
423 +Found users returned with the demo field requested in return parameter in json format.
427 427  )))
428 428  
429 -\\
426 +
430 430  
431 -**Sample response for /users/(% style="color: rgb(80,80,80);" %)<OCID or ocid_hash>(%%)**
432 -
433 -Along with the demo in json format, the active packages and products of the user referred to as products and resources respectively are also returned.
434 -
435 -(% class="relative-table wrapped" style="width: 100.0%;" %)
436 -|=(((
437 -(% class="content-wrapper" %)
438 -(((
439 -[[image:attach:Screen Shot 2020-02-26 at 11.15.52 AM.png||width="1407"]]
440 -)))
441 -)))
442 -
443 -\\
444 -
445 -**Sample response for /users/lookup?(% style="color: rgb(80,80,80);" %)11=santosh@[[one-count.com>>url:http://one-count.com||shape="rect"]]&return=2,3(%%)**
446 -
447 -(% class="wrapped" %)
448 -|=(((
449 -(% class="content-wrapper" %)
450 -(((
451 -[[image:attach:Screen Shot 2020-02-26 at 11.22.13 AM.png||height="250"]]
452 -)))
453 -)))
454 -
455 -\\
456 -
457 457  (% class="western" %)
458 458  **POST method should be used to create users.**
459 459  
... ... @@ -531,7 +531,7 @@
531 531  Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
532 532  )))
533 533  
534 -\\
505 +
535 535  
536 536  (% class="western" %)
537 537  **PUT method should be used to update users.**
... ... @@ -601,10 +601,10 @@
601 601  )))
602 602  
603 603  (% class="western" %)
604 -\\
575 +
605 605  
606 606  (% class="western" %)
607 -\\
578 +
608 608  
609 609  (% class="western" %)
610 610  Create new users. Here in this example the JSON for request is passed in userFile.json file.
... ... @@ -619,7 +619,7 @@
619 619  **
620 620  **
621 621  
622 -\\
593 +
623 623  
624 624  (% class="western" %)
625 625  **COMPONENT: Questions**
... ... @@ -755,7 +755,7 @@
755 755  JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
756 756  )))
757 757  
758 -\\
729 +
759 759  
760 760  (% class="western" %)
761 761  **GET method can be used to lookup questions.**
... ... @@ -813,7 +813,7 @@
813 813  Returns found question details.
814 814  )))
815 815  
816 -\\
787 +
817 817  
818 818  (% class="western" %)
819 819  **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).**
... ... @@ -862,7 +862,7 @@
862 862  Returns ONEcount question id on successful creation of the question.
863 863  )))
864 864  
865 -\\
836 +
866 866  
867 867  (% class="western" %)
868 868  PUT method should be used to update question.
... ... @@ -912,7 +912,7 @@
912 912  )))
913 913  
914 914  (% class="western" %)
915 -\\
886 +
916 916  
917 917  (% class="western" %)
918 918  Example: Get list of questions from api which has FirstName in text
... ... @@ -971,7 +971,7 @@
971 971  }
972 972  
973 973  (% class="western" %)
974 -\\
945 +
975 975  
976 976  (% class="western" %)
977 977  **COMPONENT: Products**
... ... @@ -1060,7 +1060,7 @@
1060 1060  {"ProductID":"65","ResourceID":”121"}
1061 1061  )))
1062 1062  
1063 -\\
1034 +
1064 1064  
1065 1065  (% class="western" %)
1066 1066  **GET method should be used to lookup products.**
... ... @@ -1115,7 +1115,7 @@
1115 1115  Returns found product details.
1116 1116  )))
1117 1117  
1118 -\\
1089 +
1119 1119  
1120 1120  (% class="western" %)
1121 1121  **POST method should be used to create products.**
... ... @@ -1170,7 +1170,7 @@
1170 1170  Product Id of the newly created product.
1171 1171  )))
1172 1172  
1173 -\\
1144 +
1174 1174  
1175 1175  (% class="western" %)
1176 1176  PUT method should be used to update an individual product given the product info.
... ... @@ -1228,7 +1228,7 @@
1228 1228  Product id of the updated product.
1229 1229  )))
1230 1230  
1231 -\\
1202 +
1232 1232  
1233 1233  (% class="western" %)
1234 1234  **COMPONENT: Terms**
... ... @@ -1288,7 +1288,7 @@
1288 1288  JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
1289 1289  )))
1290 1290  
1291 -\\
1262 +
1292 1292  
1293 1293  (% class="western" %)
1294 1294  **GET method should be used to lookup products.**
... ... @@ -1343,7 +1343,7 @@
1343 1343  Returns found term details.
1344 1344  )))
1345 1345  
1346 -\\
1317 +
1347 1347  
1348 1348  (% class="western" %)
1349 1349  **POST method should be used to create products.**
... ... @@ -1401,7 +1401,7 @@
1401 1401  Term Id of the newly created term.
1402 1402  )))
1403 1403  
1404 -\\
1375 +
1405 1405  
1406 1406  (% class="western" %)
1407 1407  PUT method should be used to update an individual term given the term info.
... ... @@ -1428,7 +1428,7 @@
1428 1428  Term details to be updated in json format to be sent with request. Id property needs to be set to identify the term to be updated.
1429 1429  
1430 1430  (% class="western" %)
1431 -\\
1402 +
1432 1432  
1433 1433  (% class="western" %)
1434 1434  **Example**:
... ... @@ -1459,7 +1459,7 @@
1459 1459  term id of the updated term.
1460 1460  )))
1461 1461  
1462 -\\
1433 +
1463 1463  
1464 1464  (% class="western" %)
1465 1465  **COMPONENT: Resources**
... ... @@ -1555,7 +1555,7 @@
1555 1555  JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
1556 1556  )))
1557 1557  
1558 -\\
1529 +
1559 1559  
1560 1560  (% class="western" %)
1561 1561  **GET method should be used to lookup resources.**
... ... @@ -1610,7 +1610,7 @@
1610 1610  Returns found resource details.
1611 1611  )))
1612 1612  
1613 -\\
1584 +
1614 1614  
1615 1615  (% class="western" %)
1616 1616  **POST method should be used to create resources.**
... ... @@ -1677,7 +1677,7 @@
1677 1677  Resource Id of the newly created resource.
1678 1678  )))
1679 1679  
1680 -\\
1651 +
1681 1681  
1682 1682  (% class="western" %)
1683 1683  PUT method should be used to update an individual resource given the resource info.
... ... @@ -1704,7 +1704,7 @@
1704 1704  Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1705 1705  
1706 1706  (% class="western" %)
1707 -\\
1678 +
1708 1708  
1709 1709  (% class="western" %)
1710 1710  Examples:
... ... @@ -1744,12 +1744,12 @@
1744 1744  resource id of the updated resource.
1745 1745  )))
1746 1746  
1747 -\\
1718 +
1748 1748  
1749 -\\
1720 +
1750 1750  
1751 1751  (% class="western" %)
1752 -\\
1723 +
1753 1753  
1754 1754  (% class="western" %)
1755 1755  **COMPONENT: Source Codes
... ... @@ -1810,7 +1810,7 @@
1810 1810  JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
1811 1811  )))
1812 1812  
1813 -\\
1784 +
1814 1814  
1815 1815  (% class="western" %)
1816 1816  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
... ... @@ -1865,10 +1865,10 @@
1865 1865  Returns found source details.
1866 1866  )))
1867 1867  
1868 -\\
1839 +
1869 1869  
1870 1870  (% class="western" %)
1871 -\\
1842 +
1872 1872  
1873 1873  (% class="western" %)
1874 1874  POST method should be used to create an individual source given the source parameters.
... ... @@ -1917,7 +1917,7 @@
1917 1917  Returns created source code id.
1918 1918  )))
1919 1919  
1920 -\\
1891 +
1921 1921  
1922 1922  (% class="western" %)
1923 1923  **PUT method can be used to update an individual source given the id.**
... ... @@ -1966,10 +1966,10 @@
1966 1966  Returns updated source id.
1967 1967  )))
1968 1968  
1969 -\\
1940 +
1970 1970  
1971 1971  (% class="western" %)
1972 -\\
1943 +
1973 1973  
1974 1974  (% class="western" %)
1975 1975  **COMPONENT: Transactions**
... ... @@ -2019,10 +2019,10 @@
2019 2019  JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
2020 2020  )))
2021 2021  
2022 -\\
1993 +
2023 2023  
2024 2024  (% class="western" %)
2025 -\\
1996 +
2026 2026  
2027 2027  (% class="western" %)
2028 2028  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
... ... @@ -2061,7 +2061,11 @@
2061 2061  EndDate: When the search should end. Only valid when UserId is set. (Date)
2062 2062  )))
2063 2063  
2064 -(% class="wrapped" style="letter-spacing: 0.0px;" %)
2035 +
2036 +
2037 +
2038 +
2039 +(% class="wrapped" %)
2065 2065  |(((
2066 2066  (% class="western" %)
2067 2067  **Response**
... ... @@ -2080,23 +2080,11 @@
2080 2080  Transactions
2081 2081  )))|(((
2082 2082  (% class="western" %)
2083 -Returns all transaction that satisfies the search criteria. Returns all the package and product transactions of the user. Package Transactions are the one with TermId and ProductId. Product Transactions are the one with ResourceId.
2058 +Returns all transaction that satisfies the search criteria.
2084 2084  )))
2085 2085  
2086 -\\
2061 +
2087 2087  
2088 -**Sample response for /(% style="color: rgb(80,80,80);" %)transactions/lookup?UserId=25255105:(%%)**
2089 -
2090 -(% class="wrapped" %)
2091 -|=(((
2092 -(% class="content-wrapper" %)
2093 -(((
2094 -[[image:attach:Screen Shot 2020-02-26 at 11.14.29 AM.png||width="1407"]]
2095 -)))
2096 -)))
2097 -
2098 -\\
2099 -
2100 2100  (% class="western" %)
2101 2101  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.
2102 2102  
... ... @@ -2144,9 +2144,9 @@
2144 2144  Returns transactionId of the newly created transaction.
2145 2145  )))
2146 2146  
2147 -\\
2110 +
2148 2148  
2149 -\\
2112 +
2150 2150  
2151 2151  (% class="western" %)
2152 2152  **COMPONENT: Leads
... ... @@ -2156,19 +2156,19 @@
2156 2156  Stats resource can be used to submit any type of stat collected on the third party systems. Each type of stat will be represented by a sub-resource. So, for telemarketing it could be **/stats/telemarketing** endpoint, for videos it can be **/stats/videos**, for webinar it could be **/stats/webinars** etc. Right now we only have telemarketing sub-resource.
2157 2157  
2158 2158  (% class="western" %)
2159 -\\
2122 +
2160 2160  
2161 2161  (% class="western" %)
2162 -\\
2125 +
2163 2163  
2164 2164  (% class="western" %)
2165 -\\
2128 +
2166 2166  
2167 2167  (% class="western" %)
2168 -\\
2131 +
2169 2169  
2170 2170  (% class="western" %)
2171 -\\
2134 +
2172 2172  
2173 2173  (% class="western" %)
2174 2174  **Telemarketing Leads
... ... @@ -2220,7 +2220,7 @@
2220 2220  JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
2221 2221  )))
2222 2222  
2223 -\\
2186 +
2224 2224  
2225 2225  (% class="western" %)
2226 2226  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.
... ... @@ -2290,13 +2290,13 @@
2290 2290  )))
2291 2291  |(((
2292 2292  (% class="western" %)
2293 -\\
2256 +
2294 2294  )))|(((
2295 2295  (% class="western" %)
2296 -\\
2259 +
2297 2297  )))|(((
2298 2298  (% class="western" %)
2299 -\\
2262 +
2300 2300  )))
2301 2301  
2302 2302  (% class="wrapped" %)
... ... @@ -2321,15 +2321,15 @@
2321 2321  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
2322 2322  )))
2323 2323  
2324 -\\
2287 +
2325 2325  
2326 -\\
2289 +
2327 2327  
2328 -\\
2291 +
2329 2329  
2330 -\\
2293 +
2331 2331  
2332 -\\
2295 +
2333 2333  
2334 2334  (% class="western" %)
2335 2335  **API REFERENCE**
... ... @@ -2378,12 +2378,12 @@
2378 2378  (% class="western" %)
2379 2379  Determines which type of question it is. Textbox, checkbox, select, radio.
2380 2380  There can be 6 types of questions.
2381 -type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2382 -type=2 means textarea type question or long response type question.
2383 -type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2384 -type = 4 means select or dropdown type questions. This is a multiple choice, 1 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 select question.
2385 -type=5 means radio button type question. This is a multiple choice, 1 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 radio question.
2386 -type=6 means 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.
2344 + type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2345 + type=2 means textarea type question or long response type question.
2346 + type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2347 + type = 4 means select or dropdown type questions. This is a multiple choice, 1 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 select question.
2348 + type=5 means radio button type question. This is a multiple choice, 1 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 radio question.
2349 + type=6 means 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.
2387 2387  )))
2388 2388  |(((
2389 2389  (% class="western" %)
... ... @@ -2406,13 +2406,13 @@
2406 2406  Alias for admin purpose.
2407 2407  )))
2408 2408  
2409 -\\
2372 +
2410 2410  
2411 2411  (% class="western" %)
2412 -\\
2375 +
2413 2413  
2414 2414  (% class="western" %)
2415 -\\
2378 +
2416 2416  
2417 2417  (% class="western" %)
2418 2418  **Type: Choices**
... ... @@ -2479,7 +2479,7 @@
2479 2479  Tied to which question id.
2480 2480  )))
2481 2481  
2482 -\\
2445 +
2483 2483  
2484 2484  (% class="western" %)
2485 2485  **Type: Users**
... ... @@ -2536,7 +2536,7 @@
2536 2536  Request date.
2537 2537  )))
2538 2538  
2539 -\\
2502 +
2540 2540  
2541 2541  (% class="western" %)
2542 2542  **Type: Demo**
... ... @@ -2583,7 +2583,7 @@
2583 2583  ...
2584 2584  )))
2585 2585  
2586 -\\
2549 +
2587 2587  
2588 2588  (% class="western" %)
2589 2589  **Type: Transactions**
... ... @@ -2730,7 +2730,7 @@
2730 2730  If there is amount (USD) included in transaction.
2731 2731  )))
2732 2732  
2733 -\\
2696 +
2734 2734  
2735 2735  (% class="western" %)
2736 2736  **Type: Sources**
... ... @@ -2787,10 +2787,10 @@
2787 2787  If this is a child source then list the parent source id.
2788 2788  )))
2789 2789  
2790 -\\
2753 +
2791 2791  
2792 2792  (% class="western" %)
2793 -\\
2756 +
2794 2794  
2795 2795  (% class="western" %)
2796 2796  **Type: Products**
... ... @@ -2847,7 +2847,7 @@
2847 2847  (Array of) Terms associated with the product.
2848 2848  )))
2849 2849  
2850 -\\
2813 +
2851 2851  
2852 2852  (% class="western" %)
2853 2853  **Type: Terms**
... ... @@ -2934,7 +2934,7 @@
2934 2934  If there is price (USD) for the term.
2935 2935  )))
2936 2936  
2937 -\\
2900 +
2938 2938  
2939 2939  (% class="western" %)
2940 2940  **Type: Resources**
... ... @@ -3045,7 +3045,7 @@
3045 3045  Int
3046 3046  )))|(((
3047 3047  (% class="western" %)
3048 -Default limit is 25 but if all the data needs to be pulled then pass limit=0.
3011 +Default limit is 25 but all the data needs to be pulled then pass limit=0.
3049 3049  )))
3050 3050  |(% colspan="1" %)(% colspan="1" %)
3051 3051  (((
... ... @@ -3058,7 +3058,7 @@
3058 3058  Default value is 0. This parameter is used to provide access to protected content.
3059 3059  )))
3060 3060  
3061 -\\
3024 +
3062 3062  
3063 3063  (% class="western" %)
3064 3064  **Type: Telemarketing**
... ... @@ -3148,12 +3148,8 @@
3148 3148  Page title that belongs to the page url that is being sent. If not provided it try to pull the title from the page but if unsuccessful then it will set it as blank.
3149 3149  
3150 3150  (% class="western" %)
3151 -\\
3114 +
3152 3152  
3153 3153  (% class="western" %)
3154 3154  If the page url already exists and it doesn't match with the one that is being sent then it will throw conflict error with the title in our system.
3155 3155  )))
3156 -
3157 -\\
3158 -
3159 -\\
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -108691457
1 +4882506
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/108691457/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/4882506/ONEcount API Documentation