Wiki source code of OLD-ONEcount API Documentation

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