Changes for page OLD-ONEcount API Documentation
Last modified by Admin on 2025/06/27 12:14
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - ONEcountAPIation1 +sonish-APIDocument-230317-1008-18 - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Admin1 +XWiki.sonish - Content
-
... ... @@ -1,8 +1,56 @@ 1 +(% class="western" align="center" %) 2 + 3 + 4 +(% class="western" align="center" %) 5 + 6 + 7 +(% class="western" align="center" %) 8 + 9 + 10 +(% class="western" align="center" %) 11 + 12 + 13 +(% class="western" align="center" %) 14 + 15 + 16 +(% class="western" align="center" %) 17 + 18 + 19 +(% class="western" align="center" %) 20 +ONEcount REST API Developer's Guide 21 + 22 +(% class="western" align="center" %) 23 +Version 2.1 24 + 25 +(% class="western" align="center" %) 26 + 27 + 28 +(% class="western" align="center" %) 29 + 30 + 31 +(% class="western" align="center" %) 32 + 33 + 34 +(% class="western" align="center" %) 35 + 36 + 37 +(% class="western" align="center" %) 38 + 39 + 40 +(% class="western" align="center" %) 41 + 42 + 43 +(% class="western" align="center" %) 44 + 45 + 46 +(% class="western" align="center" %) 47 + 48 + 1 1 (% class="western" %) 2 2 **Introduction** 3 3 4 4 (% class="western" %) 5 -ONEcount REST API i sdesignedtolowyoutodirectlymanipulate theunderlyingdata within theONEcountpplication. This API can be used to lookup, create and updated different ONEcountdata components which are listed below.53 +ONEcount REST API provides different functionality to accomplish many integration related tasks. This API can be used to lookup, create and updated different ONEcount resources which are listed below. 6 6 7 7 (% class="western" %) 8 8 REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following: ... ... @@ -10,11 +10,14 @@ 10 10 1. ((( 11 11 (% class="western" %) 12 12 **GET** - Used for lookup of resources 13 -))) 61 + 62 +* ((( 14 14 1. ((( 15 15 (% class="western" %) 16 16 **PUT** - Used to update a resource 17 17 ))) 67 +))) 68 +))) 18 18 1. ((( 19 19 (% class="western" %) 20 20 **POST** - Used to create a new resource ... ... @@ -21,55 +21,178 @@ 21 21 ))) 22 22 23 23 (% class="western" %) 24 - Specifically, theONEcount API providesto thefollowing components:75 +ONEcount API provides following functionalities: 25 25 26 -1. User data 27 -11. List users 28 -11. Lookup users 29 -11. Create users 30 -11. Update users 31 -1. Questions 32 -11. Lookup questions 33 -11. List questions 34 -11. Create questions 35 -1. Product data 36 -11. Lookup products 37 -11. Create products 38 -11. Update products 39 -1. Term Data 40 -11. Lookup terms 41 -11. Create terms 42 -11. Update terms 43 -1. Resource Data 44 -11. Lookup resources 45 -11. Create resources 46 -11. Update resources 47 -1. Transaction data 48 -11. Lookup transactions 49 -11. Create transactions 50 -1. Source Codes 51 -11. Lookup source code 52 -11. Create source codes 53 -11. Update source codes 54 -1. Attach a resource to a product 55 -1. Leads 56 -11. Create a lead 57 -\\\\\\ 77 +1. ((( 78 +(% class="western" %) 79 +**Lookup** 58 58 81 +* 82 + 59 59 (% class="western" %) 60 - **AccessingAPI**84 +User lookup 61 61 86 +* 87 + 62 62 (% class="western" %) 63 - **RESTAPI URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]89 +Transaction lookup 64 64 91 +* 92 + 65 65 (% class="western" %) 66 - **Appkey**:THIS WILL BE PROVIDED TO YOU94 +Question lookup 67 67 96 +* 97 + 68 68 (% class="western" %) 69 -** 70 -** 99 +Source code lookup 71 71 101 +* 102 + 72 72 (% class="western" %) 104 +Product lookup 105 + 106 +* 107 + 108 +(% class="western" %) 109 +Term lookup 110 + 111 +* 112 + 113 +(% class="western" %) 114 +Resource lookup 115 +))) 116 +1. ((( 117 +(% class="western" %) 118 +**Create** 119 + 120 +* 121 + 122 +(% class="western" %) 123 +Add a user/demo 124 + 125 +* 126 + 127 +(% class="western" %) 128 +Add a question 129 + 130 +* 131 + 132 +(% class="western" %) 133 +Add user transaction 134 + 135 +* 136 + 137 +(% class="western" %) 138 +Add source code 139 + 140 +* 141 + 142 +(% class="western" %) 143 +Add Product 144 + 145 +* 146 + 147 +(% class="western" %) 148 +Add Term 149 + 150 +* 151 + 152 +(% class="western" %) 153 +Add Resource 154 + 155 +* 156 + 157 +(% class="western" %) 158 +Stats – Telemarketing 159 +))) 160 +1. ((( 161 +(% class="western" %) 162 +**Update** 163 + 164 +* 165 + 166 +(% class="western" %) 167 +Update a user/demo 168 + 169 +* 170 + 171 +(% class="western" %) 172 +Update a question 173 + 174 +* 175 + 176 +(% class="western" %) 177 +Update source code 178 + 179 +* 180 + 181 +(% class="western" %) 182 +Update product 183 + 184 +* 185 + 186 +(% class="western" %) 187 +Update term 188 + 189 +* 190 + 191 +(% class="western" %) 192 +Update resource 193 +))) 194 +1. ((( 195 +(% class="western" %) 196 +**List** 197 + 198 +* 199 + 200 +(% class="western" %) 201 +ListQuestions 202 + 203 +* 204 + 205 +(% class="western" %) 206 +ListSourceCodes 207 +))) 208 + 209 +(% class="western" %) 210 + 211 + 212 +1. ((( 213 +(% class="western" %) 214 +**Attach** 215 +))) 216 + 217 +* ((( 218 +(% class="western" %) 219 +Attach resource to product 220 +))) 221 + 222 +(% class="western" %) 223 + 224 + 225 +(% class="western" %) 226 + 227 + 228 +(% class="western" %) 229 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]] 230 + 231 +(% class="western" %) 232 +**Appkey**: THIS WILL BE PROVIDED 233 + 234 +(% class="western" %) 235 + 236 + 237 +(% class="western" %) 238 +**Function** 239 + 240 +(% class="western" %) 241 +The ONEcount REST API will be used to create, update & lookup users, transactions and questions e.t.c. in ONEcount hosted install of the client. 242 + 243 +(% class="western" %) 244 +**Accessing API** 245 + 246 +(% class="western" %) 73 73 Your HTTP requests to a REST API resource should contain the following information: 74 74 75 75 * ((( ... ... @@ -90,12 +90,9 @@ 90 90 ))) 91 91 92 92 (% class="western" %) 93 - 267 +**Request** 94 94 95 95 (% class="western" %) 96 -**General API Usage** 97 - 98 -(% class="western" %) 99 99 The request data in POST (for create and update) will consist of request parameters required by each method in JSON format. Value of resource will determine which resource is being requested and the access method will determine whether you are trying to create, update or lookup that resource. 100 100 101 101 (% class="western" %) ... ... @@ -224,99 +224,131 @@ 224 224 225 225 226 226 (% class="western" %) 227 -** 228 -** 398 +**Resources** 229 229 230 -**COMPONENT: Users** 231 - 232 232 (% class="western" %) 233 - Usersmeansthecustomersof your system. Userscan be added, updated andsearchedforusing theusers resourcefromthe api.For lookup, Ifa returnparameter isspecifiedUsers objectwillhavethosefields. If nothingis specifiedby defaultnly UserIdisturned.401 +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. 234 234 403 +* ((( 235 235 (% class="western" %) 236 -Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added. 405 +questions 406 +))) 407 +* ((( 408 +(% class="western" %) 409 +users 410 +))) 411 +* ((( 412 +(% class="western" %) 413 +products 414 +))) 415 +* ((( 416 +(% class="western" %) 417 +terms 418 +))) 419 +* ((( 420 +(% class="western" %) 421 +resources 422 +))) 423 +* ((( 424 +(% class="western" %) 425 +sources 426 +))) 427 +* ((( 428 +(% class="western" %) 429 +transactions 430 +))) 237 237 238 238 (% class="western" %) 239 - In this case the provided demographic information inusersobjectwill be used tocreate anew user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated.433 +**Questions** 240 240 241 241 (% class="western" %) 242 - If username andpasswordis not one oftheparametersbeingpassed,thenarandomusername andpasswordwillbegeneratedfortheuserwhilecreatinghis useraccount inONEcount.436 +This resource is for manipulating questions resource. Questions in ONEcount means any question that is asked to the subscriber. It could be any questions that appears on customer forms or print forms that gets answered by a subscriber. Questions api call will allow creation, update and search of question in ONEcount. To add a new questions to the system you'll make a POST api call to the questions resource. 243 243 244 244 (% class="western" %) 245 - Returnparameterwillhavecommaseparatedlist of questionIds thatis requestedback fromtheAPI.439 +The data that is sent should be in JSON format and of type questions as described in References section. The type property of questions object is described below. Questions object will only need a choices block if the question is a multiple choice question(type=4 or 5 or 6) 246 246 247 247 (% class="western" %) 248 - Returnisanoptional parameterinrequest. If return isnotrequested then by default, only UserId (which is ONEcount ID) will be returned in the Users object.442 +There can be 6 types of questions: 249 249 250 - 251 - 252 252 |((( 253 -(% class="western" %) 254 -** Method**445 +(% class="western" align="center" %) 446 +**Type** 255 255 )))|((( 256 256 (% class="western" %) 257 -**Url** 449 +**Description** 450 +))) 451 +|((( 452 +(% class="western" align="center" %) 453 +1 258 258 )))|((( 259 259 (% class="western" %) 260 - **Action**456 +Textbox type questions or short response type question. The response length needs to be less than 255 characters. 261 261 ))) 262 262 |((( 263 -(% class="western" %) 264 - GET459 +(% class="western" align="center" %) 460 +2 265 265 )))|((( 266 266 (% class="western" %) 267 -/users 463 +Textarea type question or long response type question. 464 +))) 465 +|((( 466 +(% class="western" align="center" %) 467 +3 268 268 )))|((( 269 269 (% class="western" %) 270 - Get users datalimiting25.470 +Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *. 271 271 ))) 272 272 |((( 473 +(% class="western" align="center" %) 474 +4 475 +)))|((( 273 273 (% class="western" %) 274 -GET 477 +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. 478 +))) 479 +|((( 480 +(% class="western" align="center" %) 481 +5 275 275 )))|((( 276 276 (% class="western" %) 277 -/users/1 484 +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. 485 +))) 486 +|((( 487 +(% class="western" align="center" %) 488 +6 278 278 )))|((( 279 279 (% class="western" %) 280 - Getdataforuserid1.The useridcan be anumericvalueorahash491 +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. 281 281 ))) 493 + 282 282 |((( 283 283 (% class="western" %) 284 - GET496 +**Method** 285 285 )))|((( 286 286 (% class="western" %) 287 - /users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2499 +**Url** 288 288 )))|((( 289 289 (% class="western" %) 290 -Lookup for user whose question id (1) is equal to supplied value. The users object returned will have value of questions 1 & 2. Here for example assumed to be firstname and last name. 291 - 292 -(% class="western" %) 293 -Return parameter defines a csv of question id that are requested back in response. 502 +**Action** 294 294 ))) 295 295 |((( 296 296 (% class="western" %) 297 - POST506 +GET 298 298 )))|((( 299 299 (% class="western" %) 300 -/u sers509 +/questions 301 301 )))|((( 302 302 (% class="western" %) 303 -Create a new users 304 - 305 -(% class="western" %) 306 -Parameters required to create the user needs to be sent as post data in JSON format. 512 +List all questions 307 307 ))) 308 308 |((( 309 309 (% class="western" %) 310 - PUT516 +GET 311 311 )))|((( 312 312 (% class="western" %) 313 -/u sers/1519 +/questions/1 314 314 )))|((( 315 315 (% class="western" %) 316 -Update user id 1. The user id can be a numeric value or a hash 317 - 318 -(% class="western" %) 319 -Parameters required to update the user needs to be sent as post data in JSON format. 522 +Returns question id 1 320 320 ))) 321 321 |((( 322 322 (% class="western" %) ... ... @@ -323,10 +323,10 @@ 323 323 GET 324 324 )))|((( 325 325 (% class="western" %) 326 -/u sers/1/partners/2529 +/questions/lookup?Text=Email 327 327 )))|((( 328 328 (% class="western" %) 329 - Getserid 1 andpartnerid 2'sONEcount hash.Theuseridcanbe a numeric valueora hash.532 +Returns all questions with “Email" in question text 330 330 ))) 331 331 |((( 332 332 (% class="western" %) ... ... @@ -333,40 +333,32 @@ 333 333 POST 334 334 )))|((( 335 335 (% class="western" %) 336 -/u sers/login539 +/questions 337 337 )))|((( 338 338 (% class="western" %) 339 -C heckto seeuserexistwithusername/email and password.542 +Create a new question 340 340 341 341 (% class="western" %) 342 -Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param. 343 - 545 +JSON of the Questions type object needs to be sent as post data. Id field should not be sent. 546 +))) 547 +|((( 344 344 (% class="western" %) 345 - Example:346 - 549 +PUT 550 +)))|((( 347 347 (% class="western" %) 348 - {"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","e":"abc@[[one-count.com>>url:http://one-count.com||shape="rect"]]","p":"1234"}349 - 552 +/questions 553 +)))|((( 350 350 (% class="western" %) 351 - OR555 +Update a question 352 352 353 353 (% class="western" %) 354 -{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"} 355 - 356 -(% class="western" %) 357 -OR 358 - 359 -(% class="western" %) 360 -{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"} 361 - 362 -(% class="western" %) 363 -**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found. 558 +JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update. 364 364 ))) 365 365 366 366 367 367 368 368 (% class="western" %) 369 -**GET method shouldbe used to lookup users.**564 +**GET method can be used to lookup questions.** 370 370 371 371 |((( 372 372 (% class="western" %) ... ... @@ -386,19 +386,18 @@ 386 386 String 387 387 )))|((( 388 388 (% class="western" %) 389 -URL encoded key value string parameters for the lookup. Returnpropertyhascsvof questionsid requestedbackinUsers object.584 +URL encoded key value string parameters for the question that a user is trying to search. 390 390 391 391 (% class="western" %) 392 -Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]587 +Params: 393 393 394 394 (% class="western" %) 395 -return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String) 590 +Text: Word or phrase that should be present in the question text (String) 591 + 592 +(% class="western" %) 593 +Type: Look up the question type. 396 396 ))) 397 397 398 - 399 - 400 - 401 - 402 402 |((( 403 403 (% class="western" %) 404 404 **Response** ... ... @@ -411,19 +411,19 @@ 411 411 ))) 412 412 |((( 413 413 (% class="western" %) 414 -Users 415 -)))|=((( 416 -(% class="western" align="left" %) 417 -Users 608 +Questions 418 418 )))|((( 419 419 (% class="western" %) 420 -Found users returned with the demo field requested in return parameter in json format. 611 +Questions 612 +)))|((( 613 +(% class="western" %) 614 +Returns found question details. 421 421 ))) 422 422 423 423 424 424 425 425 (% class="western" %) 426 -**POST method should be used to create users.** 620 +**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).** 427 427 428 428 |((( 429 429 (% class="western" %) ... ... @@ -437,48 +437,44 @@ 437 437 ))) 438 438 |((( 439 439 (% class="western" %) 440 - Users634 +Questions 441 441 )))|((( 442 442 (% class="western" %) 443 - Users637 +Questions 444 444 )))|((( 445 445 (% class="western" %) 446 - Users object that containsinformationabout userto create.PartnerIdNeeds tocified.640 +This defines the question contents and possible responses. 447 447 ))) 642 + 448 448 |((( 449 449 (% class="western" %) 450 - Transactions645 +**Response** 451 451 )))|((( 452 452 (% class="western" %) 453 -T ransactions648 +**Type** 454 454 )))|((( 455 455 (% class="western" %) 456 - (Array of) transaction objectspecifying parts of the transaction to be added to the new user. UserId and TransactionId, SubscriptionType will be ignored if specified. As this is new user and new transaction is being added.651 +**Description** 457 457 ))) 458 458 |((( 459 459 (% class="western" %) 460 - DedupeColumns655 +QuestionId 461 461 )))|((( 462 462 (% class="western" %) 463 - String658 +Int 464 464 )))|((( 465 465 (% class="western" %) 466 - CSVofquestion id'sthatshouldbeconsideredto findduplicate.661 +Returns ONEcount question id on successful creation of the question. 467 467 ))) 468 -|((( 663 + 664 + 665 + 469 469 (% class="western" %) 470 -Return 471 -)))|((( 472 -(% class="western" %) 473 -String 474 -)))|((( 475 -(% class="western" %) 476 -CSV of ONEcount QuestionId's requested back in Users object in response. 477 -))) 667 +PUT method should be used to update question. 478 478 479 479 |((( 480 480 (% class="western" %) 481 -**Re sponse**671 +**Request** 482 482 )))|((( 483 483 (% class="western" %) 484 484 **Type** ... ... @@ -488,23 +488,18 @@ 488 488 ))) 489 489 |((( 490 490 (% class="western" %) 491 -Users 492 -)))|=((( 493 -(% class="western" align="left" %) 494 -Users 681 +Questions 495 495 )))|((( 496 496 (% class="western" %) 497 -Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned. 684 +Questions 685 +)))|((( 686 +(% class="western" %) 687 +This defines the question contents and responses. 498 498 ))) 499 499 500 - 501 - 502 -(% class="western" %) 503 -**PUT method should be used to update users.** 504 - 505 505 |((( 506 506 (% class="western" %) 507 -**Re quest**692 +**Response** 508 508 )))|((( 509 509 (% class="western" %) 510 510 **Type** ... ... @@ -514,173 +514,167 @@ 514 514 ))) 515 515 |((( 516 516 (% class="western" %) 517 - Users702 +QuestionId 518 518 )))|((( 519 519 (% class="western" %) 520 - Users705 +Int 521 521 )))|((( 522 522 (% class="western" %) 523 - Users object with update fields.Returnproperty has csvofquestionsidrequestedbackin Usersobject.708 +Returns ONEcount question id on successful update of the question. 524 524 ))) 525 - |(((710 + 526 526 (% class="western" %) 527 - Return528 - )))|(((712 + 713 + 529 529 (% class="western" %) 530 -String 531 -)))|((( 715 +Example: Get list of questions from api which has FirstName in text 716 + 717 +{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}} 718 + 532 532 (% class="western" %) 533 -CSV of ONEcount QuestionId's requested back in Users object in response 534 -))) 535 -|((( 720 +{ 721 + 536 536 (% class="western" %) 537 - RequestDate538 - )))|(((723 +"result": { 724 + 539 539 (% class="western" %) 540 - Date541 - )))|(((726 +"success": "1", 727 + 542 542 (% class="western" %) 543 -RequestDate to use for the demo update. If not provided current date will be used. 544 -))) 729 +"error": { 545 545 546 -|((( 547 547 (% class="western" %) 548 - **Response**549 - )))|(((732 +"code": "0", 733 + 550 550 (% class="western" %) 551 - **Type**552 - )))|(((735 +"message": "" 736 + 553 553 (% class="western" %) 554 -**Description** 555 -))) 556 -|((( 738 +} 739 + 557 557 (% class="western" %) 558 -Users 559 -)))|=((( 560 -(% class="western" align="left" %) 561 -Users 562 -)))|((( 741 +}, 742 + 563 563 (% class="western" %) 564 -Updated user returned with the demo field requested in return parameter in json format. 565 -))) 744 +"Questions": [ 566 566 567 567 (% class="western" %) 568 - 747 +{ 569 569 570 570 (% class="western" %) 571 - 750 +"Id": "6", 572 572 573 573 (% class="western" %) 574 - Createnew users. Here inthis examplethe JSON for request is passed in userFile.json file.753 +"Text": "FirstName", 575 575 576 -{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}} 755 +(% class="western" %) 756 +"Type": "1", 577 577 578 578 (% class="western" %) 579 -** 580 -** 759 +"Alias": "FName" 581 581 582 582 (% class="western" %) 583 -** 584 -** 762 +} 585 585 586 - 764 +(% class="western" %) 765 +] 587 587 588 588 (% class="western" %) 589 - **COMPONENT: Questions**768 +} 590 590 591 591 (% class="western" %) 592 -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). 593 593 772 +**Users** 773 + 594 594 (% class="western" %) 595 - Thisresource isformanipulatingquestions resource.Questionsin ONEcountans anyquestionthat is asked to the subscriber. Itcouldbeany questionsthat appearson customerformsprintformsthat getsanswered by a subscriber.Questionsapicallwillallowcreation,updateandsearch ofquestionin ONEcount.Toadd a newquestionstothesystemyou'llmakePOST api calltothequestions resource.775 +Users means the customers of your system. Users can be added, updated and searched for using the users resource from the api. For lookup, If a return parameter is specified Users object will have those fields. If nothing is specified by default only UserId is returned. 596 596 597 597 (% class="western" %) 598 - Thedatathatissenthouldbe inJSON formatandof typequestionsasdescribedin Referencessection.Thetypepropertyof questionsobjectisdescribedbelow.Questionsobject willonlyneedachoicesblockifthequestionisamultiplechoicequestion(type=4or5or 6)778 +Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added. 599 599 600 600 (% class="western" %) 601 - There can be6types ofquestions:781 +In this case the provided demographic information in users object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated. 602 602 603 -(% class="wrapped" %) 604 -|((( 605 -(% class="western" align="center" %) 606 -**Type** 607 -)))|((( 608 608 (% class="western" %) 609 -**Description** 610 -))) 784 +If username and password is not one of the parameters being passed, then a random username and password will be generated for the user while creating his user account in ONEcount. 785 + 786 +(% class="western" %) 787 +Return parameter will have the comma separated list of question Ids that is requested back from the API. 788 + 789 +(% class="western" %) 790 +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. 791 + 792 +(% class="western" %) 793 + 794 + 611 611 |((( 612 -(% class="western" align="center"%)613 - 1796 +(% class="western" %) 797 +**Method** 614 614 )))|((( 615 615 (% class="western" %) 616 -Textbox type questions or short response type question. The response length needs to be less than 255 characters. 617 -))) 618 -|((( 619 -(% class="western" align="center" %) 620 -2 800 +**Url** 621 621 )))|((( 622 622 (% class="western" %) 623 - Textarea type questionor long response type question.803 +**Action** 624 624 ))) 625 625 |((( 626 -(% class="western" align="center"%)627 - 3806 +(% class="western" %) 807 +GET 628 628 )))|((( 629 629 (% class="western" %) 630 -Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *. 631 -))) 632 -|((( 633 -(% class="western" align="center" %) 634 -4 810 +/users 635 635 )))|((( 636 636 (% class="western" %) 637 - Selector dropdown type questions. This is a multiplechoice, 1responsetype question. When creating this type of question the choices block also needs to be partof the questions object thatwill hold the possible choices ofthe select question.813 +Get users data limiting 25. 638 638 ))) 639 639 |((( 640 -(% class="western" align="center"%)641 - 5816 +(% class="western" %) 817 +GET 642 642 )))|((( 643 643 (% class="western" %) 644 -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. 645 -))) 646 -|((( 647 -(% class="western" align="center" %) 648 -6 820 +/users/1 649 649 )))|((( 650 650 (% class="western" %) 651 - Checkboxtypequestion. This isamultiple choice,multi responsetype question.Whencreating this type of question thechoicesblockalsoneedstobepartof the questions objectthat will hold thepossiblechoicesof the checkbox question.823 +Get data for user id 1. The user id can be a numeric value or a hash 652 652 ))) 653 - 654 -(% class="wrapped" %) 655 655 |((( 656 656 (% class="western" %) 657 - **Method**827 +GET 658 658 )))|((( 659 659 (% class="western" %) 660 - **Url**830 +/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2 661 661 )))|((( 662 662 (% class="western" %) 663 -**Action** 833 +Lookup for user whose question id (1) is equal to supplied value. The users object returned will have value of questions 1 & 2. Here for example assumed to be firstname and last name. 834 + 835 +(% class="western" %) 836 +Return parameter defines a csv of question id that are requested back in response. 664 664 ))) 665 665 |((( 666 666 (% class="western" %) 667 - GET840 +POST 668 668 )))|((( 669 669 (% class="western" %) 670 -/ questions843 +/users 671 671 )))|((( 672 672 (% class="western" %) 673 -List all questions 846 +Create a new users 847 + 848 +(% class="western" %) 849 +Parameters required to create the user needs to be sent as post data in JSON format. 674 674 ))) 675 675 |((( 676 676 (% class="western" %) 677 - GET853 +PUT 678 678 )))|((( 679 679 (% class="western" %) 680 -/ questions/1856 +/users/1 681 681 )))|((( 682 682 (% class="western" %) 683 -Returns question id 1 859 +Update user id 1. The user id can be a numeric value or a hash 860 + 861 +(% class="western" %) 862 +Parameters required to update the user needs to be sent as post data in JSON format. 684 684 ))) 685 685 |((( 686 686 (% class="western" %) ... ... @@ -687,10 +687,10 @@ 687 687 GET 688 688 )))|((( 689 689 (% class="western" %) 690 -/ questions/lookup?Text=Email869 +/users/1/partners/2 691 691 )))|((( 692 692 (% class="western" %) 693 - Returns allquestionswith“Email"inquestiontext872 +Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash. 694 694 ))) 695 695 |((( 696 696 (% class="western" %) ... ... @@ -697,34 +697,41 @@ 697 697 POST 698 698 )))|((( 699 699 (% class="western" %) 700 -/ questions879 +/users/login 701 701 )))|((( 702 702 (% class="western" %) 703 -C reateanewquestion882 +Check to see user exist with username/email and password. 704 704 705 705 (% class="western" %) 706 -JSON of the Questions type object needs to be sent as post data. Id field should not be sent. 707 -))) 708 -|((( 885 +Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param. 886 + 709 709 (% class="western" %) 710 - PUT711 - )))|(((888 +Example: 889 + 712 712 (% class="western" %) 713 - /questions714 - )))|(((891 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","e":"abc@[[one-count.com>>url:http://one-count.com||shape="rect"]]","p":"1234"} 892 + 715 715 (% class="western" %) 716 - Update a question894 +OR 717 717 718 718 (% class="western" %) 719 -JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update. 897 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"} 898 + 899 +(% class="western" %) 900 +OR 901 + 902 +(% class="western" %) 903 +{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"} 904 + 905 +(% class="western" %) 906 +**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found. 720 720 ))) 721 721 722 722 723 723 724 724 (% class="western" %) 725 -**GET method canbe used to lookupquestions.**912 +**GET method should be used to lookup users.** 726 726 727 -(% class="wrapped" %) 728 728 |((( 729 729 (% class="western" %) 730 730 **Request** ... ... @@ -743,19 +743,19 @@ 743 743 String 744 744 )))|((( 745 745 (% class="western" %) 746 -URL encoded key value string parameters for the question thatauser isryingtosearch.932 +URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object. 747 747 748 748 (% class="western" %) 749 -Params: 935 +Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]] 750 750 751 751 (% class="western" %) 752 -Text: Word or phrase that should be present in the question text (String) 753 - 754 -(% class="western" %) 755 -Type: Look up the question type. 938 +return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String) 756 756 ))) 757 757 758 -(% class="wrapped" %) 941 + 942 + 943 + 944 + 759 759 |((( 760 760 (% class="western" %) 761 761 **Response** ... ... @@ -768,21 +768,20 @@ 768 768 ))) 769 769 |((( 770 770 (% class="western" %) 771 -Questions 957 +Users 958 +)))|=((( 959 +(% class="western" align="left" %) 960 +Users 772 772 )))|((( 773 773 (% class="western" %) 774 -Questions 775 -)))|((( 776 -(% class="western" %) 777 -Returns found question details. 963 +Found users returned with the demo field requested in return parameter in json format. 778 778 ))) 779 779 780 780 781 781 782 782 (% class="western" %) 783 -**POST method should be used to create questions. Thedata 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).**969 +**POST method should be used to create users.** 784 784 785 -(% class="wrapped" %) 786 786 |((( 787 787 (% class="western" %) 788 788 **Request** ... ... @@ -795,46 +795,48 @@ 795 795 ))) 796 796 |((( 797 797 (% class="western" %) 798 - Questions983 +Users 799 799 )))|((( 800 800 (% class="western" %) 801 - Questions986 +Users 802 802 )))|((( 803 803 (% class="western" %) 804 - Thisdefinesthequestioncontentsandpossibleresponses.989 +Users object that contains information about user to create. PartnerId Needs to be specified. 805 805 ))) 806 - 807 -(% class="wrapped" %) 808 808 |((( 809 809 (% class="western" %) 810 - **Response**993 +Transactions 811 811 )))|((( 812 812 (% class="western" %) 813 - **Type**996 +Transactions 814 814 )))|((( 815 815 (% class="western" %) 816 - **Description**999 +(Array of) transaction object specifying parts of the transaction to be added to the new user. UserId and TransactionId, SubscriptionType will be ignored if specified. As this is new user and new transaction is being added. 817 817 ))) 818 818 |((( 819 819 (% class="western" %) 820 - QuestionId1003 +DedupeColumns 821 821 )))|((( 822 822 (% class="western" %) 823 - Int1006 +String 824 824 )))|((( 825 825 (% class="western" %) 826 - ReturnsONEcountquestion idonsuccessful creationofthe question.1009 +CSV of question id's that should be considered to find duplicate. 827 827 ))) 828 - 829 - 830 - 1011 +|((( 831 831 (% class="western" %) 832 -PUT method should be used to update question. 1013 +Return 1014 +)))|((( 1015 +(% class="western" %) 1016 +String 1017 +)))|((( 1018 +(% class="western" %) 1019 +CSV of ONEcount QuestionId's requested back in Users object in response. 1020 +))) 833 833 834 -(% class="wrapped" %) 835 835 |((( 836 836 (% class="western" %) 837 -**Re quest**1024 +**Response** 838 838 )))|((( 839 839 (% class="western" %) 840 840 **Type** ... ... @@ -844,19 +844,23 @@ 844 844 ))) 845 845 |((( 846 846 (% class="western" %) 847 -Questions 1034 +Users 1035 +)))|=((( 1036 +(% class="western" align="left" %) 1037 +Users 848 848 )))|((( 849 849 (% class="western" %) 850 -Questions 851 -)))|((( 852 -(% class="western" %) 853 -This defines the question contents and responses. 1040 +Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned. 854 854 ))) 855 855 856 -(% class="wrapped" %) 1043 + 1044 + 1045 +(% class="western" %) 1046 +**PUT method should be used to update users.** 1047 + 857 857 |((( 858 858 (% class="western" %) 859 -**Re sponse**1050 +**Request** 860 860 )))|((( 861 861 (% class="western" %) 862 862 **Type** ... ... @@ -866,84 +866,73 @@ 866 866 ))) 867 867 |((( 868 868 (% class="western" %) 869 - QuestionId1060 +Users 870 870 )))|((( 871 871 (% class="western" %) 872 - Int1063 +Users 873 873 )))|((( 874 874 (% class="western" %) 875 -Returns ONEcountquestion idon successful updateofthequestion.1066 +Users object with update fields. Return property has csv of questions id requested back in Users object. 876 876 ))) 877 - 1068 +|((( 878 878 (% class="western" %) 879 - 880 - 1070 +Return 1071 +)))|((( 881 881 (% class="western" %) 882 -Example: Get list of questions from api which has FirstName in text 883 - 884 -{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}} 885 - 1073 +String 1074 +)))|((( 886 886 (% class="western" %) 887 -{ 888 - 1076 +CSV of ONEcount QuestionId's requested back in Users object in response 1077 +))) 1078 +|((( 889 889 (% class="western" %) 890 - "result": {891 - 1080 +RequestDate 1081 +)))|((( 892 892 (% class="western" %) 893 - "success": "1",894 - 1083 +Date 1084 +)))|((( 895 895 (% class="western" %) 896 -"error": { 1086 +RequestDate to use for the demo update. If not provided current date will be used. 1087 +))) 897 897 1089 +|((( 898 898 (% class="western" %) 899 - "code": "0",900 - 1091 +**Response** 1092 +)))|((( 901 901 (% class="western" %) 902 - "message": ""903 - 1094 +**Type** 1095 +)))|((( 904 904 (% class="western" %) 905 -} 906 - 1097 +**Description** 1098 +))) 1099 +|((( 907 907 (% class="western" %) 908 -}, 909 - 1101 +Users 1102 +)))|=((( 1103 +(% class="western" align="left" %) 1104 +Users 1105 +)))|((( 910 910 (% class="western" %) 911 -"Questions": [ 1107 +Updated user returned with the demo field requested in return parameter in json format. 1108 +))) 912 912 913 913 (% class="western" %) 914 - {1111 + 915 915 916 916 (% class="western" %) 917 - "Id":"6",1114 + 918 918 919 919 (% class="western" %) 920 - "Text":"FirstName",1117 +Create new users. Here in this example the JSON for request is passed in userFile.json file. 921 921 922 -(% class="western" %) 923 -"Type": "1", 1119 +{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}} 924 924 925 925 (% class="western" %) 926 - "Alias": "FName"1122 +**Products** 927 927 928 928 (% class="western" %) 929 -} 930 - 931 -(% class="western" %) 932 -] 933 - 934 -(% class="western" %) 935 -} 936 - 937 -(% class="western" %) 938 -\\ 939 - 940 -(% class="western" %) 941 -**COMPONENT: Products** 942 - 943 -(% class="western" %) 944 944 This resource is for manipulating products resource. A product can be created, updated or searched. 945 945 946 -(% class="wrapped" %) 947 947 |((( 948 948 (% class="western" %) 949 949 **Method** ... ... @@ -1029,7 +1029,6 @@ 1029 1029 (% class="western" %) 1030 1030 **GET method should be used to lookup products.** 1031 1031 1032 -(% class="wrapped" %) 1033 1033 |((( 1034 1034 (% class="western" %) 1035 1035 **Request** ... ... @@ -1057,7 +1057,6 @@ 1057 1057 Name: Name of the Product for lookup (String) 1058 1058 ))) 1059 1059 1060 -(% class="wrapped" %) 1061 1061 |((( 1062 1062 (% class="western" %) 1063 1063 **Response** ... ... @@ -1084,7 +1084,6 @@ 1084 1084 (% class="western" %) 1085 1085 **POST method should be used to create products.** 1086 1086 1087 -(% class="wrapped" %) 1088 1088 |((( 1089 1089 (% class="western" %) 1090 1090 **Request** ... ... @@ -1112,7 +1112,6 @@ 1112 1112 {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17} 1113 1113 ))) 1114 1114 1115 -(% class="wrapped" %) 1116 1116 |((( 1117 1117 (% class="western" %) 1118 1118 **Response** ... ... @@ -1139,7 +1139,6 @@ 1139 1139 (% class="western" %) 1140 1140 PUT method should be used to update an individual product given the product info. 1141 1141 1142 -(% class="wrapped" %) 1143 1143 |((( 1144 1144 (% class="western" %) 1145 1145 **Request** ... ... @@ -1170,7 +1170,6 @@ 1170 1170 {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17} 1171 1171 ))) 1172 1172 1173 -(% class="wrapped" %) 1174 1174 |((( 1175 1175 (% class="western" %) 1176 1176 **Response** ... ... @@ -1195,12 +1195,11 @@ 1195 1195 1196 1196 1197 1197 (% class="western" %) 1198 -** COMPONENT: Terms**1372 +**Terms** 1199 1199 1200 1200 (% class="western" %) 1201 1201 This resource is for manipulating terms resource. A term can be created, updated or searched. 1202 1202 1203 -(% class="wrapped" %) 1204 1204 |((( 1205 1205 (% class="western" %) 1206 1206 **Method** ... ... @@ -1257,7 +1257,6 @@ 1257 1257 (% class="western" %) 1258 1258 **GET method should be used to lookup products.** 1259 1259 1260 -(% class="wrapped" %) 1261 1261 |((( 1262 1262 (% class="western" %) 1263 1263 **Request** ... ... @@ -1285,7 +1285,6 @@ 1285 1285 Name: Name of the term for lookup (String) 1286 1286 ))) 1287 1287 1288 -(% class="wrapped" %) 1289 1289 |((( 1290 1290 (% class="western" %) 1291 1291 **Response** ... ... @@ -1312,7 +1312,6 @@ 1312 1312 (% class="western" %) 1313 1313 **POST method should be used to create products.** 1314 1314 1315 -(% class="wrapped" %) 1316 1316 |((( 1317 1317 (% class="western" %) 1318 1318 **Request** ... ... @@ -1343,7 +1343,6 @@ 1343 1343 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17} 1344 1344 ))) 1345 1345 1346 -(% class="wrapped" %) 1347 1347 |((( 1348 1348 (% class="western" %) 1349 1349 **Response** ... ... @@ -1370,7 +1370,6 @@ 1370 1370 (% class="western" %) 1371 1371 PUT method should be used to update an individual term given the term info. 1372 1372 1373 -(% class="wrapped" %) 1374 1374 |((( 1375 1375 (% class="western" %) 1376 1376 **Request** ... ... @@ -1401,7 +1401,6 @@ 1401 1401 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17} 1402 1402 ))) 1403 1403 1404 -(% class="wrapped" %) 1405 1405 |((( 1406 1406 (% class="western" %) 1407 1407 **Response** ... ... @@ -1426,48 +1426,11 @@ 1426 1426 1427 1427 1428 1428 (% class="western" %) 1429 -** COMPONENT:Resources**1596 +**Resources** 1430 1430 1431 1431 (% class="western" %) 1432 -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. 1433 - 1434 -* ((( 1435 -(% class="western" %) 1436 -questions 1437 -))) 1438 -* ((( 1439 -(% class="western" %) 1440 -users 1441 -))) 1442 -* ((( 1443 -(% class="western" %) 1444 -products 1445 -))) 1446 -* ((( 1447 -(% class="western" %) 1448 -terms 1449 -))) 1450 -* ((( 1451 -(% class="western" %) 1452 -resources 1453 -))) 1454 -* ((( 1455 -(% class="western" %) 1456 -sources 1457 -))) 1458 -* ((( 1459 -(% class="western" %) 1460 -transactions 1461 -))) 1462 - 1463 -(% class="western" %) 1464 -** 1465 -** 1466 - 1467 -(% class="western" %) 1468 1468 This resource is for manipulating resources resource. A resource can be created, updated or searched. 1469 1469 1470 -(% class="wrapped" %) 1471 1471 |((( 1472 1472 (% class="western" %) 1473 1473 **Method** ... ... @@ -1522,9 +1522,8 @@ 1522 1522 1523 1523 1524 1524 (% class="western" %) 1525 -**GET method should be used to lookup r esources.**1655 +**GET method should be used to lookup products.** 1526 1526 1527 -(% class="wrapped" %) 1528 1528 |((( 1529 1529 (% class="western" %) 1530 1530 **Request** ... ... @@ -1552,7 +1552,6 @@ 1552 1552 Name: Name of the resource for lookup (String) 1553 1553 ))) 1554 1554 1555 -(% class="wrapped" %) 1556 1556 |((( 1557 1557 (% class="western" %) 1558 1558 **Response** ... ... @@ -1577,9 +1577,8 @@ 1577 1577 1578 1578 1579 1579 (% class="western" %) 1580 -**POST method should be used to create r esources.**1708 +**POST method should be used to create products.** 1581 1581 1582 -(% class="wrapped" %) 1583 1583 |((( 1584 1584 (% class="western" %) 1585 1585 **Request** ... ... @@ -1610,7 +1610,6 @@ 1610 1610 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”} 1611 1611 ))) 1612 1612 1613 -(% class="wrapped" %) 1614 1614 |((( 1615 1615 (% class="western" %) 1616 1616 **Response** ... ... @@ -1637,7 +1637,6 @@ 1637 1637 (% class="western" %) 1638 1638 PUT method should be used to update an individual resource given the resource info. 1639 1639 1640 -(% class="wrapped" %) 1641 1641 |((( 1642 1642 (% class="western" %) 1643 1643 **Request** ... ... @@ -1668,7 +1668,6 @@ 1668 1668 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”} 1669 1669 ))) 1670 1670 1671 -(% class="wrapped" %) 1672 1672 |((( 1673 1673 (% class="western" %) 1674 1674 **Response** ... ... @@ -1692,6 +1692,7 @@ 1692 1692 1693 1693 1694 1694 1819 +(% class="western" %) 1695 1695 1696 1696 1697 1697 (% class="western" %) ... ... @@ -1698,13 +1698,11 @@ 1698 1698 1699 1699 1700 1700 (% class="western" %) 1701 -**COMPONENT: Source Codes 1702 -** 1826 +**Sources** 1703 1703 1704 1704 (% class="western" %) 1705 -This resource is for manipulating source code fora resource. A source code can be created, updated or searched.1829 +This resource is for manipulating sources resource. A source can be created, updated or searched. 1706 1706 1707 -(% class="wrapped" %) 1708 1708 |((( 1709 1709 (% class="western" %) 1710 1710 **Method** ... ... @@ -1761,7 +1761,6 @@ 1761 1761 (% class="western" %) 1762 1762 **Sources can be looked up given the code or Id. GET method should be used for lookup.** 1763 1763 1764 -(% class="wrapped" %) 1765 1765 |((( 1766 1766 (% class="western" %) 1767 1767 **Request** ... ... @@ -1789,7 +1789,6 @@ 1789 1789 Source: Source value (String) 1790 1790 ))) 1791 1791 1792 -(% class="wrapped" %) 1793 1793 |((( 1794 1794 (% class="western" %) 1795 1795 **Response** ... ... @@ -1819,7 +1819,6 @@ 1819 1819 (% class="western" %) 1820 1820 POST method should be used to create an individual source given the source parameters. 1821 1821 1822 -(% class="wrapped" %) 1823 1823 |((( 1824 1824 (% class="western" %) 1825 1825 **Request** ... ... @@ -1841,7 +1841,6 @@ 1841 1841 Defines the contents that makes up the source. Id parameters should not be set. 1842 1842 ))) 1843 1843 1844 -(% class="wrapped" %) 1845 1845 |((( 1846 1846 (% class="western" %) 1847 1847 **Response** ... ... @@ -1868,7 +1868,6 @@ 1868 1868 (% class="western" %) 1869 1869 **PUT method can be used to update an individual source given the id.** 1870 1870 1871 -(% class="wrapped" %) 1872 1872 |((( 1873 1873 (% class="western" %) 1874 1874 **Request** ... ... @@ -1890,7 +1890,6 @@ 1890 1890 Defines the contents that makes up the source. The id parameter needs to be set which will identify the id of the source to be updated. 1891 1891 ))) 1892 1892 1893 -(% class="wrapped" %) 1894 1894 |((( 1895 1895 (% class="western" %) 1896 1896 **Response** ... ... @@ -1918,12 +1918,11 @@ 1918 1918 1919 1919 1920 1920 (% class="western" %) 1921 -** COMPONENT: Transactions**2038 +**Transactions** 1922 1922 1923 1923 (% class="western" %) 1924 1924 This resource is for manipulating transactions resource. A transaction can be created or searched. 1925 1925 1926 -(% class="wrapped" %) 1927 1927 |((( 1928 1928 (% class="western" %) 1929 1929 **Method** ... ... @@ -1973,7 +1973,6 @@ 1973 1973 (% class="western" %) 1974 1974 Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup. 1975 1975 1976 -(% class="wrapped" %) 1977 1977 |((( 1978 1978 (% class="western" %) 1979 1979 **Request** ... ... @@ -2011,7 +2011,6 @@ 2011 2011 2012 2012 2013 2013 2014 -(% class="wrapped" %) 2015 2015 |((( 2016 2016 (% class="western" %) 2017 2017 **Response** ... ... @@ -2038,7 +2038,6 @@ 2038 2038 (% class="western" %) 2039 2039 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. 2040 2040 2041 -(% class="wrapped" %) 2042 2042 |((( 2043 2043 (% class="western" %) 2044 2044 **Request** ... ... @@ -2060,7 +2060,6 @@ 2060 2060 Contains fields that define a transaction. Id field should not be set. 2061 2061 ))) 2062 2062 2063 -(% class="wrapped" %) 2064 2064 |((( 2065 2065 (% class="western" %) 2066 2066 **Response** ... ... @@ -2084,11 +2084,8 @@ 2084 2084 2085 2085 2086 2086 2087 - 2088 - 2089 2089 (% class="western" %) 2090 -**COMPONENT: Leads 2091 -** 2200 +**Stats** 2092 2092 2093 2093 (% class="western" %) 2094 2094 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. ... ... @@ -2109,14 +2109,12 @@ 2109 2109 2110 2110 2111 2111 (% class="western" %) 2112 -**Telemarketing Leads 2113 -** 2221 +**Telemarketing** 2114 2114 2115 2115 (% class="western" %) 2116 2116 2117 2117 This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed. 2118 2118 2119 -(% class="wrapped" %) 2120 2120 |((( 2121 2121 (% class="western" %) 2122 2122 **Method** ... ... @@ -2163,7 +2163,6 @@ 2163 2163 (% class="western" %) 2164 2164 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. 2165 2165 2166 -(% class="wrapped" %) 2167 2167 |((( 2168 2168 (% class="western" %) 2169 2169 **Request** ... ... @@ -2237,7 +2237,6 @@ 2237 2237 2238 2238 ))) 2239 2239 2240 -(% class="wrapped" %) 2241 2241 |((( 2242 2242 (% class="western" %) 2243 2243 **Response** ... ... @@ -2261,21 +2261,12 @@ 2261 2261 2262 2262 2263 2263 2264 - 2265 - 2266 - 2267 - 2268 - 2269 - 2270 - 2271 - 2272 2272 (% class="western" %) 2273 -** APIREFERENCE**2370 +**Reference** 2274 2274 2275 2275 (% class="western" %) 2276 2276 **Type: Questions** 2277 2277 2278 -(% class="wrapped" %) 2279 2279 |((( 2280 2280 (% class="western" %) 2281 2281 **Property Name** ... ... @@ -2355,7 +2355,6 @@ 2355 2355 (% class="western" %) 2356 2356 **Type: Choices** 2357 2357 2358 -(% class="wrapped" %) 2359 2359 |((( 2360 2360 (% class="western" %) 2361 2361 **Property Name** ... ... @@ -2422,7 +2422,6 @@ 2422 2422 (% class="western" %) 2423 2423 **Type: Users** 2424 2424 2425 -(% class="wrapped" %) 2426 2426 |((( 2427 2427 (% class="western" %) 2428 2428 **Property Name** ... ... @@ -2479,7 +2479,6 @@ 2479 2479 (% class="western" %) 2480 2480 **Type: Demo** 2481 2481 2482 -(% class="wrapped" %) 2483 2483 |((( 2484 2484 (% class="western" %) 2485 2485 **Property Name** ... ... @@ -2526,7 +2526,6 @@ 2526 2526 (% class="western" %) 2527 2527 **Type: Transactions** 2528 2528 2529 -(% class="wrapped" %) 2530 2530 |((( 2531 2531 (% class="western" %) 2532 2532 **Property Name** ... ... @@ -2673,7 +2673,6 @@ 2673 2673 (% class="western" %) 2674 2674 **Type: Sources** 2675 2675 2676 -(% class="wrapped" %) 2677 2677 |((( 2678 2678 (% class="western" %) 2679 2679 **Property Name** ... ... @@ -2733,7 +2733,6 @@ 2733 2733 (% class="western" %) 2734 2734 **Type: Products** 2735 2735 2736 -(% class="wrapped" %) 2737 2737 |((( 2738 2738 (% class="western" %) 2739 2739 **Property Name** ... ... @@ -2790,7 +2790,6 @@ 2790 2790 (% class="western" %) 2791 2791 **Type: Terms** 2792 2792 2793 -(% class="wrapped" %) 2794 2794 |((( 2795 2795 (% class="western" %) 2796 2796 **Property Name** ... ... @@ -2877,7 +2877,6 @@ 2877 2877 (% class="western" %) 2878 2878 **Type: Resources** 2879 2879 2880 -(% class="wrapped" %) 2881 2881 |((( 2882 2882 (% class="western" %) 2883 2883 **Property Name** ... ... @@ -2975,7 +2975,6 @@ 2975 2975 (% class="western" %) 2976 2976 **Type: Telemarketing** 2977 2977 2978 -(% class="wrapped" %) 2979 2979 |((( 2980 2980 (% class="western" %) 2981 2981 **Property Name**
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -3539 0101 +3538998 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://info.onecount.net//wiki/spaces/OD/pages/3539 010/ONEcountAPIation1 +https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18