Skip to Content

Wiki source code of ONEcount API Documentation

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