Wiki source code of ONEcount API Documentation

Version 1.1 by rayaan@one-count_com on 2023/12/12 04:31
Hide last authors
rayaan@one-count_com 1.1 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 1. Engagements\\
58 11. Get all Engagements
59 11. Get specific engagement by engagement id
60 11. Create Engagements
61 11. Update Engagements
62 11. Add users data to Engagement
63
64 \\
65
66 (% class="western" %)
67 **Accessing API**
68
69 (% class="western" %)
70 **REST API URL: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||style="" rel="nofollow" shape="rect" class="external-link"]]**
71
72 (% class="western" %)
73 **Appkey**: THIS WILL BE PROVIDED TO YOU
74
75 (% class="western" %)
76 \\
77
78 (% class="western" %)
79 Your HTTP requests to a REST API resource should contain the following information:
80
81 * (((
82 (% class="western" %)
83 An HTTP method GET, POST, PUT.
84 )))
85 * (((
86 (% class="western" %)
87 An Appkey sent as Appkey header in the http request to authenticate the request.
88 )))
89 * (((
90 (% class="western" %)
91 Resource name in the url (/resourcename)
92 )))
93 * (((
94 (% class="western" %)
95 Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
96 )))
97
98 (% class="western" %)
99 \\
100
101 (% class="western" %)
102 **General API Usage**
103
104 (% class="western" %)
105 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.
106
107 (% class="western" %)
108 For lookup, the parameter list will be part of the request url.
109
110 (% class="western" %)
111 \\
112
113 (% class="western" %)
114 **Response**
115
116 (% class="western" %)
117 API will output the response in a JSON format discussed below.
118
119 {{code language="yml" theme="RDark" title="Response" collapse="true"}}
120 {
121 "result": {
122 "success": "1",
123 "error": {
124 "code": "0",
125 "message": ""
126 }
127 },
128 "Users": {
129 "Id": "12562",
130 "PartnerId": "5467",
131 "Demo": {
132 "6": "Rayaan",
133 "7": "Ahmed"
134 }
135 }
136 }
137 {{/code}}
138
139 (% class="western" %)
140 \\
141
142 (% class="western" %)
143 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.
144
145 \\
146
147 (% class="western" %)
148 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.
149
150 If the value of success is 1 then the response parameters of the called method will also be output.
151
152 (% class="western" %)
153 For (% class="StyledLeaf___StyledSpan-sc-129cvv1-0 hSAwv slate-bold" %)**GET **requests we can pass** limit **as parameter in URL.
154
155 === **COMPONENT: Users** ===
156
157 (% class="western" %)
158 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.
159
160 (% class="western" %)
161 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.
162
163 (% class="western" %)
164 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.
165
166 (% class="western" %)
167 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.
168
169 (% class="western" %)
170 Return parameter will have the comma separated list of question Ids that is requested back from the API.
171
172 (% class="western" %)
173 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.
174
175 \\
176
177 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
178 (((
179 (% class="western" %)
180 **Method**
181 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
182 (((
183 (% class="western" %)
184 **Url**
185 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
186 (((
187 (% class="western" %)
188 **Action**
189 )))
190 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
191 (((
192 (% class="western" %)
193 GET
194 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
195 (((
196 (% class="western" %)
197 /users
198 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
199 (((
200 (% class="western" %)
201 Get users data limiting 25.
202 )))
203 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
204 (((
205 (% class="western" %)
206 GET
207 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
208 (((
209 (% class="western" %)
210 /users/<ocid or ocid_hash>
211 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
212 (((
213 (% class="western" %)
214 Get data for user id 1. The user id can be a numeric value or a hash
215 )))
216 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
217 (((
218 (% class="western" %)
219 GET
220 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
221 (((
222 (% class="western" %)
223 /users/lookup?1=user1@[[email.com>>url:http://email.com/||style="" rel="nofollow" shape="rect" class="external-link"]]&return=1,2
224 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
225 (((
226 (% class="western" %)
227 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.
228
229 (% class="western" %)
230 Return parameter defines a csv of question id that are requested back in response.
231 )))
232 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
233 (((
234 (% class="western" %)
235 POST
236 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
237 (((
238 (% class="western" %)
239 /users
240 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
241 (((
242 (% class="western" %)
243 Create a new users
244
245 (% class="western" %)
246 Parameters required to create the user needs to be sent as post data in JSON format.
247 )))
248 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
249 (((
250 (% class="western" %)
251 PUT
252 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
253 (((
254 (% class="western" %)
255 /users/1
256 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
257 (((
258 (% class="western" %)
259 Update user id 1. The user id can be a numeric value or a hash
260
261 (% class="western" %)
262 Parameters required to update the user needs to be sent as post data in JSON format.
263 )))
264 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
265 (((
266 (% class="western" %)
267 GET
268 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
269 (((
270 (% class="western" %)
271 /users/1/partners/2
272 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
273 (((
274 (% class="western" %)
275 Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
276 )))
277 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
278 (((
279 (% class="western" %)
280 POST
281 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
282 (((
283 (% class="western" %)
284 /users/login
285 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
286 (((
287 (% class="western" %)
288 Check to see user exist with username/email and password.
289
290 (% class="western" %)
291 Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
292
293 (% class="western" %)
294 Example:
295
296 (% class="western" %)
297 {"u":"[[abc@one-count.com>>mailto:abc@one-count.com||style="" rel="nofollow" shape="rect" class="external-link"]]","e":"abc@[[one-count.com>>url:http://one-count.com/||style="" rel="nofollow" shape="rect" class="external-link"]]","p":"1234"}
298
299 (% class="western" %)
300 OR
301
302 (% class="western" %)
303 {"u":"[[abc@one-count.com>>mailto:abc@one-count.com||style="" rel="nofollow" shape="rect" class="external-link"]]","p":"1234"}
304
305 (% class="western" %)
306 OR
307
308 (% class="western" %)
309 {"e":"[[abc@one-count.com>>mailto:abc@one-count.com||style="" rel="nofollow" shape="rect" class="external-link"]]","p":"1234"}
310
311 (% class="western" %)
312 **OUTPUT** : Should get OCID of the user if it finds it otherwise get and error with msg user not found.
313 )))
314
315 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
316 == (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)All Users(%%) ==
317
318 ----
319
320 {{column width="100%"}}
321 (% class="nolink" %)https:~/~/api.onecount.net/v2/users
322 {{/column}}
323
324 (% style="" %)
325 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
326
327 ----
328
329 (% style="" %)
330 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
331
332 ==== Example ====
333
334 ----
335
336 (% style="color: rgb(107,107,107);" %)Request
337
338 {{code language="php" theme="RDark" title="Get All Users Request" collapse="true"}}
339 <?php
340
341 $curl = curl_init();
342
343 curl_setopt_array($curl, array(
344 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users',
345 CURLOPT_RETURNTRANSFER => true,
346 CURLOPT_ENCODING => '',
347 CURLOPT_MAXREDIRS => 10,
348 CURLOPT_TIMEOUT => 0,
349 CURLOPT_FOLLOWLOCATION => true,
350 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
351 CURLOPT_CUSTOMREQUEST => 'GET',
352 CURLOPT_HTTPHEADER => array(
353 'Appkey: {{ONECOUNT API KEY}}'
354 ),
355 ));
356
357 $response = curl_exec($curl);
358
359 curl_close($curl);
360 echo $response;
361
362
363 {{/code}}
364
365 \\
366
367 (% style="color: rgb(107,107,107);" %)Response  200 OK
368
369 {{code language="yml" theme="RDark" title="Get All Users Response" collapse="true"}}
370 {
371 "result": {
372 "success": "1",
373 "error": {
374 "code": "",
375 "message": ""
376 }
377 },
378 "Users": [
379 {
380 "Id": 10,
381 "OCID_HASH": "309d0ba643ac9cf164fa7089db622444fb82bf031c79ebb97c8566d0b91a224c",
382 "Demo": {
383 "1": "ORISH+IMNG12373@gcnmedia.com",
384 "2": "user_26_2",
385 "3": "pass_262",
386 "4": "orish123"
387 }
388 },
389 {
390 "Id": 26,
391 "OCID_HASH": "362b0815ab579017802c0539fa30d45c46f2e357025756e3a998225aa2c3f123",
392 "Demo": {
393 "1": "ORISH+IMNG12374@gcnmedia.com",
394 "2": "user_82_2",
395 "3": "pass_822",
396 "4": "orish111"
397 }
398 },
399 {
400 "Id": 34,
401 "OCID_HASH": "508ae86cfa9185a59a855b6f0aaf1ef52e1895c7a7bd1ee01d1f7be82ea233d2",
402 "Demo": {
403 "1": "",
404 "2": "user_1405614567717",
405 "3": "",
406 "4": "sonish",
407 "5": "shrestha",
408 "6": "Test",
409 "7": "GCN",
410 "8": "Sterling",
411 "9": "Norwalk",
412 "10": "",
413 "11": "",
414 "12": "",
415 "13": "Nepa",
416 "14": "",
417 "15": ""
418 }
419 },
420 {
421 "Id": 42,
422 "OCID_HASH": "3fd11fb98076330290d14edd70265c273eaf5ad72e498fc9ac4f2b580a2f36cc",
423 "Demo": {
424 "1": "orish@gcnpublishing.com",
425 "2": "user_106_42",
426 "3": "f5a622347842b9384cae63bb998f2aa19aea2ebc43fa2f00800e9accd85a8dd1",
427 "4": "Orish",
428 "5": "Shrestha",
429 "6": "Director of Engineering",
430 "7": "ONEcount",
431 "8": "194 Main Street",
432 "9": "Suite 2NW",
433 "10": "Norwalk",
434 "11": "CT",
435 "12": "06851",
436 "13": "",
437 "15": "",
438 "106": "",
439 "114": "",
440 "130": "",
441 "138": "",
442 "146": "",
443 "234": "",
444 "242": "",
445 "250": ""
446 }
447 },
448 {
449 "Id": 50,
450 "OCID_HASH": "88d721f543c79f8ea718d9020897c9036d1d303099a649585f6d4c37e354c5d3",
451 "Demo": {
452 "1": "sundeep@gcnpublishing.com",
453 "2": "",
454 "3": "",
455 "4": "Sundeep",
456 "5": "Dangol",
457 "6": "Director of Integrations",
458 "7": "ONEcount",
459 "8": "194 Main Street",
460 "9": "Suite 2NW",
461 "10": "Norwalk",
462 "11": "CT",
463 "12": "06851",
464 "13": "",
465 "15": "",
466 "106": "",
467 "114": "",
468 "130": "",
469 "138": "",
470 "146": "",
471 "234": "",
472 "242": ""
473 }
474 },
475 {
476 "Id": 58,
477 "OCID_HASH": "c45f5d1d27364ee19973148d6c02999cbfbc8b2ca80f7655dd6a873b864eb211",
478 "Demo": {
479 "1": "sean@gcnpublishing.com",
480 "2": "user_106_34",
481 "3": "pass_10634",
482 "4": "Sean",
483 "5": "Fulton",
484 "6": "Vice President",
485 "7": "ONEcount",
486 "8": "194 Main Street",
487 "9": "Suite 2NW",
488 "10": "Norwalk",
489 "11": "CT",
490 "12": "06851",
491 "13": "UNITED STATES"
492 }
493 },
494 {
495 "Id": 66,
496 "OCID_HASH": "f037520f7af46301532a95b39d8fd8e607988afe3c7b67f086740e6676775bee",
497 "Demo": {
498 "1": "joanne@gcnpublishing.com",
499 "2": "user_106_2",
500 "3": "c55b18c5a4e475034ccc8cd14e132e1fd7e2aadcd8dcc625996ba51d145f160e",
501 "4": "Joanne",
502 "5": "Persico",
503 "6": "President",
504 "7": "ONEcount",
505 "8": "194 Main Street",
506 "9": "Suite 2NW",
507 "10": "Norwalk",
508 "11": "CT",
509 "12": "06851",
510 "13": "UNITED STATES",
511 "234": "",
512 "242": "",
513 "250": ""
514 }
515 },
516 {
517 "Id": 74,
518 "OCID_HASH": "abb8adfb275030ad96808967edea5003e3ed9da5965b6d8f4537597dff17af4f",
519 "Demo": {
520 "1": "melanie@gcnpublishing.com",
521 "2": "user_106_18",
522 "3": "pass_10618",
523 "4": "Melanie",
524 "5": "Mason",
525 "6": "Director of Customer Experience",
526 "7": "ONEcount",
527 "8": "194 Main Street",
528 "9": "Suite 2NW",
529 "10": "Norwalk",
530 "11": "CT",
531 "12": "06851",
532 "13": "UNITED STATES",
533 "14": "",
534 "15": "",
535 "106": "",
536 "114": "",
537 "130": "",
538 "138": "",
539 "146": "",
540 "154": "",
541 "162": "",
542 "170": "",
543 "178": "",
544 "186": "",
545 "202": "",
546 "218": "",
547 "226": "",
548 "234": "",
549 "242": "",
550 "250": ""
551 }
552 },
553 {
554 "Id": 82,
555 "OCID_HASH": "6b2635a195d46e9df53ec6069d198fa0fe26d26111c0b71b9bc39652935f6034",
556 "Demo": {
557 "1": "doug@gcnpublishing.com",
558 "2": "user_106_58",
559 "3": "pass_10658",
560 "4": "Doug",
561 "5": "LaFarge",
562 "7": "ONEcount",
563 "8": "194 Main Street",
564 "9": "Suite 2NW",
565 "10": "Norwalk",
566 "11": "CT",
567 "12": "06851",
568 "13": "UNITED STATES"
569 }
570 },
571 {
572 "Id": 90,
573 "OCID_HASH": "869434d36ef71f8244c5eacaac35cb87d9ee16f3c8bbeddaddb87869588deb52",
574 "Demo": {
575 "1": "subash@gcnpublishing.com",
576 "2": "user_106_50",
577 "3": "pass_10650",
578 "4": "Subash",
579 "5": "Tamang",
580 "7": "ONEcount",
581 "8": "194 Main Street",
582 "9": "Suite 2NW",
583 "10": "Norwalk",
584 "11": "CT",
585 "12": "06851",
586 "13": "UNITED STATES"
587 }
588 },
589 {
590 "Id": 98,
591 "OCID_HASH": "f46e4d07d8c2aede8e3f0b4d30cf984f9ce507147b75cff17315642d456d7cca",
592 "Demo": {
593 "1": "sonish@gcnpublishing.com",
594 "2": "user_106_10",
595 "3": "pass_10610",
596 "4": "Sonishs",
597 "5": "Shrestha",
598 "8": "334 Street",
599 "10": "Ashburn",
600 "11": "VA",
601 "12": "11118",
602 "13": "United States"
603 }
604 },
605 {
606 "Id": 162,
607 "OCID_HASH": "86616a428abeabe722079cb29ffd3b76341aa7895b2bd3579dfd89e01a737f0c",
608 "Demo": {
609 "1": "orish+1@gcnpublishing.com",
610 "2": "user_130_42",
611 "3": "pass_13042",
612 "4": "OrishGCN",
613 "5": "Shrestha",
614 "8": "123 street",
615 "10": "New Rochelle",
616 "11": "NY",
617 "12": "11111",
618 "13": "United States"
619 }
620 },
621 {
622 "Id": 170,
623 "OCID_HASH": "3fb40dbcd3c0ca47fd3a80f5a34290c68a2e7ff79d4d8f28b388677bea2df2ac",
624 "Demo": {
625 "1": "sundeep+1@gcnpublishing.com",
626 "2": "user_130_26",
627 "3": "pass_13026",
628 "4": "SundeepGCN",
629 "5": "Dangol",
630 "8": "456 Street",
631 "10": "Bridgeport",
632 "11": "CT",
633 "12": "11112",
634 "13": "United States"
635 }
636 },
637 {
638 "Id": 178,
639 "OCID_HASH": "ca72068a59896a3cec1faf52a4701d13b539039467cbe9d5d9b60b54e263040f",
640 "Demo": {
641 "1": "sean+1@gcnpublishing.com",
642 "2": "user_130_34",
643 "3": "pass_13034",
644 "4": "SeanGCN",
645 "5": "Fulton",
646 "8": "222 Street",
647 "10": "Norwalk",
648 "11": "CT",
649 "12": "11113",
650 "13": "United States"
651 }
652 },
653 {
654 "Id": 186,
655 "OCID_HASH": "4b643f02f3d30d0b6ae465b4d758a721574e798712c3d42bd5458a1fd5634243",
656 "Demo": {
657 "1": "joanne+1@gcnpublishing.com",
658 "2": "user_130_2",
659 "3": "pass_1302",
660 "4": "JoanneGCN",
661 "5": "Persico",
662 "8": "222 Street",
663 "10": "Norwalk",
664 "11": "CT",
665 "12": "11114",
666 "13": "United States"
667 }
668 },
669 {
670 "Id": 194,
671 "OCID_HASH": "d3200217585d2d954e0b55ee9ff1c939f265067420ff82c6e924dcdd71ccc960",
672 "Demo": {
673 "1": "melanie+1@gcnpublishing.com",
674 "2": "user_130_18",
675 "3": "pass_13018",
676 "4": "MelanieGCN",
677 "5": "Mason",
678 "6": "",
679 "7": "",
680 "8": "345 Street",
681 "9": "",
682 "10": "Norwalk",
683 "11": "CT",
684 "12": "11115",
685 "13": "United States",
686 "14": "",
687 "15": "",
688 "106": "",
689 "114": "",
690 "130": "",
691 "138": "",
692 "146": "",
693 "154": "",
694 "162": "",
695 "170": "",
696 "178": "",
697 "186": "",
698 "202": "",
699 "218": "",
700 "226": "",
701 "234": "",
702 "242": "",
703 "250": "",
704 "266": "01"
705 }
706 },
707 {
708 "Id": 202,
709 "OCID_HASH": "a7c7d5016322340c4394538d68f601a0720e70850091387114963aba0f1bae09",
710 "Demo": {
711 "1": "doug+1@gcnpublishing.com",
712 "2": "user_130_58",
713 "3": "pass_13058",
714 "4": "DougGCN",
715 "5": "La Farge",
716 "8": "849 Street",
717 "10": "Tuson",
718 "11": "AZ",
719 "12": "11116",
720 "13": "United States"
721 }
722 },
723 {
724 "Id": 210,
725 "OCID_HASH": "f0f0d59478e9a4aa9b0fad6ae5bfc4292a169f899135e8c4d16cada9e9dc267d",
726 "Demo": {
727 "1": "subash+1@gcnpublishing.com",
728 "2": "user_130_50",
729 "3": "pass_13050",
730 "4": "SubashGCN",
731 "5": "Tamang",
732 "8": "112 Street",
733 "10": "Herndon",
734 "11": "VA",
735 "12": "11117",
736 "13": "United States"
737 }
738 },
739 {
740 "Id": 218,
741 "OCID_HASH": "4939a3be6dfd79c715a1144d82815f2abe8e413d04e4311284a05610589ad87b",
742 "Demo": {
743 "1": "sonish+1@gcnpublishing.com",
744 "2": "user_130_10",
745 "3": "pass_13010",
746 "4": "SonishGCN",
747 "5": "Shrestha",
748 "8": "334 Street",
749 "10": "Reston",
750 "11": "VA",
751 "12": "11118",
752 "13": "United States"
753 }
754 },
755 {
756 "Id": 282,
757 "OCID_HASH": "44421a4b109b0f5eb412b29e0037df61aae9ea95003d73f0175e5d6db8c0f928",
758 "Demo": {
759 "1": "orish+11@gcnpublishing.com",
760 "2": "user_138_42",
761 "3": "pass_13842",
762 "4": "OrishGCN",
763 "5": "Shrestha",
764 "8": "123 street",
765 "10": "New Rochelle",
766 "11": "NY",
767 "12": "11111",
768 "13": "United States"
769 }
770 },
771 {
772 "Id": 290,
773 "OCID_HASH": "971c357d4808224595f83a30bba9f05d1118bd7fd4f1d51160cad57dfd6b2137",
774 "Demo": {
775 "1": "sundeep+11@gcnpublishing.com",
776 "2": "user_138_26",
777 "3": "pass_13826",
778 "4": "SundeepGCN",
779 "5": "Dangol",
780 "8": "456 Street",
781 "10": "Bridgeport",
782 "11": "CT",
783 "12": "11112",
784 "13": "United States"
785 }
786 },
787 {
788 "Id": 298,
789 "OCID_HASH": "4fa0426afe48ee79602e9c47dda1987797b1983ecaa5975a09885ac4480f5033",
790 "Demo": {
791 "1": "sean+11@gcnpublishing.com",
792 "2": "user_138_34",
793 "3": "pass_13834",
794 "4": "SeanGCN",
795 "5": "Fulton",
796 "8": "222 Street",
797 "10": "Norwalk",
798 "11": "CT",
799 "12": "11113",
800 "13": "United States"
801 }
802 },
803 {
804 "Id": 306,
805 "OCID_HASH": "67037db60fea235ebcb48fae4eeef08a4b33c2f8860944925b615e602ba7a6e1",
806 "Demo": {
807 "1": "joanne+11@gcnpublishing.com",
808 "2": "user_138_2",
809 "3": "pass_1382",
810 "4": "JoanneGCN",
811 "5": "Persico",
812 "8": "222 Street",
813 "10": "Norwalk",
814 "11": "CT",
815 "12": "11114",
816 "13": "United States"
817 }
818 },
819 {
820 "Id": 314,
821 "OCID_HASH": "6421cab33907111f038ead8fc0aeafed785642e9b92cda544b2048f90ada259f",
822 "Demo": {
823 "1": "melanie+11@gcnpublishing.com",
824 "2": "user_138_18",
825 "3": "pass_13818",
826 "4": "MelanieGCN",
827 "5": "Mason",
828 "8": "345 Street",
829 "10": "Norwalk",
830 "11": "CT",
831 "12": "11115",
832 "13": "United States"
833 }
834 },
835 {
836 "Id": 322,
837 "OCID_HASH": "334b6f64d387b9a45b8ac7e0901d438cace133899b608c03a0f8c1f706882958",
838 "Demo": {
839 "1": "doug+11@gcnpublishing.com",
840 "2": "user_138_58",
841 "3": "pass_13858",
842 "4": "DougGCN",
843 "5": "La Farge",
844 "8": "849 Street",
845 "10": "Tuson",
846 "11": "AZ",
847 "12": "11116",
848 "13": "United States"
849 }
850 }
851 ]
852 }
853 {{/code}}
854
855 \\
856
857 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
858 == (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)specific User(%%) ==
859
860 ----
861
862 {{column width="100%"}}
863 (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/(% style="color: rgb(33,33,33);" %)~{~{OCID}}
864 {{/column}}
865
866 (% style="" %)
867 ~{~{OCID}} is user id which is provided by ONEcount
868
869 (% style="" %)
870 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
871
872 ----
873
874 (% style="" %)
875 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
876
877 ==== Example ====
878
879 ----
880
881 (% style="color: rgb(107,107,107);" %)Request
882
883 {{code language="php" theme="RDark" title="Get specific User Request" collapse="true"}}
884 <?php
885
886 $curl = curl_init();
887
888 curl_setopt_array($curl, array(
889 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users/8418',
890 CURLOPT_RETURNTRANSFER => true,
891 CURLOPT_ENCODING => '',
892 CURLOPT_MAXREDIRS => 10,
893 CURLOPT_TIMEOUT => 0,
894 CURLOPT_FOLLOWLOCATION => true,
895 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
896 CURLOPT_CUSTOMREQUEST => 'GET',
897 CURLOPT_HTTPHEADER => array(
898 'Appkey: {{ONECOUNT API KEY}}'
899 ),
900 ));
901
902 $response = curl_exec($curl);
903
904 curl_close($curl);
905 echo $response;
906 {{/code}}
907
908 \\
909
910 (% style="color: rgb(107,107,107);" %)Response  200 OK
911
912 {{code language="yml" theme="RDark" title="Get specific user Response" collapse="true"}}
913 {
914 "result": {
915 "success": "1",
916 "error": {
917 "code": "",
918 "message": ""
919 }
920 },
921 "Users": [
922 {
923 "Id": 8418,
924 "PartnerId": null,
925 "OCID_HASH": "7eedae58c56e97e79a9d42e85e7ef6e252563e60e92bd6d9ac7b7be748ffa823",
926 "Demo": {
927 "1": "",
928 "2": "user_242_5634",
929 "3": "pass_2425634",
930 "4": "Stuart",
931 "5": "Allen",
932 "6": "Pub",
933 "7": "Latinfinance",
934 "9": "2121 Ponce de Leon Blvd",
935 "10": "Coral Gables",
936 "11": "Fl",
937 "12": "33134",
938 "13": "",
939 "15": "",
940 "106": "",
941 "114": "",
942 "122": "305-448-6593",
943 "130": "",
944 "138": "",
945 "146": "5434982f-a05b-5f1e-2176-4809012686bb"
946 },
947 "Products": [
948 34
949 ],
950 "Resources": [
951 114,
952 98
953 ],
954 "Segments": []
955 }
956 ]
957 }
958 {{/code}}
959
960 \\
961
962 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
963 == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) User Login(%%) ==
964
965 ----
966
967 {{column width="100%"}}
968 (% class="nolink" %)https:~/~/api.onecount.net/v2/users(% style="color: rgb(33,33,33);" %)/login
969 {{/column}}
970
971 (% style="" %)
972 \\
973
974 (% style="" %)
975 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
976
977 ----
978
979 (% style="" %)
980 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
981
982 === (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
983
984 ----
985
986 {{code language="yml" theme="RDark" title="Body" collapse="true"}}
987 {"e":"rayaan@one-count.com","p":"12345"}
988 {{/code}}
989
990 ==== Example ====
991
992 ----
993
994 (% style="color: rgb(107,107,107);" %)Request
995
996 {{code language="php" theme="RDark" title="User login Request" collapse="true"}}
997 <?php
998
999 $curl = curl_init();
1000
1001 curl_setopt_array($curl, array(
1002 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users/login',
1003 CURLOPT_RETURNTRANSFER => true,
1004 CURLOPT_ENCODING => '',
1005 CURLOPT_MAXREDIRS => 10,
1006 CURLOPT_TIMEOUT => 0,
1007 CURLOPT_FOLLOWLOCATION => true,
1008 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
1009 CURLOPT_CUSTOMREQUEST => 'POST',
1010 CURLOPT_POSTFIELDS =>'{"e":"rayaan@one-count.com","p":"12345"}',
1011 CURLOPT_HTTPHEADER => array(
1012 'Appkey: {{ONECOUNT API KEY}}'
1013 ),
1014 ));
1015
1016 $response = curl_exec($curl);
1017
1018 curl_close($curl);
1019 echo $response;
1020 {{/code}}
1021
1022 \\
1023
1024 (% style="color: rgb(107,107,107);" %)Response  200 OK
1025
1026 {{code language="yml" theme="RDark" title="Login user Response" collapse="true"}}
1027 {
1028 "result": {
1029 "success": "1",
1030 "error": {
1031 "code": "",
1032 "message": ""
1033 }
1034 },
1035 "Users": [
1036 "1845775"
1037 ]
1038 }
1039 {{/code}}
1040
1041 \\
1042
1043 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
1044 == (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)lookup User(%%) ==
1045
1046 ----
1047
1048 {{column width="100%"}}
1049 (% class="nolink" %)https:~/~/api.onecount.net/v2/users(% style="color: rgb(33,33,33);" %)/lookup?2=user_242_6298&return=1,2,3,4
1050 {{/column}}
1051
1052 (% style="" %)
1053 \\
1054
1055 (% style="" %)
1056 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
1057
1058 ----
1059
1060 (% style="" %)
1061 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
1062
1063 === (% style="color: rgb(33,33,33);" %)Query Params(%%) ===
1064
1065 ----
1066
1067 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)2  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)user_242_6298(%%)
1068 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)return  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)1,2,3,4
1069
1070 ==== Example ====
1071
1072 ----
1073
1074 (% style="color: rgb(107,107,107);" %)Request
1075
1076 {{code language="php" theme="RDark" title="Lookup user Request" collapse="true"}}
1077 <?php
1078
1079 $curl = curl_init();
1080
1081 curl_setopt_array($curl, array(
1082 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users/lookup?2=user_242_6298&return=1%2C2%2C3%2C4',
1083 CURLOPT_RETURNTRANSFER => true,
1084 CURLOPT_ENCODING => '',
1085 CURLOPT_MAXREDIRS => 10,
1086 CURLOPT_TIMEOUT => 0,
1087 CURLOPT_FOLLOWLOCATION => true,
1088 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
1089 CURLOPT_CUSTOMREQUEST => 'GET',
1090 CURLOPT_HTTPHEADER => array(
1091 'Appkey: {{ONECOUNT API KEY}}'
1092 ),
1093 ));
1094
1095 $response = curl_exec($curl);
1096
1097 curl_close($curl);
1098 echo $response;
1099 {{/code}}
1100
1101 \\
1102
1103 (% style="color: rgb(107,107,107);" %)Response  200 OK
1104
1105 {{code language="yml" theme="RDark" title="Lookup user Response" collapse="true"}}
1106 {
1107 "result": {
1108 "success": "1",
1109 "error": {
1110 "code": "",
1111 "message": ""
1112 }
1113 },
1114 "Users": [
1115 {
1116 "Id": 9082,
1117 "PartnerId": null,
1118 "OCID_HASH": "c91c697bc764c64a78bb0bbc9a848ace303169fb17da177a06264d4ede2ca659",
1119 "Demo": {
1120 "2": "user_242_6298",
1121 "3": "pass_2426298"
1122 }
1123 }
1124 ]
1125 }
1126 {{/code}}
1127
1128 \\
1129
1130 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
1131 == (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Partners(%%) ==
1132
1133 ----
1134
1135 {{column width="100%"}}
1136 (% class="nolink nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/users/~{~{OCID}}/partners/~{~{Partner id}}
1137 {{/column}}
1138
1139 (% style="" %)
1140 \\
1141
1142 (% style="" %)
1143 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
1144
1145 ----
1146
1147 (% style="" %)
1148 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
1149
1150 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
1151 == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Create user(%%) ==
1152
1153 ----
1154
1155 {{column width="100%"}}
1156 (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
1157 {{/column}}
1158
1159 (% style="" %)
1160 \\
1161
1162 (% style="" %)
1163 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
1164
1165 ----
1166
1167 (% style="" %)
1168 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
1169
1170 === (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
1171
1172 ----
1173
1174 {{code language="yml" theme="RDark" title="Body" collapse="true"}}
1175 {"Users":{"PartnerId":1,"Demo":{"1":"testApirayaan7@onecount.net","4":"Rayaan","5":"Ahmed"}},"DedupeColumns":"1","Transactions":[]}
1176 {{/code}}
1177
1178 ==== Example ====
1179
1180 ----
1181
1182 (% style="color: rgb(107,107,107);" %)Request
1183
1184 {{code language="php" theme="RDark" title="Create User Request" collapse="true"}}
1185 <?php
1186
1187 $curl = curl_init();
1188
1189 curl_setopt_array($curl, array(
1190 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users',
1191 CURLOPT_RETURNTRANSFER => true,
1192 CURLOPT_ENCODING => '',
1193 CURLOPT_MAXREDIRS => 10,
1194 CURLOPT_TIMEOUT => 0,
1195 CURLOPT_FOLLOWLOCATION => true,
1196 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
1197 CURLOPT_CUSTOMREQUEST => 'POST',
1198 CURLOPT_POSTFIELDS =>'{"Users":{"PartnerId":1,"Demo":{"1":"testApirayaan6@onecount.net","4":"Rayaan","5":"Ahmed"}},"DedupeColumns":"1","Transactions":[]}',
1199 CURLOPT_HTTPHEADER => array(
1200 'Appkey: {{ONECOUNT API KEY}}'
1201 ),
1202 ));
1203
1204 $response = curl_exec($curl);
1205
1206 curl_close($curl);
1207 echo $response;
1208 {{/code}}
1209
1210 \\
1211
1212 (% style="color: rgb(107,107,107);" %)Response  200 OK
1213
1214 {{code language="yml" theme="RDark" title="Create user Response" collapse="true"}}
1215 {
1216 "result": {
1217 "success": "1",
1218 "error": {
1219 "code": "",
1220 "message": ""
1221 }
1222 },
1223 "Users": {
1224 "Id": 1845831
1225 }
1226 }
1227 {{/code}}
1228
1229 \\
1230
1231 (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
1232 == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(0, 83, 184)" %)PUT (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Update user(%%) ==
1233
1234 ----
1235
1236 {{column width="100%"}}
1237 (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/~{~{OCID}}
1238 {{/column}}
1239
1240 (% style="" %)
1241 \\
1242
1243 (% style="" %)
1244 === (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
1245
1246 ----
1247
1248 (% style="" %)
1249 (% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
1250
1251 === (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
1252
1253 ----
1254
1255 {{code language="yml" theme="RDark" title="Body" collapse="true"}}
1256 {"Users":{"Demo":{"6":"title1"}}}
1257 {{/code}}
1258
1259 ==== Example ====
1260
1261 ----
1262
1263 (% style="color: rgb(107,107,107);" %)Request
1264
1265 {{code language="php" theme="RDark" title="Update User Request" collapse="true"}}
1266 <?php
1267
1268 $curl = curl_init();
1269
1270 curl_setopt_array($curl, array(
1271 CURLOPT_URL => 'rayaan.onecount.net/api/v2/users/{{OCID}}',
1272 CURLOPT_RETURNTRANSFER => true,
1273 CURLOPT_ENCODING => '',
1274 CURLOPT_MAXREDIRS => 10,
1275 CURLOPT_TIMEOUT => 0,
1276 CURLOPT_FOLLOWLOCATION => true,
1277 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
1278 CURLOPT_CUSTOMREQUEST => 'PUT',
1279 CURLOPT_POSTFIELDS =>'{"Users":{"Demo":{"6":"title"}}}',
1280 CURLOPT_HTTPHEADER => array(
1281 'Appkey: {{ONECOUNT API KEY}}'
1282 ),
1283 ));
1284
1285 $response = curl_exec($curl);
1286
1287 curl_close($curl);
1288 echo $response;
1289
1290
1291 {{/code}}
1292
1293 \\
1294
1295 (% style="color: rgb(107,107,107);" %)Response  200 OK
1296
1297 {{code language="yml" theme="RDark" title="Update user Response" collapse="true"}}
1298 {
1299 "result": {
1300 "success": "1",
1301 "error": {
1302 "code": "",
1303 "message": ""
1304 }
1305 },
1306 "Users": [
1307 {
1308 "Id": 1845823,
1309 "OCID_HASH": "fccaa8dc7afadccc5882528d47b27c2bb53e2788dd0ac1fe170abef77a9c4d5b"
1310 }
1311 ]
1312 }
1313 {{/code}}
1314
1315 \\
1316
1317 \\
1318
1319 \\
1320
1321 \\
1322
1323 \\
1324
1325 \\
1326
1327 \\
1328
1329 \\
1330
1331 \\
1332
1333 \\
1334
1335 \\
1336
1337 \\
1338
1339 \\
1340
1341 \\
1342
1343 \\
1344
1345 \\
1346
1347 \\
1348
1349 \\
1350
1351 \\
1352
1353 \\
1354
1355 \\
1356
1357 \\
1358
1359 \\
1360
1361 \\
1362
1363 \\
1364
1365 \\
1366
1367 \\
1368
1369 \\
1370
1371 \\
1372
1373 (% class="western" %)
1374 **GET method should be used to lookup users.**
1375
1376 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1377 (((
1378 (% class="western" %)
1379 **Request**
1380 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1381 (((
1382 (% class="western" %)
1383 **Type**
1384 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1385 (((
1386 (% class="western" %)
1387 **Description**
1388 )))
1389 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1390 (((
1391 (% class="western" %)
1392 Lookup params
1393 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1394 (((
1395 (% class="western" %)
1396 String
1397 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1398 (((
1399 (% class="western" %)
1400 URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
1401
1402 (% class="western" %)
1403 Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com/||style="" rel="nofollow" shape="rect" class="external-link"]]
1404
1405 (% class="western" %)
1406 return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
1407
1408 (% class="western" %)
1409 If return is not provided, all the demographics will be returned.
1410 )))
1411
1412 \\
1413
1414 \\
1415
1416 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1417 (((
1418 (% class="western" %)
1419 **Response**
1420 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1421 (((
1422 (% class="western" %)
1423 **Type**
1424 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1425 (((
1426 (% class="western" %)
1427 **Description**
1428 )))
1429 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1430 (((
1431 (% class="western" %)
1432 Users
1433 )))|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1434 (((
1435 (% class="western" align="left" %)
1436 Users
1437 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1438 (((
1439 (% class="western" %)
1440 Found users returned with the demo field requested in return parameter in json format
1441 )))
1442
1443 \\
1444
1445 **Sample response for /users/(% style="color: rgb(80,80,80);" %)<OCID or ocid_hash>(%%)**
1446
1447 Along with the demo in json format, the active packages and products of the user referred to as products and resources respectively are also returned.
1448
1449 (% class="relative-table" style="width: 1432.1px;" %)
1450 (% class="" %)|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1451 (((
1452 (% class="content-wrapper" %)
1453 (((
1454 (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:attach:Screen Shot 2020-02-26 at 11.15.52 AM.png||width="1407"]]
1455 )))
1456 )))
1457
1458 \\
1459
1460 **Sample response for /users/lookup?(% style="color: rgb(80,80,80);" %)11=santosh@[[one-count.com>>url:http://one-count.com/||style="" rel="nofollow" shape="rect" class="external-link"]]&return=2,3(%%)**
1461
1462 (% class="" %)|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1463 (((
1464 (% class="content-wrapper" %)
1465 (((
1466 (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:attach:Screen Shot 2020-02-26 at 11.22.13 AM.png||height="250"]]
1467 )))
1468 )))
1469
1470 \\
1471
1472 (% class="western" %)
1473 **POST method should be used to create users.**
1474
1475 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1476 (((
1477 (% class="western" %)
1478 **Request**
1479 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1480 (((
1481 (% class="western" %)
1482 **Type**
1483 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1484 (((
1485 (% class="western" %)
1486 **Description**
1487 )))
1488 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1489 (((
1490 (% class="western" %)
1491 Users
1492 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1493 (((
1494 (% class="western" %)
1495 Users
1496 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1497 (((
1498 (% class="western" %)
1499 Users object that contains information about user to create. PartnerId Needs to be specified.
1500 )))
1501 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1502 (((
1503 (% class="western" %)
1504 Transactions
1505 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1506 (((
1507 (% class="western" %)
1508 Transactions
1509 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1510 (((
1511 (% class="western" %)
1512 (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.
1513 )))
1514 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1515 (((
1516 (% class="western" %)
1517 DedupeColumns
1518 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1519 (((
1520 (% class="western" %)
1521 String
1522 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1523 (((
1524 (% class="western" %)
1525 CSV of question id's that should be considered to find duplicate.
1526 )))
1527 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1528 (((
1529 (% class="western" %)
1530 Return
1531 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1532 (((
1533 (% class="western" %)
1534 String
1535 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1536 (((
1537 (% class="western" %)
1538 CSV of ONEcount QuestionId's requested back in Users object in response.
1539 )))
1540
1541 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1542 (((
1543 (% class="western" %)
1544 **Response**
1545 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1546 (((
1547 (% class="western" %)
1548 **Type**
1549 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1550 (((
1551 (% class="western" %)
1552 **Description**
1553 )))
1554 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1555 (((
1556 (% class="western" %)
1557 Users
1558 )))|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1559 (((
1560 (% class="western" align="left" %)
1561 Users
1562 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1563 (((
1564 (% class="western" %)
1565 Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
1566 )))
1567
1568 \\
1569
1570 (% class="western" %)
1571 **PUT method should be used to update users.**
1572
1573 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1574 (((
1575 (% class="western" %)
1576 **Request**
1577 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1578 (((
1579 (% class="western" %)
1580 **Type**
1581 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1582 (((
1583 (% class="western" %)
1584 **Description**
1585 )))
1586 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1587 (((
1588 (% class="western" %)
1589 Users
1590 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1591 (((
1592 (% class="western" %)
1593 Users
1594 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1595 (((
1596 (% class="western" %)
1597 Users object with update fields. Return property has csv of questions id requested back in Users object.
1598 )))
1599 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1600 (((
1601 (% class="western" %)
1602 Return
1603 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1604 (((
1605 (% class="western" %)
1606 String
1607 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1608 (((
1609 (% class="western" %)
1610 CSV of ONEcount QuestionId's requested back in Users object in response
1611 )))
1612 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1613 (((
1614 (% class="western" %)
1615 RequestDate
1616 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1617 (((
1618 (% class="western" %)
1619 Date
1620 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1621 (((
1622 (% class="western" %)
1623 RequestDate to use for the demo update. If not provided current date will be used.
1624 )))
1625
1626 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1627 (((
1628 (% class="western" %)
1629 **Response**
1630 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1631 (((
1632 (% class="western" %)
1633 **Type**
1634 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1635 (((
1636 (% class="western" %)
1637 **Description**
1638 )))
1639 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1640 (((
1641 (% class="western" %)
1642 Users
1643 )))|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1644 (((
1645 (% class="western" align="left" %)
1646 Users
1647 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1648 (((
1649 (% class="western" %)
1650 Updated user returned with the demo field requested in return parameter in json format.
1651 )))
1652
1653 (% class="western" %)
1654 \\
1655
1656 (% class="western" %)
1657 \\
1658
1659 (% class="western" %)
1660 Create new users. Here in this example the JSON for request is passed in userFile.json file.
1661
1662 {{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
1663
1664 (% class="western" %)
1665 **~ **
1666
1667 (% class="western" %)
1668 **~ **
1669
1670 \\
1671
1672 (% class="western" %)
1673 **COMPONENT: Questions**
1674
1675 (% class="western" %)
1676 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).
1677
1678 (% class="western" %)
1679 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.
1680
1681 (% class="western" %)
1682 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)
1683
1684 (% class="western" %)
1685 There can be 6 types of questions:
1686
1687 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1688 (((
1689 (% class="western" align="center" %)
1690 **Type**
1691 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1692 (((
1693 (% class="western" %)
1694 **Description**
1695 )))
1696 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1697 (((
1698 (% class="western" align="center" %)
1699 1
1700 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1701 (((
1702 (% class="western" %)
1703 Textbox type questions or short response type question. The response length needs to be less than 255 characters.
1704 )))
1705 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1706 (((
1707 (% class="western" align="center" %)
1708 2
1709 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1710 (((
1711 (% class="western" %)
1712 Textarea type question or long response type question.
1713 )))
1714 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1715 (((
1716 (% class="western" align="center" %)
1717 3
1718 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1719 (((
1720 (% class="western" %)
1721 Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
1722 )))
1723 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1724 (((
1725 (% class="western" align="center" %)
1726 4
1727 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1728 (((
1729 (% class="western" %)
1730 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.
1731 )))
1732 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1733 (((
1734 (% class="western" align="center" %)
1735 5
1736 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1737 (((
1738 (% class="western" %)
1739 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.
1740 )))
1741 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1742 (((
1743 (% class="western" align="center" %)
1744 6
1745 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1746 (((
1747 (% class="western" %)
1748 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.
1749 )))
1750
1751 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1752 (((
1753 (% class="western" %)
1754 **Method**
1755 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1756 (((
1757 (% class="western" %)
1758 **Url**
1759 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1760 (((
1761 (% class="western" %)
1762 **Action**
1763 )))
1764 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1765 (((
1766 (% class="western" %)
1767 GET
1768 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1769 (((
1770 (% class="western" %)
1771 /questions
1772 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1773 (((
1774 (% class="western" %)
1775 List all questions
1776 )))
1777 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1778 (((
1779 (% class="western" %)
1780 GET
1781 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1782 (((
1783 (% class="western" %)
1784 /questions/1
1785 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1786 (((
1787 (% class="western" %)
1788 Returns question id 1
1789 )))
1790 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1791 (((
1792 (% class="western" %)
1793 GET
1794 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1795 (((
1796 (% class="western" %)
1797 /questions/lookup?Text=Email
1798 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1799 (((
1800 (% class="western" %)
1801 Returns all questions with “Email" in question text
1802 )))
1803 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1804 (((
1805 (% class="western" %)
1806 POST
1807 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1808 (((
1809 (% class="western" %)
1810 /questions
1811 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1812 (((
1813 (% class="western" %)
1814 Create a new question
1815
1816 (% class="western" %)
1817 JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
1818 )))
1819 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1820 (((
1821 (% class="western" %)
1822 PUT
1823 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1824 (((
1825 (% class="western" %)
1826 /questions
1827 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1828 (((
1829 (% class="western" %)
1830 Update a question
1831
1832 (% class="western" %)
1833 JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
1834 )))
1835
1836 \\
1837
1838 (% class="western" %)
1839 **GET method can be used to lookup questions.**
1840
1841 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1842 (((
1843 (% class="western" %)
1844 **Request**
1845 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1846 (((
1847 (% class="western" %)
1848 **Type**
1849 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1850 (((
1851 (% class="western" %)
1852 **Description**
1853 )))
1854 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1855 (((
1856 (% class="western" %)
1857 Lookup params
1858 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1859 (((
1860 (% class="western" %)
1861 String
1862 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1863 (((
1864 (% class="western" %)
1865 URL encoded key value string parameters for the question that a user is trying to search.
1866
1867 (% class="western" %)
1868 Params:
1869
1870 (% class="western" %)
1871 Text: Word or phrase that should be present in the question text (String)
1872
1873 (% class="western" %)
1874 Type: Look up the question type.
1875 )))
1876
1877 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1878 (((
1879 (% class="western" %)
1880 **Response**
1881 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1882 (((
1883 (% class="western" %)
1884 **Type**
1885 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1886 (((
1887 (% class="western" %)
1888 **Description**
1889 )))
1890 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1891 (((
1892 (% class="western" %)
1893 Questions
1894 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1895 (((
1896 (% class="western" %)
1897 Questions
1898 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1899 (((
1900 (% class="western" %)
1901 Returns found question details.
1902 )))
1903
1904 \\
1905
1906 (% class="western" %)
1907 **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).**
1908
1909 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1910 (((
1911 (% class="western" %)
1912 **Request**
1913 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1914 (((
1915 (% class="western" %)
1916 **Type**
1917 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1918 (((
1919 (% class="western" %)
1920 **Description**
1921 )))
1922 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1923 (((
1924 (% class="western" %)
1925 Questions
1926 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1927 (((
1928 (% class="western" %)
1929 Questions
1930 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1931 (((
1932 (% class="western" %)
1933 This defines the question contents and possible responses.
1934 )))
1935
1936 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1937 (((
1938 (% class="western" %)
1939 **Response**
1940 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1941 (((
1942 (% class="western" %)
1943 **Type**
1944 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1945 (((
1946 (% class="western" %)
1947 **Description**
1948 )))
1949 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1950 (((
1951 (% class="western" %)
1952 QuestionId
1953 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1954 (((
1955 (% class="western" %)
1956 Int
1957 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1958 (((
1959 (% class="western" %)
1960 Returns ONEcount question id on successful creation of the question.
1961 )))
1962
1963 \\
1964
1965 (% class="western" %)
1966 PUT method should be used to update question.
1967
1968 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1969 (((
1970 (% class="western" %)
1971 **Request**
1972 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1973 (((
1974 (% class="western" %)
1975 **Type**
1976 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1977 (((
1978 (% class="western" %)
1979 **Description**
1980 )))
1981 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1982 (((
1983 (% class="western" %)
1984 Questions
1985 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1986 (((
1987 (% class="western" %)
1988 Questions
1989 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1990 (((
1991 (% class="western" %)
1992 This defines the question contents and responses.
1993 )))
1994
1995 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
1996 (((
1997 (% class="western" %)
1998 **Response**
1999 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2000 (((
2001 (% class="western" %)
2002 **Type**
2003 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2004 (((
2005 (% class="western" %)
2006 **Description**
2007 )))
2008 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2009 (((
2010 (% class="western" %)
2011 QuestionId
2012 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2013 (((
2014 (% class="western" %)
2015 Int
2016 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2017 (((
2018 (% class="western" %)
2019 Returns ONEcount question id on successful update of the question.
2020 )))
2021
2022 (% class="western" %)
2023 \\
2024
2025 (% class="western" %)
2026 Example: Get list of questions from api which has FirstName in text
2027
2028 {{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
2029
2030 (% class="western" %)
2031 {
2032
2033 (% class="western" %)
2034 "result": {
2035
2036 (% class="western" %)
2037 "success": "1",
2038
2039 (% class="western" %)
2040 "error": {
2041
2042 (% class="western" %)
2043 "code": "0",
2044
2045 (% class="western" %)
2046 "message": ""
2047
2048 (% class="western" %)
2049 }
2050
2051 (% class="western" %)
2052 },
2053
2054 (% class="western" %)
2055 "Questions": [
2056
2057 (% class="western" %)
2058 {
2059
2060 (% class="western" %)
2061 "Id": "6",
2062
2063 (% class="western" %)
2064 "Text": "FirstName",
2065
2066 (% class="western" %)
2067 "Type": "1",
2068
2069 (% class="western" %)
2070 "Alias": "FName"
2071
2072 (% class="western" %)
2073 }
2074
2075 (% class="western" %)
2076 ]
2077
2078 (% class="western" %)
2079 }
2080
2081 (% class="western" %)
2082 \\
2083
2084 (% class="western" %)
2085 **COMPONENT: Products**
2086
2087 (% class="western" %)
2088 This resource is for manipulating products resource. A product can be created, updated or searched.
2089
2090 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2091 (((
2092 (% class="western" %)
2093 **Method**
2094 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2095 (((
2096 (% class="western" %)
2097 **Url**
2098 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2099 (((
2100 (% class="western" %)
2101 **Action**
2102 )))
2103 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2104 (((
2105 (% class="western" %)
2106 GET
2107 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2108 (((
2109 (% class="western" %)
2110 /products
2111 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2112 (((
2113 (% class="western" %)
2114 Get all product details
2115 )))
2116 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2117 (((
2118 (% class="western" %)
2119 GET
2120 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2121 (((
2122 (% class="western" %)
2123 /products/5
2124 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2125 (((
2126 (% class="western" %)
2127 Get product id 5
2128 )))
2129 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2130 (((
2131 (% class="western" %)
2132 GET
2133 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2134 (((
2135 (% class="western" %)
2136 /products/lookup?Title=productname
2137 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2138 (((
2139 (% class="western" %)
2140 Lookup products by Title
2141 )))
2142 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2143 (((
2144 (% class="western" %)
2145 POST
2146 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2147 (((
2148 (% class="western" %)
2149 /products
2150 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2151 (((
2152 (% class="western" %)
2153 JSON of the Products type object needs to be sent as post data. Id field should not be sent.
2154 )))
2155 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2156 (((
2157 (% class="western" %)
2158 PUT
2159 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2160 (((
2161 (% class="western" %)
2162 /products/5
2163 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2164 (((
2165 (% class="western" %)
2166 JSON of the Products type object needs to be sent as post data. Id field is mandatory for update.
2167 )))
2168 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2169 (((
2170 (% class="western" %)
2171 POST
2172 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2173 (((
2174 (% class="western" %)
2175 /products/attachResource
2176 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2177 (((
2178 (% class="western" %)
2179 JSON of the Product and Resource ids to be sent as post data.
2180
2181 (% class="western" %)
2182 Both fields are mandatory.
2183
2184 (% class="western" %)
2185 Example:
2186
2187 (% class="western" %)
2188 {"ProductID":"65","ResourceID":”121"}
2189 )))
2190
2191 \\
2192
2193 (% class="western" %)
2194 **GET method should be used to lookup products.**
2195
2196 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2197 (((
2198 (% class="western" %)
2199 **Request**
2200 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2201 (((
2202 (% class="western" %)
2203 **Type**
2204 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2205 (((
2206 (% class="western" %)
2207 **Description**
2208 )))
2209 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2210 (((
2211 (% class="western" %)
2212 Lookup params
2213 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2214 (((
2215 (% class="western" %)
2216 String
2217 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2218 (((
2219 (% class="western" %)
2220 URL encoded key value string parameter for the lookup.
2221
2222 (% class="western" %)
2223 Params:
2224
2225 (% class="western" %)
2226 Name: Name of the Product for lookup (String)
2227 )))
2228
2229 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2230 (((
2231 (% class="western" %)
2232 **Response**
2233 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2234 (((
2235 (% class="western" %)
2236 **Type**
2237 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2238 (((
2239 (% class="western" %)
2240 **Description**
2241 )))
2242 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2243 (((
2244 (% class="western" %)
2245 Products
2246 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2247 (((
2248 (% class="western" %)
2249 Products
2250 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2251 (((
2252 (% class="western" %)
2253 Returns found product details.
2254 )))
2255
2256 \\
2257
2258 (% class="western" %)
2259 **POST method should be used to create products.**
2260
2261 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2262 (((
2263 (% class="western" %)
2264 **Request**
2265 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2266 (((
2267 (% class="western" %)
2268 **Type**
2269 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2270 (((
2271 (% class="western" %)
2272 **Description**
2273 )))
2274 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2275 (((
2276 (% class="western" %)
2277 Products
2278 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2279 (((
2280 (% class="western" %)
2281 Products
2282 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2283 (((
2284 (% class="western" %)
2285 Product details in json to be sent as post data. Id should not be set.
2286
2287 (% class="western" %)
2288 Example:
2289
2290 (% class="western" %)
2291 {"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
2292 )))
2293
2294 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2295 (((
2296 (% class="western" %)
2297 **Response**
2298 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2299 (((
2300 (% class="western" %)
2301 **Type**
2302 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2303 (((
2304 (% class="western" %)
2305 **Description**
2306 )))
2307 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2308 (((
2309 (% class="western" %)
2310 ProductId
2311 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2312 (((
2313 (% class="western" %)
2314 int
2315 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2316 (((
2317 (% class="western" %)
2318 Product Id of the newly created product.
2319 )))
2320
2321 \\
2322
2323 (% class="western" %)
2324 PUT method should be used to update an individual product given the product info.
2325
2326 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2327 (((
2328 (% class="western" %)
2329 **Request**
2330 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2331 (((
2332 (% class="western" %)
2333 **Type**
2334 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2335 (((
2336 (% class="western" %)
2337 **Description**
2338 )))
2339 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2340 (((
2341 (% class="western" %)
2342 Products
2343 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2344 (((
2345 (% class="western" %)
2346 Product
2347 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2348 (((
2349 (% class="western" %)
2350 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.
2351
2352 (% class="western" %)
2353 **Possible Request Params**: Title, Description, PrimaryFormId, ResourceID
2354
2355 (% class="western" %)
2356 **Example**:
2357
2358 (% class="western" %)
2359 {"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
2360 )))
2361
2362 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2363 (((
2364 (% class="western" %)
2365 **Response**
2366 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2367 (((
2368 (% class="western" %)
2369 **Type**
2370 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2371 (((
2372 (% class="western" %)
2373 **Description**
2374 )))
2375 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2376 (((
2377 (% class="western" %)
2378 ProductId
2379 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2380 (((
2381 (% class="western" %)
2382 Int
2383 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2384 (((
2385 (% class="western" %)
2386 Product id of the updated product.
2387 )))
2388
2389 \\
2390
2391 (% class="western" %)
2392 **COMPONENT: Terms**
2393
2394 (% class="western" %)
2395 This resource is for manipulating terms resource. A term can be created, updated or searched.
2396
2397 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2398 (((
2399 (% class="western" %)
2400 **Method**
2401 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2402 (((
2403 (% class="western" %)
2404 **Url**
2405 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2406 (((
2407 (% class="western" %)
2408 **Action**
2409 )))
2410 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2411 (((
2412 (% class="western" %)
2413 GET
2414 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2415 (((
2416 (% class="western" %)
2417 /terms/5
2418 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2419 (((
2420 (% class="western" %)
2421 Get term id 5
2422 )))
2423 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2424 (((
2425 (% class="western" %)
2426 GET
2427 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2428 (((
2429 (% class="western" %)
2430 /terms/lookup?Name=termname
2431 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2432 (((
2433 (% class="western" %)
2434 Lookup terms by Name
2435 )))
2436 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2437 (((
2438 (% class="western" %)
2439 POST
2440 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2441 (((
2442 (% class="western" %)
2443 /terms
2444 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2445 (((
2446 (% class="western" %)
2447 JSON of the terms type object needs to be sent as post data. Id field should not be sent.
2448 )))
2449 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2450 (((
2451 (% class="western" %)
2452 PUT
2453 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2454 (((
2455 (% class="western" %)
2456 /terms/5
2457 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2458 (((
2459 (% class="western" %)
2460 JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
2461 )))
2462
2463 \\
2464
2465 (% class="western" %)
2466 **GET method should be used to lookup products.**
2467
2468 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2469 (((
2470 (% class="western" %)
2471 **Request**
2472 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2473 (((
2474 (% class="western" %)
2475 **Type**
2476 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2477 (((
2478 (% class="western" %)
2479 **Description**
2480 )))
2481 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2482 (((
2483 (% class="western" %)
2484 Lookup params
2485 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2486 (((
2487 (% class="western" %)
2488 String
2489 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2490 (((
2491 (% class="western" %)
2492 URL encoded key value string parameter for the lookup.
2493
2494 (% class="western" %)
2495 Params:
2496
2497 (% class="western" %)
2498 Name: Name of the term for lookup (String)
2499 )))
2500
2501 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2502 (((
2503 (% class="western" %)
2504 **Response**
2505 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2506 (((
2507 (% class="western" %)
2508 **Type**
2509 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2510 (((
2511 (% class="western" %)
2512 **Description**
2513 )))
2514 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2515 (((
2516 (% class="western" %)
2517 Terms
2518 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2519 (((
2520 (% class="western" %)
2521 Terms
2522 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2523 (((
2524 (% class="western" %)
2525 Returns found term details.
2526 )))
2527
2528 \\
2529
2530 (% class="western" %)
2531 **POST method should be used to create products.**
2532
2533 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2534 (((
2535 (% class="western" %)
2536 **Request**
2537 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2538 (((
2539 (% class="western" %)
2540 **Type**
2541 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2542 (((
2543 (% class="western" %)
2544 **Description**
2545 )))
2546 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2547 (((
2548 (% class="western" %)
2549 Terms
2550 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2551 (((
2552 (% class="western" %)
2553 Terms
2554 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2555 (((
2556 (% class="western" %)
2557 Term details in json to be sent as post data. Id should not be set.
2558
2559 (% class="western" %)
2560 **Possible Request Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt
2561
2562 (% class="western" %)
2563 **Example**:
2564
2565 (% class="western" %)
2566 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
2567 )))
2568
2569 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2570 (((
2571 (% class="western" %)
2572 **Response**
2573 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2574 (((
2575 (% class="western" %)
2576 **Type**
2577 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2578 (((
2579 (% class="western" %)
2580 **Description**
2581 )))
2582 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2583 (((
2584 (% class="western" %)
2585 TermId
2586 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2587 (((
2588 (% class="western" %)
2589 int
2590 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2591 (((
2592 (% class="western" %)
2593 Term Id of the newly created term.
2594 )))
2595
2596 \\
2597
2598 (% class="western" %)
2599 PUT method should be used to update an individual term given the term info.
2600
2601 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2602 (((
2603 (% class="western" %)
2604 **Request**
2605 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2606 (((
2607 (% class="western" %)
2608 **Type**
2609 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2610 (((
2611 (% class="western" %)
2612 **Description**
2613 )))
2614 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2615 (((
2616 (% class="western" %)
2617 Terms
2618 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2619 (((
2620 (% class="western" %)
2621 Term
2622 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2623 (((
2624 (% class="western" %)
2625 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.
2626
2627 (% class="western" %)
2628 \\
2629
2630 (% class="western" %)
2631 **Example**:
2632
2633 (% class="western" %)
2634 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
2635 )))
2636
2637 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2638 (((
2639 (% class="western" %)
2640 **Response**
2641 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2642 (((
2643 (% class="western" %)
2644 **Type**
2645 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2646 (((
2647 (% class="western" %)
2648 **Description**
2649 )))
2650 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2651 (((
2652 (% class="western" %)
2653 TermId
2654 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2655 (((
2656 (% class="western" %)
2657 Int
2658 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2659 (((
2660 (% class="western" %)
2661 term id of the updated term.
2662 )))
2663
2664 \\
2665
2666 (% class="western" %)
2667 **COMPONENT: Resources**
2668
2669 (% class="western" %)
2670 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.
2671
2672 * (((
2673 (% class="western" %)
2674 questions
2675 )))
2676 * (((
2677 (% class="western" %)
2678 users
2679 )))
2680 * (((
2681 (% class="western" %)
2682 products
2683 )))
2684 * (((
2685 (% class="western" %)
2686 terms
2687 )))
2688 * (((
2689 (% class="western" %)
2690 resources
2691 )))
2692 * (((
2693 (% class="western" %)
2694 sources
2695 )))
2696 * (((
2697 (% class="western" %)
2698 transactions
2699 )))
2700
2701 (% class="western" %)
2702 **~ **
2703
2704 (% class="western" %)
2705 This resource is for manipulating resources resource. A resource can be created, updated or searched.
2706
2707 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2708 (((
2709 (% class="western" %)
2710 **Method**
2711 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2712 (((
2713 (% class="western" %)
2714 **Url**
2715 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2716 (((
2717 (% class="western" %)
2718 **Action**
2719 )))
2720 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2721 (((
2722 (% class="western" %)
2723 GET
2724 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2725 (((
2726 (% class="western" %)
2727 /resources/5
2728 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2729 (((
2730 (% class="western" %)
2731 Get resource id 5
2732 )))
2733 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2734 (((
2735 (% class="western" %)
2736 GET
2737 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2738 (((
2739 (% class="western" %)
2740 /resources/lookup?Name=resourcename
2741 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2742 (((
2743 (% class="western" %)
2744 Lookup resources by Name
2745 )))
2746 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2747 (((
2748 (% class="western" %)
2749 POST
2750 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2751 (((
2752 (% class="western" %)
2753 /resources
2754 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2755 (((
2756 (% class="western" %)
2757 JSON of the resources type object needs to be sent as post data. Id field should not be sent.
2758 )))
2759 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2760 (((
2761 (% class="western" %)
2762 PUT
2763 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2764 (((
2765 (% class="western" %)
2766 /resources/5
2767 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2768 (((
2769 (% class="western" %)
2770 JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
2771 )))
2772
2773 \\
2774
2775 (% class="western" %)
2776 **GET method should be used to lookup resources.**
2777
2778 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2779 (((
2780 (% class="western" %)
2781 **Request**
2782 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2783 (((
2784 (% class="western" %)
2785 **Type**
2786 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2787 (((
2788 (% class="western" %)
2789 **Description**
2790 )))
2791 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2792 (((
2793 (% class="western" %)
2794 Lookup params
2795 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2796 (((
2797 (% class="western" %)
2798 String
2799 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2800 (((
2801 (% class="western" %)
2802 URL encoded key value string parameter for the lookup.
2803
2804 (% class="western" %)
2805 Params:
2806
2807 (% class="western" %)
2808 Name: Name of the resource for lookup (String)
2809 )))
2810
2811 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2812 (((
2813 (% class="western" %)
2814 **Response**
2815 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2816 (((
2817 (% class="western" %)
2818 **Type**
2819 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2820 (((
2821 (% class="western" %)
2822 **Description**
2823 )))
2824 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2825 (((
2826 (% class="western" %)
2827 Resources
2828 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2829 (((
2830 (% class="western" %)
2831 Resources
2832 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2833 (((
2834 (% class="western" %)
2835 Returns found resource details.
2836 )))
2837
2838 \\
2839
2840 (% class="western" %)
2841 **POST method should be used to create resources.**
2842
2843 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2844 (((
2845 (% class="western" %)
2846 **Request**
2847 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2848 (((
2849 (% class="western" %)
2850 **Type**
2851 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2852 (((
2853 (% class="western" %)
2854 **Description**
2855 )))
2856 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2857 (((
2858 (% class="western" %)
2859 Resources
2860 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2861 (((
2862 (% class="western" %)
2863 Resources
2864 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2865 (((
2866 (% class="western" %)
2867 resource details in json to be sent as post data. Id should not be set.
2868
2869 (% class="western" %)
2870 **Possible Request Params**: Name, Description, Type, Value, FreePass
2871
2872 (% class="western" %)
2873 **Example**:
2874
2875 (% class="western" %)
2876 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
2877
2878 (% class="western" %)
2879 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
2880
2881 (% class="western" %)
2882 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
2883
2884 (% class="western" %)
2885 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
2886 )))
2887
2888 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2889 (((
2890 (% class="western" %)
2891 **Response**
2892 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2893 (((
2894 (% class="western" %)
2895 **Type**
2896 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2897 (((
2898 (% class="western" %)
2899 **Description**
2900 )))
2901 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2902 (((
2903 (% class="western" %)
2904 ResourceId
2905 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2906 (((
2907 (% class="western" %)
2908 int
2909 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2910 (((
2911 (% class="western" %)
2912 Resource Id of the newly created resource.
2913 )))
2914
2915 \\
2916
2917 (% class="western" %)
2918 PUT method should be used to update an individual resource given the resource info.
2919
2920 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2921 (((
2922 (% class="western" %)
2923 **Request**
2924 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2925 (((
2926 (% class="western" %)
2927 **Type**
2928 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2929 (((
2930 (% class="western" %)
2931 **Description**
2932 )))
2933 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2934 (((
2935 (% class="western" %)
2936 Resources
2937 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2938 (((
2939 (% class="western" %)
2940 Resource
2941 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2942 (((
2943 (% class="western" %)
2944 Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
2945
2946 (% class="western" %)
2947 \\
2948
2949 (% class="western" %)
2950 Examples:
2951
2952 (% class="western" %)
2953 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
2954
2955 (% class="western" %)
2956 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
2957
2958 (% class="western" %)
2959 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
2960
2961 (% class="western" %)
2962 {"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
2963 )))
2964
2965 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2966 (((
2967 (% class="western" %)
2968 **Response**
2969 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2970 (((
2971 (% class="western" %)
2972 **Type**
2973 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2974 (((
2975 (% class="western" %)
2976 **Description**
2977 )))
2978 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2979 (((
2980 (% class="western" %)
2981 ResourceId
2982 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2983 (((
2984 (% class="western" %)
2985 Int
2986 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
2987 (((
2988 (% class="western" %)
2989 resource id of the updated resource.
2990 )))
2991
2992 \\
2993
2994 \\
2995
2996 (% class="western" %)
2997 \\
2998
2999 (% class="western" %)
3000 **COMPONENT: Source Codes
3001 **
3002
3003 (% class="western" %)
3004 This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
3005
3006 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3007 (((
3008 (% class="western" %)
3009 **Method**
3010 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3011 (((
3012 (% class="western" %)
3013 **Url**
3014 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3015 (((
3016 (% class="western" %)
3017 **Action**
3018 )))
3019 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3020 (((
3021 (% class="western" %)
3022 GET
3023 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3024 (((
3025 (% class="western" %)
3026 /sources/1
3027 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3028 (((
3029 (% class="western" %)
3030 Get source id 1.
3031 )))
3032 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3033 (((
3034 (% class="western" %)
3035 GET
3036 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3037 (((
3038 (% class="western" %)
3039 /sources/lookup?Source=sourcename
3040 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3041 (((
3042 (% class="western" %)
3043 Lookup sources by source.
3044 )))
3045 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3046 (((
3047 (% class="western" %)
3048 POST
3049 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3050 (((
3051 (% class="western" %)
3052 /sources
3053 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3054 (((
3055 (% class="western" %)
3056 JSON of the Sources type object needs to be sent as post data. Id field should not be sent.
3057 )))
3058 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3059 (((
3060 (% class="western" %)
3061 PUT
3062 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3063 (((
3064 (% class="western" %)
3065 /sources
3066 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3067 (((
3068 (% class="western" %)
3069 JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
3070 )))
3071
3072 \\
3073
3074 (% class="western" %)
3075 **Sources can be looked up given the code or Id. GET method should be used for lookup.**
3076
3077 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3078 (((
3079 (% class="western" %)
3080 **Request**
3081 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3082 (((
3083 (% class="western" %)
3084 **Type**
3085 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3086 (((
3087 (% class="western" %)
3088 **Description**
3089 )))
3090 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3091 (((
3092 (% class="western" %)
3093 Lookup params
3094 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3095 (((
3096 (% class="western" %)
3097 String
3098 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3099 (((
3100 (% class="western" %)
3101 URL encoded key value string parameter for the lookup.
3102
3103 (% class="western" %)
3104 Params:
3105
3106 (% class="western" %)
3107 Source: Source value (String)
3108 )))
3109
3110 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3111 (((
3112 (% class="western" %)
3113 **Response**
3114 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3115 (((
3116 (% class="western" %)
3117 **Type**
3118 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3119 (((
3120 (% class="western" %)
3121 **Description**
3122 )))
3123 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3124 (((
3125 (% class="western" %)
3126 Sources
3127 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3128 (((
3129 (% class="western" %)
3130 Sources
3131 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3132 (((
3133 (% class="western" %)
3134 Returns found source details.
3135 )))
3136
3137 \\
3138
3139 (% class="western" %)
3140 \\
3141
3142 (% class="western" %)
3143 POST method should be used to create an individual source given the source parameters.
3144
3145 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3146 (((
3147 (% class="western" %)
3148 **Request**
3149 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3150 (((
3151 (% class="western" %)
3152 **Type**
3153 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3154 (((
3155 (% class="western" %)
3156 **Description**
3157 )))
3158 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3159 (((
3160 (% class="western" %)
3161 Sources
3162 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3163 (((
3164 (% class="western" %)
3165 Sources
3166 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3167 (((
3168 (% class="western" %)
3169 Defines the contents that makes up the source. Id parameters should not be set.
3170 )))
3171
3172 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3173 (((
3174 (% class="western" %)
3175 **Response**
3176 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3177 (((
3178 (% class="western" %)
3179 **Type**
3180 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3181 (((
3182 (% class="western" %)
3183 **Description**
3184 )))
3185 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3186 (((
3187 (% class="western" %)
3188 SourceId
3189 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3190 (((
3191 (% class="western" %)
3192 int
3193 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3194 (((
3195 (% class="western" %)
3196 Returns created source code id.
3197 )))
3198
3199 \\
3200
3201 (% class="western" %)
3202 **PUT method can be used to update an individual source given the id.**
3203
3204 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3205 (((
3206 (% class="western" %)
3207 **Request**
3208 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3209 (((
3210 (% class="western" %)
3211 **Type**
3212 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3213 (((
3214 (% class="western" %)
3215 **Description**
3216 )))
3217 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3218 (((
3219 (% class="western" %)
3220 Sources
3221 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3222 (((
3223 (% class="western" %)
3224 Sources
3225 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3226 (((
3227 (% class="western" %)
3228 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.
3229 )))
3230
3231 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3232 (((
3233 (% class="western" %)
3234 **Response**
3235 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3236 (((
3237 (% class="western" %)
3238 **Type**
3239 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3240 (((
3241 (% class="western" %)
3242 **Description**
3243 )))
3244 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3245 (((
3246 (% class="western" %)
3247 SourceId
3248 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3249 (((
3250 (% class="western" %)
3251 int
3252 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3253 (((
3254 (% class="western" %)
3255 Returns updated source id.
3256 )))
3257
3258 \\
3259
3260 (% class="western" %)
3261 \\
3262
3263 (% class="western" %)
3264 **COMPONENT: Transactions**
3265
3266 (% class="western" %)
3267 This resource is for manipulating transactions resource. A transaction can be created or searched.
3268
3269 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3270 (((
3271 (% class="western" %)
3272 **Method**
3273 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3274 (((
3275 (% class="western" %)
3276 **Url**
3277 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3278 (((
3279 (% class="western" %)
3280 **Action**
3281 )))
3282 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3283 (((
3284 (% class="western" %)
3285 GET
3286 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3287 (((
3288 (% class="western" %)
3289 /transactions
3290 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3291 (((
3292 (% class="western" %)
3293 List all transactions
3294 )))
3295 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3296 (((
3297 (% class="western" %)
3298 GET
3299 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3300 (((
3301 (% class="western" %)
3302 /transactions/lookup?UserId=1
3303 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3304 (((
3305 (% class="western" %)
3306 Lookup all transaction of UserId = 1
3307 )))
3308 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3309 (((
3310 (% class="western" %)
3311 POST
3312 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3313 (((
3314 (% class="western" %)
3315 /transactions
3316 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3317 (((
3318 (% class="western" %)
3319 JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
3320 )))
3321
3322 \\
3323
3324 (% class="western" %)
3325 \\
3326
3327 (% class="western" %)
3328 Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
3329
3330 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3331 (((
3332 (% class="western" %)
3333 **Request**
3334 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3335 (((
3336 (% class="western" %)
3337 **Type**
3338 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3339 (((
3340 (% class="western" %)
3341 **Description**
3342 )))
3343 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3344 (((
3345 (% class="western" %)
3346 Lookup params
3347 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3348 (((
3349 (% class="western" %)
3350 String
3351 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3352 (((
3353 (% class="western" %)
3354 URL encoded key value string parameter for the lookup.
3355
3356 (% class="western" %)
3357 Params:
3358
3359 (% class="western" %)
3360 UserId: Id of the user whose transaction is to be looked up (Int)
3361
3362 (% class="western" %)
3363 StartDate: Date from which the start should happen. Only valid when UserId is set. (Date)
3364
3365 (% class="western" %)
3366 EndDate: When the search should end. Only valid when UserId is set. (Date)
3367 )))
3368
3369 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3370 (((
3371 (% class="western" %)
3372 **Response**
3373 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3374 (((
3375 (% class="western" %)
3376 **Type**
3377 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3378 (((
3379 (% class="western" %)
3380 **Description**
3381 )))
3382 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3383 (((
3384 (% class="western" %)
3385 Transactions
3386 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3387 (((
3388 (% class="western" %)
3389 Transactions
3390 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3391 (((
3392 (% class="western" %)
3393 Returns all transaction that satisfies the search criteria. Returns all the package and product transactions of the user. Package Transactions are the one with TermId and ProductId. Product Transactions are the one with ResourceId.
3394 )))
3395
3396 \\
3397
3398 **Sample response for /(% style="color: rgb(80,80,80);" %)transactions/lookup?UserId=25255105:(%%)**
3399
3400 (% class="" %)|=(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3401 (((
3402 (% class="content-wrapper" %)
3403 (((
3404 (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:attach:Screen Shot 2020-02-26 at 11.14.29 AM.png||width="1407"]]
3405 )))
3406 )))
3407
3408 \\
3409
3410 (% class="western" %)
3411 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.
3412
3413 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3414 (((
3415 (% class="western" %)
3416 **Request**
3417 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3418 (((
3419 (% class="western" %)
3420 **Type**
3421 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3422 (((
3423 (% class="western" %)
3424 **Description**
3425 )))
3426 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3427 (((
3428 (% class="western" %)
3429 Transactions
3430 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3431 (((
3432 (% class="western" %)
3433 Transactions
3434 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3435 (((
3436 (% class="western" %)
3437 Contains fields that define a transaction. Id field should not be set.
3438 )))
3439
3440 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3441 (((
3442 (% class="western" %)
3443 **Response**
3444 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3445 (((
3446 (% class="western" %)
3447 **Type**
3448 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3449 (((
3450 (% class="western" %)
3451 **Description**
3452 )))
3453 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3454 (((
3455 (% class="western" %)
3456 TransactionId
3457 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3458 (((
3459 (% class="western" %)
3460 int
3461 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3462 (((
3463 (% class="western" %)
3464 Returns transactionId of the newly created transaction.
3465 )))
3466
3467 \\
3468
3469 \\
3470
3471 (% class="western" %)
3472 **COMPONENT: Leads
3473 **
3474
3475 (% class="western" %)
3476 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.
3477
3478 (% class="western" %)
3479 \\
3480
3481 (% class="western" %)
3482 \\
3483
3484 (% class="western" %)
3485 \\
3486
3487 (% class="western" %)
3488 \\
3489
3490 (% class="western" %)
3491 \\
3492
3493 (% class="western" %)
3494 **Telemarketing Leads
3495 **
3496
3497 (% class="western" %)
3498
3499 This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
3500
3501 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3502 (((
3503 (% class="western" %)
3504 **Method**
3505 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3506 (((
3507 (% class="western" %)
3508 **Url**
3509 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3510 (((
3511 (% class="western" %)
3512 **Action**
3513 )))
3514 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3515 (((
3516 (% class="western" %)
3517 GET
3518 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3519 (((
3520 (% class="western" %)
3521 /stats/telemarketing
3522 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3523 (((
3524 (% class="western" %)
3525 List telemarketing stats
3526 )))
3527 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3528 (((
3529 (% class="western" %)
3530 GET
3531 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3532 (((
3533 (% class="western" %)
3534 /stats/telemarketing/1000
3535 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3536 (((
3537 (% class="western" %)
3538 Get telemarketing stat whose id is 1000 in the system.
3539 )))
3540 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3541 (((
3542 (% class="western" %)
3543 POST
3544 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3545 (((
3546 (% class="western" %)
3547 /stats/telemarketing
3548 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3549 (((
3550 (% class="western" %)
3551 JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
3552 )))
3553
3554 \\
3555
3556 (% class="western" %)
3557 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.
3558
3559 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3560 (((
3561 (% class="western" %)
3562 **Request**
3563 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3564 (((
3565 (% class="western" %)
3566 **Type**
3567 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3568 (((
3569 (% class="western" %)
3570 **Description**
3571 )))
3572 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3573 (((
3574 (% class="western" %)
3575 Telemarketing
3576 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3577 (((
3578 (% class="western" %)
3579 Telemarketing
3580 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3581 (((
3582 (% class="western" %)
3583 Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section.
3584
3585 (% class="western" %)
3586 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.
3587
3588 (% class="western" %)
3589 E.g
3590
3591 (% class="western" %)
3592 {
3593
3594 (% class="western" %)
3595 "Telemarketing":[
3596
3597 (% class="western" %)
3598 {
3599
3600 (% class="western" %)
3601 "OCID":"5000",
3602
3603 (% class="western" %)
3604 "Date": "2016-01-01",
3605
3606 (% class="western" %)
3607 "Time": "10:10:10",
3608
3609 (% class="western" %)
3610 "ResourceId":"250",
3611
3612 (% class="western" %)
3613 "PageUrl": "[[http:~~/~~/www.one-count.com/detail/a.php>>url:http://www.one-count.com/detail/a.php||style="" rel="nofollow" shape="rect" class="external-link"]]",
3614
3615 (% class="western" %)
3616 "PageTitle":"tests"
3617
3618 (% class="western" %)
3619 }
3620
3621 (% class="western" %)
3622 ]
3623
3624 (% class="western" %)
3625 }
3626 )))
3627 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3628 (((
3629 (% class="western" %)
3630 \\
3631 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3632 (((
3633 (% class="western" %)
3634 \\
3635 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3636 (((
3637 (% class="western" %)
3638 \\
3639 )))
3640
3641 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3642 (((
3643 (% class="western" %)
3644 **Response**
3645 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3646 (((
3647 (% class="western" %)
3648 **Type**
3649 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3650 (((
3651 (% class="western" %)
3652 **Description**
3653 )))
3654 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3655 (((
3656 (% class="western" %)
3657 Ids
3658 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3659 (((
3660 (% class="western" %)
3661 String
3662 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3663 (((
3664 (% class="western" %)
3665 Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
3666 )))
3667
3668 \\
3669
3670 \\
3671
3672 \\
3673
3674 \\
3675
3676 \\
3677
3678 (% class="western" %)
3679 **API REFERENCE**
3680
3681 (% class="western" %)
3682 **Type: Questions**
3683
3684 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3685 (((
3686 (% class="western" %)
3687 **Property Name**
3688 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3689 (((
3690 (% class="western" %)
3691 **Type**
3692 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3693 (((
3694 (% class="western" %)
3695 **Description**
3696 )))
3697 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3698 (((
3699 (% class="western" %)
3700 Id
3701 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3702 (((
3703 (% class="western" %)
3704 Int
3705 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3706 (((
3707 (% class="western" %)
3708 Id of the question.
3709 )))
3710 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3711 (((
3712 (% class="western" %)
3713 Text
3714 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3715 (((
3716 (% class="western" %)
3717 String
3718 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3719 (((
3720 (% class="western" %)
3721 Text of the question.
3722 )))
3723 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3724 (((
3725 (% class="western" %)
3726 Type
3727 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3728 (((
3729 (% class="western" %)
3730 Int
3731 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3732 (((
3733 (% class="western" %)
3734 Determines which type of question it is. Textbox, checkbox, select, radio.
3735 There can be 6 types of questions.
3736 type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
3737 type=2 means textarea type question or long response type question.
3738 type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
3739 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.
3740 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.
3741 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.
3742 )))
3743 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3744 (((
3745 (% class="western" %)
3746 Choices
3747 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3748 (((
3749 (% class="western" %)
3750 choices
3751 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3752 (((
3753 (% class="western" %)
3754 If multiple choice question this field will have the choices.
3755 )))
3756 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3757 (((
3758 (% class="western" %)
3759 Alias
3760 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3761 (((
3762 (% class="western" %)
3763 String
3764 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3765 (((
3766 (% class="western" %)
3767 Alias for admin purpose.
3768 )))
3769
3770 (% class="western" %)
3771 \\
3772
3773 (% class="western" %)
3774 \\
3775
3776 (% class="western" %)
3777 **Type: Choices**
3778
3779 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3780 (((
3781 (% class="western" %)
3782 **Property Name**
3783 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3784 (((
3785 (% class="western" %)
3786 **Type**
3787 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3788 (((
3789 (% class="western" %)
3790 **Description**
3791 )))
3792 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3793 (((
3794 (% class="western" %)
3795 Id
3796 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3797 (((
3798 (% class="western" %)
3799 int
3800 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3801 (((
3802 (% class="western" %)
3803 Id of the choice.
3804 )))
3805 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3806 (((
3807 (% class="western" %)
3808 Text
3809 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3810 (((
3811 (% class="western" %)
3812 string
3813 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3814 (((
3815 (% class="western" %)
3816 Display text of choice.
3817 )))
3818 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3819 (((
3820 (% class="western" %)
3821 Value
3822 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3823 (((
3824 (% class="western" %)
3825 String
3826 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3827 (((
3828 (% class="western" %)
3829 Value stored in db.
3830 )))
3831 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3832 (((
3833 (% class="western" %)
3834 Order
3835 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3836 (((
3837 (% class="western" %)
3838 Int
3839 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3840 (((
3841 (% class="western" %)
3842 Display order.
3843 )))
3844 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3845 (((
3846 (% class="western" %)
3847 QuestionId
3848 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3849 (((
3850 (% class="western" %)
3851 Int
3852 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3853 (((
3854 (% class="western" %)
3855 Tied to which question id.
3856 )))
3857
3858 \\
3859
3860 (% class="western" %)
3861 **Type: Users**
3862
3863 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3864 (((
3865 (% class="western" %)
3866 **Property Name**
3867 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3868 (((
3869 (% class="western" %)
3870 **Type**
3871 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3872 (((
3873 (% class="western" %)
3874 **Description**
3875 )))
3876 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3877 (((
3878 (% class="western" %)
3879 Id
3880 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3881 (((
3882 (% class="western" %)
3883 Int
3884 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3885 (((
3886 (% class="western" %)
3887 ID of the user in ONEcount.
3888 )))
3889 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3890 (((
3891 (% class="western" %)
3892 PartnerId
3893 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3894 (((
3895 (% class="western" %)
3896 Int
3897 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3898 (((
3899 (% class="western" %)
3900 ID of the user in partners system (e.g. id of your system).
3901 )))
3902 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3903 (((
3904 (% class="western" %)
3905 Demo
3906 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3907 (((
3908 (% class="western" %)
3909 Demo
3910 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3911 (((
3912 (% class="western" %)
3913 Object of user's demo question ids and respective response values.
3914 )))
3915 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3916 (((
3917 (% class="western" %)
3918 RequestDate
3919 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3920 (((
3921 (% class="western" %)
3922 Date
3923 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3924 (((
3925 (% class="western" %)
3926 Request date.
3927 )))
3928
3929 \\
3930
3931 (% class="western" %)
3932 **Type: Demo**
3933
3934 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3935 (((
3936 (% class="western" %)
3937 **Property Name**
3938 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3939 (((
3940 (% class="western" %)
3941 **Type**
3942 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3943 (((
3944 (% class="western" %)
3945 **Description**
3946 )))
3947 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3948 (((
3949 (% class="western" %)
3950 QuestionId (e.g 6)
3951 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3952 (((
3953 (% class="western" %)
3954 String
3955 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3956 (((
3957 (% class="western" %)
3958 6 is the value of “Id” property of question resource(Text = “First Name”)
3959 )))
3960 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3961 (((
3962 (% class="western" %)
3963 QuestionId (e.g 7)
3964 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3965 (((
3966 (% class="western" %)
3967 String
3968 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3969 (((
3970 (% class="western" %)
3971 7 is the value of “Id” property of question resource(Text = “Last Name”)
3972 )))
3973 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3974 (((
3975 (% class="western" %)
3976 ...
3977 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3978 (((
3979 (% class="western" %)
3980 ...
3981 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3982 (((
3983 (% class="western" %)
3984 ...
3985 )))
3986
3987 \\
3988
3989 (% class="western" %)
3990 **Type: Transactions**
3991
3992 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3993 (((
3994 (% class="western" %)
3995 **Property Name**
3996 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
3997 (((
3998 (% class="western" %)
3999 **Type**
4000 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4001 (((
4002 (% class="western" %)
4003 **Description**
4004 )))
4005 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4006 (((
4007 (% class="western" %)
4008 Id
4009 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4010 (((
4011 (% class="western" %)
4012 Int
4013 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4014 (((
4015 (% class="western" %)
4016 ID of the transaction.
4017 )))
4018 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4019 (((
4020 (% class="western" %)
4021 UserId
4022 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4023 (((
4024 (% class="western" %)
4025 Int
4026 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4027 (((
4028 (% class="western" %)
4029 Id of user in ONEcount.
4030 )))
4031 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4032 (((
4033 (% class="western" %)
4034 TermId
4035 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4036 (((
4037 (% class="western" %)
4038 Int
4039 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4040 (((
4041 (% class="western" %)
4042 TermId in ONEcount.
4043 )))
4044 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4045 (((
4046 (% class="western" %)
4047 ProductStatus
4048 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4049 (((
4050 (% class="western" %)
4051 Int
4052 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4053 (((
4054 (% class="western" %)
4055 Status ID.
4056 )))
4057 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4058 (((
4059 (% class="western" %)
4060 SubscriptionType
4061 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4062 (((
4063 (% class="western" %)
4064 Char
4065 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4066 (((
4067 (% class="western" %)
4068 Can be n,r or u for new, renew or unsubscribe.
4069 )))
4070 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4071 (((
4072 (% class="western" %)
4073 TransactionDate
4074 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4075 (((
4076 (% class="western" %)
4077 Date
4078 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4079 (((
4080 (% class="western" %)
4081 Date when the transaction occurred.
4082 )))
4083 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4084 (((
4085 (% class="western" %)
4086 TransactionTime
4087 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4088 (((
4089 (% class="western" %)
4090 Time
4091 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4092 (((
4093 (% class="western" %)
4094 Time of transaction.
4095 )))
4096 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4097 (((
4098 (% class="western" %)
4099 RequestDate
4100 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4101 (((
4102 (% class="western" %)
4103 Date
4104 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4105 (((
4106 (% class="western" %)
4107 The effective request date for the transaction.
4108 )))
4109 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4110 (((
4111 (% class="western" %)
4112 UserIP
4113 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4114 (((
4115 (% class="western" %)
4116 String
4117 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4118 (((
4119 (% class="western" %)
4120 IP of the user.
4121 )))
4122 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4123 (((
4124 (% class="western" %)
4125 Source
4126 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4127 (((
4128 (% class="western" %)
4129 String
4130 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4131 (((
4132 (% class="western" %)
4133 The transaction needs to be tied to a source code this will define it.
4134 )))
4135 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4136 (((
4137 (% class="western" %)
4138 MediaFilePath
4139 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4140 (((
4141 (% class="western" %)
4142 String
4143 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4144 (((
4145 (% class="western" %)
4146 The url of media associated with that transaction. Eg image, audio.
4147 )))
4148 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4149 (((
4150 (% class="western" %)
4151 ExpireDate
4152 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4153 (((
4154 (% class="western" %)
4155 Date
4156 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4157 (((
4158 (% class="western" %)
4159 Date when the subscription expires.
4160 )))
4161 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4162 (((
4163 (% class="western" %)
4164 Amount
4165 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4166 (((
4167 (% class="western" %)
4168 Float
4169 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4170 (((
4171 (% class="western" %)
4172 If there is amount (USD) included in transaction.
4173 )))
4174
4175 \\
4176
4177 (% class="western" %)
4178 **Type: Sources**
4179
4180 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4181 (((
4182 (% class="western" %)
4183 **Property Name**
4184 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4185 (((
4186 (% class="western" %)
4187 **Type**
4188 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4189 (((
4190 (% class="western" %)
4191 **Description**
4192 )))
4193 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4194 (((
4195 (% class="western" %)
4196 Id
4197 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4198 (((
4199 (% class="western" %)
4200 Int
4201 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4202 (((
4203 (% class="western" %)
4204 Id of the source.
4205 )))
4206 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4207 (((
4208 (% class="western" %)
4209 Source
4210 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4211 (((
4212 (% class="western" %)
4213 String
4214 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4215 (((
4216 (% class="western" %)
4217 Value of the source.
4218 )))
4219 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4220 (((
4221 (% class="western" %)
4222 Description
4223 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4224 (((
4225 (% class="western" %)
4226 Text
4227 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4228 (((
4229 (% class="western" %)
4230 Description of the source.
4231 )))
4232 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4233 (((
4234 (% class="western" %)
4235 ParentId
4236 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4237 (((
4238 (% class="western" %)
4239 int
4240 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4241 (((
4242 (% class="western" %)
4243 If this is a child source then list the parent source id.
4244 )))
4245
4246 (% class="western" %)
4247 \\
4248
4249 (% class="western" %)
4250 **Type: Products**
4251
4252 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4253 (((
4254 (% class="western" %)
4255 **Property Name**
4256 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4257 (((
4258 (% class="western" %)
4259 **Type**
4260 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4261 (((
4262 (% class="western" %)
4263 **Description**
4264 )))
4265 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4266 (((
4267 (% class="western" %)
4268 Id
4269 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4270 (((
4271 (% class="western" %)
4272 Int
4273 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4274 (((
4275 (% class="western" %)
4276 Specify only for update.
4277 )))
4278 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4279 (((
4280 (% class="western" %)
4281 Name
4282 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4283 (((
4284 (% class="western" %)
4285 String
4286 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4287 (((
4288 (% class="western" %)
4289 Name of the Product.
4290 )))
4291 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4292 (((
4293 (% class="western" %)
4294 Description
4295 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4296 (((
4297 (% class="western" %)
4298 Text
4299 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4300 (((
4301 (% class="western" %)
4302 Description of the product.
4303 )))
4304 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4305 (((
4306 (% class="western" %)
4307 Terms
4308 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4309 (((
4310 (% class="western" %)
4311 Terms
4312 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4313 (((
4314 (% class="western" %)
4315 (Array of) Terms associated with the product.
4316 )))
4317
4318 \\
4319
4320 (% class="western" %)
4321 **Type: Terms**
4322
4323 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4324 (((
4325 (% class="western" %)
4326 **Property Name**
4327 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4328 (((
4329 (% class="western" %)
4330 **Type**
4331 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4332 (((
4333 (% class="western" %)
4334 **Description**
4335 )))
4336 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4337 (((
4338 (% class="western" %)
4339 Id
4340 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4341 (((
4342 (% class="western" %)
4343 int
4344 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4345 (((
4346 (% class="western" %)
4347 Id of the term.
4348 )))
4349 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4350 (((
4351 (% class="western" %)
4352 Name
4353 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4354 (((
4355 (% class="western" %)
4356 string
4357 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4358 (((
4359 (% class="western" %)
4360 Name of the Term.
4361 )))
4362 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4363 (((
4364 (% class="western" %)
4365 Description
4366 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4367 (((
4368 (% class="western" %)
4369 text
4370 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4371 (((
4372 (% class="western" %)
4373 Description of the term.
4374 )))
4375 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4376 (((
4377 (% class="western" %)
4378 Duration
4379 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4380 (((
4381 (% class="western" %)
4382 int
4383 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4384 (((
4385 (% class="western" %)
4386 Duration of term validity.
4387 )))
4388 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4389 (((
4390 (% class="western" %)
4391 DurationUnit
4392 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4393 (((
4394 (% class="western" %)
4395 sting
4396 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4397 (((
4398 (% class="western" %)
4399 Y (year), M (Month), D (Days).
4400 )))
4401 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4402 (((
4403 (% class="western" %)
4404 ProductId
4405 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4406 (((
4407 (% class="western" %)
4408 int
4409 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4410 (((
4411 (% class="western" %)
4412 Id of the product the term is tied to.
4413 )))
4414 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4415 (((
4416 (% class="western" %)
4417 Price
4418 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4419 (((
4420 (% class="western" %)
4421 float
4422 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4423 (((
4424 (% class="western" %)
4425 If there is price (USD) for the term.
4426 )))
4427
4428 \\
4429
4430 (% class="western" %)
4431 **Type: Resources**
4432
4433 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4434 (((
4435 (% class="western" %)
4436 **Property Name**
4437 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4438 (((
4439 (% class="western" %)
4440 **Type**
4441 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4442 (((
4443 (% class="western" %)
4444 **Description**
4445 )))
4446 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4447 (((
4448 (% class="western" %)
4449 Id
4450 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4451 (((
4452 (% class="western" %)
4453 Int
4454 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4455 (((
4456 (% class="western" %)
4457 Specify only for update.
4458 )))
4459 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4460 (((
4461 (% class="western" %)
4462 Name
4463 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4464 (((
4465 (% class="western" %)
4466 String
4467 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4468 (((
4469 (% class="western" %)
4470 Name of the Resource.
4471 )))
4472 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4473 (((
4474 (% class="western" %)
4475 Description
4476 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4477 (((
4478 (% class="western" %)
4479 Text
4480 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4481 (((
4482 (% class="western" %)
4483 Description of the Resource.
4484 )))
4485 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4486 (((
4487 (% class="western" %)
4488 Type
4489 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4490 (((
4491 (% class="western" %)
4492 Int
4493 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4494 (((
4495 (% class="western" %)
4496 Type Options
4497
4498 (% class="western" %)
4499 **0** : File
4500
4501 (% class="western" %)
4502 **2 : **Newsletter
4503
4504 (% class="western" %)
4505 **3 : **Section
4506
4507 (% class="western" %)
4508 **4 : **Page
4509
4510 (% class="western" %)
4511 **5 : **Function
4512 )))
4513 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4514 (((
4515 (% class="western" %)
4516 Value
4517 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4518 (((
4519 (% class="western" %)
4520 String
4521
4522 (% class="western" %)
4523 or
4524
4525 (% class="western" %)
4526 Array
4527 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4528 (((
4529 (% class="western" %)
4530 Value of Resource Type:
4531
4532 (% class="western" %)
4533 When requesting a resource (GET), you should expect a string if there is only one value. If there are multiple values, you should expect an array.
4534
4535 (% class="western" %)
4536 For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
4537
4538 (% class="western" %)
4539 Example :
4540
4541 (% class="western" %)
4542 if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].
4543 **if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
4544
4545 (% class="western" %)
4546 For Function type resource leave it blank.
4547 )))
4548 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4549 (((
4550 (% class="western" %)
4551 limit
4552 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4553 (((
4554 (% class="western" %)
4555 Int
4556 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4557 (((
4558 (% class="western" %)
4559 Default limit is 25 but if all the data needs to be pulled then pass limit=0.
4560 )))
4561 (% class="" %)|(% colspan="1" style="text-align: left;vertical-align: top;" %)(% colspan="1" style="text-align: left;vertical-align: top;" %)
4562 (((
4563 FreePass
4564 )))|(% colspan="1" style="text-align: left;vertical-align: top;" %)(% colspan="1" style="text-align: left;vertical-align: top;" %)
4565 (((
4566 Int
4567 )))|(% colspan="1" style="text-align: left;vertical-align: top;" %)(% colspan="1" style="text-align: left;vertical-align: top;" %)
4568 (((
4569 Default value is 0. This parameter is used to provide access to protected content.
4570 )))
4571
4572 \\
4573
4574 (% class="western" %)
4575 **Type: Telemarketing**
4576
4577 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4578 (((
4579 (% class="western" %)
4580 **Property Name**
4581 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4582 (((
4583 (% class="western" %)
4584 **Type**
4585 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4586 (((
4587 (% class="western" %)
4588 **Description**
4589 )))
4590 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4591 (((
4592 (% class="western" %)
4593 Id
4594 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4595 (((
4596 (% class="western" %)
4597 int
4598 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4599 (((
4600 (% class="western" %)
4601 Id of the telemarketing stat. This is autogenerated from the system and can be used to lookup the stat.
4602 )))
4603 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4604 (((
4605 (% class="western" %)
4606 OCID
4607 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4608 (((
4609 (% class="western" %)
4610 int
4611 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4612 (((
4613 (% class="western" %)
4614 Onecount ID of the user.
4615 )))
4616 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4617 (((
4618 (% class="western" %)
4619 Date
4620 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4621 (((
4622 (% class="western" %)
4623 Date
4624 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4625 (((
4626 (% class="western" %)
4627 Date when the stat occurred. Format: yyyy-mm-dd
4628 )))
4629 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4630 (((
4631 (% class="western" %)
4632 Time
4633 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4634 (((
4635 (% class="western" %)
4636 Time
4637 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4638 (((
4639 (% class="western" %)
4640 Time of stat. Format: h:m:s (24 hour format)
4641 )))
4642 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4643 (((
4644 (% class="western" %)
4645 ResourceId
4646 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4647 (((
4648 (% class="western" %)
4649 int
4650 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4651 (((
4652 (% class="western" %)
4653 Id of resource currently being sent for the sat. If the resource type is page type resource then need to send
4654
4655 (% class="western" %)
4656 PageTitle otherwise it will follow the process described in PageTitle.
4657 )))
4658 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4659 (((
4660 (% class="western" %)
4661 PageUrl
4662 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4663 (((
4664 (% class="western" %)
4665 string
4666 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4667 (((
4668 (% class="western" %)
4669 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.
4670 )))
4671 (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4672 (((
4673 (% class="western" %)
4674 PageTitle
4675 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4676 (((
4677 (% class="western" %)
4678 string
4679 )))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
4680 (((
4681 (% class="western" %)
4682 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.
4683
4684 (% class="western" %)
4685 \\
4686
4687 (% class="western" %)
4688 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.
4689 )))
4690
4691 \\