Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 10.4
edited by Rayaan Ahmed
on 2024/02/29 16:01
Change comment: (Autosaved)
To version 13.1
edited by Rayaan Ahmed
on 2025/02/03 19:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -330,10 +330,6 @@
330 330  
331 331  ----
332 332  
333 -{{panel bgColor="#D3D3D3" width="100%"}}
334 -(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
335 -{{/panel}}
336 -
337 337  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
338 338  
339 339  ----
... ... @@ -868,12 +868,6 @@
868 868  
869 869  ----
870 870  
871 -{{panel bgColor="#D3D3D3" width="100%"}}
872 - (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/(% style="color:#212121" %)~{~{OCID}}
873 -{{/panel}}
874 -
875 -=== (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
876 -
877 877  ----
878 878  
879 879  (% class="Text__TextContainer-sc-1kqigik-0 cEvDCP iauueY item-key sc-fznXWL" style="color:#212121" %)Appkey                                                                                                 (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color:#212121" %)~{~{ONECOUNT API KEY}}
... ... @@ -966,10 +966,6 @@
966 966  
967 967  ----
968 968  
969 -{{panel bgColor="#D3D3D3" width="100%"}}
970 - (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users(% class="nolink" style="color:#212121" %)/login
971 -{{/panel}}
972 -
973 973  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
974 974  
975 975  ----
... ... @@ -1040,10 +1040,6 @@
1040 1040  
1041 1041  ----
1042 1042  
1043 -{{panel bgColor="#D3D3D3" width="100%"}}
1044 -(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users(% class="nolink" style="color:#212121" %)/lookup?2=user_242_6298&return=1,2,3,4
1045 -{{/panel}}
1046 -
1047 1047  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
1048 1048  
1049 1049  ----
... ... @@ -1120,10 +1120,6 @@
1120 1120  
1121 1121  ----
1122 1122  
1123 -{{panel bgColor="#D3D3D3" width="100%"}}
1124 -(% class="nolink nolink" %)https:~/~/api.onecount.net/v2(% class="nolink" style="color:#212121" %)/users/~{~{OCID}}/partners/~{~{Partner id}}
1125 -{{/panel}}
1126 -
1127 1127  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
1128 1128  
1129 1129  ----
... ... @@ -1135,11 +1135,7 @@
1135 1135  
1136 1136  ----
1137 1137  
1138 -{{panel bgColor="#D3D3D3" width="100%"}}
1139 -(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
1140 -{{/panel}}
1141 1141  
1142 -
1143 1143  (% class="western" %)
1144 1144  **POST method should be used to create users.**
1145 1145  
... ... @@ -1308,11 +1308,7 @@
1308 1308  
1309 1309  ----
1310 1310  
1311 -{{panel bgColor="#D3D3D3" width="100%"}}
1312 - (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/~{~{OCID(% class="nolink" %)}}
1313 -{{/panel}}
1314 1314  
1315 -
1316 1316  (% class="western" %)
1317 1317  **PUT method should be used to update users.**
1318 1318  
... ... @@ -13398,7 +13398,7 @@
13398 13398  
13399 13399  {{code language="yml" title="Body"}}
13400 13400  {"Metrics":[
13401 - {"Attendance Status":[{"text":"check's","value":"check's"},{"text":"c","value":"c"}]},
13371 + {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
13402 13402   {"lagacy status":[{"text":"c","value":"c"}]}
13403 13403   ]}
13404 13404  {{/code}}
... ... @@ -13409,7 +13409,7 @@
13409 13409  
13410 13410  (% style="color:#6b6b6b" %)Request
13411 13411  
13412 -{{code language="php" title="Update Engagement Request"}}
13382 +{{code language="php" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13413 13413   <?php
13414 13414  
13415 13415  $curl = curl_init();
... ... @@ -13423,9 +13423,9 @@
13423 13423   CURLOPT_FOLLOWLOCATION => true,
13424 13424   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13425 13425   CURLOPT_CUSTOMREQUEST => 'PUT',
13426 - CURLOPT_POSTFIELDS =>'{"Name":"Test engagement 3", "Metrics":[
13427 - {"Attendance Status":[{"text":"Attended","value":"attended"},{"text":"Not Attended","value":"not_attended"}],"Type": "select"},
13428 - {"Price":[],"Type": "text"}
13396 + CURLOPT_POSTFIELDS =>'{"Metrics":[
13397 + {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
13398 + {"lagacy status":[{"text":"c","value":"c"}]}
13429 13429   ]}',
13430 13430   CURLOPT_HTTPHEADER => array(
13431 13431   'Appkey: {{ONECOUNT API KEY}}',
... ... @@ -13443,7 +13443,7 @@
13443 13443  
13444 13444  (% style="color:#6b6b6b" %)Response  200 OK
13445 13445  
13446 -{{code language="yml" theme="RDark" collapse="true" title="Update Engagement Response"}}
13416 +{{code language="yml" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13447 13447  {
13448 13448   "result": {
13449 13449   "success": "1",
... ... @@ -13468,6 +13468,14 @@
13468 13468   {
13469 13469   "text": "Not Attended",
13470 13470   "value": "not_attended"
13441 + },
13442 + {
13443 + "text":"checks",
13444 + "value":"checks"
13445 + },
13446 + {
13447 + "text":"c",
13448 + "value":"c"
13471 13471   }
13472 13472   ]
13473 13473   },
... ... @@ -15324,3 +15324,85 @@
15324 15324  (% class="western" %)
15325 15325  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.
15326 15326  )))
15305 +
15306 +
15307 +**Example 1: How to use API  to unsubscribe user from package if you don't have a package ID or term ID**
15308 +
15309 +**~1. Get all packages using below API call**
15310 +
15311 +[[https:~~/~~/api.onecount.net/v2/products?limit=10000>>url:https://api.onecount.net/v2/products?limit=10000]]
15312 +\\This will give all the packages with all the resources attached to that package below is sample response.
15313 +
15314 +
15315 +[
15316 +
15317 + {
15318 +
15319 + "ProductId": 2374,
15320 +
15321 + "Title": "OptL-0- ENTECH EVENT-VSL Virtual Seminars",
15322 +
15323 + "Description": "",
15324 +
15325 + "ResourceIDs": [
15326 +
15327 + 16366,
15328 +
15329 + 16374,
15330 +
15331 + 16638,
15332 +
15333 + 16646,
15334 +
15335 + 17030,
15336 +
15337 + 17038,
15338 +
15339 + 17046,
15340 +
15341 + 17054
15342 +
15343 + ],
15344 +
15345 + "PrimaryFormID": [
15346 +
15347 + "251fc466-0f68-483d-afa6-1b05cb3ae9b0"
15348 +
15349 + ],
15350 +
15351 + "Terms": {
15352 +
15353 + "Id": 2462,
15354 +
15355 + "Name": "Active",
15356 +
15357 + "Description": "",
15358 +
15359 + "Duration": 1,
15360 +
15361 + "DurationUnit": "D",
15362 +
15363 + "Price": "0",
15364 +
15365 + "ProductId": 2374
15366 +
15367 + }
15368 +
15369 + }
15370 +
15371 +]
15372 +
15373 +
15374 +FYI : ResourceIDs are product ids
15375 +
15376 +Productid is package id
15377 +\\If your desired resource is in the package then use the product id and term id to unsubscribe user from that package
15378 +
15379 +**2. Use product id and term id  from the response above to unsubscribe user from the package**
15380 +\\Use this API and body to unsubscribe users
15381 +\\[[https:~~/~~/api.onecount.net/v2/transactions>>url:https://api.onecount.net/v2/transactions]]
15382 +\\**BODY:**
15383 +{"UserId": 126715990,"TermId":2462,"UserIP":"192.168.0.1" ,"SubscriptionType":"u" , "ProductId":2374 ,"ResourceId":0,"FormId": "","Source": 39,"ProductStatus": 2,"Amount":"0.00" ,"PaypalTransId":"" , "MediaFilePath":"" ,"Remarks": "USER UNSUBSCRIBED FROM API","BatchId":"1234" ,"Quantity": 1, "ExpireDate":"20260115" }
15384 +\\\\This will unsubscribe user from that package
15385 +
15386 +