Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 6.1
edited by Admin
on 2017/04/05 10:47
Change comment: There is no comment for this version
To version 19.1
edited by Admin
on 2023/12/14 21:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ONEcount API Documentation
1 +OLD-ONEcount API Documentation
Content
... ... @@ -2,7 +2,7 @@
2 2  **Introduction**
3 3  
4 4  (% class="western" %)
5 -ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. his API can be used to lookup, create and updated different ONEcount resources which are listed below.
5 +ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. This API can be used to lookup, create and update different ONEcount data components 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:
... ... @@ -9,7 +9,7 @@
9 9  
10 10  1. (((
11 11  (% class="western" %)
12 -**GET** - Used for lookup of resources
12 +**GET** - Used for lookup of resourcesresources
13 13  )))
14 14  1. (((
15 15  (% class="western" %)
... ... @@ -28,10 +28,10 @@
28 28  11. Lookup users
29 29  11. Create users
30 30  11. Update users
31 -1. Transaction data
32 -11. Lookup transactions
33 -11. Create transactions
34 -\\
31 +1. Questions
32 +11. Lookup questions
33 +11. List questions
34 +11. Create questions
35 35  1. Product data
36 36  11. Lookup products
37 37  11. Create products
... ... @@ -44,10 +44,9 @@
44 44  11. Lookup resources
45 45  11. Create resources
46 46  11. Update resources
47 -1. Questions
48 -11. Lookup questions
49 -11. List questions
50 -11. Create questions
47 +1. Transaction data
48 +11. Lookup transactions
49 +11. Create transactions
51 51  1. Source Codes
52 52  11. Lookup source code
53 53  11. Create source codes
... ... @@ -67,8 +67,7 @@
67 67  **Appkey**: THIS WILL BE PROVIDED TO YOU
68 68  
69 69  (% class="western" %)
70 -**
71 -**
69 +**~ **
72 72  
73 73  (% class="western" %)
74 74  Your HTTP requests to a REST API resource should contain the following information:
... ... @@ -91,7 +91,7 @@
91 91  )))
92 92  
93 93  (% class="western" %)
94 -
92 +\\
95 95  
96 96  (% class="western" %)
97 97  **General API Usage**
... ... @@ -103,7 +103,7 @@
103 103  For lookup, the parameter list will be part of the request url.
104 104  
105 105  (% class="western" %)
106 -
104 +\\
107 107  
108 108  (% class="western" %)
109 109  **Response**
... ... @@ -166,7 +166,7 @@
166 166  The result of the api request will be determined by the value of the success property of result object. Here the value of success will either be 1 (true) or 0 (false) depending on whether the requested action succeed.
167 167  
168 168  (% class="western" %)
169 -
167 +\\
170 170  
171 171  (% class="western" %)
172 172  If value of success is 0 then an error will be generated inside the result object. Code property will have an error code. message property will have the details about the error. This value might be used to display the error in the client application. The response will always have a result object in it plus the individual response listed for each method.
... ... @@ -222,118 +222,102 @@
222 222   ]}]}}}}
223 223  
224 224  (% class="western" %)
225 -
223 +\\
226 226  
227 227  (% class="western" %)
228 -**
229 -**
226 +**~ **
230 230  
231 -(% class="western" %)
232 -**
233 -**
228 +**COMPONENT: Users**
234 234  
235 235  (% class="western" %)
236 -**
237 -**
231 +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.
238 238  
239 -
240 -
241 241  (% class="western" %)
242 -**RESOURCE: Questions**
234 +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.
243 243  
244 244  (% class="western" %)
245 -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).
237 +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.
246 246  
247 247  (% class="western" %)
248 -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.
240 +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.
249 249  
250 250  (% class="western" %)
251 -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)
243 +Return parameter will have the comma separated list of question Ids that is requested back from the API.
252 252  
253 253  (% class="western" %)
254 -There can be 6 types of questions:
246 +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.
255 255  
248 +\\
249 +
256 256  (% class="wrapped" %)
257 257  |(((
258 -(% class="western" align="center" %)
259 -**Type**
260 -)))|(((
261 261  (% class="western" %)
262 -**Description**
263 -)))
264 -|(((
265 -(% class="western" align="center" %)
266 -1
253 +**Method**
267 267  )))|(((
268 268  (% class="western" %)
269 -Textbox type questions or short response type question. The response length needs to be less than 255 characters.
270 -)))
271 -|(((
272 -(% class="western" align="center" %)
273 -2
256 +**Url**
274 274  )))|(((
275 275  (% class="western" %)
276 -Textarea type question or long response type question.
259 +**Action**
277 277  )))
278 278  |(((
279 -(% class="western" align="center" %)
280 -3
262 +(% class="western" %)
263 +GET
281 281  )))|(((
282 282  (% class="western" %)
283 -Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
284 -)))
285 -|(((
286 -(% class="western" align="center" %)
287 -4
266 +/users
288 288  )))|(((
289 289  (% class="western" %)
290 -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.
269 +Get users data limiting 25.
291 291  )))
292 292  |(((
293 -(% class="western" align="center" %)
294 -5
272 +(% class="western" %)
273 +GET
295 295  )))|(((
296 296  (% class="western" %)
297 -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.
298 -)))
299 -|(((
300 -(% class="western" align="center" %)
301 -6
276 +/users/<ocid or ocid_hash>
302 302  )))|(((
303 303  (% class="western" %)
304 -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.
279 +Get data for user id 1. The user id can be a numeric value or a hash
305 305  )))
306 -
307 -(% class="wrapped" %)
308 308  |(((
309 309  (% class="western" %)
310 -**Method**
283 +GET
311 311  )))|(((
312 312  (% class="western" %)
313 -**Url**
286 +/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
314 314  )))|(((
315 315  (% class="western" %)
316 -**Action**
289 +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.
290 +
291 +(% class="western" %)
292 +Return parameter defines a csv of question id that are requested back in response.
317 317  )))
318 318  |(((
319 319  (% class="western" %)
320 -GET
296 +POST
321 321  )))|(((
322 322  (% class="western" %)
323 -/questions
299 +/users
324 324  )))|(((
325 325  (% class="western" %)
326 -List all questions
302 +Create a new users
303 +
304 +(% class="western" %)
305 +Parameters required to create the user needs to be sent as post data in JSON format.
327 327  )))
328 328  |(((
329 329  (% class="western" %)
330 -GET
309 +PUT
331 331  )))|(((
332 332  (% class="western" %)
333 -/questions/1
312 +/users/1
334 334  )))|(((
335 335  (% class="western" %)
336 -Returns question id 1
315 +Update user id 1. The user id can be a numeric value or a hash
316 +
317 +(% class="western" %)
318 +Parameters required to update the user needs to be sent as post data in JSON format.
337 337  )))
338 338  |(((
339 339  (% class="western" %)
... ... @@ -340,10 +340,10 @@
340 340  GET
341 341  )))|(((
342 342  (% class="western" %)
343 -/questions/lookup?Text=Email
325 +/users/1/partners/2
344 344  )))|(((
345 345  (% class="western" %)
346 -Returns all questions with “Email" in question text
328 +Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
347 347  )))
348 348  |(((
349 349  (% class="western" %)
... ... @@ -350,32 +350,40 @@
350 350  POST
351 351  )))|(((
352 352  (% class="western" %)
353 -/questions
335 +/users/login
354 354  )))|(((
355 355  (% class="western" %)
356 -Create a new question
338 +Check to see user exist with username/email and password.
357 357  
358 358  (% class="western" %)
359 -JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
360 -)))
361 -|(((
341 +Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
342 +
362 362  (% class="western" %)
363 -PUT
364 -)))|(((
344 +Example:
345 +
365 365  (% class="western" %)
366 -/questions
367 -)))|(((
347 +{"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"}
348 +
368 368  (% class="western" %)
369 -Update a question
350 +OR
370 370  
371 371  (% class="western" %)
372 -JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
353 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
354 +
355 +(% class="western" %)
356 +OR
357 +
358 +(% class="western" %)
359 +{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
360 +
361 +(% class="western" %)
362 +**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
373 373  )))
374 374  
375 -
365 +\\
376 376  
377 377  (% class="western" %)
378 -**GET method can be used to lookup questions.**
368 +**GET method should be used to lookup users.**
379 379  
380 380  (% class="wrapped" %)
381 381  |(((
... ... @@ -396,18 +396,22 @@
396 396  String
397 397  )))|(((
398 398  (% class="western" %)
399 -URL encoded key value string parameters for the question that a user is trying to search.
389 +URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
400 400  
401 401  (% class="western" %)
402 -Params:
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"]]
403 403  
404 404  (% class="western" %)
405 -Text: Word or phrase that should be present in the question text (String)
395 +return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
406 406  
407 407  (% class="western" %)
408 -Type: Look up the question type.
398 +If return is not provided, all the demographics will be returned.
409 409  )))
410 410  
401 +\\
402 +
403 +\\
404 +
411 411  (% class="wrapped" %)
412 412  |(((
413 413  (% class="western" %)
... ... @@ -421,19 +421,45 @@
421 421  )))
422 422  |(((
423 423  (% class="western" %)
424 -Questions
418 +Users
419 +)))|=(((
420 +(% class="western" align="left" %)
421 +Users
425 425  )))|(((
426 426  (% class="western" %)
427 -Questions
428 -)))|(((
429 -(% class="western" %)
430 -Returns found question details.
424 +Found users returned with the demo field requested in return parameter in json format
431 431  )))
432 432  
433 -
427 +\\
434 434  
429 +**Sample response for /users/(% style="color: rgb(80,80,80);" %)<OCID or ocid_hash>(%%)**
430 +
431 +Along with the demo in json format, the active packages and products of the user referred to as products and resources respectively are also returned.
432 +
433 +(% class="relative-table wrapped" style="width: 100.0%;" %)
434 +|=(((
435 +(% class="content-wrapper" %)
436 +(((
437 +[[image:attach:Screen Shot 2020-02-26 at 11.15.52 AM.png||width="1407"]]
438 +)))
439 +)))
440 +
441 +\\
442 +
443 +**Sample response for /users/lookup?(% style="color: rgb(80,80,80);" %)11=santosh@[[one-count.com>>url:http://one-count.com||shape="rect"]]&return=2,3(%%)**
444 +
445 +(% class="wrapped" %)
446 +|=(((
447 +(% class="content-wrapper" %)
448 +(((
449 +[[image:attach:Screen Shot 2020-02-26 at 11.22.13 AM.png||height="250"]]
450 +)))
451 +)))
452 +
453 +\\
454 +
435 435  (% class="western" %)
436 -**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).**
456 +**POST method should be used to create users.**
437 437  
438 438  (% class="wrapped" %)
439 439  |(((
... ... @@ -448,46 +448,49 @@
448 448  )))
449 449  |(((
450 450  (% class="western" %)
451 -Questions
471 +Users
452 452  )))|(((
453 453  (% class="western" %)
454 -Questions
474 +Users
455 455  )))|(((
456 456  (% class="western" %)
457 -This defines the question contents and possible responses.
477 +Users object that contains information about user to create. PartnerId Needs to be specified.
458 458  )))
459 -
460 -(% class="wrapped" %)
461 461  |(((
462 462  (% class="western" %)
463 -**Response**
481 +Transactions
464 464  )))|(((
465 465  (% class="western" %)
466 -**Type**
484 +Transactions
467 467  )))|(((
468 468  (% class="western" %)
469 -**Description**
487 +(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.
470 470  )))
471 471  |(((
472 472  (% class="western" %)
473 -QuestionId
491 +DedupeColumns
474 474  )))|(((
475 475  (% class="western" %)
476 -Int
494 +String
477 477  )))|(((
478 478  (% class="western" %)
479 -Returns ONEcount question id on successful creation of the question.
497 +CSV of question id's that should be considered to find duplicate.
480 480  )))
481 -
482 -
483 -
499 +|(((
484 484  (% class="western" %)
485 -PUT method should be used to update question.
501 +Return
502 +)))|(((
503 +(% class="western" %)
504 +String
505 +)))|(((
506 +(% class="western" %)
507 +CSV of ONEcount QuestionId's requested back in Users object in response.
508 +)))
486 486  
487 487  (% class="wrapped" %)
488 488  |(((
489 489  (% class="western" %)
490 -**Request**
513 +**Response**
491 491  )))|(((
492 492  (% class="western" %)
493 493  **Type**
... ... @@ -497,19 +497,24 @@
497 497  )))
498 498  |(((
499 499  (% class="western" %)
500 -Questions
523 +Users
524 +)))|=(((
525 +(% class="western" align="left" %)
526 +Users
501 501  )))|(((
502 502  (% class="western" %)
503 -Questions
504 -)))|(((
505 -(% class="western" %)
506 -This defines the question contents and responses.
529 +Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
507 507  )))
508 508  
532 +\\
533 +
534 +(% class="western" %)
535 +**PUT method should be used to update users.**
536 +
509 509  (% class="wrapped" %)
510 510  |(((
511 511  (% class="western" %)
512 -**Response**
540 +**Request**
513 513  )))|(((
514 514  (% class="western" %)
515 515  **Type**
... ... @@ -519,168 +519,172 @@
519 519  )))
520 520  |(((
521 521  (% class="western" %)
522 -QuestionId
550 +Users
523 523  )))|(((
524 524  (% class="western" %)
525 -Int
553 +Users
526 526  )))|(((
527 527  (% class="western" %)
528 -Returns ONEcount question id on successful update of the question.
556 +Users object with update fields. Return property has csv of questions id requested back in Users object.
529 529  )))
530 -
558 +|(((
531 531  (% class="western" %)
532 -
533 -
560 +Return
561 +)))|(((
534 534  (% class="western" %)
535 -Example: Get list of questions from api which has FirstName in text
536 -
537 -{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
538 -
563 +String
564 +)))|(((
539 539  (% class="western" %)
540 -{
541 -
566 +CSV of ONEcount QuestionId's requested back in Users object in response
567 +)))
568 +|(((
542 542  (% class="western" %)
543 -"result": {
544 -
570 +RequestDate
571 +)))|(((
545 545  (% class="western" %)
546 -"success": "1",
547 -
573 +Date
574 +)))|(((
548 548  (% class="western" %)
549 -"error": {
576 +RequestDate to use for the demo update. If not provided current date will be used.
577 +)))
550 550  
579 +(% class="wrapped" %)
580 +|(((
551 551  (% class="western" %)
552 -"code": "0",
553 -
582 +**Response**
583 +)))|(((
554 554  (% class="western" %)
555 -"message": ""
556 -
585 +**Type**
586 +)))|(((
557 557  (% class="western" %)
558 -}
559 -
588 +**Description**
589 +)))
590 +|(((
560 560  (% class="western" %)
561 -},
562 -
592 +Users
593 +)))|=(((
594 +(% class="western" align="left" %)
595 +Users
596 +)))|(((
563 563  (% class="western" %)
564 -"Questions": [
598 +Updated user returned with the demo field requested in return parameter in json format.
599 +)))
565 565  
566 566  (% class="western" %)
567 -{
602 +\\
568 568  
569 569  (% class="western" %)
570 -"Id": "6",
605 +\\
571 571  
572 572  (% class="western" %)
573 -"Text": "FirstName",
608 +Create new users. Here in this example the JSON for request is passed in userFile.json file.
574 574  
575 -(% class="western" %)
576 -"Type": "1",
610 +{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
577 577  
578 578  (% class="western" %)
579 -"Alias": "FName"
613 +**~ **
580 580  
581 581  (% class="western" %)
582 -}
616 +**~ **
583 583  
584 -(% class="western" %)
585 -]
618 +\\
586 586  
587 587  (% class="western" %)
588 -}
621 +**COMPONENT: Questions**
589 589  
590 590  (% class="western" %)
624 +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).
591 591  
592 -**RESOURCE: Users**
593 -
594 594  (% class="western" %)
595 -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.
627 +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.
596 596  
597 597  (% class="western" %)
598 -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.
630 +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)
599 599  
600 600  (% class="western" %)
601 -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.
633 +There can be 6 types of questions:
602 602  
603 -(% class="western" %)
604 -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.
605 -
606 -(% class="western" %)
607 -Return parameter will have the comma separated list of question Ids that is requested back from the API.
608 -
609 -(% class="western" %)
610 -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.
611 -
612 -(% class="western" %)
613 -
614 -
615 615  (% class="wrapped" %)
616 616  |(((
617 -(% class="western" %)
618 -**Method**
637 +(% class="western" align="center" %)
638 +**Type**
619 619  )))|(((
620 620  (% class="western" %)
621 -**Url**
641 +**Description**
642 +)))
643 +|(((
644 +(% class="western" align="center" %)
645 +1
622 622  )))|(((
623 623  (% class="western" %)
624 -**Action**
648 +Textbox type questions or short response type question. The response length needs to be less than 255 characters.
625 625  )))
626 626  |(((
627 -(% class="western" %)
628 -GET
651 +(% class="western" align="center" %)
652 +2
629 629  )))|(((
630 630  (% class="western" %)
631 -/users
655 +Textarea type question or long response type question.
656 +)))
657 +|(((
658 +(% class="western" align="center" %)
659 +3
632 632  )))|(((
633 633  (% class="western" %)
634 -Get users data limiting 25.
662 +Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
635 635  )))
636 636  |(((
665 +(% class="western" align="center" %)
666 +4
667 +)))|(((
637 637  (% class="western" %)
638 -GET
669 +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.
670 +)))
671 +|(((
672 +(% class="western" align="center" %)
673 +5
639 639  )))|(((
640 640  (% class="western" %)
641 -/users/1
676 +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.
677 +)))
678 +|(((
679 +(% class="western" align="center" %)
680 +6
642 642  )))|(((
643 643  (% class="western" %)
644 -Get data for user id 1. The user id can be a numeric value or a hash
683 +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.
645 645  )))
685 +
686 +(% class="wrapped" %)
646 646  |(((
647 647  (% class="western" %)
648 -GET
689 +**Method**
649 649  )))|(((
650 650  (% class="western" %)
651 -/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
692 +**Url**
652 652  )))|(((
653 653  (% class="western" %)
654 -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.
655 -
656 -(% class="western" %)
657 -Return parameter defines a csv of question id that are requested back in response.
695 +**Action**
658 658  )))
659 659  |(((
660 660  (% class="western" %)
661 -POST
699 +GET
662 662  )))|(((
663 663  (% class="western" %)
664 -/users
702 +/questions
665 665  )))|(((
666 666  (% class="western" %)
667 -Create a new users
668 -
669 -(% class="western" %)
670 -Parameters required to create the user needs to be sent as post data in JSON format.
705 +List all questions
671 671  )))
672 672  |(((
673 673  (% class="western" %)
674 -PUT
709 +GET
675 675  )))|(((
676 676  (% class="western" %)
677 -/users/1
712 +/questions/1
678 678  )))|(((
679 679  (% class="western" %)
680 -Update user id 1. The user id can be a numeric value or a hash
681 -
682 -(% class="western" %)
683 -Parameters required to update the user needs to be sent as post data in JSON format.
715 +Returns question id 1
684 684  )))
685 685  |(((
686 686  (% class="western" %)
... ... @@ -687,10 +687,10 @@
687 687  GET
688 688  )))|(((
689 689  (% class="western" %)
690 -/users/1/partners/2
722 +/questions/lookup?Text=Email
691 691  )))|(((
692 692  (% class="western" %)
693 -Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
725 +Returns all questions with “Email" in question text
694 694  )))
695 695  |(((
696 696  (% class="western" %)
... ... @@ -697,40 +697,32 @@
697 697  POST
698 698  )))|(((
699 699  (% class="western" %)
700 -/users/login
732 +/questions
701 701  )))|(((
702 702  (% class="western" %)
703 -Check to see user exist with username/email and password.
735 +Create a new question
704 704  
705 705  (% class="western" %)
706 -Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
707 -
738 +JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
739 +)))
740 +|(((
708 708  (% class="western" %)
709 -Example:
710 -
742 +PUT
743 +)))|(((
711 711  (% class="western" %)
712 -{"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"}
713 -
745 +/questions
746 +)))|(((
714 714  (% class="western" %)
715 -OR
748 +Update a question
716 716  
717 717  (% class="western" %)
718 -{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
719 -
720 -(% class="western" %)
721 -OR
722 -
723 -(% class="western" %)
724 -{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
725 -
726 -(% class="western" %)
727 -**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
751 +JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
728 728  )))
729 729  
730 -
754 +\\
731 731  
732 732  (% class="western" %)
733 -**GET method should be used to lookup users.**
757 +**GET method can be used to lookup questions.**
734 734  
735 735  (% class="wrapped" %)
736 736  |(((
... ... @@ -751,19 +751,18 @@
751 751  String
752 752  )))|(((
753 753  (% class="western" %)
754 -URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
778 +URL encoded key value string parameters for the question that a user is trying to search.
755 755  
756 756  (% class="western" %)
757 -Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
781 +Params:
758 758  
759 759  (% class="western" %)
760 -return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
784 +Text: Word or phrase that should be present in the question text (String)
785 +
786 +(% class="western" %)
787 +Type: Look up the question type.
761 761  )))
762 762  
763 -
764 -
765 -
766 -
767 767  (% class="wrapped" %)
768 768  |(((
769 769  (% class="western" %)
... ... @@ -777,19 +777,19 @@
777 777  )))
778 778  |(((
779 779  (% class="western" %)
780 -Users
781 -)))|=(((
782 -(% class="western" align="left" %)
783 -Users
803 +Questions
784 784  )))|(((
785 785  (% class="western" %)
786 -Found users returned with the demo field requested in return parameter in json format.
806 +Questions
807 +)))|(((
808 +(% class="western" %)
809 +Returns found question details.
787 787  )))
788 788  
789 -
812 +\\
790 790  
791 791  (% class="western" %)
792 -**POST method should be used to create users.**
815 +**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).**
793 793  
794 794  (% class="wrapped" %)
795 795  |(((
... ... @@ -804,49 +804,46 @@
804 804  )))
805 805  |(((
806 806  (% class="western" %)
807 -Users
830 +Questions
808 808  )))|(((
809 809  (% class="western" %)
810 -Users
833 +Questions
811 811  )))|(((
812 812  (% class="western" %)
813 -Users object that contains information about user to create. PartnerId Needs to be specified.
836 +This defines the question contents and possible responses.
814 814  )))
838 +
839 +(% class="wrapped" %)
815 815  |(((
816 816  (% class="western" %)
817 -Transactions
842 +**Response**
818 818  )))|(((
819 819  (% class="western" %)
820 -Transactions
845 +**Type**
821 821  )))|(((
822 822  (% class="western" %)
823 -(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.
848 +**Description**
824 824  )))
825 825  |(((
826 826  (% class="western" %)
827 -DedupeColumns
852 +QuestionId
828 828  )))|(((
829 829  (% class="western" %)
830 -String
855 +Int
831 831  )))|(((
832 832  (% class="western" %)
833 -CSV of question id's that should be considered to find duplicate.
858 +Returns ONEcount question id on successful creation of the question.
834 834  )))
835 -|(((
860 +
861 +\\
862 +
836 836  (% class="western" %)
837 -Return
838 -)))|(((
839 -(% class="western" %)
840 -String
841 -)))|(((
842 -(% class="western" %)
843 -CSV of ONEcount QuestionId's requested back in Users object in response.
844 -)))
864 +PUT method should be used to update question.
845 845  
846 846  (% class="wrapped" %)
847 847  |(((
848 848  (% class="western" %)
849 -**Response**
869 +**Request**
850 850  )))|(((
851 851  (% class="western" %)
852 852  **Type**
... ... @@ -856,24 +856,19 @@
856 856  )))
857 857  |(((
858 858  (% class="western" %)
859 -Users
860 -)))|=(((
861 -(% class="western" align="left" %)
862 -Users
879 +Questions
863 863  )))|(((
864 864  (% class="western" %)
865 -Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
882 +Questions
883 +)))|(((
884 +(% class="western" %)
885 +This defines the question contents and responses.
866 866  )))
867 867  
868 -
869 -
870 -(% class="western" %)
871 -**PUT method should be used to update users.**
872 -
873 873  (% class="wrapped" %)
874 874  |(((
875 875  (% class="western" %)
876 -**Request**
891 +**Response**
877 877  )))|(((
878 878  (% class="western" %)
879 879  **Type**
... ... @@ -883,72 +883,81 @@
883 883  )))
884 884  |(((
885 885  (% class="western" %)
886 -Users
901 +QuestionId
887 887  )))|(((
888 888  (% class="western" %)
889 -Users
904 +Int
890 890  )))|(((
891 891  (% class="western" %)
892 -Users object with update fields. Return property has csv of questions id requested back in Users object.
907 +Returns ONEcount question id on successful update of the question.
893 893  )))
894 -|(((
909 +
895 895  (% class="western" %)
896 -Return
897 -)))|(((
911 +\\
912 +
898 898  (% class="western" %)
899 -String
900 -)))|(((
914 +Example: Get list of questions from api which has FirstName in text
915 +
916 +{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
917 +
901 901  (% class="western" %)
902 -CSV of ONEcount QuestionId's requested back in Users object in response
903 -)))
904 -|(((
919 +{
920 +
905 905  (% class="western" %)
906 -RequestDate
907 -)))|(((
922 +"result": {
923 +
908 908  (% class="western" %)
909 -Date
910 -)))|(((
925 +"success": "1",
926 +
911 911  (% class="western" %)
912 -RequestDate to use for the demo update. If not provided current date will be used.
913 -)))
928 +"error": {
914 914  
915 -(% class="wrapped" %)
916 -|(((
917 917  (% class="western" %)
918 -**Response**
919 -)))|(((
931 +"code": "0",
932 +
920 920  (% class="western" %)
921 -**Type**
922 -)))|(((
934 +"message": ""
935 +
923 923  (% class="western" %)
924 -**Description**
925 -)))
926 -|(((
937 +}
938 +
927 927  (% class="western" %)
928 -Users
929 -)))|=(((
930 -(% class="western" align="left" %)
931 -Users
932 -)))|(((
940 +},
941 +
933 933  (% class="western" %)
934 -Updated user returned with the demo field requested in return parameter in json format.
935 -)))
943 +"Questions": [
936 936  
937 937  (% class="western" %)
938 -
946 +{
939 939  
940 940  (% class="western" %)
941 -
949 +"Id": "6",
942 942  
943 943  (% class="western" %)
944 -Create new users. Here in this example the JSON for request is passed in userFile.json file.
952 +"Text": "FirstName",
945 945  
946 -{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
954 +(% class="western" %)
955 +"Type": "1",
947 947  
948 948  (% class="western" %)
949 -**Products**
958 +"Alias": "FName"
950 950  
951 951  (% class="western" %)
961 +}
962 +
963 +(% class="western" %)
964 +]
965 +
966 +(% class="western" %)
967 +}
968 +
969 +(% class="western" %)
970 +\\
971 +
972 +(% class="western" %)
973 +**COMPONENT: Products**
974 +
975 +(% class="western" %)
952 952  This resource is for manipulating products resource. A product can be created, updated or searched.
953 953  
954 954  (% class="wrapped" %)
... ... @@ -1032,7 +1032,7 @@
1032 1032  {"ProductID":"65","ResourceID":”121"}
1033 1033  )))
1034 1034  
1035 -
1059 +\\
1036 1036  
1037 1037  (% class="western" %)
1038 1038  **GET method should be used to lookup products.**
... ... @@ -1087,7 +1087,7 @@
1087 1087  Returns found product details.
1088 1088  )))
1089 1089  
1090 -
1114 +\\
1091 1091  
1092 1092  (% class="western" %)
1093 1093  **POST method should be used to create products.**
... ... @@ -1117,7 +1117,7 @@
1117 1117  Example:
1118 1118  
1119 1119  (% class="western" %)
1120 -{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1144 +{"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1121 1121  )))
1122 1122  
1123 1123  (% class="wrapped" %)
... ... @@ -1142,7 +1142,7 @@
1142 1142  Product Id of the newly created product.
1143 1143  )))
1144 1144  
1145 -
1169 +\\
1146 1146  
1147 1147  (% class="western" %)
1148 1148  PUT method should be used to update an individual product given the product info.
... ... @@ -1175,7 +1175,7 @@
1175 1175  **Example**:
1176 1176  
1177 1177  (% class="western" %)
1178 -{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1202 +{"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
1179 1179  )))
1180 1180  
1181 1181  (% class="wrapped" %)
... ... @@ -1200,10 +1200,10 @@
1200 1200  Product id of the updated product.
1201 1201  )))
1202 1202  
1203 -
1227 +\\
1204 1204  
1205 1205  (% class="western" %)
1206 -**Terms**
1230 +**COMPONENT: Terms**
1207 1207  
1208 1208  (% class="western" %)
1209 1209  This resource is for manipulating terms resource. A term can be created, updated or searched.
... ... @@ -1260,7 +1260,7 @@
1260 1260  JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
1261 1261  )))
1262 1262  
1263 -
1287 +\\
1264 1264  
1265 1265  (% class="western" %)
1266 1266  **GET method should be used to lookup products.**
... ... @@ -1315,7 +1315,7 @@
1315 1315  Returns found term details.
1316 1316  )))
1317 1317  
1318 -
1342 +\\
1319 1319  
1320 1320  (% class="western" %)
1321 1321  **POST method should be used to create products.**
... ... @@ -1373,7 +1373,7 @@
1373 1373  Term Id of the newly created term.
1374 1374  )))
1375 1375  
1376 -
1400 +\\
1377 1377  
1378 1378  (% class="western" %)
1379 1379  PUT method should be used to update an individual term given the term info.
... ... @@ -1400,7 +1400,7 @@
1400 1400  Term details to be updated in json format to be sent with request. Id property needs to be set to identify the term to be updated.
1401 1401  
1402 1402  (% class="western" %)
1403 -
1427 +\\
1404 1404  
1405 1405  (% class="western" %)
1406 1406  **Example**:
... ... @@ -1431,12 +1431,47 @@
1431 1431  term id of the updated term.
1432 1432  )))
1433 1433  
1434 -
1458 +\\
1435 1435  
1436 1436  (% class="western" %)
1437 -**Resources**
1461 +**COMPONENT: Resources**
1438 1438  
1439 1439  (% class="western" %)
1464 +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.
1465 +
1466 +* (((
1467 +(% class="western" %)
1468 +questions
1469 +)))
1470 +* (((
1471 +(% class="western" %)
1472 +users
1473 +)))
1474 +* (((
1475 +(% class="western" %)
1476 +products
1477 +)))
1478 +* (((
1479 +(% class="western" %)
1480 +terms
1481 +)))
1482 +* (((
1483 +(% class="western" %)
1484 +resources
1485 +)))
1486 +* (((
1487 +(% class="western" %)
1488 +sources
1489 +)))
1490 +* (((
1491 +(% class="western" %)
1492 +transactions
1493 +)))
1494 +
1495 +(% class="western" %)
1496 +**~ **
1497 +
1498 +(% class="western" %)
1440 1440  This resource is for manipulating resources resource. A resource can be created, updated or searched.
1441 1441  
1442 1442  (% class="wrapped" %)
... ... @@ -1491,10 +1491,10 @@
1491 1491  JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
1492 1492  )))
1493 1493  
1494 -
1553 +\\
1495 1495  
1496 1496  (% class="western" %)
1497 -**GET method should be used to lookup products.**
1556 +**GET method should be used to lookup resources.**
1498 1498  
1499 1499  (% class="wrapped" %)
1500 1500  |(((
... ... @@ -1546,10 +1546,10 @@
1546 1546  Returns found resource details.
1547 1547  )))
1548 1548  
1549 -
1608 +\\
1550 1550  
1551 1551  (% class="western" %)
1552 -**POST method should be used to create products.**
1611 +**POST method should be used to create resources.**
1553 1553  
1554 1554  (% class="wrapped" %)
1555 1555  |(((
... ... @@ -1573,7 +1573,7 @@
1573 1573  resource details in json to be sent as post data. Id should not be set.
1574 1574  
1575 1575  (% class="western" %)
1576 -**Possible Request Params**: Name, Description, Type, Value
1635 +**Possible Request Params**: Name, Description, Type, Value, FreePass
1577 1577  
1578 1578  (% class="western" %)
1579 1579  **Example**:
... ... @@ -1580,6 +1580,15 @@
1580 1580  
1581 1581  (% class="western" %)
1582 1582  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1642 +
1643 +(% class="western" %)
1644 +{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1645 +
1646 +(% class="western" %)
1647 +{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
1648 +
1649 +(% class="western" %)
1650 +{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1583 1583  )))
1584 1584  
1585 1585  (% class="wrapped" %)
... ... @@ -1604,7 +1604,7 @@
1604 1604  Resource Id of the newly created resource.
1605 1605  )))
1606 1606  
1607 -
1675 +\\
1608 1608  
1609 1609  (% class="western" %)
1610 1610  PUT method should be used to update an individual resource given the resource info.
... ... @@ -1628,16 +1628,25 @@
1628 1628  Resource
1629 1629  )))|(((
1630 1630  (% class="western" %)
1631 -Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated.
1699 +Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1632 1632  
1633 1633  (% class="western" %)
1634 -
1702 +\\
1635 1635  
1636 1636  (% class="western" %)
1637 -Example:
1705 +Examples:
1638 1638  
1639 1639  (% class="western" %)
1640 1640  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1709 +
1710 +(% class="western" %)
1711 +{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1712 +
1713 +(% class="western" %)
1714 +{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
1715 +
1716 +(% class="western" %)
1717 +{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1641 1641  )))
1642 1642  
1643 1643  (% class="wrapped" %)
... ... @@ -1662,52 +1662,20 @@
1662 1662  resource id of the updated resource.
1663 1663  )))
1664 1664  
1665 -
1742 +\\
1666 1666  
1667 -(% class="western" %)
1668 -**Resources**
1744 +\\
1669 1669  
1670 1670  (% class="western" %)
1671 -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.
1747 +\\
1672 1672  
1673 -* (((
1674 1674  (% class="western" %)
1675 -questions
1676 -)))
1677 -* (((
1678 -(% class="western" %)
1679 -users
1680 -)))
1681 -* (((
1682 -(% class="western" %)
1683 -products
1684 -)))
1685 -* (((
1686 -(% class="western" %)
1687 -terms
1688 -)))
1689 -* (((
1690 -(% class="western" %)
1691 -resources
1692 -)))
1693 -* (((
1694 -(% class="western" %)
1695 -sources
1696 -)))
1697 -* (((
1698 -(% class="western" %)
1699 -transactions
1700 -)))
1750 +**COMPONENT: Source Codes
1751 +**
1701 1701  
1702 1702  (% class="western" %)
1703 -
1754 +This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
1704 1704  
1705 -(% class="western" %)
1706 -**Sources**
1707 -
1708 -(% class="western" %)
1709 -This resource is for manipulating sources resource. A source can be created, updated or searched.
1710 -
1711 1711  (% class="wrapped" %)
1712 1712  |(((
1713 1713  (% class="western" %)
... ... @@ -1760,7 +1760,7 @@
1760 1760  JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
1761 1761  )))
1762 1762  
1763 -
1808 +\\
1764 1764  
1765 1765  (% class="western" %)
1766 1766  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
... ... @@ -1815,10 +1815,10 @@
1815 1815  Returns found source details.
1816 1816  )))
1817 1817  
1818 -
1863 +\\
1819 1819  
1820 1820  (% class="western" %)
1821 -
1866 +\\
1822 1822  
1823 1823  (% class="western" %)
1824 1824  POST method should be used to create an individual source given the source parameters.
... ... @@ -1867,7 +1867,7 @@
1867 1867  Returns created source code id.
1868 1868  )))
1869 1869  
1870 -
1915 +\\
1871 1871  
1872 1872  (% class="western" %)
1873 1873  **PUT method can be used to update an individual source given the id.**
... ... @@ -1916,13 +1916,13 @@
1916 1916  Returns updated source id.
1917 1917  )))
1918 1918  
1919 -
1964 +\\
1920 1920  
1921 1921  (% class="western" %)
1922 -
1967 +\\
1923 1923  
1924 1924  (% class="western" %)
1925 -**Transactions**
1970 +**COMPONENT: Transactions**
1926 1926  
1927 1927  (% class="western" %)
1928 1928  This resource is for manipulating transactions resource. A transaction can be created or searched.
... ... @@ -1969,10 +1969,10 @@
1969 1969  JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
1970 1970  )))
1971 1971  
1972 -
2017 +\\
1973 1973  
1974 1974  (% class="western" %)
1975 -
2020 +\\
1976 1976  
1977 1977  (% class="western" %)
1978 1978  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
... ... @@ -2011,11 +2011,7 @@
2011 2011  EndDate: When the search should end. Only valid when UserId is set. (Date)
2012 2012  )))
2013 2013  
2014 -
2015 -
2016 -
2017 -
2018 -(% class="wrapped" %)
2059 +(% class="wrapped" style="letter-spacing: 0.0px;" %)
2019 2019  |(((
2020 2020  (% class="western" %)
2021 2021  **Response**
... ... @@ -2034,11 +2034,23 @@
2034 2034  Transactions
2035 2035  )))|(((
2036 2036  (% class="western" %)
2037 -Returns all transaction that satisfies the search criteria.
2078 +Returns all transaction that satisfies the search criteria. Returns all the package and product transactions of the user. Package Transactions are the one with TermId and ProductId. Product Transactions are the one with ResourceId.
2038 2038  )))
2039 2039  
2040 -
2081 +\\
2041 2041  
2083 +**Sample response for /(% style="color: rgb(80,80,80);" %)transactions/lookup?UserId=25255105:(%%)**
2084 +
2085 +(% class="wrapped" %)
2086 +|=(((
2087 +(% class="content-wrapper" %)
2088 +(((
2089 +[[image:attach:Screen Shot 2020-02-26 at 11.14.29 AM.png||width="1407"]]
2090 +)))
2091 +)))
2092 +
2093 +\\
2094 +
2042 2042  (% class="western" %)
2043 2043  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.
2044 2044  
... ... @@ -2086,39 +2086,35 @@
2086 2086  Returns transactionId of the newly created transaction.
2087 2087  )))
2088 2088  
2089 -
2142 +\\
2090 2090  
2091 -
2144 +\\
2092 2092  
2093 -
2094 -
2095 -
2096 -
2097 -
2098 -
2099 2099  (% class="western" %)
2100 -**Stats**
2147 +**COMPONENT: Leads
2148 +**
2101 2101  
2102 2102  (% class="western" %)
2103 2103  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.
2104 2104  
2105 2105  (% class="western" %)
2106 -
2154 +\\
2107 2107  
2108 2108  (% class="western" %)
2109 -
2157 +\\
2110 2110  
2111 2111  (% class="western" %)
2112 -
2160 +\\
2113 2113  
2114 2114  (% class="western" %)
2115 -
2163 +\\
2116 2116  
2117 2117  (% class="western" %)
2118 -
2166 +\\
2119 2119  
2120 2120  (% class="western" %)
2121 -**Telemarketing**
2169 +**Telemarketing Leads
2170 +**
2122 2122  
2123 2123  (% class="western" %)
2124 2124  
... ... @@ -2166,7 +2166,7 @@
2166 2166  JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
2167 2167  )))
2168 2168  
2169 -
2218 +\\
2170 2170  
2171 2171  (% class="western" %)
2172 2172  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.
... ... @@ -2236,13 +2236,13 @@
2236 2236  )))
2237 2237  |(((
2238 2238  (% class="western" %)
2239 -
2288 +\\
2240 2240  )))|(((
2241 2241  (% class="western" %)
2242 -
2291 +\\
2243 2243  )))|(((
2244 2244  (% class="western" %)
2245 -
2294 +\\
2246 2246  )))
2247 2247  
2248 2248  (% class="wrapped" %)
... ... @@ -2267,18 +2267,18 @@
2267 2267  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
2268 2268  )))
2269 2269  
2270 -
2319 +\\
2271 2271  
2272 -
2321 +\\
2273 2273  
2274 -
2323 +\\
2275 2275  
2276 -
2325 +\\
2277 2277  
2278 -
2327 +\\
2279 2279  
2280 2280  (% class="western" %)
2281 -**Reference**
2330 +**API REFERENCE**
2282 2282  
2283 2283  (% class="western" %)
2284 2284  **Type: Questions**
... ... @@ -2324,12 +2324,12 @@
2324 2324  (% class="western" %)
2325 2325  Determines which type of question it is. Textbox, checkbox, select, radio.
2326 2326  There can be 6 types of questions.
2327 - type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2328 - type=2 means textarea type question or long response type question.
2329 - type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2330 - type = 4 means 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.
2331 - type=5 means 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.
2332 - type=6 means 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.
2376 +type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2377 +type=2 means textarea type question or long response type question.
2378 +type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2379 +type = 4 means 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.
2380 +type=5 means 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.
2381 +type=6 means 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.
2333 2333  )))
2334 2334  |(((
2335 2335  (% class="western" %)
... ... @@ -2352,13 +2352,13 @@
2352 2352  Alias for admin purpose.
2353 2353  )))
2354 2354  
2355 -
2404 +\\
2356 2356  
2357 2357  (% class="western" %)
2358 -
2407 +\\
2359 2359  
2360 2360  (% class="western" %)
2361 -
2410 +\\
2362 2362  
2363 2363  (% class="western" %)
2364 2364  **Type: Choices**
... ... @@ -2425,7 +2425,7 @@
2425 2425  Tied to which question id.
2426 2426  )))
2427 2427  
2428 -
2477 +\\
2429 2429  
2430 2430  (% class="western" %)
2431 2431  **Type: Users**
... ... @@ -2482,7 +2482,7 @@
2482 2482  Request date.
2483 2483  )))
2484 2484  
2485 -
2534 +\\
2486 2486  
2487 2487  (% class="western" %)
2488 2488  **Type: Demo**
... ... @@ -2529,7 +2529,7 @@
2529 2529  ...
2530 2530  )))
2531 2531  
2532 -
2581 +\\
2533 2533  
2534 2534  (% class="western" %)
2535 2535  **Type: Transactions**
... ... @@ -2676,7 +2676,7 @@
2676 2676  If there is amount (USD) included in transaction.
2677 2677  )))
2678 2678  
2679 -
2728 +\\
2680 2680  
2681 2681  (% class="western" %)
2682 2682  **Type: Sources**
... ... @@ -2733,10 +2733,10 @@
2733 2733  If this is a child source then list the parent source id.
2734 2734  )))
2735 2735  
2736 -
2785 +\\
2737 2737  
2738 2738  (% class="western" %)
2739 -
2788 +\\
2740 2740  
2741 2741  (% class="western" %)
2742 2742  **Type: Products**
... ... @@ -2793,7 +2793,7 @@
2793 2793  (Array of) Terms associated with the product.
2794 2794  )))
2795 2795  
2796 -
2845 +\\
2797 2797  
2798 2798  (% class="western" %)
2799 2799  **Type: Terms**
... ... @@ -2880,7 +2880,7 @@
2880 2880  If there is price (USD) for the term.
2881 2881  )))
2882 2882  
2883 -
2932 +\\
2884 2884  
2885 2885  (% class="western" %)
2886 2886  **Type: Resources**
... ... @@ -2957,14 +2957,30 @@
2957 2957  )))|(((
2958 2958  (% class="western" %)
2959 2959  String
3009 +
3010 +(% class="western" %)
3011 +or
3012 +
3013 +(% class="western" %)
3014 +Array
2960 2960  )))|(((
2961 2961  (% class="western" %)
2962 -Value of Resource Type.
3017 +Value of Resource Type:
2963 2963  
2964 2964  (% class="western" %)
2965 -Example : if the Type sent is 3 then Value would be **/digital/**
3020 +When requesting a resource (GET), you should expect a string if there is only one value. If there are multiple values, you should expect an array.
2966 2966  
2967 2967  (% class="western" %)
3023 +For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
3024 +
3025 +(% class="western" %)
3026 +Example :
3027 +
3028 +(% class="western" %)
3029 +if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].** **
3030 +**if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
3031 +
3032 +(% class="western" %)
2968 2968  For Function type resource leave it blank.
2969 2969  )))
2970 2970  |(((
... ... @@ -2975,10 +2975,20 @@
2975 2975  Int
2976 2976  )))|(((
2977 2977  (% class="western" %)
2978 -Default limit is 25 but all the data needs to be pulled then pass limit=0.
3043 +Default limit is 25 but if all the data needs to be pulled then pass limit=0.
2979 2979  )))
3045 +|(% colspan="1" %)(% colspan="1" %)
3046 +(((
3047 +FreePass
3048 +)))|(% colspan="1" %)(% colspan="1" %)
3049 +(((
3050 +Int
3051 +)))|(% colspan="1" %)(% colspan="1" %)
3052 +(((
3053 +Default value is 0. This parameter is used to provide access to protected content.
3054 +)))
2980 2980  
2981 -
3056 +\\
2982 2982  
2983 2983  (% class="western" %)
2984 2984  **Type: Telemarketing**
... ... @@ -3068,8 +3068,12 @@
3068 3068  Page title that belongs to the page url that is being sent. If not provided it try to pull the title from the page but if unsuccessful then it will set it as blank.
3069 3069  
3070 3070  (% class="western" %)
3071 -
3146 +\\
3072 3072  
3073 3073  (% class="western" %)
3074 3074  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.
3075 3075  )))
3151 +
3152 +\\
3153 +
3154 +\\
OCDEV-OC-API-04032017-030417-1545-35.pdf
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +57.8 KB
Content
Screen Shot 2020-02-26 at 11.14.29 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +397.9 KB
Content
Screen Shot 2020-02-26 at 11.15.52 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +50.1 KB
Content
Screen Shot 2020-02-26 at 11.22.13 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +159.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539009
1 +3538995
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539009/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/3538995/OLD-ONEcount API Documentation