Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 12.1
edited by Admin User
on 2024/04/29 14:06
Change comment: There is no comment for this version
To version 10.2
edited by Rayaan Ahmed
on 2024/02/29 15:51
Change comment: (Autosaved)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.admin
1 +XWiki.rayaan
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  
... ... @@ -12865,12 +12865,7 @@
12865 12865  (% class="western" %)
12866 12866  NOTE: While updating a select and checkbox type question you need to pass complete set of Choices for that question including the one which are already existing. If not the choices will be overwritten from the choices from the body.
12867 12867  )))
12868 -|(% style="text-align:left; vertical-align:top" %)POST|(% style="text-align:left; vertical-align:top" %)/engagements/metric/<engagement id>|(% style="text-align:left; vertical-align:top" %)(((
12869 -Add options to specific metric in an engagement without passing all options and overriding existing options.
12870 -
12871 -Parameters required to update the engagement needs to be sent as post data in JSON format.
12872 -\\This API is used to add options only for select and checkbox metrics.
12873 -)))
12898 +|(% style="text-align:left; vertical-align:top" %)POST|(% style="text-align:left; vertical-align:top" %) |(% style="text-align:left; vertical-align:top" %)
12874 12874  |(% style="text-align:left; vertical-align:top" %)(% style="text-align: left;vertical-align: top;" %)
12875 12875  (((
12876 12876  (% class="western" %)
... ... @@ -13347,149 +13347,6 @@
13347 13347  {{/code}}
13348 13348  
13349 13349  
13350 -(% id="HPUTUpdateEngagement" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13351 -== (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" id="cke_bm_7146126S" style="color:#0053b8; display:none" %) (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#ad7a03" %)POST(% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#0053b8" %) (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)Add options to metric(%%) ==
13352 -
13353 -----
13354 -
13355 -{{panel bgColor="#D3D3D3" width="100%"}}
13356 - (% class="nolink" %)https:~/~/api.onecount.net/v2(%%)/engagements/metric/(% style="color:#212121" %)~{~{Engagement Id}}
13357 -{{/panel}}
13358 -
13359 -=== (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
13360 -
13361 -----
13362 -
13363 -(% 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}}
13364 -
13365 -=== (% style="color:#212121" %)Body (% style="color:#6b6b6b" %)raw (json)(%%) ===
13366 -
13367 -----
13368 -
13369 -{{code language="yml" title="Body"}}
13370 -{"Metrics":[
13371 - {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
13372 - {"lagacy status":[{"text":"c","value":"c"}]}
13373 - ]}
13374 -{{/code}}
13375 -
13376 -==== Example ====
13377 -
13378 -----
13379 -
13380 -(% style="color:#6b6b6b" %)Request
13381 -
13382 -{{code language="php" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13383 - <?php
13384 -
13385 -$curl = curl_init();
13386 -
13387 -curl_setopt_array($curl, array(
13388 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/metric/{{Engagement Id}}',
13389 - CURLOPT_RETURNTRANSFER => true,
13390 - CURLOPT_ENCODING => '',
13391 - CURLOPT_MAXREDIRS => 10,
13392 - CURLOPT_TIMEOUT => 0,
13393 - CURLOPT_FOLLOWLOCATION => true,
13394 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"}]}
13399 - ]}',
13400 - CURLOPT_HTTPHEADER => array(
13401 - 'Appkey: {{ONECOUNT API KEY}}',
13402 - 'Content-Type: application/json'
13403 - ),
13404 -));
13405 -
13406 -$response = curl_exec($curl);
13407 -
13408 -curl_close($curl);
13409 -echo $response;
13410 -
13411 -{{/code}}
13412 -
13413 -
13414 -(% style="color:#6b6b6b" %)Response  200 OK
13415 -
13416 -{{code language="yml" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
13417 -{
13418 - "result": {
13419 - "success": "1",
13420 - "error": {
13421 - "code": "",
13422 - "message": ""
13423 - }
13424 - },
13425 - "Engagements": [
13426 - {
13427 - "Id": "e0e816ec-77ba-4db1-bfc0-22d340337357",
13428 - "Name": "Test engagement 3",
13429 - "Metrics": [
13430 - {
13431 - "Name": "Attendance Status",
13432 - "Type": "select",
13433 - "Values": [
13434 - {
13435 - "text": "Attended",
13436 - "value": "attended"
13437 - },
13438 - {
13439 - "text": "Not Attended",
13440 - "value": "not_attended"
13441 - },
13442 - {
13443 - "text":"checks",
13444 - "value":"checks"
13445 - },
13446 - {
13447 - "text":"c",
13448 - "value":"c"
13449 - }
13450 - ]
13451 - },
13452 - {
13453 - "Name": "Price",
13454 - "Type": "text"
13455 - },
13456 - {
13457 - "Name": "Name",
13458 - "Type": "select",
13459 - "Values": [
13460 - {
13461 - "text": "Webinar 1",
13462 - "value": "Webinar_1"
13463 - },
13464 - {
13465 - "text": "Webinar 2",
13466 - "value": "Webinar_2"
13467 - }
13468 - ]
13469 - },
13470 - {
13471 - "Name": "Transaction Date",
13472 - "Type": "text"
13473 - },
13474 - {
13475 - "Name": "id",
13476 - "Type": "text"
13477 - },
13478 - {
13479 - "Name": "activity_time",
13480 - "Type": "text"
13481 - }
13482 - ]
13483 - }
13484 - ]
13485 -}
13486 -{{/code}}
13487 -
13488 -
13489 -
13490 -
13491 -
13492 -
13493 13493  (% id="HPOSTAddUsertoEngagement" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13494 13494  == (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#ad7a03" %)POST(% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %) Add User to Engagement(%%) ==
13495 13495