Skip to Content

Wiki source code of ONEcount API Documentation

Version 17.1 by shravya@one-count_com on 2020/02/26 12:41
Show last authors
1 (% class="western" %)
2 **Introduction**
3
4 (% class="western" %)
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
7 (% class="western" %)
8 REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
9
10 1. (((
11 (% class="western" %)
12 **GET** - Used for lookup of resourcesresources
13 )))
14 1. (((
15 (% class="western" %)
16 **PUT** - Used to update a resource
17 )))
18 1. (((
19 (% class="western" %)
20 **POST** - Used to create a new resource
21 )))
22
23 (% class="western" %)
24 Specifically, the ONEcount API provides to the following components:
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 \\\\\\
58
59 (% class="western" %)
60 **Accessing API**
61
62 (% class="western" %)
63 **REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
64
65 (% class="western" %)
66 **Appkey**: THIS WILL BE PROVIDED TO YOU
67
68 (% class="western" %)
69 **
70 **
71
72 (% class="western" %)
73 Your HTTP requests to a REST API resource should contain the following information:
74
75 * (((
76 (% class="western" %)
77 An HTTP method GET, POST, PUT.
78 )))
79 * (((
80 (% class="western" %)
81 An Appkey sent as Appkey header in the http request to authenticate the request.
82 )))
83 * (((
84 (% class="western" %)
85 Resource name in the url (/resourcename)
86 )))
87 * (((
88 (% class="western" %)
89 Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
90 )))
91
92 (% class="western" %)
93 \\
94
95 (% class="western" %)
96 **General API Usage**
97
98 (% class="western" %)
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
101 (% class="western" %)
102 For lookup, the parameter list will be part of the request url.
103
104 (% class="western" %)
105 \\
106
107 (% class="western" %)
108 **Response**
109
110 (% class="western" %)
111 API will output the response in a JSON format discussed below.
112
113 (% class="western" %)
114 {
115
116 (% class="western" %)
117 "result": {
118
119 (% class="western" %)
120 "success": "1",
121
122 (% class="western" %)
123 "error": {
124
125 (% class="western" %)
126 "code": "0",
127
128 (% class="western" %)
129 "message": ""
130
131 (% class="western" %)
132 }
133
134 (% class="western" %)
135 },
136
137 (% class="western" %)
138 "Users": {
139
140 (% class="western" %)
141 "Id": "12562",
142
143 (% class="western" %)
144 "PartnerId": "5467",
145
146 (% class="western" %)
147 "Demo": {
148
149 (% class="western" %)
150 "6": "Sundeep",
151
152 (% class="western" %)
153 "7": "Dangol"
154
155 (% class="western" %)
156 }
157
158 (% class="western" %)
159 }
160
161 (% class="western" %)
162 }
163
164 (% class="western" %)
165 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.
166
167 (% class="western" %)
168 \\
169
170 (% class="western" %)
171 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.
172
173 (% class="western" %)
174 If the value of success is 1 then the response parameters of the called method will also be output.
175
176 (% class="western" %)
177 Example: Get list of questions from api
178
179 {{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions
180 {
181 "result": {
182 "success": "1",
183 "error": {
184 "code": "0",
185 "message": ""
186 }
187 },
188 "Questions": [
189 {
190 "Id": "6",
191 "Text": "First Name",
192 "Type": "1",
193 "Alias": "FName"
194 },
195 {
196 "Id": "7",
197 "Text": "Last Name",
198 "Type": "1",
199 "Alias": "LName"
200 },
201 {
202 "Id": "5",
203 "Text": "Specialty",
204 "Type": "5",
205 "Alias": "specialty all",
206 "Choices": [
207 {
208 "Id": "123",
209 "Text": "Physician",
210 "Value": "PH",
211 "Order": "1",
212 "QuestionId": "5"
213 },
214 {
215 "Id": "124",
216 "Text": "Nurse Practioner",
217 "Value": "NP",
218 "Order": "2",
219 "QuestionId": "5"
220 }
221 ]}]}}}}
222
223 (% class="western" %)
224 \\
225
226 (% class="western" %)
227 **
228 **
229
230 **COMPONENT: Users**
231
232 (% class="western" %)
233 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.
234
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.
237
238 (% class="western" %)
239 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.
240
241 (% class="western" %)
242 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.
243
244 (% class="western" %)
245 Return parameter will have the comma separated list of question Ids that is requested back from the API.
246
247 (% class="western" %)
248 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.
249
250 \\
251
252 (% class="wrapped" %)
253 |(((
254 (% class="western" %)
255 **Method**
256 )))|(((
257 (% class="western" %)
258 **Url**
259 )))|(((
260 (% class="western" %)
261 **Action**
262 )))
263 |(((
264 (% class="western" %)
265 GET
266 )))|(((
267 (% class="western" %)
268 /users
269 )))|(((
270 (% class="western" %)
271 Get users data limiting 25.
272 )))
273 |(((
274 (% class="western" %)
275 GET
276 )))|(((
277 (% class="western" %)
278 /users/1
279 )))|(((
280 (% class="western" %)
281 Get data for user id 1. The user id can be a numeric value or a hash
282 )))
283 |(((
284 (% class="western" %)
285 GET
286 )))|(((
287 (% class="western" %)
288 /users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
289 )))|(((
290 (% class="western" %)
291 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.
292
293 (% class="western" %)
294 Return parameter defines a csv of question id that are requested back in response.
295 )))
296 |(((
297 (% class="western" %)
298 POST
299 )))|(((
300 (% class="western" %)
301 /users
302 )))|(((
303 (% class="western" %)
304 Create a new users
305
306 (% class="western" %)
307 Parameters required to create the user needs to be sent as post data in JSON format.
308 )))
309 |(((
310 (% class="western" %)
311 PUT
312 )))|(((
313 (% class="western" %)
314 /users/1
315 )))|(((
316 (% class="western" %)
317 Update user id 1. The user id can be a numeric value or a hash
318
319 (% class="western" %)
320 Parameters required to update the user needs to be sent as post data in JSON format.
321 )))
322 |(((
323 (% class="western" %)
324 GET
325 )))|(((
326 (% class="western" %)
327 /users/1/partners/2
328 )))|(((
329 (% class="western" %)
330 Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
331 )))
332 |(((
333 (% class="western" %)
334 POST
335 )))|(((
336 (% class="western" %)
337 /users/login
338 )))|(((
339 (% class="western" %)
340 Check to see user exist with username/email and password.
341
342 (% class="western" %)
343 Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
344
345 (% class="western" %)
346 Example:
347
348 (% class="western" %)
349 {"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"}
350
351 (% class="western" %)
352 OR
353
354 (% class="western" %)
355 {"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
356
357 (% class="western" %)
358 OR
359
360 (% class="western" %)
361 {"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
362
363 (% class="western" %)
364 **OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
365 )))
366
367 \\
368
369 (% class="western" %)
370 **GET method should be used to lookup users.**
371
372 (% class="wrapped" %)
373 |(((
374 (% class="western" %)
375 **Request**
376 )))|(((
377 (% class="western" %)
378 **Type**
379 )))|(((
380 (% class="western" %)
381 **Description**
382 )))
383 |(((
384 (% class="western" %)
385 Lookup params
386 )))|(((
387 (% class="western" %)
388 String
389 )))|(((
390 (% class="western" %)
391 URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
392
393 (% class="western" %)
394 Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
395
396 (% class="western" %)
397 return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
398
399 (% class="western" %)
400 If return is not provided, all the demographics will be returned.
401 )))
402
403 \\
404
405 \\
406
407 (% class="wrapped" %)
408 |(((
409 (% class="western" %)
410 **Response**
411 )))|(((
412 (% class="western" %)
413 **Type**
414 )))|(((
415 (% class="western" %)
416 **Description**
417 )))
418 |(((
419 (% class="western" %)
420 Users
421 )))|=(((
422 (% class="western" align="left" %)
423 Users
424 )))|(((
425 (% class="western" %)
426 Found users returned with the demo field requested in return parameter in json format
427 )))
428
429 \\
430
431 **Sample response for /users/(% style="color: rgb(80,80,80);" %)25255449(%%)**
432
433 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.
434
435 (% class="relative-table wrapped" style="width: 100.0%;" %)
436 |=(((
437 (% class="content-wrapper" %)
438 (((
439 [[image:attach:Screen Shot 2020-02-26 at 11.15.52 AM.png||width="1407"]]
440 )))
441 )))
442
443 \\
444
445 **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(%%)**
446
447 (% class="wrapped" %)
448 |=(((
449 (% class="content-wrapper" %)
450 (((
451 [[image:attach:Screen Shot 2020-02-26 at 11.22.13 AM.png||height="250"]]
452 )))
453 )))
454
455 \\
456
457 (% class="western" %)
458 **POST method should be used to create users.**
459
460 (% class="wrapped" %)
461 |(((
462 (% class="western" %)
463 **Request**
464 )))|(((
465 (% class="western" %)
466 **Type**
467 )))|(((
468 (% class="western" %)
469 **Description**
470 )))
471 |(((
472 (% class="western" %)
473 Users
474 )))|(((
475 (% class="western" %)
476 Users
477 )))|(((
478 (% class="western" %)
479 Users object that contains information about user to create. PartnerId Needs to be specified.
480 )))
481 |(((
482 (% class="western" %)
483 Transactions
484 )))|(((
485 (% class="western" %)
486 Transactions
487 )))|(((
488 (% class="western" %)
489 (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.
490 )))
491 |(((
492 (% class="western" %)
493 DedupeColumns
494 )))|(((
495 (% class="western" %)
496 String
497 )))|(((
498 (% class="western" %)
499 CSV of question id's that should be considered to find duplicate.
500 )))
501 |(((
502 (% class="western" %)
503 Return
504 )))|(((
505 (% class="western" %)
506 String
507 )))|(((
508 (% class="western" %)
509 CSV of ONEcount QuestionId's requested back in Users object in response.
510 )))
511
512 (% class="wrapped" %)
513 |(((
514 (% class="western" %)
515 **Response**
516 )))|(((
517 (% class="western" %)
518 **Type**
519 )))|(((
520 (% class="western" %)
521 **Description**
522 )))
523 |(((
524 (% class="western" %)
525 Users
526 )))|=(((
527 (% class="western" align="left" %)
528 Users
529 )))|(((
530 (% class="western" %)
531 Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
532 )))
533
534 \\
535
536 (% class="western" %)
537 **PUT method should be used to update users.**
538
539 (% class="wrapped" %)
540 |(((
541 (% class="western" %)
542 **Request**
543 )))|(((
544 (% class="western" %)
545 **Type**
546 )))|(((
547 (% class="western" %)
548 **Description**
549 )))
550 |(((
551 (% class="western" %)
552 Users
553 )))|(((
554 (% class="western" %)
555 Users
556 )))|(((
557 (% class="western" %)
558 Users object with update fields. Return property has csv of questions id requested back in Users object.
559 )))
560 |(((
561 (% class="western" %)
562 Return
563 )))|(((
564 (% class="western" %)
565 String
566 )))|(((
567 (% class="western" %)
568 CSV of ONEcount QuestionId's requested back in Users object in response
569 )))
570 |(((
571 (% class="western" %)
572 RequestDate
573 )))|(((
574 (% class="western" %)
575 Date
576 )))|(((
577 (% class="western" %)
578 RequestDate to use for the demo update. If not provided current date will be used.
579 )))
580
581 (% class="wrapped" %)
582 |(((
583 (% class="western" %)
584 **Response**
585 )))|(((
586 (% class="western" %)
587 **Type**
588 )))|(((
589 (% class="western" %)
590 **Description**
591 )))
592 |(((
593 (% class="western" %)
594 Users
595 )))|=(((
596 (% class="western" align="left" %)
597 Users
598 )))|(((
599 (% class="western" %)
600 Updated user returned with the demo field requested in return parameter in json format.
601 )))
602
603 (% class="western" %)
604 \\
605
606 (% class="western" %)
607 \\
608
609 (% class="western" %)
610 Create new users. Here in this example the JSON for request is passed in userFile.json file.
611
612 {{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
613
614 (% class="western" %)
615 **
616 **
617
618 (% class="western" %)
619 **
620 **
621
622 \\
623
624 (% class="western" %)
625 **COMPONENT: Questions**
626
627 (% class="western" %)
628 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).
629
630 (% class="western" %)
631 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.
632
633 (% class="western" %)
634 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)
635
636 (% class="western" %)
637 There can be 6 types of questions:
638
639 (% class="wrapped" %)
640 |(((
641 (% class="western" align="center" %)
642 **Type**
643 )))|(((
644 (% class="western" %)
645 **Description**
646 )))
647 |(((
648 (% class="western" align="center" %)
649 1
650 )))|(((
651 (% class="western" %)
652 Textbox type questions or short response type question. The response length needs to be less than 255 characters.
653 )))
654 |(((
655 (% class="western" align="center" %)
656 2
657 )))|(((
658 (% class="western" %)
659 Textarea type question or long response type question.
660 )))
661 |(((
662 (% class="western" align="center" %)
663 3
664 )))|(((
665 (% class="western" %)
666 Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
667 )))
668 |(((
669 (% class="western" align="center" %)
670 4
671 )))|(((
672 (% class="western" %)
673 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.
674 )))
675 |(((
676 (% class="western" align="center" %)
677 5
678 )))|(((
679 (% class="western" %)
680 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.
681 )))
682 |(((
683 (% class="western" align="center" %)
684 6
685 )))|(((
686 (% class="western" %)
687 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.
688 )))
689
690 (% class="wrapped" %)
691 |(((
692 (% class="western" %)
693 **Method**
694 )))|(((
695 (% class="western" %)
696 **Url**
697 )))|(((
698 (% class="western" %)
699 **Action**
700 )))
701 |(((
702 (% class="western" %)
703 GET
704 )))|(((
705 (% class="western" %)
706 /questions
707 )))|(((
708 (% class="western" %)
709 List all questions
710 )))
711 |(((
712 (% class="western" %)
713 GET
714 )))|(((
715 (% class="western" %)
716 /questions/1
717 )))|(((
718 (% class="western" %)
719 Returns question id 1
720 )))
721 |(((
722 (% class="western" %)
723 GET
724 )))|(((
725 (% class="western" %)
726 /questions/lookup?Text=Email
727 )))|(((
728 (% class="western" %)
729 Returns all questions with “Email" in question text
730 )))
731 |(((
732 (% class="western" %)
733 POST
734 )))|(((
735 (% class="western" %)
736 /questions
737 )))|(((
738 (% class="western" %)
739 Create a new question
740
741 (% class="western" %)
742 JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
743 )))
744 |(((
745 (% class="western" %)
746 PUT
747 )))|(((
748 (% class="western" %)
749 /questions
750 )))|(((
751 (% class="western" %)
752 Update a question
753
754 (% class="western" %)
755 JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
756 )))
757
758 \\
759
760 (% class="western" %)
761 **GET method can be used to lookup questions.**
762
763 (% class="wrapped" %)
764 |(((
765 (% class="western" %)
766 **Request**
767 )))|(((
768 (% class="western" %)
769 **Type**
770 )))|(((
771 (% class="western" %)
772 **Description**
773 )))
774 |(((
775 (% class="western" %)
776 Lookup params
777 )))|(((
778 (% class="western" %)
779 String
780 )))|(((
781 (% class="western" %)
782 URL encoded key value string parameters for the question that a user is trying to search.
783
784 (% class="western" %)
785 Params:
786
787 (% class="western" %)
788 Text: Word or phrase that should be present in the question text (String)
789
790 (% class="western" %)
791 Type: Look up the question type.
792 )))
793
794 (% class="wrapped" %)
795 |(((
796 (% class="western" %)
797 **Response**
798 )))|(((
799 (% class="western" %)
800 **Type**
801 )))|(((
802 (% class="western" %)
803 **Description**
804 )))
805 |(((
806 (% class="western" %)
807 Questions
808 )))|(((
809 (% class="western" %)
810 Questions
811 )))|(((
812 (% class="western" %)
813 Returns found question details.
814 )))
815
816 \\
817
818 (% class="western" %)
819 **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).**
820
821 (% class="wrapped" %)
822 |(((
823 (% class="western" %)
824 **Request**
825 )))|(((
826 (% class="western" %)
827 **Type**
828 )))|(((
829 (% class="western" %)
830 **Description**
831 )))
832 |(((
833 (% class="western" %)
834 Questions
835 )))|(((
836 (% class="western" %)
837 Questions
838 )))|(((
839 (% class="western" %)
840 This defines the question contents and possible responses.
841 )))
842
843 (% class="wrapped" %)
844 |(((
845 (% class="western" %)
846 **Response**
847 )))|(((
848 (% class="western" %)
849 **Type**
850 )))|(((
851 (% class="western" %)
852 **Description**
853 )))
854 |(((
855 (% class="western" %)
856 QuestionId
857 )))|(((
858 (% class="western" %)
859 Int
860 )))|(((
861 (% class="western" %)
862 Returns ONEcount question id on successful creation of the question.
863 )))
864
865 \\
866
867 (% class="western" %)
868 PUT method should be used to update question.
869
870 (% class="wrapped" %)
871 |(((
872 (% class="western" %)
873 **Request**
874 )))|(((
875 (% class="western" %)
876 **Type**
877 )))|(((
878 (% class="western" %)
879 **Description**
880 )))
881 |(((
882 (% class="western" %)
883 Questions
884 )))|(((
885 (% class="western" %)
886 Questions
887 )))|(((
888 (% class="western" %)
889 This defines the question contents and responses.
890 )))
891
892 (% class="wrapped" %)
893 |(((
894 (% class="western" %)
895 **Response**
896 )))|(((
897 (% class="western" %)
898 **Type**
899 )))|(((
900 (% class="western" %)
901 **Description**
902 )))
903 |(((
904 (% class="western" %)
905 QuestionId
906 )))|(((
907 (% class="western" %)
908 Int
909 )))|(((
910 (% class="western" %)
911 Returns ONEcount question id on successful update of the question.
912 )))
913
914 (% class="western" %)
915 \\
916
917 (% class="western" %)
918 Example: Get list of questions from api which has FirstName in text
919
920 {{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
921
922 (% class="western" %)
923 {
924
925 (% class="western" %)
926 "result": {
927
928 (% class="western" %)
929 "success": "1",
930
931 (% class="western" %)
932 "error": {
933
934 (% class="western" %)
935 "code": "0",
936
937 (% class="western" %)
938 "message": ""
939
940 (% class="western" %)
941 }
942
943 (% class="western" %)
944 },
945
946 (% class="western" %)
947 "Questions": [
948
949 (% class="western" %)
950 {
951
952 (% class="western" %)
953 "Id": "6",
954
955 (% class="western" %)
956 "Text": "FirstName",
957
958 (% class="western" %)
959 "Type": "1",
960
961 (% class="western" %)
962 "Alias": "FName"
963
964 (% class="western" %)
965 }
966
967 (% class="western" %)
968 ]
969
970 (% class="western" %)
971 }
972
973 (% class="western" %)
974 \\
975
976 (% class="western" %)
977 **COMPONENT: Products**
978
979 (% class="western" %)
980 This resource is for manipulating products resource. A product can be created, updated or searched.
981
982 (% class="wrapped" %)
983 |(((
984 (% class="western" %)
985 **Method**
986 )))|(((
987 (% class="western" %)
988 **Url**
989 )))|(((
990 (% class="western" %)
991 **Action**
992 )))
993 |(((
994 (% class="western" %)
995 GET
996 )))|(((
997 (% class="western" %)
998 /products
999 )))|(((
1000 (% class="western" %)
1001 Get all product details
1002 )))
1003 |(((
1004 (% class="western" %)
1005 GET
1006 )))|(((
1007 (% class="western" %)
1008 /products/5
1009 )))|(((
1010 (% class="western" %)
1011 Get product id 5
1012 )))
1013 |(((
1014 (% class="western" %)
1015 GET
1016 )))|(((
1017 (% class="western" %)
1018 /products/lookup?Title=productname
1019 )))|(((
1020 (% class="western" %)
1021 Lookup products by Title
1022 )))
1023 |(((
1024 (% class="western" %)
1025 POST
1026 )))|(((
1027 (% class="western" %)
1028 /products
1029 )))|(((
1030 (% class="western" %)
1031 JSON of the Products type object needs to be sent as post data. Id field should not be sent.
1032 )))
1033 |(((
1034 (% class="western" %)
1035 PUT
1036 )))|(((
1037 (% class="western" %)
1038 /products/5
1039 )))|(((
1040 (% class="western" %)
1041 JSON of the Products type object needs to be sent as post data. Id field is mandatory for update.
1042 )))
1043 |(((
1044 (% class="western" %)
1045 POST
1046 )))|(((
1047 (% class="western" %)
1048 /products/attachResource
1049 )))|(((
1050 (% class="western" %)
1051 JSON of the Product and Resource ids to be sent as post data.
1052
1053 (% class="western" %)
1054 Both fields are mandatory.
1055
1056 (% class="western" %)
1057 Example:
1058
1059 (% class="western" %)
1060 {"ProductID":"65","ResourceID":”121"}
1061 )))
1062
1063 \\
1064
1065 (% class="western" %)
1066 **GET method should be used to lookup products.**
1067
1068 (% class="wrapped" %)
1069 |(((
1070 (% class="western" %)
1071 **Request**
1072 )))|(((
1073 (% class="western" %)
1074 **Type**
1075 )))|(((
1076 (% class="western" %)
1077 **Description**
1078 )))
1079 |(((
1080 (% class="western" %)
1081 Lookup params
1082 )))|(((
1083 (% class="western" %)
1084 String
1085 )))|(((
1086 (% class="western" %)
1087 URL encoded key value string parameter for the lookup.
1088
1089 (% class="western" %)
1090 Params:
1091
1092 (% class="western" %)
1093 Name: Name of the Product for lookup (String)
1094 )))
1095
1096 (% class="wrapped" %)
1097 |(((
1098 (% class="western" %)
1099 **Response**
1100 )))|(((
1101 (% class="western" %)
1102 **Type**
1103 )))|(((
1104 (% class="western" %)
1105 **Description**
1106 )))
1107 |(((
1108 (% class="western" %)
1109 Products
1110 )))|(((
1111 (% class="western" %)
1112 Products
1113 )))|(((
1114 (% class="western" %)
1115 Returns found product details.
1116 )))
1117
1118 \\
1119
1120 (% class="western" %)
1121 **POST method should be used to create products.**
1122
1123 (% class="wrapped" %)
1124 |(((
1125 (% class="western" %)
1126 **Request**
1127 )))|(((
1128 (% class="western" %)
1129 **Type**
1130 )))|(((
1131 (% class="western" %)
1132 **Description**
1133 )))
1134 |(((
1135 (% class="western" %)
1136 Products
1137 )))|(((
1138 (% class="western" %)
1139 Products
1140 )))|(((
1141 (% class="western" %)
1142 Product details in json to be sent as post data. Id should not be set.
1143
1144 (% class="western" %)
1145 Example:
1146
1147 (% class="western" %)
1148 {"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1149 )))
1150
1151 (% class="wrapped" %)
1152 |(((
1153 (% class="western" %)
1154 **Response**
1155 )))|(((
1156 (% class="western" %)
1157 **Type**
1158 )))|(((
1159 (% class="western" %)
1160 **Description**
1161 )))
1162 |(((
1163 (% class="western" %)
1164 ProductId
1165 )))|(((
1166 (% class="western" %)
1167 int
1168 )))|(((
1169 (% class="western" %)
1170 Product Id of the newly created product.
1171 )))
1172
1173 \\
1174
1175 (% class="western" %)
1176 PUT method should be used to update an individual product given the product info.
1177
1178 (% class="wrapped" %)
1179 |(((
1180 (% class="western" %)
1181 **Request**
1182 )))|(((
1183 (% class="western" %)
1184 **Type**
1185 )))|(((
1186 (% class="western" %)
1187 **Description**
1188 )))
1189 |(((
1190 (% class="western" %)
1191 Products
1192 )))|(((
1193 (% class="western" %)
1194 Product
1195 )))|(((
1196 (% class="western" %)
1197 Product details to be updated in json format to be sent with request. Id property needs to be set to identify the product to be updated. If you send term and resource along with product creation then it will automatically attach term to product and resource to product.
1198
1199 (% class="western" %)
1200 **Possible Request Params**: Title, Description, PrimaryFormId, ResourceID
1201
1202 (% class="western" %)
1203 **Example**:
1204
1205 (% class="western" %)
1206 {"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
1207 )))
1208
1209 (% class="wrapped" %)
1210 |(((
1211 (% class="western" %)
1212 **Response**
1213 )))|(((
1214 (% class="western" %)
1215 **Type**
1216 )))|(((
1217 (% class="western" %)
1218 **Description**
1219 )))
1220 |(((
1221 (% class="western" %)
1222 ProductId
1223 )))|(((
1224 (% class="western" %)
1225 Int
1226 )))|(((
1227 (% class="western" %)
1228 Product id of the updated product.
1229 )))
1230
1231 \\
1232
1233 (% class="western" %)
1234 **COMPONENT: Terms**
1235
1236 (% class="western" %)
1237 This resource is for manipulating terms resource. A term can be created, updated or searched.
1238
1239 (% class="wrapped" %)
1240 |(((
1241 (% class="western" %)
1242 **Method**
1243 )))|(((
1244 (% class="western" %)
1245 **Url**
1246 )))|(((
1247 (% class="western" %)
1248 **Action**
1249 )))
1250 |(((
1251 (% class="western" %)
1252 GET
1253 )))|(((
1254 (% class="western" %)
1255 /terms/5
1256 )))|(((
1257 (% class="western" %)
1258 Get term id 5
1259 )))
1260 |(((
1261 (% class="western" %)
1262 GET
1263 )))|(((
1264 (% class="western" %)
1265 /terms/lookup?Name=termname
1266 )))|(((
1267 (% class="western" %)
1268 Lookup terms by Name
1269 )))
1270 |(((
1271 (% class="western" %)
1272 POST
1273 )))|(((
1274 (% class="western" %)
1275 /terms
1276 )))|(((
1277 (% class="western" %)
1278 JSON of the terms type object needs to be sent as post data. Id field should not be sent.
1279 )))
1280 |(((
1281 (% class="western" %)
1282 PUT
1283 )))|(((
1284 (% class="western" %)
1285 /terms/5
1286 )))|(((
1287 (% class="western" %)
1288 JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
1289 )))
1290
1291 \\
1292
1293 (% class="western" %)
1294 **GET method should be used to lookup products.**
1295
1296 (% class="wrapped" %)
1297 |(((
1298 (% class="western" %)
1299 **Request**
1300 )))|(((
1301 (% class="western" %)
1302 **Type**
1303 )))|(((
1304 (% class="western" %)
1305 **Description**
1306 )))
1307 |(((
1308 (% class="western" %)
1309 Lookup params
1310 )))|(((
1311 (% class="western" %)
1312 String
1313 )))|(((
1314 (% class="western" %)
1315 URL encoded key value string parameter for the lookup.
1316
1317 (% class="western" %)
1318 Params:
1319
1320 (% class="western" %)
1321 Name: Name of the term for lookup (String)
1322 )))
1323
1324 (% class="wrapped" %)
1325 |(((
1326 (% class="western" %)
1327 **Response**
1328 )))|(((
1329 (% class="western" %)
1330 **Type**
1331 )))|(((
1332 (% class="western" %)
1333 **Description**
1334 )))
1335 |(((
1336 (% class="western" %)
1337 Terms
1338 )))|(((
1339 (% class="western" %)
1340 Terms
1341 )))|(((
1342 (% class="western" %)
1343 Returns found term details.
1344 )))
1345
1346 \\
1347
1348 (% class="western" %)
1349 **POST method should be used to create products.**
1350
1351 (% class="wrapped" %)
1352 |(((
1353 (% class="western" %)
1354 **Request**
1355 )))|(((
1356 (% class="western" %)
1357 **Type**
1358 )))|(((
1359 (% class="western" %)
1360 **Description**
1361 )))
1362 |(((
1363 (% class="western" %)
1364 Terms
1365 )))|(((
1366 (% class="western" %)
1367 Terms
1368 )))|(((
1369 (% class="western" %)
1370 Term details in json to be sent as post data. Id should not be set.
1371
1372 (% class="western" %)
1373 **Possible Request Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt
1374
1375 (% class="western" %)
1376 **Example**:
1377
1378 (% class="western" %)
1379 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1380 )))
1381
1382 (% class="wrapped" %)
1383 |(((
1384 (% class="western" %)
1385 **Response**
1386 )))|(((
1387 (% class="western" %)
1388 **Type**
1389 )))|(((
1390 (% class="western" %)
1391 **Description**
1392 )))
1393 |(((
1394 (% class="western" %)
1395 TermId
1396 )))|(((
1397 (% class="western" %)
1398 int
1399 )))|(((
1400 (% class="western" %)
1401 Term Id of the newly created term.
1402 )))
1403
1404 \\
1405
1406 (% class="western" %)
1407 PUT method should be used to update an individual term given the term info.
1408
1409 (% class="wrapped" %)
1410 |(((
1411 (% class="western" %)
1412 **Request**
1413 )))|(((
1414 (% class="western" %)
1415 **Type**
1416 )))|(((
1417 (% class="western" %)
1418 **Description**
1419 )))
1420 |(((
1421 (% class="western" %)
1422 Terms
1423 )))|(((
1424 (% class="western" %)
1425 Term
1426 )))|(((
1427 (% class="western" %)
1428 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.
1429
1430 (% class="western" %)
1431 \\
1432
1433 (% class="western" %)
1434 **Example**:
1435
1436 (% class="western" %)
1437 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1438 )))
1439
1440 (% class="wrapped" %)
1441 |(((
1442 (% class="western" %)
1443 **Response**
1444 )))|(((
1445 (% class="western" %)
1446 **Type**
1447 )))|(((
1448 (% class="western" %)
1449 **Description**
1450 )))
1451 |(((
1452 (% class="western" %)
1453 TermId
1454 )))|(((
1455 (% class="western" %)
1456 Int
1457 )))|(((
1458 (% class="western" %)
1459 term id of the updated term.
1460 )))
1461
1462 \\
1463
1464 (% class="western" %)
1465 **COMPONENT: Resources**
1466
1467 (% class="western" %)
1468 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.
1469
1470 * (((
1471 (% class="western" %)
1472 questions
1473 )))
1474 * (((
1475 (% class="western" %)
1476 users
1477 )))
1478 * (((
1479 (% class="western" %)
1480 products
1481 )))
1482 * (((
1483 (% class="western" %)
1484 terms
1485 )))
1486 * (((
1487 (% class="western" %)
1488 resources
1489 )))
1490 * (((
1491 (% class="western" %)
1492 sources
1493 )))
1494 * (((
1495 (% class="western" %)
1496 transactions
1497 )))
1498
1499 (% class="western" %)
1500 **
1501 **
1502
1503 (% class="western" %)
1504 This resource is for manipulating resources resource. A resource can be created, updated or searched.
1505
1506 (% class="wrapped" %)
1507 |(((
1508 (% class="western" %)
1509 **Method**
1510 )))|(((
1511 (% class="western" %)
1512 **Url**
1513 )))|(((
1514 (% class="western" %)
1515 **Action**
1516 )))
1517 |(((
1518 (% class="western" %)
1519 GET
1520 )))|(((
1521 (% class="western" %)
1522 /resources/5
1523 )))|(((
1524 (% class="western" %)
1525 Get resource id 5
1526 )))
1527 |(((
1528 (% class="western" %)
1529 GET
1530 )))|(((
1531 (% class="western" %)
1532 /resources/lookup?Name=resourcename
1533 )))|(((
1534 (% class="western" %)
1535 Lookup resources by Name
1536 )))
1537 |(((
1538 (% class="western" %)
1539 POST
1540 )))|(((
1541 (% class="western" %)
1542 /resources
1543 )))|(((
1544 (% class="western" %)
1545 JSON of the resources type object needs to be sent as post data. Id field should not be sent.
1546 )))
1547 |(((
1548 (% class="western" %)
1549 PUT
1550 )))|(((
1551 (% class="western" %)
1552 /resources/5
1553 )))|(((
1554 (% class="western" %)
1555 JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
1556 )))
1557
1558 \\
1559
1560 (% class="western" %)
1561 **GET method should be used to lookup resources.**
1562
1563 (% class="wrapped" %)
1564 |(((
1565 (% class="western" %)
1566 **Request**
1567 )))|(((
1568 (% class="western" %)
1569 **Type**
1570 )))|(((
1571 (% class="western" %)
1572 **Description**
1573 )))
1574 |(((
1575 (% class="western" %)
1576 Lookup params
1577 )))|(((
1578 (% class="western" %)
1579 String
1580 )))|(((
1581 (% class="western" %)
1582 URL encoded key value string parameter for the lookup.
1583
1584 (% class="western" %)
1585 Params:
1586
1587 (% class="western" %)
1588 Name: Name of the resource for lookup (String)
1589 )))
1590
1591 (% class="wrapped" %)
1592 |(((
1593 (% class="western" %)
1594 **Response**
1595 )))|(((
1596 (% class="western" %)
1597 **Type**
1598 )))|(((
1599 (% class="western" %)
1600 **Description**
1601 )))
1602 |(((
1603 (% class="western" %)
1604 Resources
1605 )))|(((
1606 (% class="western" %)
1607 Resources
1608 )))|(((
1609 (% class="western" %)
1610 Returns found resource details.
1611 )))
1612
1613 \\
1614
1615 (% class="western" %)
1616 **POST method should be used to create resources.**
1617
1618 (% class="wrapped" %)
1619 |(((
1620 (% class="western" %)
1621 **Request**
1622 )))|(((
1623 (% class="western" %)
1624 **Type**
1625 )))|(((
1626 (% class="western" %)
1627 **Description**
1628 )))
1629 |(((
1630 (% class="western" %)
1631 Resources
1632 )))|(((
1633 (% class="western" %)
1634 Resources
1635 )))|(((
1636 (% class="western" %)
1637 resource details in json to be sent as post data. Id should not be set.
1638
1639 (% class="western" %)
1640 **Possible Request Params**: Name, Description, Type, Value, FreePass
1641
1642 (% class="western" %)
1643 **Example**:
1644
1645 (% class="western" %)
1646 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1647
1648 (% class="western" %)
1649 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1650
1651 (% class="western" %)
1652 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
1653
1654 (% class="western" %)
1655 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1656 )))
1657
1658 (% class="wrapped" %)
1659 |(((
1660 (% class="western" %)
1661 **Response**
1662 )))|(((
1663 (% class="western" %)
1664 **Type**
1665 )))|(((
1666 (% class="western" %)
1667 **Description**
1668 )))
1669 |(((
1670 (% class="western" %)
1671 ResourceId
1672 )))|(((
1673 (% class="western" %)
1674 int
1675 )))|(((
1676 (% class="western" %)
1677 Resource Id of the newly created resource.
1678 )))
1679
1680 \\
1681
1682 (% class="western" %)
1683 PUT method should be used to update an individual resource given the resource info.
1684
1685 (% class="wrapped" %)
1686 |(((
1687 (% class="western" %)
1688 **Request**
1689 )))|(((
1690 (% class="western" %)
1691 **Type**
1692 )))|(((
1693 (% class="western" %)
1694 **Description**
1695 )))
1696 |(((
1697 (% class="western" %)
1698 Resources
1699 )))|(((
1700 (% class="western" %)
1701 Resource
1702 )))|(((
1703 (% class="western" %)
1704 Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1705
1706 (% class="western" %)
1707 \\
1708
1709 (% class="western" %)
1710 Examples:
1711
1712 (% class="western" %)
1713 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1714
1715 (% class="western" %)
1716 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1717
1718 (% class="western" %)
1719 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
1720
1721 (% class="western" %)
1722 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1723 )))
1724
1725 (% class="wrapped" %)
1726 |(((
1727 (% class="western" %)
1728 **Response**
1729 )))|(((
1730 (% class="western" %)
1731 **Type**
1732 )))|(((
1733 (% class="western" %)
1734 **Description**
1735 )))
1736 |(((
1737 (% class="western" %)
1738 ResourceId
1739 )))|(((
1740 (% class="western" %)
1741 Int
1742 )))|(((
1743 (% class="western" %)
1744 resource id of the updated resource.
1745 )))
1746
1747 \\
1748
1749 \\
1750
1751 (% class="western" %)
1752 \\
1753
1754 (% class="western" %)
1755 **COMPONENT: Source Codes
1756 **
1757
1758 (% class="western" %)
1759 This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
1760
1761 (% class="wrapped" %)
1762 |(((
1763 (% class="western" %)
1764 **Method**
1765 )))|(((
1766 (% class="western" %)
1767 **Url**
1768 )))|(((
1769 (% class="western" %)
1770 **Action**
1771 )))
1772 |(((
1773 (% class="western" %)
1774 GET
1775 )))|(((
1776 (% class="western" %)
1777 /sources/1
1778 )))|(((
1779 (% class="western" %)
1780 Get source id 1.
1781 )))
1782 |(((
1783 (% class="western" %)
1784 GET
1785 )))|(((
1786 (% class="western" %)
1787 /sources/lookup?Source=sourcename
1788 )))|(((
1789 (% class="western" %)
1790 Lookup sources by source.
1791 )))
1792 |(((
1793 (% class="western" %)
1794 POST
1795 )))|(((
1796 (% class="western" %)
1797 /sources
1798 )))|(((
1799 (% class="western" %)
1800 JSON of the Sources type object needs to be sent as post data. Id field should not be sent.
1801 )))
1802 |(((
1803 (% class="western" %)
1804 PUT
1805 )))|(((
1806 (% class="western" %)
1807 /sources
1808 )))|(((
1809 (% class="western" %)
1810 JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
1811 )))
1812
1813 \\
1814
1815 (% class="western" %)
1816 **Sources can be looked up given the code or Id. GET method should be used for lookup.**
1817
1818 (% class="wrapped" %)
1819 |(((
1820 (% class="western" %)
1821 **Request**
1822 )))|(((
1823 (% class="western" %)
1824 **Type**
1825 )))|(((
1826 (% class="western" %)
1827 **Description**
1828 )))
1829 |(((
1830 (% class="western" %)
1831 Lookup params
1832 )))|(((
1833 (% class="western" %)
1834 String
1835 )))|(((
1836 (% class="western" %)
1837 URL encoded key value string parameter for the lookup.
1838
1839 (% class="western" %)
1840 Params:
1841
1842 (% class="western" %)
1843 Source: Source value (String)
1844 )))
1845
1846 (% class="wrapped" %)
1847 |(((
1848 (% class="western" %)
1849 **Response**
1850 )))|(((
1851 (% class="western" %)
1852 **Type**
1853 )))|(((
1854 (% class="western" %)
1855 **Description**
1856 )))
1857 |(((
1858 (% class="western" %)
1859 Sources
1860 )))|(((
1861 (% class="western" %)
1862 Sources
1863 )))|(((
1864 (% class="western" %)
1865 Returns found source details.
1866 )))
1867
1868 \\
1869
1870 (% class="western" %)
1871 \\
1872
1873 (% class="western" %)
1874 POST method should be used to create an individual source given the source parameters.
1875
1876 (% class="wrapped" %)
1877 |(((
1878 (% class="western" %)
1879 **Request**
1880 )))|(((
1881 (% class="western" %)
1882 **Type**
1883 )))|(((
1884 (% class="western" %)
1885 **Description**
1886 )))
1887 |(((
1888 (% class="western" %)
1889 Sources
1890 )))|(((
1891 (% class="western" %)
1892 Sources
1893 )))|(((
1894 (% class="western" %)
1895 Defines the contents that makes up the source. Id parameters should not be set.
1896 )))
1897
1898 (% class="wrapped" %)
1899 |(((
1900 (% class="western" %)
1901 **Response**
1902 )))|(((
1903 (% class="western" %)
1904 **Type**
1905 )))|(((
1906 (% class="western" %)
1907 **Description**
1908 )))
1909 |(((
1910 (% class="western" %)
1911 SourceId
1912 )))|(((
1913 (% class="western" %)
1914 int
1915 )))|(((
1916 (% class="western" %)
1917 Returns created source code id.
1918 )))
1919
1920 \\
1921
1922 (% class="western" %)
1923 **PUT method can be used to update an individual source given the id.**
1924
1925 (% class="wrapped" %)
1926 |(((
1927 (% class="western" %)
1928 **Request**
1929 )))|(((
1930 (% class="western" %)
1931 **Type**
1932 )))|(((
1933 (% class="western" %)
1934 **Description**
1935 )))
1936 |(((
1937 (% class="western" %)
1938 Sources
1939 )))|(((
1940 (% class="western" %)
1941 Sources
1942 )))|(((
1943 (% class="western" %)
1944 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.
1945 )))
1946
1947 (% class="wrapped" %)
1948 |(((
1949 (% class="western" %)
1950 **Response**
1951 )))|(((
1952 (% class="western" %)
1953 **Type**
1954 )))|(((
1955 (% class="western" %)
1956 **Description**
1957 )))
1958 |(((
1959 (% class="western" %)
1960 SourceId
1961 )))|(((
1962 (% class="western" %)
1963 int
1964 )))|(((
1965 (% class="western" %)
1966 Returns updated source id.
1967 )))
1968
1969 \\
1970
1971 (% class="western" %)
1972 \\
1973
1974 (% class="western" %)
1975 **COMPONENT: Transactions**
1976
1977 (% class="western" %)
1978 This resource is for manipulating transactions resource. A transaction can be created or searched.
1979
1980 (% class="wrapped" %)
1981 |(((
1982 (% class="western" %)
1983 **Method**
1984 )))|(((
1985 (% class="western" %)
1986 **Url**
1987 )))|(((
1988 (% class="western" %)
1989 **Action**
1990 )))
1991 |(((
1992 (% class="western" %)
1993 GET
1994 )))|(((
1995 (% class="western" %)
1996 /transactions
1997 )))|(((
1998 (% class="western" %)
1999 List all transactions
2000 )))
2001 |(((
2002 (% class="western" %)
2003 GET
2004 )))|(((
2005 (% class="western" %)
2006 /transactions/lookup?UserId=1
2007 )))|(((
2008 (% class="western" %)
2009 Lookup all transaction of UserId = 1
2010 )))
2011 |(((
2012 (% class="western" %)
2013 POST
2014 )))|(((
2015 (% class="western" %)
2016 /transactions
2017 )))|(((
2018 (% class="western" %)
2019 JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
2020 )))
2021
2022 \\
2023
2024 (% class="western" %)
2025 \\
2026
2027 (% class="western" %)
2028 Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2029
2030 (% class="wrapped" %)
2031 |(((
2032 (% class="western" %)
2033 **Request**
2034 )))|(((
2035 (% class="western" %)
2036 **Type**
2037 )))|(((
2038 (% class="western" %)
2039 **Description**
2040 )))
2041 |(((
2042 (% class="western" %)
2043 Lookup params
2044 )))|(((
2045 (% class="western" %)
2046 String
2047 )))|(((
2048 (% class="western" %)
2049 URL encoded key value string parameter for the lookup.
2050
2051 (% class="western" %)
2052 Params:
2053
2054 (% class="western" %)
2055 UserId: Id of the user whose transaction is to be looked up (Int)
2056
2057 (% class="western" %)
2058 StartDate: Date from which the start should happen. Only valid when UserId is set. (Date)
2059
2060 (% class="western" %)
2061 EndDate: When the search should end. Only valid when UserId is set. (Date)
2062 )))
2063
2064 (% class="wrapped" style="letter-spacing: 0.0px;" %)
2065 |(((
2066 (% class="western" %)
2067 **Response**
2068 )))|(((
2069 (% class="western" %)
2070 **Type**
2071 )))|(((
2072 (% class="western" %)
2073 **Description**
2074 )))
2075 |(((
2076 (% class="western" %)
2077 Transactions
2078 )))|(((
2079 (% class="western" %)
2080 Transactions
2081 )))|(((
2082 (% class="western" %)
2083 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.
2084 )))
2085
2086 \\
2087
2088 **Sample response for /(% style="color: rgb(80,80,80);" %)transactions/lookup?UserId=25255105:(%%)**
2089
2090 (% class="wrapped" %)
2091 |=(((
2092 (% class="content-wrapper" %)
2093 (((
2094 [[image:attach:Screen Shot 2020-02-26 at 11.14.29 AM.png||width="1407"]]
2095 )))
2096 )))
2097
2098 \\
2099
2100 (% class="western" %)
2101 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.
2102
2103 (% class="wrapped" %)
2104 |(((
2105 (% class="western" %)
2106 **Request**
2107 )))|(((
2108 (% class="western" %)
2109 **Type**
2110 )))|(((
2111 (% class="western" %)
2112 **Description**
2113 )))
2114 |(((
2115 (% class="western" %)
2116 Transactions
2117 )))|(((
2118 (% class="western" %)
2119 Transactions
2120 )))|(((
2121 (% class="western" %)
2122 Contains fields that define a transaction. Id field should not be set.
2123 )))
2124
2125 (% class="wrapped" %)
2126 |(((
2127 (% class="western" %)
2128 **Response**
2129 )))|(((
2130 (% class="western" %)
2131 **Type**
2132 )))|(((
2133 (% class="western" %)
2134 **Description**
2135 )))
2136 |(((
2137 (% class="western" %)
2138 TransactionId
2139 )))|(((
2140 (% class="western" %)
2141 int
2142 )))|(((
2143 (% class="western" %)
2144 Returns transactionId of the newly created transaction.
2145 )))
2146
2147 \\
2148
2149 \\
2150
2151 (% class="western" %)
2152 **COMPONENT: Leads
2153 **
2154
2155 (% class="western" %)
2156 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.
2157
2158 (% class="western" %)
2159 \\
2160
2161 (% class="western" %)
2162 \\
2163
2164 (% class="western" %)
2165 \\
2166
2167 (% class="western" %)
2168 \\
2169
2170 (% class="western" %)
2171 \\
2172
2173 (% class="western" %)
2174 **Telemarketing Leads
2175 **
2176
2177 (% class="western" %)
2178
2179 This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2180
2181 (% class="wrapped" %)
2182 |(((
2183 (% class="western" %)
2184 **Method**
2185 )))|(((
2186 (% class="western" %)
2187 **Url**
2188 )))|(((
2189 (% class="western" %)
2190 **Action**
2191 )))
2192 |(((
2193 (% class="western" %)
2194 GET
2195 )))|(((
2196 (% class="western" %)
2197 /stats/telemarketing
2198 )))|(((
2199 (% class="western" %)
2200 List telemarketing stats
2201 )))
2202 |(((
2203 (% class="western" %)
2204 GET
2205 )))|(((
2206 (% class="western" %)
2207 /stats/telemarketing/1000
2208 )))|(((
2209 (% class="western" %)
2210 Get telemarketing stat whose id is 1000 in the system.
2211 )))
2212 |(((
2213 (% class="western" %)
2214 POST
2215 )))|(((
2216 (% class="western" %)
2217 /stats/telemarketing
2218 )))|(((
2219 (% class="western" %)
2220 JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
2221 )))
2222
2223 \\
2224
2225 (% class="western" %)
2226 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.
2227
2228 (% class="wrapped" %)
2229 |(((
2230 (% class="western" %)
2231 **Request**
2232 )))|(((
2233 (% class="western" %)
2234 **Type**
2235 )))|(((
2236 (% class="western" %)
2237 **Description**
2238 )))
2239 |(((
2240 (% class="western" %)
2241 Telemarketing
2242 )))|(((
2243 (% class="western" %)
2244 Telemarketing
2245 )))|(((
2246 (% class="western" %)
2247 Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section.
2248
2249 (% class="western" %)
2250 Workflow: OCID: This id is required field. This represents the unique id of the user in onecount system. This id can be looked up from the /user/lookup resource if the ocid is not known by providing user demographic questions, if not found new user needs to be created in the onecount system by posting the user demographic from /user resource. If the ocid is found send the demo data to user resource (PUT) to update the demographic information.
2251
2252 (% class="western" %)
2253 E.g
2254
2255 (% class="western" %)
2256 {
2257
2258 (% class="western" %)
2259 "Telemarketing":[
2260
2261 (% class="western" %)
2262 {
2263
2264 (% class="western" %)
2265 "OCID":"5000",
2266
2267 (% class="western" %)
2268 "Date": "2016-01-01",
2269
2270 (% class="western" %)
2271 "Time": "10:10:10",
2272
2273 (% class="western" %)
2274 "ResourceId":"250",
2275
2276 (% class="western" %)
2277 "PageUrl": "[[http:~~/~~/www.one-count.com/detail/a.php>>url:http://www.one-count.com/detail/a.php||shape="rect" class="western"]]",
2278
2279 (% class="western" %)
2280 "PageTitle":"tests"
2281
2282 (% class="western" %)
2283 }
2284
2285 (% class="western" %)
2286 ]
2287
2288 (% class="western" %)
2289 }
2290 )))
2291 |(((
2292 (% class="western" %)
2293 \\
2294 )))|(((
2295 (% class="western" %)
2296 \\
2297 )))|(((
2298 (% class="western" %)
2299 \\
2300 )))
2301
2302 (% class="wrapped" %)
2303 |(((
2304 (% class="western" %)
2305 **Response**
2306 )))|(((
2307 (% class="western" %)
2308 **Type**
2309 )))|(((
2310 (% class="western" %)
2311 **Description**
2312 )))
2313 |(((
2314 (% class="western" %)
2315 Ids
2316 )))|(((
2317 (% class="western" %)
2318 String
2319 )))|(((
2320 (% class="western" %)
2321 Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
2322 )))
2323
2324 \\
2325
2326 \\
2327
2328 \\
2329
2330 \\
2331
2332 \\
2333
2334 (% class="western" %)
2335 **API REFERENCE**
2336
2337 (% class="western" %)
2338 **Type: Questions**
2339
2340 (% class="wrapped" %)
2341 |(((
2342 (% class="western" %)
2343 **Property Name**
2344 )))|(((
2345 (% class="western" %)
2346 **Type**
2347 )))|(((
2348 (% class="western" %)
2349 **Description**
2350 )))
2351 |(((
2352 (% class="western" %)
2353 Id
2354 )))|(((
2355 (% class="western" %)
2356 Int
2357 )))|(((
2358 (% class="western" %)
2359 Id of the question.
2360 )))
2361 |(((
2362 (% class="western" %)
2363 Text
2364 )))|(((
2365 (% class="western" %)
2366 String
2367 )))|(((
2368 (% class="western" %)
2369 Text of the question.
2370 )))
2371 |(((
2372 (% class="western" %)
2373 Type
2374 )))|(((
2375 (% class="western" %)
2376 Int
2377 )))|(((
2378 (% class="western" %)
2379 Determines which type of question it is. Textbox, checkbox, select, radio.
2380 There can be 6 types of questions.
2381 type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2382 type=2 means textarea type question or long response type question.
2383 type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2384 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.
2385 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.
2386 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.
2387 )))
2388 |(((
2389 (% class="western" %)
2390 Choices
2391 )))|(((
2392 (% class="western" %)
2393 choices
2394 )))|(((
2395 (% class="western" %)
2396 If multiple choice question this field will have the choices.
2397 )))
2398 |(((
2399 (% class="western" %)
2400 Alias
2401 )))|(((
2402 (% class="western" %)
2403 String
2404 )))|(((
2405 (% class="western" %)
2406 Alias for admin purpose.
2407 )))
2408
2409 \\
2410
2411 (% class="western" %)
2412 \\
2413
2414 (% class="western" %)
2415 \\
2416
2417 (% class="western" %)
2418 **Type: Choices**
2419
2420 (% class="wrapped" %)
2421 |(((
2422 (% class="western" %)
2423 **Property Name**
2424 )))|(((
2425 (% class="western" %)
2426 **Type**
2427 )))|(((
2428 (% class="western" %)
2429 **Description**
2430 )))
2431 |(((
2432 (% class="western" %)
2433 Id
2434 )))|(((
2435 (% class="western" %)
2436 int
2437 )))|(((
2438 (% class="western" %)
2439 Id of the choice.
2440 )))
2441 |(((
2442 (% class="western" %)
2443 Text
2444 )))|(((
2445 (% class="western" %)
2446 string
2447 )))|(((
2448 (% class="western" %)
2449 Display text of choice.
2450 )))
2451 |(((
2452 (% class="western" %)
2453 Value
2454 )))|(((
2455 (% class="western" %)
2456 String
2457 )))|(((
2458 (% class="western" %)
2459 Value stored in db.
2460 )))
2461 |(((
2462 (% class="western" %)
2463 Order
2464 )))|(((
2465 (% class="western" %)
2466 Int
2467 )))|(((
2468 (% class="western" %)
2469 Display order.
2470 )))
2471 |(((
2472 (% class="western" %)
2473 QuestionId
2474 )))|(((
2475 (% class="western" %)
2476 Int
2477 )))|(((
2478 (% class="western" %)
2479 Tied to which question id.
2480 )))
2481
2482 \\
2483
2484 (% class="western" %)
2485 **Type: Users**
2486
2487 (% class="wrapped" %)
2488 |(((
2489 (% class="western" %)
2490 **Property Name**
2491 )))|(((
2492 (% class="western" %)
2493 **Type**
2494 )))|(((
2495 (% class="western" %)
2496 **Description**
2497 )))
2498 |(((
2499 (% class="western" %)
2500 Id
2501 )))|(((
2502 (% class="western" %)
2503 Int
2504 )))|(((
2505 (% class="western" %)
2506 ID of the user in ONEcount.
2507 )))
2508 |(((
2509 (% class="western" %)
2510 PartnerId
2511 )))|(((
2512 (% class="western" %)
2513 Int
2514 )))|(((
2515 (% class="western" %)
2516 ID of the user in partners system (e.g. id of your system).
2517 )))
2518 |(((
2519 (% class="western" %)
2520 Demo
2521 )))|(((
2522 (% class="western" %)
2523 Demo
2524 )))|(((
2525 (% class="western" %)
2526 Object of user's demo question ids and respective response values.
2527 )))
2528 |(((
2529 (% class="western" %)
2530 RequestDate
2531 )))|(((
2532 (% class="western" %)
2533 Date
2534 )))|(((
2535 (% class="western" %)
2536 Request date.
2537 )))
2538
2539 \\
2540
2541 (% class="western" %)
2542 **Type: Demo**
2543
2544 (% class="wrapped" %)
2545 |(((
2546 (% class="western" %)
2547 **Property Name**
2548 )))|(((
2549 (% class="western" %)
2550 **Type**
2551 )))|(((
2552 (% class="western" %)
2553 **Description**
2554 )))
2555 |(((
2556 (% class="western" %)
2557 QuestionId (e.g 6)
2558 )))|(((
2559 (% class="western" %)
2560 String
2561 )))|(((
2562 (% class="western" %)
2563 6 is the value of “Id” property of question resource(Text = “First Name”)
2564 )))
2565 |(((
2566 (% class="western" %)
2567 QuestionId (e.g 7)
2568 )))|(((
2569 (% class="western" %)
2570 String
2571 )))|(((
2572 (% class="western" %)
2573 7 is the value of “Id” property of question resource(Text = “Last Name”)
2574 )))
2575 |(((
2576 (% class="western" %)
2577 ...
2578 )))|(((
2579 (% class="western" %)
2580 ...
2581 )))|(((
2582 (% class="western" %)
2583 ...
2584 )))
2585
2586 \\
2587
2588 (% class="western" %)
2589 **Type: Transactions**
2590
2591 (% class="wrapped" %)
2592 |(((
2593 (% class="western" %)
2594 **Property Name**
2595 )))|(((
2596 (% class="western" %)
2597 **Type**
2598 )))|(((
2599 (% class="western" %)
2600 **Description**
2601 )))
2602 |(((
2603 (% class="western" %)
2604 Id
2605 )))|(((
2606 (% class="western" %)
2607 Int
2608 )))|(((
2609 (% class="western" %)
2610 ID of the transaction.
2611 )))
2612 |(((
2613 (% class="western" %)
2614 UserId
2615 )))|(((
2616 (% class="western" %)
2617 Int
2618 )))|(((
2619 (% class="western" %)
2620 Id of user in ONEcount.
2621 )))
2622 |(((
2623 (% class="western" %)
2624 TermId
2625 )))|(((
2626 (% class="western" %)
2627 Int
2628 )))|(((
2629 (% class="western" %)
2630 TermId in ONEcount.
2631 )))
2632 |(((
2633 (% class="western" %)
2634 ProductStatus
2635 )))|(((
2636 (% class="western" %)
2637 Int
2638 )))|(((
2639 (% class="western" %)
2640 Status ID.
2641 )))
2642 |(((
2643 (% class="western" %)
2644 SubscriptionType
2645 )))|(((
2646 (% class="western" %)
2647 Char
2648 )))|(((
2649 (% class="western" %)
2650 Can be n,r or u for new, renew or unsubscribe.
2651 )))
2652 |(((
2653 (% class="western" %)
2654 TransactionDate
2655 )))|(((
2656 (% class="western" %)
2657 Date
2658 )))|(((
2659 (% class="western" %)
2660 Date when the transaction occurred.
2661 )))
2662 |(((
2663 (% class="western" %)
2664 TransactionTime
2665 )))|(((
2666 (% class="western" %)
2667 Time
2668 )))|(((
2669 (% class="western" %)
2670 Time of transaction.
2671 )))
2672 |(((
2673 (% class="western" %)
2674 RequestDate
2675 )))|(((
2676 (% class="western" %)
2677 Date
2678 )))|(((
2679 (% class="western" %)
2680 The effective request date for the transaction.
2681 )))
2682 |(((
2683 (% class="western" %)
2684 UserIP
2685 )))|(((
2686 (% class="western" %)
2687 String
2688 )))|(((
2689 (% class="western" %)
2690 IP of the user.
2691 )))
2692 |(((
2693 (% class="western" %)
2694 Source
2695 )))|(((
2696 (% class="western" %)
2697 String
2698 )))|(((
2699 (% class="western" %)
2700 The transaction needs to be tied to a source code this will define it.
2701 )))
2702 |(((
2703 (% class="western" %)
2704 MediaFilePath
2705 )))|(((
2706 (% class="western" %)
2707 String
2708 )))|(((
2709 (% class="western" %)
2710 The url of media associated with that transaction. Eg image, audio.
2711 )))
2712 |(((
2713 (% class="western" %)
2714 ExpireDate
2715 )))|(((
2716 (% class="western" %)
2717 Date
2718 )))|(((
2719 (% class="western" %)
2720 Date when the subscription expires.
2721 )))
2722 |(((
2723 (% class="western" %)
2724 Amount
2725 )))|(((
2726 (% class="western" %)
2727 Float
2728 )))|(((
2729 (% class="western" %)
2730 If there is amount (USD) included in transaction.
2731 )))
2732
2733 \\
2734
2735 (% class="western" %)
2736 **Type: Sources**
2737
2738 (% class="wrapped" %)
2739 |(((
2740 (% class="western" %)
2741 **Property Name**
2742 )))|(((
2743 (% class="western" %)
2744 **Type**
2745 )))|(((
2746 (% class="western" %)
2747 **Description**
2748 )))
2749 |(((
2750 (% class="western" %)
2751 Id
2752 )))|(((
2753 (% class="western" %)
2754 Int
2755 )))|(((
2756 (% class="western" %)
2757 Id of the source.
2758 )))
2759 |(((
2760 (% class="western" %)
2761 Source
2762 )))|(((
2763 (% class="western" %)
2764 String
2765 )))|(((
2766 (% class="western" %)
2767 Value of the source.
2768 )))
2769 |(((
2770 (% class="western" %)
2771 Description
2772 )))|(((
2773 (% class="western" %)
2774 Text
2775 )))|(((
2776 (% class="western" %)
2777 Description of the source.
2778 )))
2779 |(((
2780 (% class="western" %)
2781 ParentId
2782 )))|(((
2783 (% class="western" %)
2784 int
2785 )))|(((
2786 (% class="western" %)
2787 If this is a child source then list the parent source id.
2788 )))
2789
2790 \\
2791
2792 (% class="western" %)
2793 \\
2794
2795 (% class="western" %)
2796 **Type: Products**
2797
2798 (% class="wrapped" %)
2799 |(((
2800 (% class="western" %)
2801 **Property Name**
2802 )))|(((
2803 (% class="western" %)
2804 **Type**
2805 )))|(((
2806 (% class="western" %)
2807 **Description**
2808 )))
2809 |(((
2810 (% class="western" %)
2811 Id
2812 )))|(((
2813 (% class="western" %)
2814 Int
2815 )))|(((
2816 (% class="western" %)
2817 Specify only for update.
2818 )))
2819 |(((
2820 (% class="western" %)
2821 Name
2822 )))|(((
2823 (% class="western" %)
2824 String
2825 )))|(((
2826 (% class="western" %)
2827 Name of the Product.
2828 )))
2829 |(((
2830 (% class="western" %)
2831 Description
2832 )))|(((
2833 (% class="western" %)
2834 Text
2835 )))|(((
2836 (% class="western" %)
2837 Description of the product.
2838 )))
2839 |(((
2840 (% class="western" %)
2841 Terms
2842 )))|(((
2843 (% class="western" %)
2844 Terms
2845 )))|(((
2846 (% class="western" %)
2847 (Array of) Terms associated with the product.
2848 )))
2849
2850 \\
2851
2852 (% class="western" %)
2853 **Type: Terms**
2854
2855 (% class="wrapped" %)
2856 |(((
2857 (% class="western" %)
2858 **Property Name**
2859 )))|(((
2860 (% class="western" %)
2861 **Type**
2862 )))|(((
2863 (% class="western" %)
2864 **Description**
2865 )))
2866 |(((
2867 (% class="western" %)
2868 Id
2869 )))|(((
2870 (% class="western" %)
2871 int
2872 )))|(((
2873 (% class="western" %)
2874 Id of the term.
2875 )))
2876 |(((
2877 (% class="western" %)
2878 Name
2879 )))|(((
2880 (% class="western" %)
2881 string
2882 )))|(((
2883 (% class="western" %)
2884 Name of the Term.
2885 )))
2886 |(((
2887 (% class="western" %)
2888 Description
2889 )))|(((
2890 (% class="western" %)
2891 text
2892 )))|(((
2893 (% class="western" %)
2894 Description of the term.
2895 )))
2896 |(((
2897 (% class="western" %)
2898 Duration
2899 )))|(((
2900 (% class="western" %)
2901 int
2902 )))|(((
2903 (% class="western" %)
2904 Duration of term validity.
2905 )))
2906 |(((
2907 (% class="western" %)
2908 DurationUnit
2909 )))|(((
2910 (% class="western" %)
2911 sting
2912 )))|(((
2913 (% class="western" %)
2914 Y (year), M (Month), D (Days).
2915 )))
2916 |(((
2917 (% class="western" %)
2918 ProductId
2919 )))|(((
2920 (% class="western" %)
2921 int
2922 )))|(((
2923 (% class="western" %)
2924 Id of the product the term is tied to.
2925 )))
2926 |(((
2927 (% class="western" %)
2928 Price
2929 )))|(((
2930 (% class="western" %)
2931 float
2932 )))|(((
2933 (% class="western" %)
2934 If there is price (USD) for the term.
2935 )))
2936
2937 \\
2938
2939 (% class="western" %)
2940 **Type: Resources**
2941
2942 (% class="wrapped" %)
2943 |(((
2944 (% class="western" %)
2945 **Property Name**
2946 )))|(((
2947 (% class="western" %)
2948 **Type**
2949 )))|(((
2950 (% class="western" %)
2951 **Description**
2952 )))
2953 |(((
2954 (% class="western" %)
2955 Id
2956 )))|(((
2957 (% class="western" %)
2958 Int
2959 )))|(((
2960 (% class="western" %)
2961 Specify only for update.
2962 )))
2963 |(((
2964 (% class="western" %)
2965 Name
2966 )))|(((
2967 (% class="western" %)
2968 String
2969 )))|(((
2970 (% class="western" %)
2971 Name of the Resource.
2972 )))
2973 |(((
2974 (% class="western" %)
2975 Description
2976 )))|(((
2977 (% class="western" %)
2978 Text
2979 )))|(((
2980 (% class="western" %)
2981 Description of the Resource.
2982 )))
2983 |(((
2984 (% class="western" %)
2985 Type
2986 )))|(((
2987 (% class="western" %)
2988 Int
2989 )))|(((
2990 (% class="western" %)
2991 Type Options
2992
2993 (% class="western" %)
2994 **0** : File
2995
2996 (% class="western" %)
2997 **2 : **Newsletter
2998
2999 (% class="western" %)
3000 **3 : **Section
3001
3002 (% class="western" %)
3003 **4 : **Page
3004
3005 (% class="western" %)
3006 **5 : **Function
3007 )))
3008 |(((
3009 (% class="western" %)
3010 Value
3011 )))|(((
3012 (% class="western" %)
3013 String
3014
3015 (% class="western" %)
3016 or
3017
3018 (% class="western" %)
3019 Array
3020 )))|(((
3021 (% class="western" %)
3022 Value of Resource Type:
3023
3024 (% class="western" %)
3025 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.
3026
3027 (% class="western" %)
3028 For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
3029
3030 (% class="western" %)
3031 Example :
3032
3033 (% class="western" %)
3034 if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].** **
3035 **if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
3036
3037 (% class="western" %)
3038 For Function type resource leave it blank.
3039 )))
3040 |(((
3041 (% class="western" %)
3042 limit
3043 )))|(((
3044 (% class="western" %)
3045 Int
3046 )))|(((
3047 (% class="western" %)
3048 Default limit is 25 but if all the data needs to be pulled then pass limit=0.
3049 )))
3050 |(% colspan="1" %)(% colspan="1" %)
3051 (((
3052 FreePass
3053 )))|(% colspan="1" %)(% colspan="1" %)
3054 (((
3055 Int
3056 )))|(% colspan="1" %)(% colspan="1" %)
3057 (((
3058 Default value is 0. This parameter is used to provide access to protected content.
3059 )))
3060
3061 \\
3062
3063 (% class="western" %)
3064 **Type: Telemarketing**
3065
3066 (% class="wrapped" %)
3067 |(((
3068 (% class="western" %)
3069 **Property Name**
3070 )))|(((
3071 (% class="western" %)
3072 **Type**
3073 )))|(((
3074 (% class="western" %)
3075 **Description**
3076 )))
3077 |(((
3078 (% class="western" %)
3079 Id
3080 )))|(((
3081 (% class="western" %)
3082 int
3083 )))|(((
3084 (% class="western" %)
3085 Id of the telemarketing stat. This is autogenerated from the system and can be used to lookup the stat.
3086 )))
3087 |(((
3088 (% class="western" %)
3089 OCID
3090 )))|(((
3091 (% class="western" %)
3092 int
3093 )))|(((
3094 (% class="western" %)
3095 Onecount ID of the user.
3096 )))
3097 |(((
3098 (% class="western" %)
3099 Date
3100 )))|(((
3101 (% class="western" %)
3102 Date
3103 )))|(((
3104 (% class="western" %)
3105 Date when the stat occurred. Format: yyyy-mm-dd
3106 )))
3107 |(((
3108 (% class="western" %)
3109 Time
3110 )))|(((
3111 (% class="western" %)
3112 Time
3113 )))|(((
3114 (% class="western" %)
3115 Time of stat. Format: h:m:s (24 hour format)
3116 )))
3117 |(((
3118 (% class="western" %)
3119 ResourceId
3120 )))|(((
3121 (% class="western" %)
3122 int
3123 )))|(((
3124 (% class="western" %)
3125 Id of resource currently being sent for the sat. If the resource type is page type resource then need to send
3126
3127 (% class="western" %)
3128 PageTitle otherwise it will follow the process described in PageTitle.
3129 )))
3130 |(((
3131 (% class="western" %)
3132 PageUrl
3133 )))|(((
3134 (% class="western" %)
3135 string
3136 )))|(((
3137 (% class="western" %)
3138 Page Url belongs to resource that is being sent with this request. If the resource is file type then it needs to be path to that file and if the resource is section it needs to be section. Basically the value here needs to exact what is defined while creating resource.
3139 )))
3140 |(((
3141 (% class="western" %)
3142 PageTitle
3143 )))|(((
3144 (% class="western" %)
3145 string
3146 )))|(((
3147 (% class="western" %)
3148 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.
3149
3150 (% class="western" %)
3151 \\
3152
3153 (% class="western" %)
3154 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.
3155 )))
3156
3157 \\
3158
3159 \\