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

Summary

Details

Page properties
Content
... ... @@ -330,6 +330,10 @@
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 +
333 333  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
334 334  
335 335  ----
... ... @@ -864,6 +864,12 @@
864 864  
865 865  ----
866 866  
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 +
867 867  ----
868 868  
869 869  (% 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}}
... ... @@ -956,6 +956,10 @@
956 956  
957 957  ----
958 958  
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 +
959 959  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
960 960  
961 961  ----
... ... @@ -1026,6 +1026,10 @@
1026 1026  
1027 1027  ----
1028 1028  
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 +
1029 1029  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
1030 1030  
1031 1031  ----
... ... @@ -1102,6 +1102,10 @@
1102 1102  
1103 1103  ----
1104 1104  
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 +
1105 1105  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
1106 1106  
1107 1107  ----
... ... @@ -1113,7 +1113,11 @@
1113 1113  
1114 1114  ----
1115 1115  
1138 +{{panel bgColor="#D3D3D3" width="100%"}}
1139 +(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
1140 +{{/panel}}
1116 1116  
1142 +
1117 1117  (% class="western" %)
1118 1118  **POST method should be used to create users.**
1119 1119  
... ... @@ -1282,7 +1282,11 @@
1282 1282  
1283 1283  ----
1284 1284  
1311 +{{panel bgColor="#D3D3D3" width="100%"}}
1312 + (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/~{~{OCID(% class="nolink" %)}}
1313 +{{/panel}}
1285 1285  
1315 +
1286 1286  (% class="western" %)
1287 1287  **PUT method should be used to update users.**
1288 1288  
... ... @@ -13368,7 +13368,7 @@
13368 13368  
13369 13369  {{code language="yml" title="Body"}}
13370 13370  {"Metrics":[
13371 - {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
13401 + {"Attendance Status":[{"text":"check's","value":"check's"},{"text":"c","value":"c"}]},
13372 13372   {"lagacy status":[{"text":"c","value":"c"}]}
13373 13373   ]}
13374 13374  {{/code}}
... ... @@ -13379,7 +13379,7 @@
13379 13379  
13380 13380  (% style="color:#6b6b6b" %)Request
13381 13381  
13382 -{{code language="php" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13412 +{{code language="php" title="Update Engagement Request"}}
13383 13383   <?php
13384 13384  
13385 13385  $curl = curl_init();
... ... @@ -13393,9 +13393,9 @@
13393 13393   CURLOPT_FOLLOWLOCATION => true,
13394 13394   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13395 13395   CURLOPT_CUSTOMREQUEST => 'PUT',
13396 - CURLOPT_POSTFIELDS =>'{"Metrics":[
13397 - {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
13398 - {"lagacy status":[{"text":"c","value":"c"}]}
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"}
13399 13399   ]}',
13400 13400   CURLOPT_HTTPHEADER => array(
13401 13401   'Appkey: {{ONECOUNT API KEY}}',
... ... @@ -13413,7 +13413,7 @@
13413 13413  
13414 13414  (% style="color:#6b6b6b" %)Response  200 OK
13415 13415  
13416 -{{code language="yml" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13446 +{{code language="yml" theme="RDark" collapse="true" title="Update Engagement Response"}}
13417 13417  {
13418 13418   "result": {
13419 13419   "success": "1",
... ... @@ -13438,14 +13438,6 @@
13438 13438   {
13439 13439   "text": "Not Attended",
13440 13440   "value": "not_attended"
13441 - },
13442 - {
13443 - "text":"checks",
13444 - "value":"checks"
13445 - },
13446 - {
13447 - "text":"c",
13448 - "value":"c"
13449 13449   }
13450 13450   ]
13451 13451   },
... ... @@ -15302,85 +15302,3 @@
15302 15302  (% class="western" %)
15303 15303  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.
15304 15304  )))
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 -