Skip to Content

Wiki source code of ONEcount API Documentation

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