Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 6.1
edited by rayaan@one-count_com
on 2023/12/12 08:01
Change comment: There is no comment for this version
To version 4.1
edited by rayaan@one-count_com
on 2023/12/12 07:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -115,7 +115,7 @@
115 115  (% class="western" %)
116 116  API will output the response in a JSON format discussed below.
117 117  
118 -{{code language="yml" theme="RDark" title="Response"}}
118 +{{code language="yml" theme="RDark" title="Response" collapse="true"}}
119 119  {
120 120   "result": {
121 121   "success": "1",
... ... @@ -335,7 +335,7 @@
335 335  
336 336  (% style="color: rgb(107,107,107);" %)Request
337 337  
338 -{{code language="php" theme="RDark" title="Get All Users Request"}}
338 +{{code language="php" theme="RDark" title="Get All Users Request" collapse="true"}}
339 339  <?php
340 340  
341 341  $curl = curl_init();
... ... @@ -364,7 +364,7 @@
364 364  
365 365  \\
366 366  
367 -(% style="color: rgb(107,107,107);" %)Response  200 OK
367 +(% style="color: rgb(107,107,107);" %)Response  200 OK
368 368  
369 369  {{code language="yml" theme="RDark" title="Get All Users Response" collapse="true"}}
370 370  {
... ... @@ -875,7 +875,7 @@
875 875  
876 876  (% style="color: rgb(107,107,107);" %)Request
877 877  
878 -{{code language="php" theme="RDark" title="Get specific User Request"}}
878 +{{code language="php" theme="RDark" title="Get specific User Request" collapse="true"}}
879 879  <?php
880 880  
881 881  $curl = curl_init();
... ... @@ -902,7 +902,7 @@
902 902  
903 903  \\
904 904  
905 -(% style="color: rgb(107,107,107);" %)Response  200 OK
905 +(% style="color: rgb(107,107,107);" %)Response  200 OK
906 906  
907 907  {{code language="yml" theme="RDark" title="Get specific user Response" collapse="true"}}
908 908  {
... ... @@ -973,7 +973,7 @@
973 973  
974 974  ----
975 975  
976 -{{code language="yml" theme="RDark" title="Body"}}
976 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
977 977  {"e":"rayaan@one-count.com","p":"12345"}
978 978  {{/code}}
979 979  
... ... @@ -983,7 +983,7 @@
983 983  
984 984  (% style="color: rgb(107,107,107);" %)Request
985 985  
986 -{{code language="php" theme="RDark" title="User login Request"}}
986 +{{code language="php" theme="RDark" title="User login Request" collapse="true"}}
987 987  <?php
988 988  
989 989  $curl = curl_init();
... ... @@ -1011,7 +1011,7 @@
1011 1011  
1012 1012  \\
1013 1013  
1014 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1014 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1015 1015  
1016 1016  {{code language="yml" theme="RDark" title="Login user Response" collapse="true"}}
1017 1017  {
... ... @@ -1058,7 +1058,7 @@
1058 1058  
1059 1059  (% style="color: rgb(107,107,107);" %)Request
1060 1060  
1061 -{{code language="php" theme="RDark" title="Lookup user Request"}}
1061 +{{code language="php" theme="RDark" title="Lookup user Request" collapse="true"}}
1062 1062  <?php
1063 1063  
1064 1064  $curl = curl_init();
... ... @@ -1085,7 +1085,7 @@
1085 1085  
1086 1086  \\
1087 1087  
1088 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1088 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1089 1089  
1090 1090  {{code language="yml" theme="RDark" title="Lookup user Response" collapse="true"}}
1091 1091  {
... ... @@ -1246,7 +1246,7 @@
1246 1246  
1247 1247  ----
1248 1248  
1249 -{{code language="yml" theme="RDark" title="Body"}}
1249 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
1250 1250  {"Users":{"PartnerId":1,"Demo":{"1":"testApirayaan7@onecount.net","4":"Rayaan","5":"Ahmed"}},"DedupeColumns":"1","Transactions":[]}
1251 1251  {{/code}}
1252 1252  
... ... @@ -1256,7 +1256,7 @@
1256 1256  
1257 1257  (% style="color: rgb(107,107,107);" %)Request
1258 1258  
1259 -{{code language="php" theme="RDark" title="Create User Request"}}
1259 +{{code language="php" theme="RDark" title="Create User Request" collapse="true"}}
1260 1260  <?php
1261 1261  
1262 1262  $curl = curl_init();
... ... @@ -1284,7 +1284,7 @@
1284 1284  
1285 1285  \\
1286 1286  
1287 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1287 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1288 1288  
1289 1289  {{code language="yml" theme="RDark" title="Create user Response" collapse="true"}}
1290 1290  {
... ... @@ -1410,7 +1410,7 @@
1410 1410  
1411 1411  ----
1412 1412  
1413 -{{code language="yml" theme="RDark" title="Body"}}
1413 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
1414 1414  {"Users":{"Demo":{"6":"title1"}}}
1415 1415  {{/code}}
1416 1416  
... ... @@ -1420,7 +1420,7 @@
1420 1420  
1421 1421  (% style="color: rgb(107,107,107);" %)Request
1422 1422  
1423 -{{code language="php" theme="RDark" title="Update User Request"}}
1423 +{{code language="php" theme="RDark" title="Update User Request" collapse="true"}}
1424 1424  <?php
1425 1425  
1426 1426  $curl = curl_init();
... ... @@ -1450,7 +1450,7 @@
1450 1450  
1451 1451  \\
1452 1452  
1453 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1453 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1454 1454  
1455 1455  {{code language="yml" theme="RDark" title="Update user Response" collapse="true"}}
1456 1456  {
... ... @@ -1474,7 +1474,7 @@
1474 1474  \\
1475 1475  
1476 1476  (% class="western" %)
1477 -=== **COMPONENT: Questions** ===
1477 +**COMPONENT: Questions**
1478 1478  
1479 1479  (% class="western" %)
1480 1480  All data fields in ONEcount are made up of questions. Questions are configurable on a per-client basis, and no two customer installations will have the same question (ie., field) layout. Therefore, before querying or updating any ONEcount installation, you'll need to get an understanding of the question layout of the installation. This API segment will allow you to query ONEcount to determine the question layout for the installation. It will also allow you to create new questions within the system. This resource does not allow you to update the data for a specific user (see User section).
... ... @@ -1664,7 +1664,7 @@
1664 1664  
1665 1665  (% style="color: rgb(107,107,107);" %)Request
1666 1666  
1667 -{{code language="php" theme="RDark" title="Get All Questions Request"}}
1667 +{{code language="php" theme="RDark" title="Get All Questions Request" collapse="true"}}
1668 1668  <?php
1669 1669  
1670 1670  $curl = curl_init();
... ... @@ -1694,7 +1694,7 @@
1694 1694  
1695 1695  \\
1696 1696  
1697 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1697 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1698 1698  
1699 1699  {{code language="yml" theme="RDark" title="Get All Questions Response" collapse="true"}}
1700 1700  {
... ... @@ -3805,7 +3805,7 @@
3805 3805  
3806 3806  (% style="color: rgb(107,107,107);" %)Request
3807 3807  
3808 -{{code language="php" theme="RDark" title="Get specific Question Request"}}
3808 +{{code language="php" theme="RDark" title="Get specific Question Request" collapse="true"}}
3809 3809  <?php
3810 3810  
3811 3811  $curl = curl_init();
... ... @@ -3832,7 +3832,7 @@
3832 3832  
3833 3833  \\
3834 3834  
3835 -(% style="color: rgb(107,107,107);" %)Response  200 OK
3835 +(% style="color: rgb(107,107,107);" %)Response  200 OK
3836 3836  
3837 3837  {{code language="yml" theme="RDark" title="Get specific question Response" collapse="true"}}
3838 3838  {
... ... @@ -3884,7 +3884,7 @@
3884 3884  
3885 3885  (% style="color: rgb(107,107,107);" %)Request
3886 3886  
3887 -{{code language="php" theme="RDark" title="Lookup question by text Request"}}
3887 +{{code language="php" theme="RDark" title="Lookup question by text Request" collapse="true"}}
3888 3888  <?php
3889 3889  
3890 3890  $curl = curl_init();
... ... @@ -3911,7 +3911,7 @@
3911 3911  
3912 3912  \\
3913 3913  
3914 -(% style="color: rgb(107,107,107);" %)Response  200 OK
3914 +(% style="color: rgb(107,107,107);" %)Response  200 OK
3915 3915  
3916 3916  {{code language="yml" theme="RDark" title="Lookup question by title Response" collapse="true"}}
3917 3917  {
... ... @@ -5330,7 +5330,7 @@
5330 5330  
5331 5331  (% style="color: rgb(107,107,107);" %)Request
5332 5332  
5333 -{{code language="php" theme="RDark" title="Lookup question by Type Request"}}
5333 +{{code language="php" theme="RDark" title="Lookup question by Type Request" collapse="true"}}
5334 5334  <?php
5335 5335  
5336 5336  $curl = curl_init();
... ... @@ -5357,7 +5357,7 @@
5357 5357  
5358 5358  \\
5359 5359  
5360 -(% style="color: rgb(107,107,107);" %)Response  200 OK
5360 +(% style="color: rgb(107,107,107);" %)Response  200 OK
5361 5361  
5362 5362  {{code language="yml" theme="RDark" title="Lookup question by type Response" collapse="true"}}
5363 5363  {
... ... @@ -8027,7 +8027,7 @@
8027 8027  
8028 8028  ----
8029 8029  
8030 -{{code language="yml" theme="RDark" title="Body"}}
8030 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8031 8031  {"Text":"Test from API 3","Type":0,"Alias":"Test from API 3"}
8032 8032  {{/code}}
8033 8033  
... ... @@ -8037,7 +8037,7 @@
8037 8037  
8038 8038  (% style="color: rgb(107,107,107);" %)Request
8039 8039  
8040 -{{code language="php" theme="RDark" title="Create Question Request"}}
8040 +{{code language="php" theme="RDark" title="Create Question Request" collapse="true"}}
8041 8041  <?php
8042 8042  
8043 8043  $curl = curl_init();
... ... @@ -8065,7 +8065,7 @@
8065 8065  
8066 8066  \\
8067 8067  
8068 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8068 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8069 8069  
8070 8070  {{code language="yml" theme="RDark" title="Create question Response" collapse="true"}}
8071 8071  {
... ... @@ -8105,7 +8105,7 @@
8105 8105  
8106 8106  ----
8107 8107  
8108 -{{code language="yml" theme="RDark" title="Body"}}
8108 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8109 8109  {"Text":"Test from API 6","Type":4,"Alias":"Test from API 6", "Choices":[{"Text":"test 1","Value":"test 1"},{"Text":"test 2","Value":"test 2"}]}
8110 8110  {{/code}}
8111 8111  
... ... @@ -8115,7 +8115,7 @@
8115 8115  
8116 8116  (% style="color: rgb(107,107,107);" %)Request
8117 8117  
8118 -{{code language="php" theme="RDark" title="Create Question Request"}}
8118 +{{code language="php" theme="RDark" title="Create Question Request" collapse="true"}}
8119 8119  <?php
8120 8120  
8121 8121  $curl = curl_init();
... ... @@ -8143,7 +8143,7 @@
8143 8143  
8144 8144  \\
8145 8145  
8146 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8146 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8147 8147  
8148 8148  {{code language="yml" theme="RDark" title="Create question Response" collapse="true"}}
8149 8149  {
... ... @@ -8183,7 +8183,7 @@
8183 8183  
8184 8184  ----
8185 8185  
8186 -{{code language="yml" theme="RDark" title="Body"}}
8186 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8187 8187  {"Text":"Test from API 6 changed","Type":4,"Alias":"Test from API 6 changed", "Choices":[{"Text":"test 1","Value":"test 1"},{"Text":"test 2","Value":"test 2"}]}
8188 8188  {{/code}}
8189 8189  
... ... @@ -8193,7 +8193,7 @@
8193 8193  
8194 8194  (% style="color: rgb(107,107,107);" %)Request
8195 8195  
8196 -{{code language="php" theme="RDark" title="Update Question Request"}}
8196 +{{code language="php" theme="RDark" title="Update Question Request" collapse="true"}}
8197 8197  <?php
8198 8198  
8199 8199  $curl = curl_init();
... ... @@ -8223,7 +8223,7 @@
8223 8223  
8224 8224  \\
8225 8225  
8226 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8226 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8227 8227  
8228 8228  {{code language="yml" theme="RDark" title="Update Question Response" collapse="true"}}
8229 8229  {
... ... @@ -8246,7 +8246,7 @@
8246 8246  \\
8247 8247  
8248 8248  (% class="western" %)
8249 -=== **COMPONENT: Products** ===
8249 +**COMPONENT: Products**
8250 8250  
8251 8251  (% class="western" %)
8252 8252  This resource is for manipulating products resource. A product can be created, updated or searched.
... ... @@ -8378,7 +8378,7 @@
8378 8378  
8379 8379  (% style="color: rgb(107,107,107);" %)Request
8380 8380  
8381 -{{code language="php" theme="RDark" title="Get All Products Request"}}
8381 +{{code language="php" theme="RDark" title="Get All Products Request" collapse="true"}}
8382 8382  <?php
8383 8383  
8384 8384  $curl = curl_init();
... ... @@ -8407,7 +8407,7 @@
8407 8407  
8408 8408  \\
8409 8409  
8410 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8410 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8411 8411  
8412 8412  {{code language="yml" theme="RDark" title="Get All Products Response" collapse="true"}}
8413 8413   {
... ... @@ -8666,7 +8666,7 @@
8666 8666  
8667 8667  (% style="color: rgb(107,107,107);" %)Request
8668 8668  
8669 -{{code language="php" theme="RDark" title="Get specific Product Request"}}
8669 +{{code language="php" theme="RDark" title="Get specific Product Request" collapse="true"}}
8670 8670   <?php
8671 8671  
8672 8672  $curl = curl_init();
... ... @@ -8693,7 +8693,7 @@
8693 8693  
8694 8694  \\
8695 8695  
8696 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8696 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8697 8697  
8698 8698  {{code language="yml" theme="RDark" title="Get specific Product Response" collapse="true"}}
8699 8699   {
... ... @@ -8756,7 +8756,7 @@
8756 8756  
8757 8757  (% style="color: rgb(107,107,107);" %)Request
8758 8758  
8759 -{{code language="php" theme="RDark" title="Lookup Product Request"}}
8759 +{{code language="php" theme="RDark" title="Lookup Product Request" collapse="true"}}
8760 8760   <?php
8761 8761  
8762 8762  $curl = curl_init();
... ... @@ -8783,7 +8783,7 @@
8783 8783  
8784 8784  \\
8785 8785  
8786 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8786 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8787 8787  
8788 8788  {{code language="yml" theme="RDark" title="Lookup Product Response" collapse="true"}}
8789 8789   {
... ... @@ -8834,7 +8834,7 @@
8834 8834  
8835 8835  ----
8836 8836  
8837 -{{code language="yml" theme="RDark" title="Body"}}
8837 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8838 8838  {"Title":"Test API package creation 2","Description": "Test API package creation 2","Terms":{"Name":"Test term for API 2"},"PrimaryFormId":0}
8839 8839  {{/code}}
8840 8840  
... ... @@ -8844,7 +8844,7 @@
8844 8844  
8845 8845  (% style="color: rgb(107,107,107);" %)Request
8846 8846  
8847 -{{code language="php" theme="RDark" title="Create Product Request"}}
8847 +{{code language="php" theme="RDark" title="Create Product Request" collapse="true"}}
8848 8848   <?php
8849 8849  
8850 8850  $curl = curl_init();
... ... @@ -8872,7 +8872,7 @@
8872 8872  
8873 8873  \\
8874 8874  
8875 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8875 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8876 8876  
8877 8877  {{code language="yml" theme="RDark" title="Create Product Response" collapse="true"}}
8878 8878   {
... ... @@ -8912,7 +8912,7 @@
8912 8912  
8913 8913  ----
8914 8914  
8915 -{{code language="yml" theme="RDark" title="Body"}}
8915 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8916 8916  {"Title":"Test API package 23","Description": "Test API package 23","PrimaryFormId":0}
8917 8917  {{/code}}
8918 8918  
... ... @@ -8922,7 +8922,7 @@
8922 8922  
8923 8923  (% style="color: rgb(107,107,107);" %)Request
8924 8924  
8925 -{{code language="php" theme="RDark" title="Update Product Request"}}
8925 +{{code language="php" theme="RDark" title="Update Product Request" collapse="true"}}
8926 8926  <?php
8927 8927  
8928 8928  $curl = curl_init();
... ... @@ -8951,7 +8951,7 @@
8951 8951  
8952 8952  \\
8953 8953  
8954 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8954 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8955 8955  
8956 8956  {{code language="yml" theme="RDark" title="Update Product Response" collapse="true"}}
8957 8957   {
... ... @@ -8974,80 +8974,8 @@
8974 8974  
8975 8975  \\
8976 8976  
8977 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
8978 -== (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Attach Resource to Product(%%) ==
8979 -
8980 -----
8981 -
8982 -{{panel bgColor="#D3D3D3" width="100%"}}
8983 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/products/attachResource
8984 -{{/panel}}
8985 -
8986 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
8987 -
8988 -----
8989 -
8990 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
8991 -
8992 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
8993 -
8994 -----
8995 -
8996 -{{code language="yml" theme="RDark" title="Body"}}
8997 -{"ProductID":"599","ResourceID":"903"}
8998 -{{/code}}
8999 -
9000 -==== Example ====
9001 -
9002 -----
9003 -
9004 -(% style="color: rgb(107,107,107);" %)Request
9005 -
9006 -{{code language="php" theme="RDark" title="Attach Resource to Product Request"}}
9007 - <?php
9008 -
9009 -$curl = curl_init();
9010 -
9011 -curl_setopt_array($curl, array(
9012 - CURLOPT_URL => 'https://api.onecount.net/v2/products/attachResource',
9013 - CURLOPT_RETURNTRANSFER => true,
9014 - CURLOPT_ENCODING => '',
9015 - CURLOPT_MAXREDIRS => 10,
9016 - CURLOPT_TIMEOUT => 0,
9017 - CURLOPT_FOLLOWLOCATION => true,
9018 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
9019 - CURLOPT_CUSTOMREQUEST => 'POST',
9020 - CURLOPT_POSTFIELDS =>'{"ProductID":"599","ResourceID":"903"}',
9021 - CURLOPT_HTTPHEADER => array(
9022 - 'Appkey: {{ONECOUNT API KEY}}'
9023 - ),
9024 -));
9025 -
9026 -$response = curl_exec($curl);
9027 -
9028 -curl_close($curl);
9029 -echo $response;
9030 -{{/code}}
9031 -
9032 -\\
9033 -
9034 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9035 -
9036 -{{code language="yml" theme="RDark" title="Create Product Response" collapse="true"}}
9037 - {
9038 - "result": {
9039 - "success": "1",
9040 - "error": {
9041 - "code": "",
9042 - "message": ""
9043 - }
9044 - },
9045 - "Products": "599"
9046 -}
9047 -{{/code}}
9048 -
9049 9049  (% class="western" %)
9050 -=== **COMPONENT: Terms** ===
8978 +**COMPONENT: Terms**
9051 9051  
9052 9052  (% class="western" %)
9053 9053  This resource is for manipulating terms resource. A term can be created, updated or searched.
... ... @@ -9144,7 +9144,7 @@
9144 9144  
9145 9145  (% style="color: rgb(107,107,107);" %)Request
9146 9146  
9147 -{{code language="php" theme="RDark" title="Get All Terms Request"}}
9075 +{{code language="php" theme="RDark" title="Get All Terms Request" collapse="true"}}
9148 9148   <?php
9149 9149  
9150 9150  $curl = curl_init();
... ... @@ -9171,7 +9171,7 @@
9171 9171  
9172 9172  \\
9173 9173  
9174 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9102 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9175 9175  
9176 9176  {{code language="yml" theme="RDark" title="Get All Terms Response" collapse="true"}}
9177 9177   {
... ... @@ -9327,7 +9327,7 @@
9327 9327  
9328 9328  (% style="color: rgb(107,107,107);" %)Request
9329 9329  
9330 -{{code language="php" theme="RDark" title="Get specific Term Request"}}
9258 +{{code language="php" theme="RDark" title="Get specific Term Request" collapse="true"}}
9331 9331   <?php
9332 9332  
9333 9333  $curl = curl_init();
... ... @@ -9354,7 +9354,7 @@
9354 9354  
9355 9355  \\
9356 9356  
9357 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9285 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9358 9358  
9359 9359  {{code language="yml" theme="RDark" title="Get specific Term Response" collapse="true"}}
9360 9360   {
... ... @@ -9408,7 +9408,7 @@
9408 9408  
9409 9409  (% style="color: rgb(107,107,107);" %)Request
9410 9410  
9411 -{{code language="php" theme="RDark" title="Lookup Term Request"}}
9339 +{{code language="php" theme="RDark" title="Lookup Term Request" collapse="true"}}
9412 9412   <?php
9413 9413  
9414 9414  $curl = curl_init();
... ... @@ -9435,7 +9435,7 @@
9435 9435  
9436 9436  \\
9437 9437  
9438 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9366 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9439 9439  
9440 9440  {{code language="yml" theme="RDark" title="Lookup Term Response" collapse="true"}}
9441 9441  {
... ... @@ -9481,7 +9481,7 @@
9481 9481  
9482 9482  ----
9483 9483  
9484 -{{code language="yml" theme="RDark" title="Body"}}
9412 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
9485 9485  {"Name":"Test API term creation","Description":"Test API term creation","Duration":10,"ProductId":599}
9486 9486  {{/code}}
9487 9487  
... ... @@ -9491,7 +9491,7 @@
9491 9491  
9492 9492  (% style="color: rgb(107,107,107);" %)Request
9493 9493  
9494 -{{code language="php" theme="RDark" title="Create Term Request"}}
9422 +{{code language="php" theme="RDark" title="Create Term Request" collapse="true"}}
9495 9495  <?php
9496 9496  
9497 9497  $curl = curl_init();
... ... @@ -9523,7 +9523,7 @@
9523 9523  
9524 9524  \\
9525 9525  
9526 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9454 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9527 9527  
9528 9528  {{code language="yml" theme="RDark" title="Create Term Response" collapse="true"}}
9529 9529  {
... ... @@ -9563,7 +9563,7 @@
9563 9563  
9564 9564  ----
9565 9565  
9566 -{{code language="yml" theme="RDark" title="Body"}}
9494 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
9567 9567  {"Name":"Test API term creation update","Description":"Test API term creation update","Duration":10,"ProductId":599}
9568 9568  {{/code}}
9569 9569  
... ... @@ -9573,7 +9573,7 @@
9573 9573  
9574 9574  (% style="color: rgb(107,107,107);" %)Request
9575 9575  
9576 -{{code language="php" theme="RDark" title="Update Term Request"}}
9504 +{{code language="php" theme="RDark" title="Update Term Request" collapse="true"}}
9577 9577   <?php
9578 9578  
9579 9579  $curl = curl_init();
... ... @@ -9601,7 +9601,7 @@
9601 9601  
9602 9602  \\
9603 9603  
9604 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9532 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9605 9605  
9606 9606  {{code language="yml" theme="RDark" title="Update Term Response" collapse="true"}}
9607 9607   {
... ... @@ -9629,7 +9629,7 @@
9629 9629  \\
9630 9630  
9631 9631  (% class="western" %)
9632 -=== **COMPONENT: Resources** ===
9560 +**COMPONENT: Resources**
9633 9633  
9634 9634  (% class="western" %)
9635 9635  Resources are the available entities that can be accessed/modified via API. Each resource can be created, updated or requested by using the corresponding http method described above.
... ... @@ -9761,7 +9761,7 @@
9761 9761  
9762 9762  (% style="color: rgb(107,107,107);" %)Request
9763 9763  
9764 -{{code language="php" theme="RDark" title="Get All Resource Request"}}
9692 +{{code language="php" theme="RDark" title="Get All Resource Request" collapse="true"}}
9765 9765   <?php
9766 9766  
9767 9767  $curl = curl_init();
... ... @@ -9788,7 +9788,7 @@
9788 9788  
9789 9789  \\
9790 9790  
9791 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9719 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9792 9792  
9793 9793  {{code language="yml" theme="RDark" title="Get All Resource Response" collapse="true"}}
9794 9794   {
... ... @@ -9907,7 +9907,7 @@
9907 9907  
9908 9908  (% style="color: rgb(107,107,107);" %)Request
9909 9909  
9910 -{{code language="php" theme="RDark" title="Get specific Resource Request"}}
9838 +{{code language="php" theme="RDark" title="Get specific Resource Request" collapse="true"}}
9911 9911   <?php
9912 9912  
9913 9913  $curl = curl_init();
... ... @@ -9934,7 +9934,7 @@
9934 9934  
9935 9935  \\
9936 9936  
9937 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9865 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9938 9938  
9939 9939  {{code language="yml" theme="RDark" title="Get specific Resource Response" collapse="true"}}
9940 9940   {
... ... @@ -9987,7 +9987,7 @@
9987 9987  
9988 9988  (% style="color: rgb(107,107,107);" %)Request
9989 9989  
9990 -{{code language="php" theme="RDark" title="Lookup Resource Request"}}
9918 +{{code language="php" theme="RDark" title="Lookup Resource Request" collapse="true"}}
9991 9991   <?php
9992 9992  
9993 9993  $curl = curl_init();
... ... @@ -10014,7 +10014,7 @@
10014 10014  
10015 10015  \\
10016 10016  
10017 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9945 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10018 10018  
10019 10019  {{code language="yml" theme="RDark" title="Lookup Resource Response" collapse="true"}}
10020 10020   {
... ... @@ -10059,7 +10059,7 @@
10059 10059  
10060 10060  ----
10061 10061  
10062 -{{code language="yml" theme="RDark" title="Body"}}
9990 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10063 10063  {"Name":"Test API product creation 22","Description":"Test API product creation 22","Type":3,"FreePass":1,"Value":["http://one-count.com"],"Gating":false,"Price":0,"PrimaryFormId":"","VendorId":1}
10064 10064  {{/code}}
10065 10065  
... ... @@ -10069,7 +10069,7 @@
10069 10069  
10070 10070  (% style="color: rgb(107,107,107);" %)Request
10071 10071  
10072 -{{code language="php" theme="RDark" title="Create Resource Request"}}
10000 +{{code language="php" theme="RDark" title="Create Resource Request" collapse="true"}}
10073 10073   <?php
10074 10074  
10075 10075  $curl = curl_init();
... ... @@ -10097,7 +10097,7 @@
10097 10097  
10098 10098  \\
10099 10099  
10100 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10028 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10101 10101  
10102 10102  {{code language="yml" theme="RDark" title="Create Resource Response" collapse="true"}}
10103 10103   {
... ... @@ -10142,7 +10142,7 @@
10142 10142  
10143 10143  ----
10144 10144  
10145 -{{code language="yml" theme="RDark" title="Body"}}
10073 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10146 10146  {"Name":"Test API product creation 23","Description":"Test API product creation 23","Type":3,"FreePass":1,"Value":["http://one-count.com","onecount.net"],"Gating":false,"Price":0,"PrimaryFormId":"","VendorId":1}
10147 10147  {{/code}}
10148 10148  
... ... @@ -10152,7 +10152,7 @@
10152 10152  
10153 10153  (% style="color: rgb(107,107,107);" %)Request
10154 10154  
10155 -{{code language="php" theme="RDark" title="Update Resource Request"}}
10083 +{{code language="php" theme="RDark" title="Update Resource Request" collapse="true"}}
10156 10156   <?php
10157 10157  
10158 10158  $curl = curl_init();
... ... @@ -10180,7 +10180,7 @@
10180 10180  
10181 10181  \\
10182 10182  
10183 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10111 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10184 10184  
10185 10185  {{code language="yml" theme="RDark" title="Update Resource Response" collapse="true"}}
10186 10186   {
... ... @@ -10216,8 +10216,8 @@
10216 10216  \\
10217 10217  
10218 10218  (% class="western" %)
10219 -=== **COMPONENT: Source Codes
10220 -** ===
10147 +**COMPONENT: Source Codes
10148 +**
10221 10221  
10222 10222  (% class="western" %)
10223 10223  This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
... ... @@ -10314,7 +10314,7 @@
10314 10314  
10315 10315  (% style="color: rgb(107,107,107);" %)Request
10316 10316  
10317 -{{code language="php" theme="RDark" title="Get All Source code Request"}}
10245 +{{code language="php" theme="RDark" title="Get All Source code Request" collapse="true"}}
10318 10318   <?php
10319 10319  
10320 10320  $curl = curl_init();
... ... @@ -10341,7 +10341,7 @@
10341 10341  
10342 10342  \\
10343 10343  
10344 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10272 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10345 10345  
10346 10346  {{code language="yml" theme="RDark" title="Get All Source code Response" collapse="true"}}
10347 10347   {
... ... @@ -10530,7 +10530,7 @@
10530 10530  
10531 10531  (% style="color: rgb(107,107,107);" %)Request
10532 10532  
10533 -{{code language="php" theme="RDark" title="Get specific Source Request"}}
10461 +{{code language="php" theme="RDark" title="Get specific Source Request" collapse="true"}}
10534 10534   <?php
10535 10535  
10536 10536  $curl = curl_init();
... ... @@ -10557,7 +10557,7 @@
10557 10557  
10558 10558  \\
10559 10559  
10560 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10488 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10561 10561  
10562 10562  {{code language="yml" theme="RDark" title="Get specific Source Response" collapse="true"}}
10563 10563   {
... ... @@ -10608,7 +10608,7 @@
10608 10608  
10609 10609  (% style="color: rgb(107,107,107);" %)Request
10610 10610  
10611 -{{code language="php" theme="RDark" title="Lookup Source code Request"}}
10539 +{{code language="php" theme="RDark" title="Lookup Source code Request" collapse="true"}}
10612 10612   <?php
10613 10613  
10614 10614  $curl = curl_init();
... ... @@ -10635,7 +10635,7 @@
10635 10635  
10636 10636  \\
10637 10637  
10638 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10566 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10639 10639  
10640 10640  {{code language="yml" theme="RDark" title="Lookup Source code Response" collapse="true"}}
10641 10641   {
... ... @@ -10678,7 +10678,7 @@
10678 10678  
10679 10679  ----
10680 10680  
10681 -{{code language="yml" theme="RDark" title="Body"}}
10609 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10682 10682  {"Source":"Test source code from API"}
10683 10683  {{/code}}
10684 10684  
... ... @@ -10688,7 +10688,7 @@
10688 10688  
10689 10689  (% style="color: rgb(107,107,107);" %)Request
10690 10690  
10691 -{{code language="php" theme="RDark" title="Create Source code Request"}}
10619 +{{code language="php" theme="RDark" title="Create Source code Request" collapse="true"}}
10692 10692   <?php
10693 10693  
10694 10694  $curl = curl_init();
... ... @@ -10716,7 +10716,7 @@
10716 10716  
10717 10717  \\
10718 10718  
10719 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10647 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10720 10720  
10721 10721  {{code language="yml" theme="RDark" title="Create Source code Response" collapse="true"}}
10722 10722   {
... ... @@ -10759,7 +10759,7 @@
10759 10759  
10760 10760  ----
10761 10761  
10762 -{{code language="yml" theme="RDark" title="Body"}}
10690 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10763 10763  {"Source":"Test API","Parent":215}
10764 10764  {{/code}}
10765 10765  
... ... @@ -10769,7 +10769,7 @@
10769 10769  
10770 10770  (% style="color: rgb(107,107,107);" %)Request
10771 10771  
10772 -{{code language="php" theme="RDark" title="Update Source code Request"}}
10700 +{{code language="php" theme="RDark" title="Update Source code Request" collapse="true"}}
10773 10773   <?php
10774 10774  
10775 10775  $curl = curl_init();
... ... @@ -10797,7 +10797,7 @@
10797 10797  
10798 10798  \\
10799 10799  
10800 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10728 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10801 10801  
10802 10802  {{code language="yml" theme="RDark" title="Update Source code Response" collapse="true"}}
10803 10803   {
... ... @@ -10823,7 +10823,7 @@
10823 10823  \\
10824 10824  
10825 10825  (% class="western" %)
10826 -=== **COMPONENT: Transactions** ===
10754 +**COMPONENT: Transactions**
10827 10827  
10828 10828  (% class="western" %)
10829 10829  This resource is for manipulating transactions resource. A transaction can be created or searched.
... ... @@ -10907,7 +10907,7 @@
10907 10907  
10908 10908  (% style="color: rgb(107,107,107);" %)Request
10909 10909  
10910 -{{code language="php" theme="RDark" title="Get All Transaction Request"}}
10838 +{{code language="php" theme="RDark" title="Get All Transaction Request" collapse="true"}}
10911 10911   <?php
10912 10912  
10913 10913  $curl = curl_init();
... ... @@ -10934,7 +10934,7 @@
10934 10934  
10935 10935  \\
10936 10936  
10937 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10865 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10938 10938  
10939 10939  {{code language="yml" theme="RDark" title="Get All Transaction Response" collapse="true"}}
10940 10940   {
... ... @@ -12473,7 +12473,7 @@
12473 12473  
12474 12474  (% style="color: rgb(107,107,107);" %)Request
12475 12475  
12476 -{{code language="php" theme="RDark" title="Get specific Transaction Request"}}
12404 +{{code language="php" theme="RDark" title="Get specific Transaction Request" collapse="true"}}
12477 12477   <?php
12478 12478  
12479 12479  $curl = curl_init();
... ... @@ -12500,7 +12500,7 @@
12500 12500  
12501 12501  \\
12502 12502  
12503 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12431 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12504 12504  
12505 12505  {{code language="yml" theme="RDark" title="Get specific Transaction Response" collapse="true"}}
12506 12506   {
... ... @@ -12560,7 +12560,7 @@
12560 12560  
12561 12561  (% style="color: rgb(107,107,107);" %)Request
12562 12562  
12563 -{{code language="php" theme="RDark" title="Lookup Transaction Request"}}
12491 +{{code language="php" theme="RDark" title="Lookup Transaction Request" collapse="true"}}
12564 12564   <?php
12565 12565  
12566 12566  $curl = curl_init();
... ... @@ -12587,7 +12587,7 @@
12587 12587  
12588 12588  \\
12589 12589  
12590 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12518 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12591 12591  
12592 12592  {{code language="yml" theme="RDark" title="Lookup Transaction Response" collapse="true"}}
12593 12593   {
... ... @@ -12815,7 +12815,7 @@
12815 12815  
12816 12816  ----
12817 12817  
12818 -{{code language="yml" theme="RDark" title="Body"}}
12746 +{{code language="yml" theme="RDark" title="Body" collapse="true"}}
12819 12819  {"UserId": 1845775,"TermId":447 ,"UserIP":"192.168.0.1" ,"SubscriptionType":"n" , "ProductId":599 ,"FormId": "8f93834c-adce-4dc7-acd0-f3a1e0f7c63f","Source": 83,"ProductStatus": 2,"Amount":"0.00" ,"PaypalTransId":"" , "MediaFilePath":"" ,"Remarks": "USER SUBSCRIBED","BatchId":"1234" ,"Quantity": 1, "ExpireDate":"20251211" }
12820 12820  {{/code}}
12821 12821  
... ... @@ -12825,7 +12825,7 @@
12825 12825  
12826 12826  (% style="color: rgb(107,107,107);" %)Request
12827 12827  
12828 -{{code language="php" theme="RDark" title="Create Transaction Request"}}
12756 +{{code language="php" theme="RDark" title="Create Transaction Request" collapse="true"}}
12829 12829   <?php
12830 12830  
12831 12831  $curl = curl_init();
... ... @@ -12853,7 +12853,7 @@
12853 12853  
12854 12854  \\
12855 12855  
12856 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12784 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12857 12857  
12858 12858  {{code language="yml" theme="RDark" title="Create Transaction Response" collapse="true"}}
12859 12859   {
... ... @@ -12884,397 +12884,57 @@
12884 12884  
12885 12885  \\
12886 12886  
12887 -=== **COMPONENT: Engagements** ===
12815 +\\
12888 12888  
12889 -(% class="western" %)
12890 -Engagement can be added, updated and searched for using the engagements resource from the api.
12817 +\\
12891 12891  
12892 -(% class="western" %)
12893 12893  \\
12894 12894  
12895 -(% class="wrapped" %)
12896 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12897 -(((
12898 -(% class="western" %)
12899 -**Method**
12900 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12901 -(((
12902 -(% class="western" %)
12903 -**Url**
12904 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12905 -(((
12906 -(% class="western" %)
12907 -**Action**
12908 -)))
12909 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12910 -(((
12911 -(% class="western" %)
12912 -GET
12913 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12914 -(((
12915 -(% class="western" %)
12916 -/(% style="color: rgb(33,33,33);" %)engagements
12917 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12918 -(((
12919 -(% class="western" %)
12920 -Get engagement data limiting 25.
12921 -)))
12922 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12923 -(((
12924 -(% class="western" %)
12925 -GET
12926 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12927 -(((
12928 -(% class="western" %)
12929 -/(% style="color: rgb(33,33,33);" %)engagements(%%)/<engagement id>
12930 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12931 -(((
12932 -(% class="western" %)
12933 -Get data for engagement id. The engagement id is a string
12934 -)))
12935 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12936 -(((
12937 -(% class="western" %)
12938 -POST
12939 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12940 -(((
12941 -(% class="western" %)
12942 -/(% style="color: rgb(33,33,33);" %)engagements
12943 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12944 -(((
12945 -(% class="western" %)
12946 -Create a new engagement
12821 +\\
12947 12947  
12948 -(% class="western" %)
12949 -Parameters required to create the engagement needs to be sent as post data in JSON format.
12950 -)))
12951 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12952 -(((
12953 -(% class="western" %)
12954 -PUT
12955 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12956 -(((
12957 -(% class="western" %)
12958 -/(% style="color: rgb(33,33,33);" %)engagements(%%)/<engagement id>
12959 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12960 -(((
12961 -(% class="western" %)
12962 -Update engagement by engagement id. The engagement id string
12823 +\\
12963 12963  
12964 -(% class="western" %)
12965 -Parameters required to update the engagement needs to be sent as post data in JSON format.
12966 -)))
12967 -|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12968 -(((
12969 -(% class="western" %)
12970 -POST
12971 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12972 -(((
12973 -(% class="western" %)
12974 -(% style="color: rgb(33,33,33);" %)/engagements/addUser
12975 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12976 -(((
12977 -(% class="western" %)
12978 -Add user to engagement
12825 +\\
12979 12979  
12980 -(% class="western" %)
12981 -Parameters required to add user to the engagement needs to be sent as post data in JSON format.
12982 -)))
12827 +\\
12983 12983  
12984 12984  \\
12985 12985  
12986 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
12987 -== (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)All Engagements(%%) ==
12831 +\\
12988 12988  
12989 -----
12833 +\\
12990 12990  
12991 -----
12835 +\\
12992 12992  
12993 -{{panel bgColor="#D3D3D3" width="100%"}}
12994 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements
12995 -{{/panel}}
12837 +\\
12996 12996  
12997 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
12839 +\\
12998 12998  
12999 -----
12841 +\\
13000 13000  
13001 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
12843 +\\
13002 13002  
13003 -==== Example ====
12845 +\\
13004 13004  
13005 -----
12847 +\\
13006 13006  
13007 -(% style="color: rgb(107,107,107);" %)Request
12849 +\\
13008 13008  
13009 -{{code language="php" theme="RDark" title="Get All Engagement Request"}}
13010 -<?php
12851 +\\
13011 13011  
13012 -$curl = curl_init();
12853 +\\
13013 13013  
13014 -curl_setopt_array($curl, array(
13015 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements',
13016 - CURLOPT_RETURNTRANSFER => true,
13017 - CURLOPT_ENCODING => '',
13018 - CURLOPT_MAXREDIRS => 10,
13019 - CURLOPT_TIMEOUT => 0,
13020 - CURLOPT_FOLLOWLOCATION => true,
13021 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13022 - CURLOPT_CUSTOMREQUEST => 'GET',
13023 - CURLOPT_HTTPHEADER => array(
13024 - 'Appkey: {{ONECOUNT API KEY}}'
13025 - ),
13026 -));
13027 -
13028 -$response = curl_exec($curl);
13029 -
13030 -curl_close($curl);
13031 -echo $response;
13032 -
13033 -
13034 -{{/code}}
13035 -
13036 13036  \\
13037 13037  
13038 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13039 -== (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Specific Engagement(%%) ==
13040 -
13041 -----
13042 -
13043 -----
13044 -
13045 -{{panel bgColor="#D3D3D3" width="100%"}}
13046 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/~{~{Engagement ID}}
13047 -{{/panel}}
13048 -
13049 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13050 -
13051 -----
13052 -
13053 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13054 -
13055 -==== Example ====
13056 -
13057 -----
13058 -
13059 -(% style="color: rgb(107,107,107);" %)Request
13060 -
13061 -{{code language="php" theme="RDark" title="Get Specific Engagement Request"}}
13062 -<?php
13063 -
13064 -$curl = curl_init();
13065 -
13066 -curl_setopt_array($curl, array(
13067 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/{{Engagement ID}}',
13068 - CURLOPT_RETURNTRANSFER => true,
13069 - CURLOPT_ENCODING => '',
13070 - CURLOPT_MAXREDIRS => 10,
13071 - CURLOPT_TIMEOUT => 0,
13072 - CURLOPT_FOLLOWLOCATION => true,
13073 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13074 - CURLOPT_CUSTOMREQUEST => 'GET',
13075 - CURLOPT_HTTPHEADER => array(
13076 - 'Appkey: {{ONECOUNT API KEY}}'
13077 - ),
13078 -));
13079 -
13080 -$response = curl_exec($curl);
13081 -
13082 -curl_close($curl);
13083 -echo $response;
13084 -
13085 -
13086 -{{/code}}
13087 -
13088 13088  \\
13089 13089  
13090 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13091 -== (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Create Engagement(%%) ==
13092 -
13093 -----
13094 -
13095 -{{panel bgColor="#D3D3D3" width="100%"}}
13096 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements
13097 -{{/panel}}
13098 -
13099 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13100 -
13101 -----
13102 -
13103 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13104 -
13105 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13106 -
13107 -----
13108 -
13109 -{{code language="yml" theme="RDark" title="Body"}}
13110 -{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13111 - {"Name":[{"webinar ID 1":"Webinar 1"},{"webinar ID 3":"Webinar 3"},{"webinar ID 3":"Webinar 3"}],"Type": "select"},
13112 - {"Attendance Status":[{"attended":"Attended"},{"not_attended":"Not Attended"}],"Type": "select"},
13113 - {"Price":[],"Type": "numeric"},
13114 - {"Transaction Date":[],"Type": "date"}
13115 -]}
13116 -{{/code}}
13117 -
13118 -==== Example ====
13119 -
13120 -----
13121 -
13122 -(% style="color: rgb(107,107,107);" %)Request
13123 -
13124 -{{code language="php" theme="RDark" title="Create Engagement Request"}}
13125 - <?php
13126 -
13127 -$curl = curl_init();
13128 -
13129 -curl_setopt_array($curl, array(
13130 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements',
13131 - CURLOPT_RETURNTRANSFER => true,
13132 - CURLOPT_ENCODING => '',
13133 - CURLOPT_MAXREDIRS => 10,
13134 - CURLOPT_TIMEOUT => 0,
13135 - CURLOPT_FOLLOWLOCATION => true,
13136 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13137 - CURLOPT_CUSTOMREQUEST => 'POST',
13138 - CURLOPT_POSTFIELDS =>'{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13139 - {"Name":[{"webinar ID 1":"Webinar 1"},{"webinar ID 3":"Webinar 3"},{"webinar ID 3":"Webinar 3"}],"Type": "select"},
13140 - {"Attendance Status":[{"attended":"Attended"},{"not_attended":"Not Attended"}],"Type": "select"},
13141 - {"Price":[],"Type": "numeric"},
13142 - {"Transaction Date":[],"Type": "date"}
13143 -]}',
13144 - CURLOPT_HTTPHEADER => array(
13145 - 'Appkey: {{ONECOUNT API KEY}}'
13146 - ),
13147 -));
13148 -
13149 -$response = curl_exec($curl);
13150 -
13151 -curl_close($curl);
13152 -echo $response;
13153 -{{/code}}
13154 -
13155 13155  \\
13156 13156  
13157 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13158 -== (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(0, 83, 184)" %)PUT (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Update Engagement(%%) ==
13159 -
13160 -----
13161 -
13162 -{{panel bgColor="#D3D3D3" width="100%"}}
13163 - (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/~{~{Engagement Id}}
13164 -{{/panel}}
13165 -
13166 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13167 -
13168 -----
13169 -
13170 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13171 -
13172 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13173 -
13174 -----
13175 -
13176 -{{code language="yml" theme="RDark" title="Body"}}
13177 -{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13178 - {"Name":[{"webinar ID 5":"Webinar 5"},{"webinar ID 4":"Webinar 4"}],"Type": "select"},
13179 - {"Price":[],"Type": "text"}
13180 -]}
13181 -{{/code}}
13182 -
13183 -==== Example ====
13184 -
13185 -----
13186 -
13187 -(% style="color: rgb(107,107,107);" %)Request
13188 -
13189 -{{code language="php" theme="RDark" title="Update Engagement Request"}}
13190 - <?php
13191 -
13192 -$curl = curl_init();
13193 -
13194 -curl_setopt_array($curl, array(
13195 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/{{Engagement Id}}',
13196 - CURLOPT_RETURNTRANSFER => true,
13197 - CURLOPT_ENCODING => '',
13198 - CURLOPT_MAXREDIRS => 10,
13199 - CURLOPT_TIMEOUT => 0,
13200 - CURLOPT_FOLLOWLOCATION => true,
13201 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13202 - CURLOPT_CUSTOMREQUEST => 'PUT',
13203 - CURLOPT_POSTFIELDS =>'{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13204 - {"Name":[{"webinar ID 5":"Webinar 5"},{"webinar ID 4":"Webinar 4"}],"Type": "select"},
13205 - {"Price":[],"Type": "text"}
13206 -]}',
13207 - CURLOPT_HTTPHEADER => array(
13208 - 'Appkey: {{ONECOUNT API KEY}}'
13209 - ),
13210 -));
13211 -
13212 -$response = curl_exec($curl);
13213 -
13214 -curl_close($curl);
13215 -echo $response;
13216 -{{/code}}
13217 -
13218 13218  \\
13219 13219  
13220 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13221 -== (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Add User to Engagement(%%) ==
13222 -
13223 -----
13224 -
13225 -{{panel bgColor="#D3D3D3" width="100%"}}
13226 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/addUser
13227 -{{/panel}}
13228 -
13229 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13230 -
13231 -----
13232 -
13233 -(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13234 -
13235 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13236 -
13237 -----
13238 -
13239 -{{code language="yml" theme="RDark" title="Body"}}
13240 -{"Engagement id":"073b3a98-129b-440e-90b1-57957215ca67","Vendor id":1, "Engagement show id":"webinar ID 4","User id":"3143231","timestamp":1702319997, "data":{"Attendance Status":"not_attended","Price":10.00},"segment":["segment id 1"]}
13241 -{{/code}}
13242 -
13243 -==== Example ====
13244 -
13245 -----
13246 -
13247 -(% style="color: rgb(107,107,107);" %)Request
13248 -
13249 -{{code language="php" theme="RDark" title="Add User to Engagement Request"}}
13250 - <?php
13251 -
13252 -$curl = curl_init();
13253 -
13254 -curl_setopt_array($curl, array(
13255 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/addUser',
13256 - CURLOPT_RETURNTRANSFER => true,
13257 - CURLOPT_ENCODING => '',
13258 - CURLOPT_MAXREDIRS => 10,
13259 - CURLOPT_TIMEOUT => 0,
13260 - CURLOPT_FOLLOWLOCATION => true,
13261 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13262 - CURLOPT_CUSTOMREQUEST => 'POST',
13263 - CURLOPT_POSTFIELDS =>'{"Engagement id":"073b3a98-129b-440e-90b1-57957215ca67","Vendor id":1, "Engagement show id":"webinar ID 4","User id":"3143231","timestamp":1702319997, "data":{"Attendance Status":"not_attended","Price":10.00},"segment":["segment id 1"]}',
13264 - CURLOPT_HTTPHEADER => array(
13265 - 'Appkey: {{ONECOUNT API KEY}}'
13266 - ),
13267 -));
13268 -
13269 -$response = curl_exec($curl);
13270 -
13271 -curl_close($curl);
13272 -echo $response;
13273 -{{/code}}
13274 -
13275 13275  (% class="western" %)
13276 -=== **COMPONENT: Leads
13277 -** ===
12864 +**COMPONENT: Leads
12865 +**
13278 13278  
13279 13279  (% class="western" %)
13280 13280  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.
... ... @@ -13459,6 +13459,14 @@
13459 13459  
13460 13460  \\
13461 13461  
13050 +\\
13051 +
13052 +\\
13053 +
13054 +\\
13055 +
13056 +\\
13057 +
13462 13462  (% class="western" %)
13463 13463  **API REFERENCE**
13464 13464  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -110231560
1 +108265483
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/110231560/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/108265483/ONEcount API Documentation