Last modified by Admin on 2025/06/27 12:14

From version 2.1
edited by sonish
on 2017/04/03 16:25
Change comment: There is no comment for this version
To version 3.1
edited by sonish
on 2017/04/03 16:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,1972 +1,3154 @@
1 -(% style="color: rgb(51,51,51);" %)API(%%) (% style="color: rgb(51,51,51);" %)Document(%%)
2 -\\\\\\\\\\\\\\\\\\\\\\\\ONEcount REST API Developer's Guide
3 -Version 2.1
4 -\\\\\\\\\\\\\\\\\\\\\\\\\\**Introduction**
5 -ONEcount REST API provides different functionality to accomplish many integration related tasks. This API can be used to lookup, create and updated different ONEcount resources which are listed below.
6 -REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
7 -~1. **GET** - Used for lookup of resources
8 - ~1. **PUT** - Used to update a resource
9 - 2. **POST** - Used to create a new resource
1 +(% class="western" align="center" %)
2 +
3 +
4 +(% class="western" align="center" %)
5 +
6 +
7 +(% class="western" align="center" %)
8 +
9 +
10 +(% class="western" align="center" %)
11 +
12 +
13 +(% class="western" align="center" %)
14 +
15 +
16 +(% class="western" align="center" %)
17 +
18 +
19 +(% class="western" align="center" %)
20 +ONEcount REST API Developer's Guide
21 +
22 +(% class="western" align="center" %)
23 +Version 2.1
24 +
25 +(% class="western" align="center" %)
26 +
27 +
28 +(% class="western" align="center" %)
29 +
30 +
31 +(% class="western" align="center" %)
32 +
33 +
34 +(% class="western" align="center" %)
35 +
36 +
37 +(% class="western" align="center" %)
38 +
39 +
40 +(% class="western" align="center" %)
41 +
42 +
43 +(% class="western" align="center" %)
44 +
45 +
46 +(% class="western" align="center" %)
47 +
48 +
49 +(% class="western" %)
50 +**Introduction**
51 +
52 +(% class="western" %)
53 +ONEcount REST API provides different functionality to accomplish many integration related tasks. This API can be used to lookup, create and updated different ONEcount resources which are listed below.
54 +
55 +(% class="western" %)
56 +REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
57 +
58 +1. (((
59 +(% class="western" %)
60 +**GET** - Used for lookup of resources
61 +
62 +* (((
63 +1. (((
64 +(% class="western" %)
65 +**PUT** - Used to update a resource
66 +)))
67 +)))
68 +)))
69 +1. (((
70 +(% class="western" %)
71 +**POST** - Used to create a new resource
72 +)))
73 +
74 +(% class="western" %)
10 10  ONEcount API provides following functionalities:
11 - ~1. **Lookup**
12 -\\\\\\\\\\\\2. **Create**
13 -\\\\\\\\\\\\\\3. **Update**
14 -\\\\\\\\\\4. **List**
15 15  
77 +1. (((
78 +(% class="western" %)
79 +**Lookup**
16 16  
17 -User lookup Transaction lookup Question lookup Source code lookup Product lookup
18 - Term lookup
19 - Resource lookup
81 +*
82 +
83 +(% class="western" %)
84 +User lookup
85 +
86 +*
87 +
88 +(% class="western" %)
89 +Transaction lookup
90 +
91 +*
92 +
93 +(% class="western" %)
94 +Question lookup
95 +
96 +*
97 +
98 +(% class="western" %)
99 +Source code lookup
100 +
101 +*
102 +
103 +(% class="western" %)
104 +Product lookup
105 +
106 +*
107 +
108 +(% class="western" %)
109 +Term lookup
110 +
111 +*
112 +
113 +(% class="western" %)
114 +Resource lookup
115 +)))
116 +1. (((
117 +(% class="western" %)
118 +**Create**
119 +
120 +*
121 +
122 +(% class="western" %)
20 20  Add a user/demo
21 - Add a question
22 - Add user transaction
23 - Add source code
24 - Add Product
25 - Add Term
26 - Add Resource
27 - Stats – Telemarketing
28 -Update a user/demo Update a question Update source code Update product Update term
29 - Update resource
30 -ListQuestionsListSourceCodes
31 -\\1. **Attach**
32 -Attach resource to product
33 -\\\\\\**REST** **API** **URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||rel="nofollow" shape="rect" class="external-link"]]
34 -**Appkey**: THIS WILL BE PROVIDED
35 -\\\\**Function**
36 -The ONEcount REST API will be used to create, update & lookup users, transactions and questions e.t.c. in ONEcount hosted install of the client.
37 -**Accessing** **API**
38 - Your HTTP requests to a REST API resource should contain the following information: An HTTP method GET, POST, PUT.
39 - An Appkey sent as Appkey header in the http request to authenticate the request.
40 - Resource name in the url (/resourcename)
41 - Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
42 -**Request**
43 -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.
44 -For lookup, the parameter list will be part of the request url.
45 -\\\\**Response**
46 -API will output the response in a JSON format discussed below.
47 -{
48 -"result": { "success": "1", "error": { "code": "0", "message": ""
49 - }
50 -},
51 -"Users": {
52 -"Id": "12562", "PartnerId": "5467", "Demo": {
53 - "6": "Sundeep", "7": "Dangol"
54 - }
55 -}
56 -}
57 -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.
58 -\\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.
59 -If the value of success is 1 then the response parameters of the called method will also be output. Example: Get list of questions from api
60 - (% style="color: rgb(51,51,51);" %)curl(%%) (% style="color: rgb(51,51,51);" %)-X(%%) (% style="color: rgb(51,51,51);" %)GET(%%) (% style="color: rgb(51,51,51);" %)-H(%%) (% style="color: rgb(51,51,51);" %)"Appkey:(%%) (% style="color: rgb(51,51,51);" %)xxx"(%%) (% style="color: rgb(51,51,51);" %)[[https:~~/~~/api.onecount.net/v2/questions>>url:https://api.onecount.net/v2/questions||rel="nofollow" shape="rect" class="external-link"]](%%)
61 - (% style="color: rgb(51,51,51);" %){(%%)
62 - (% style="color: rgb(51,51,51);" %)"result":(%%) (% style="color: rgb(51,51,51);" %){(%%) (% style="color: rgb(51,51,51);" %)"success":(%%) (% style="color: rgb(51,51,51);" %)"1",(%%) (% style="color: rgb(51,51,51);" %)"error":(%%) (% style="color: rgb(51,51,51);" %){(%%)
63 - (% style="color: rgb(51,51,51);" %)"code":(%%) (% style="color: rgb(51,51,51);" %)"0",(%%)
64 - (% style="color: rgb(51,51,51);" %)"message":(%%) (% style="color: rgb(51,51,51);" %)""(%%)
65 - (% style="color: rgb(51,51,51);" %)}(%%)
66 - (% style="color: rgb(51,51,51);" %)},(%%)
67 - (% style="color: rgb(51,51,51);" %)"Questions":(%%) (% style="color: rgb(51,51,51);" %)[(%%)
68 - (% style="color: rgb(51,51,51);" %){(%%)
69 - (% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"6",(%%)
70 - (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"First(%%) (% style="color: rgb(51,51,51);" %)Name",(%%) (% style="color: rgb(51,51,51);" %)"Type":(%%) (% style="color: rgb(51,51,51);" %)"1",(%%)
71 - (% style="color: rgb(51,51,51);" %)"Alias":(%%) (% style="color: rgb(51,51,51);" %)"FName"(%%)
72 - (% style="color: rgb(51,51,51);" %)},(%%)
73 - (% style="color: rgb(51,51,51);" %){(%%)
74 - (% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"7",(%%)
75 - (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Last(%%) (% style="color: rgb(51,51,51);" %)Name",(%%) (% style="color: rgb(51,51,51);" %)"Type":(%%) (% style="color: rgb(51,51,51);" %)"1",(%%)
76 - (% style="color: rgb(51,51,51);" %)"Alias":(%%) (% style="color: rgb(51,51,51);" %)"LName"(%%)
77 - (% style="color: rgb(51,51,51);" %)},(%%)
78 - (% style="color: rgb(51,51,51);" %){(%%)
79 - (% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"5",(%%)
80 - (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Specialty",(%%) (% style="color: rgb(51,51,51);" %)"Type":(%%) (% style="color: rgb(51,51,51);" %)"5",(%%)
81 - (% style="color: rgb(51,51,51);" %)"Alias":(%%) (% style="color: rgb(51,51,51);" %)"specialty(%%) (% style="color: rgb(51,51,51);" %)all",(%%) (% style="color: rgb(51,51,51);" %)"Choices":(%%) (% style="color: rgb(51,51,51);" %)[(%%)
82 - (% style="color: rgb(51,51,51);" %){(%%)
124 +
125 +*
126 +
127 +(% class="western" %)
128 +Add a question
129 +
130 +*
131 +
132 +(% class="western" %)
133 +Add user transaction
134 +
135 +*
136 +
137 +(% class="western" %)
138 +Add source code
139 +
140 +*
141 +
142 +(% class="western" %)
143 +Add Product
144 +
145 +*
146 +
147 +(% class="western" %)
148 +Add Term
149 +
150 +*
151 +
152 +(% class="western" %)
153 +Add Resource
154 +
155 +*
156 +
157 +(% class="western" %)
158 +Stats – Telemarketing
159 +)))
160 +1. (((
161 +(% class="western" %)
162 +**Update**
163 +
164 +*
165 +
166 +(% class="western" %)
167 +Update a user/demo
168 +
169 +*
170 +
171 +(% class="western" %)
172 +Update a question
173 +
174 +*
175 +
176 +(% class="western" %)
177 +Update source code
178 +
179 +*
180 +
181 +(% class="western" %)
182 +Update product
183 +
184 +*
185 +
186 +(% class="western" %)
187 +Update term
188 +
189 +*
190 +
191 +(% class="western" %)
192 +Update resource
193 +)))
194 +1. (((
195 +(% class="western" %)
196 +**List**
197 +
198 +*
199 +
200 +(% class="western" %)
201 +ListQuestions
202 +
203 +*
204 +
205 +(% class="western" %)
206 +ListSourceCodes
207 +)))
208 +
209 +(% class="western" %)
83 83  
84 -\\\\\\(% style="color: rgb(51,51,51);" %)},(%%)
85 - (% style="color: rgb(51,51,51);" %){(%%)
86 -\\\\\\\\(% style="color: rgb(51,51,51);" %)}(%%)
87 - (% style="color: rgb(51,51,51);" %)]}]}(%%)
88 - (% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"123",(%%)
89 - (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Physician",(%%) (% style="color: rgb(51,51,51);" %)"Value":(%%) (% style="color: rgb(51,51,51);" %)"PH",(%%) (% style="color: rgb(51,51,51);" %)"Order":(%%) (% style="color: rgb(51,51,51);" %)"1",(%%) (% style="color: rgb(51,51,51);" %)"QuestionId":(%%) (% style="color: rgb(51,51,51);" %)"5"(%%)
90 -\\(% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"124",(%%)
91 - (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Nurse(%%) (% style="color: rgb(51,51,51);" %)Practioner",(%%) (% style="color: rgb(51,51,51);" %)"Value":(%%) (% style="color: rgb(51,51,51);" %)"NP",(%%)
92 - (% style="color: rgb(51,51,51);" %)"Order":(%%) (% style="color: rgb(51,51,51);" %)"2",(%%) (% style="color: rgb(51,51,51);" %)"QuestionId":(%%) (% style="color: rgb(51,51,51);" %)"5"(%%)
211 +
212 +1. (((
213 +(% class="western" %)
214 +**Attach**
215 +)))
216 +
217 +* (((
218 +(% class="western" %)
219 +Attach resource to product
220 +)))
221 +
222 +(% class="western" %)
93 93  
94 -**Resources**
95 -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.
96 -questions users products terms resources sources transactions
97 -**Questions**
98 -This resource is for manipulating questions resource. Questions in ONEcount means any question that is asked to the subscriber. It could be anyquestions 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.
99 -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)
100 -There can be 6 types of questions:\\
101 101  
225 +(% class="western" %)
226 +
227 +
228 +(% class="western" %)
229 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
230 +
231 +(% class="western" %)
232 +**Appkey**: THIS WILL BE PROVIDED
233 +
234 +(% class="western" %)
235 +
236 +
237 +(% class="western" %)
238 +**Function**
239 +
240 +(% class="western" %)
241 +The ONEcount REST API will be used to create, update & lookup users, transactions and questions e.t.c. in ONEcount hosted install of the client.
242 +
243 +(% class="western" %)
244 +**Accessing API**
245 +
246 +(% class="western" %)
247 +Your HTTP requests to a REST API resource should contain the following information:
248 +
249 +* (((
250 +(% class="western" %)
251 +An HTTP method GET, POST, PUT.
252 +)))
253 +* (((
254 +(% class="western" %)
255 +An Appkey sent as Appkey header in the http request to authenticate the request.
256 +)))
257 +* (((
258 +(% class="western" %)
259 +Resource name in the url (/resourcename)
260 +)))
261 +* (((
262 +(% class="western" %)
263 +Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
264 +)))
265 +
266 +(% class="western" %)
267 +**Request**
268 +
269 +(% class="western" %)
270 +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.
271 +
272 +(% class="western" %)
273 +For lookup, the parameter list will be part of the request url.
274 +
275 +(% class="western" %)
276 +
277 +
278 +(% class="western" %)
279 +**Response**
280 +
281 +(% class="western" %)
282 +API will output the response in a JSON format discussed below.
283 +
284 +(% class="western" %)
285 +{
286 +
287 +(% class="western" %)
288 +"result": {
289 +
290 +(% class="western" %)
291 +"success": "1",
292 +
293 +(% class="western" %)
294 +"error": {
295 +
296 +(% class="western" %)
297 +"code": "0",
298 +
299 +(% class="western" %)
300 +"message": ""
301 +
302 +(% class="western" %)
303 +}
304 +
305 +(% class="western" %)
306 +},
307 +
308 +(% class="western" %)
309 +"Users": {
310 +
311 +(% class="western" %)
312 +"Id": "12562",
313 +
314 +(% class="western" %)
315 +"PartnerId": "5467",
316 +
317 +(% class="western" %)
318 +"Demo": {
319 +
320 +(% class="western" %)
321 +"6": "Sundeep",
322 +
323 +(% class="western" %)
324 +"7": "Dangol"
325 +
326 +(% class="western" %)
327 +}
328 +
329 +(% class="western" %)
330 +}
331 +
332 +(% class="western" %)
333 +}
334 +
335 +(% class="western" %)
336 +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.
337 +
338 +(% class="western" %)
339 +
340 +
341 +(% class="western" %)
342 +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.
343 +
344 +(% class="western" %)
345 +If the value of success is 1 then the response parameters of the called method will also be output.
346 +
347 +(% class="western" %)
348 +Example: Get list of questions from api
349 +
350 +{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions
351 +{
352 + "result": {
353 + "success": "1",
354 + "error": {
355 + "code": "0",
356 + "message": ""
357 + }
358 + },
359 + "Questions": [
360 + {
361 + "Id": "6",
362 + "Text": "First Name",
363 + "Type": "1",
364 + "Alias": "FName"
365 + },
366 + {
367 + "Id": "7",
368 + "Text": "Last Name",
369 + "Type": "1",
370 + "Alias": "LName"
371 + },
372 + {
373 + "Id": "5",
374 + "Text": "Specialty",
375 + "Type": "5",
376 + "Alias": "specialty all",
377 + "Choices": [
378 + {
379 + "Id": "123",
380 + "Text": "Physician",
381 + "Value": "PH",
382 + "Order": "1",
383 + "QuestionId": "5"
384 + },
385 + {
386 + "Id": "124",
387 + "Text": "Nurse Practioner",
388 + "Value": "NP",
389 + "Order": "2",
390 + "QuestionId": "5"
391 + }
392 + ]}]}}}}
393 +
394 +(% class="western" %)
395 +
396 +
397 +(% class="western" %)
398 +**Resources**
399 +
400 +(% class="western" %)
401 +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.
402 +
403 +* (((
404 +(% class="western" %)
405 +questions
406 +)))
407 +* (((
408 +(% class="western" %)
409 +users
410 +)))
411 +* (((
412 +(% class="western" %)
413 +products
414 +)))
415 +* (((
416 +(% class="western" %)
417 +terms
418 +)))
419 +* (((
420 +(% class="western" %)
421 +resources
422 +)))
423 +* (((
424 +(% class="western" %)
425 +sources
426 +)))
427 +* (((
428 +(% class="western" %)
429 +transactions
430 +)))
431 +
432 +(% class="western" %)
433 +**Questions**
434 +
435 +(% class="western" %)
436 +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.
437 +
438 +(% class="western" %)
439 +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)
440 +
441 +(% class="western" %)
442 +There can be 6 types of questions:
443 +
102 102  |(((
445 +(% class="western" align="center" %)
103 103  **Type**
104 104  )))|(((
448 +(% class="western" %)
105 105  **Description**
106 106  )))
107 107  |(((
452 +(% class="western" align="center" %)
108 108  1
109 109  )))|(((
455 +(% class="western" %)
110 110  Textbox type questions or short response type question. The response length needs to be less than 255 characters.
111 111  )))
112 112  |(((
459 +(% class="western" align="center" %)
113 113  2
114 114  )))|(((
462 +(% class="western" %)
115 115  Textarea type question or long response type question.
116 116  )))
117 117  |(((
466 +(% class="western" align="center" %)
118 118  3
119 119  )))|(((
120 -Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as
121 -*.
469 +(% class="western" %)
470 +Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
122 122  )))
123 123  |(((
473 +(% class="western" align="center" %)
124 124  4
125 125  )))|(((
476 +(% class="western" %)
126 126  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.
127 127  )))
128 128  |(((
480 +(% class="western" align="center" %)
129 129  5
130 130  )))|(((
483 +(% class="western" %)
131 131  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.
132 132  )))
133 133  |(((
487 +(% class="western" align="center" %)
134 134  6
135 135  )))|(((
490 +(% class="western" %)
136 136  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.
137 137  )))
138 138  
139 -\\
140 -
141 141  |(((
495 +(% class="western" %)
142 142  **Method**
143 143  )))|(((
498 +(% class="western" %)
144 144  **Url**
145 145  )))|(((
501 +(% class="western" %)
146 146  **Action**
147 147  )))
148 148  |(((
505 +(% class="western" %)
149 149  GET
150 150  )))|(((
508 +(% class="western" %)
151 151  /questions
152 152  )))|(((
511 +(% class="western" %)
153 153  List all questions
154 154  )))
155 155  |(((
515 +(% class="western" %)
156 156  GET
157 157  )))|(((
518 +(% class="western" %)
158 158  /questions/1
159 159  )))|(((
521 +(% class="western" %)
160 160  Returns question id 1
161 161  )))
162 162  |(((
525 +(% class="western" %)
163 163  GET
164 164  )))|(((
528 +(% class="western" %)
165 165  /questions/lookup?Text=Email
166 166  )))|(((
167 -Returns all questions with "Email" in question text
531 +(% class="western" %)
532 +Returns all questions with “Email" in question text
168 168  )))
169 169  |(((
535 +(% class="western" %)
170 170  POST
171 171  )))|(((
538 +(% class="western" %)
172 172  /questions
173 173  )))|(((
174 -Create a new question
175 -\\JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
541 +(% class="western" %)
542 +Create a new question
543 +
544 +(% class="western" %)
545 +JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
176 176  )))
177 177  |(((
548 +(% class="western" %)
178 178  PUT
179 179  )))|(((
551 +(% class="western" %)
180 180  /questions
181 181  )))|(((
182 -Update a question
183 -\\JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
554 +(% class="western" %)
555 +Update a question
556 +
557 +(% class="western" %)
558 +JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
184 184  )))
185 185  
561 +
186 186  
187 -\\**GET** **method** **can** **be** **used** **to** **lookup** **questions.**\\
563 +(% class="western" %)
564 +**GET method can be used to lookup questions.**
188 188  
189 189  |(((
567 +(% class="western" %)
190 190  **Request**
191 191  )))|(((
570 +(% class="western" %)
192 192  **Type**
193 193  )))|(((
573 +(% class="western" %)
194 194  **Description**
195 195  )))
196 196  |(((
577 +(% class="western" %)
197 197  Lookup params
198 198  )))|(((
580 +(% class="western" %)
199 199  String
200 200  )))|(((
201 -URL encoded key value string parameters for the question that a user is trying to search. Params:
202 -Text: Word or phrase that should be present in the question text (String)
203 -\\Type: Look up the question type.
204 -)))
583 +(% class="western" %)
584 +URL encoded key value string parameters for the question that a user is trying to search.
205 205  
206 -\\
586 +(% class="western" %)
587 +Params:
207 207  
589 +(% class="western" %)
590 +Text: Word or phrase that should be present in the question text (String)
591 +
592 +(% class="western" %)
593 +Type: Look up the question type.
594 +)))
595 +
208 208  |(((
597 +(% class="western" %)
209 209  **Response**
210 210  )))|(((
600 +(% class="western" %)
211 211  **Type**
212 212  )))|(((
603 +(% class="western" %)
213 213  **Description**
214 214  )))
215 215  |(((
607 +(% class="western" %)
216 216  Questions
217 217  )))|(((
610 +(% class="western" %)
218 218  Questions
219 219  )))|(((
613 +(% class="western" %)
220 220  Returns found question details.
221 221  )))
222 222  
617 +
223 223  
224 -\\**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).**\\
619 +(% class="western" %)
620 +**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).**
225 225  
226 226  |(((
623 +(% class="western" %)
227 227  **Request**
228 228  )))|(((
626 +(% class="western" %)
229 229  **Type**
230 230  )))|(((
629 +(% class="western" %)
231 231  **Description**
232 232  )))
233 233  |(((
633 +(% class="western" %)
234 234  Questions
235 235  )))|(((
636 +(% class="western" %)
236 236  Questions
237 237  )))|(((
639 +(% class="western" %)
238 238  This defines the question contents and possible responses.
239 239  )))
240 240  
241 -\\
242 -
243 243  |(((
644 +(% class="western" %)
244 244  **Response**
245 245  )))|(((
647 +(% class="western" %)
246 246  **Type**
247 247  )))|(((
650 +(% class="western" %)
248 248  **Description**
249 249  )))
250 250  |(((
654 +(% class="western" %)
251 251  QuestionId
252 252  )))|(((
657 +(% class="western" %)
253 253  Int
254 254  )))|(((
660 +(% class="western" %)
255 255  Returns ONEcount question id on successful creation of the question.
256 256  )))
257 257  
258 -PUT method should be used to update question.\\
664 +
259 259  
666 +(% class="western" %)
667 +PUT method should be used to update question.
668 +
260 260  |(((
670 +(% class="western" %)
261 261  **Request**
262 262  )))|(((
673 +(% class="western" %)
263 263  **Type**
264 264  )))|(((
676 +(% class="western" %)
265 265  **Description**
266 266  )))
267 267  |(((
680 +(% class="western" %)
268 268  Questions
269 269  )))|(((
683 +(% class="western" %)
270 270  Questions
271 271  )))|(((
686 +(% class="western" %)
272 272  This defines the question contents and responses.
273 273  )))
274 274  
275 -\\
276 -
277 277  |(((
691 +(% class="western" %)
278 278  **Response**
279 279  )))|(((
694 +(% class="western" %)
280 280  **Type**
281 281  )))|(((
697 +(% class="western" %)
282 282  **Description**
283 283  )))
284 284  |(((
701 +(% class="western" %)
285 285  QuestionId
286 286  )))|(((
704 +(% class="western" %)
287 287  Int
288 288  )))|(((
707 +(% class="western" %)
289 289  Returns ONEcount question id on successful update of the question.
290 290  )))
291 291  
711 +(% class="western" %)
712 +
292 292  
293 -
294 -{{unmigrated-wiki-markup}}
295 -\\
296 -\\
714 +(% class="western" %)
297 297  Example: Get list of questions from api which has FirstName in text
298 -\\
299 -<span style="color: #333333">curl</span> <span style="color: #333333">-X</span> <span style="color: #333333">GET</span> <span style="color: #333333">-H</span> <span style="color: #333333">"Appkey:</span> <span style="color: #333333">xxx"</span> <span style="color: #333333"><a href="https://api.onecount.net/v2/questions/lookup?Text=FirstName" class="external-link" rel="nofollow">https://api.onecount.net/v2/questions/lookup?Text=FirstName</a></span>
300 -\\
301 -\{
302 -\\
303 -"result": \{ "success": "1", "error": \{ "code": "0", "message": ""
304 -\}
305 -\\
306 -\},
307 -\\
308 -"Questions": \[
309 -\\
310 -\{
311 -\\
716 +
717 +{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
718 +
719 +(% class="western" %)
720 +{
721 +
722 +(% class="western" %)
723 +"result": {
724 +
725 +(% class="western" %)
726 +"success": "1",
727 +
728 +(% class="western" %)
729 +"error": {
730 +
731 +(% class="western" %)
732 +"code": "0",
733 +
734 +(% class="western" %)
735 +"message": ""
736 +
737 +(% class="western" %)
738 +}
739 +
740 +(% class="western" %)
741 +},
742 +
743 +(% class="western" %)
744 +"Questions": [
745 +
746 +(% class="western" %)
747 +{
748 +
749 +(% class="western" %)
312 312  "Id": "6",
313 -\\
314 -"Text": "FirstName", "Type": "1",
751 +
752 +(% class="western" %)
753 +"Text": "FirstName",
754 +
755 +(% class="western" %)
756 +"Type": "1",
757 +
758 +(% class="western" %)
315 315  "Alias": "FName"
316 -\\
317 -\}
318 -\\
319 -\]
320 -\\
321 -\}
322 -\\
323 -\\
324 -*Users*
325 -\\
760 +
761 +(% class="western" %)
762 +}
763 +
764 +(% class="western" %)
765 +]
766 +
767 +(% class="western" %)
768 +}
769 +
770 +(% class="western" %)
771 +
772 +**Users**
773 +
774 +(% class="western" %)
326 326  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.
327 -\\
776 +
777 +(% class="western" %)
328 328  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.
329 -\\
779 +
780 +(% class="western" %)
330 330  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.
331 -\\
782 +
783 +(% class="western" %)
332 332  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.
333 -\\
785 +
786 +(% class="western" %)
334 334  Return parameter will have the comma separated list of question Ids that is requested back from the API.
335 -\\
336 -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
337 -Users object.
338 -\\
339 -\\
340 -\\
341 -*Method* *Url* *Action*\\
342 -{{/unmigrated-wiki-markup}}
343 343  
789 +(% class="western" %)
790 +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.
791 +
792 +(% class="western" %)
793 +
794 +
344 344  |(((
796 +(% class="western" %)
797 +**Method**
798 +)))|(((
799 +(% class="western" %)
800 +**Url**
801 +)))|(((
802 +(% class="western" %)
803 +**Action**
804 +)))
805 +|(((
806 +(% class="western" %)
345 345  GET
346 346  )))|(((
809 +(% class="western" %)
347 347  /users
348 348  )))|(((
812 +(% class="western" %)
349 349  Get users data limiting 25.
350 350  )))
351 351  |(((
816 +(% class="western" %)
352 352  GET
353 353  )))|(((
819 +(% class="western" %)
354 354  /users/1
355 355  )))|(((
822 +(% class="western" %)
356 356  Get data for user id 1. The user id can be a numeric value or a hash
357 357  )))
358 358  |(((
826 +(% class="western" %)
359 359  GET
360 360  )))|(((
361 -/users/lookup?1=user1@
362 -[[(% style="color: rgb(0,51,102);" %)email.com(%%)&return=1,2>>url:http://email.com||shape="rect"]]
829 +(% class="western" %)
830 +/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
363 363  )))|(((
364 -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.
365 -\\Return parameter defines a csv of question id that are requested back in response.
832 +(% class="western" %)
833 +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.
834 +
835 +(% class="western" %)
836 +Return parameter defines a csv of question id that are requested back in response.
366 366  )))
367 367  |(((
839 +(% class="western" %)
368 368  POST
369 369  )))|(((
842 +(% class="western" %)
370 370  /users
371 371  )))|(((
372 -Create a new users
373 -\\Parameters required to create the user needs to be sent as post data in JSON format.
845 +(% class="western" %)
846 +Create a new users
847 +
848 +(% class="western" %)
849 +Parameters required to create the user needs to be sent as post data in JSON format.
374 374  )))
375 375  |(((
852 +(% class="western" %)
376 376  PUT
377 377  )))|(((
855 +(% class="western" %)
378 378  /users/1
379 379  )))|(((
380 -Update user id 1. The user id can be a numeric value or a hash
381 -\\Parameters required to update the user needs to be sent as post data in JSON format.
858 +(% class="western" %)
859 +Update user id 1. The user id can be a numeric value or a hash
860 +
861 +(% class="western" %)
862 +Parameters required to update the user needs to be sent as post data in JSON format.
382 382  )))
383 383  |(((
865 +(% class="western" %)
384 384  GET
385 385  )))|(((
868 +(% class="western" %)
386 386  /users/1/partners/2
387 387  )))|(((
871 +(% class="western" %)
388 388  Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
389 389  )))
390 390  |(((
875 +(% class="western" %)
391 391  POST
392 392  )))|(((
878 +(% class="western" %)
393 393  /users/login
394 394  )))|(((
395 -Check to see user exist with username/email and password.
396 -\\Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
397 -\\Example:
398 -\\[[{"u":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","e":"abc@[[(% style="color: rgb(0,51,102);" %)one-count.com(%%)","p":"1234"}>>url:http://one-count.com||shape="rect"]] OR
399 -[[{"u":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","p":"1234"} OR
400 -[[{"e":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","p":"1234"}
401 -\\**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
881 +(% class="western" %)
882 +Check to see user exist with username/email and password.
883 +
884 +(% class="western" %)
885 +Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
886 +
887 +(% class="western" %)
888 +Example:
889 +
890 +(% class="western" %)
891 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","e":"abc@[[one-count.com>>url:http://one-count.com||shape="rect"]]","p":"1234"}
892 +
893 +(% class="western" %)
894 +OR
895 +
896 +(% class="western" %)
897 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
898 +
899 +(% class="western" %)
900 +OR
901 +
902 +(% class="western" %)
903 +{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
904 +
905 +(% class="western" %)
906 +**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
402 402  )))
403 403  
909 +
404 404  
405 -\\**GET** **method** **should** **be** **used** **to** **lookup** **users.**\\
911 +(% class="western" %)
912 +**GET method should be used to lookup users.**
406 406  
407 407  |(((
915 +(% class="western" %)
408 408  **Request**
409 409  )))|(((
918 +(% class="western" %)
410 410  **Type**
411 411  )))|(((
921 +(% class="western" %)
412 412  **Description**
413 413  )))
414 414  |(((
925 +(% class="western" %)
415 415  Lookup params
416 416  )))|(((
928 +(% class="western" %)
417 417  String
418 418  )))|(((
419 -URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in
420 -Users object.
421 -\\Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[(% style="color: rgb(0,51,102);" %)email.com>>url:http://email.com||shape="rect"]](%%)
422 -\\return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId
423 -(String)
931 +(% class="western" %)
932 +URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
933 +
934 +(% class="western" %)
935 +Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
936 +
937 +(% class="western" %)
938 +return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
424 424  )))
425 425  
941 +
426 426  
427 -\\\\\\
943 +
428 428  
429 429  |(((
946 +(% class="western" %)
430 430  **Response**
431 431  )))|(((
949 +(% class="western" %)
432 432  **Type**
433 433  )))|(((
952 +(% class="western" %)
434 434  **Description**
435 435  )))
436 436  |(((
956 +(% class="western" %)
437 437  Users
958 +)))|=(((
959 +(% class="western" align="left" %)
960 +Users
438 438  )))|(((
439 -(% style="color: rgb(51,51,51);" %)**Users**
440 -)))|(((
962 +(% class="western" %)
441 441  Found users returned with the demo field requested in return parameter in json format.
442 442  )))
443 443  
966 +
444 444  
445 -\\**POST** **method** **should** **be** **used** **to** **create** **users.**\\
968 +(% class="western" %)
969 +**POST method should be used to create users.**
446 446  
447 447  |(((
972 +(% class="western" %)
448 448  **Request**
449 449  )))|(((
975 +(% class="western" %)
450 450  **Type**
451 451  )))|(((
978 +(% class="western" %)
452 452  **Description**
453 453  )))
454 454  |(((
982 +(% class="western" %)
455 455  Users
456 456  )))|(((
985 +(% class="western" %)
457 457  Users
458 458  )))|(((
988 +(% class="western" %)
459 459  Users object that contains information about user to create. PartnerId Needs to be specified.
460 460  )))
461 461  |(((
992 +(% class="western" %)
462 462  Transactions
463 463  )))|(((
995 +(% class="western" %)
464 464  Transactions
465 465  )))|(((
998 +(% class="western" %)
466 466  (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.
467 467  )))
468 468  |(((
1002 +(% class="western" %)
469 469  DedupeColumns
470 470  )))|(((
1005 +(% class="western" %)
471 471  String
472 472  )))|(((
1008 +(% class="western" %)
473 473  CSV of question id's that should be considered to find duplicate.
474 474  )))
1011 +|(((
1012 +(% class="western" %)
1013 +Return
1014 +)))|(((
1015 +(% class="western" %)
1016 +String
1017 +)))|(((
1018 +(% class="western" %)
1019 +CSV of ONEcount QuestionId's requested back in Users object in response.
1020 +)))
475 475  
476 -\\
477 -
478 478  |(((
1023 +(% class="western" %)
479 479  **Response**
480 480  )))|(((
1026 +(% class="western" %)
481 481  **Type**
482 482  )))|(((
1029 +(% class="western" %)
483 483  **Description**
484 484  )))
485 485  |(((
1033 +(% class="western" %)
486 486  Users
1035 +)))|=(((
1036 +(% class="western" align="left" %)
1037 +Users
487 487  )))|(((
488 -(% style="color: rgb(51,51,51);" %)**Users**
489 -)))|(((
490 -Created users returned with the demo field requested in return parameter in json format. If return was not specified only
491 -UserId will be returned.
1039 +(% class="western" %)
1040 +Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
492 492  )))
493 493  
1043 +
494 494  
495 -\\**PUT** **method** **should** **be** **used** **to** **update** **users.**\\
1045 +(% class="western" %)
1046 +**PUT method should be used to update users.**
496 496  
497 497  |(((
1049 +(% class="western" %)
498 498  **Request**
499 499  )))|(((
1052 +(% class="western" %)
500 500  **Type**
501 501  )))|(((
1055 +(% class="western" %)
502 502  **Description**
503 503  )))
504 504  |(((
1059 +(% class="western" %)
505 505  Users
506 506  )))|(((
1062 +(% class="western" %)
507 507  Users
508 508  )))|(((
1065 +(% class="western" %)
509 509  Users object with update fields. Return property has csv of questions id requested back in Users object.
510 510  )))
511 511  |(((
1069 +(% class="western" %)
512 512  Return
513 513  )))|(((
1072 +(% class="western" %)
514 514  String
515 515  )))|(((
1075 +(% class="western" %)
516 516  CSV of ONEcount QuestionId's requested back in Users object in response
517 517  )))
518 518  |(((
1079 +(% class="western" %)
519 519  RequestDate
520 520  )))|(((
1082 +(% class="western" %)
521 521  Date
522 522  )))|(((
1085 +(% class="western" %)
523 523  RequestDate to use for the demo update. If not provided current date will be used.
524 524  )))
525 525  
526 -\\
527 -
528 528  |(((
1090 +(% class="western" %)
529 529  **Response**
530 530  )))|(((
1093 +(% class="western" %)
531 531  **Type**
532 532  )))|(((
1096 +(% class="western" %)
533 533  **Description**
534 534  )))
535 535  |(((
1100 +(% class="western" %)
536 536  Users
1102 +)))|=(((
1103 +(% class="western" align="left" %)
1104 +Users
537 537  )))|(((
538 -(% style="color: rgb(51,51,51);" %)**Users**
539 -)))|(((
1106 +(% class="western" %)
540 540  Updated user returned with the demo field requested in return parameter in json format.
541 541  )))
542 542  
1110 +(% class="western" %)
1111 +
543 543  
544 -\\\\\\Create new users. Here in this example the JSON for request is passed in userFile.json file.
545 -(% style="color: rgb(51,51,51);" %)curl(%%) (% style="color: rgb(51,51,51);" %)-X(%%) (% style="color: rgb(51,51,51);" %)POST(%%) (% style="color: rgb(51,51,51);" %)-H(%%) (% style="color: rgb(51,51,51);" %)"Appkey:(%%) (% style="color: rgb(51,51,51);" %)xxx"(%%) (% style="color: rgb(51,51,51);" %)-H(%%) (% style="color: rgb(51,51,51);" %)"Content-Type:(%%) (% style="color: rgb(51,51,51);" %)application/json"(%%) (% style="color: rgb(51,51,51);" %)–data-binary(%%) (% style="color: rgb(51,51,51);" %)-d(%%) (% style="color: rgb(51,51,51);" %)'@userFile.json'(%%) (% style="color: rgb(51,51,51);" %)[[https:~~/~~/api.onecount.net/v2/users>>url:https://api.onecount.net/v2/users||rel="nofollow" shape="rect" class="external-link"]](%%) (mailto~:@userFile.json)
546 -**Products**
547 -This resource is for manipulating products resource. A product can be created, updated or searched.\\
1113 +(% class="western" %)
1114 +
548 548  
1116 +(% class="western" %)
1117 +Create new users. Here in this example the JSON for request is passed in userFile.json file.
1118 +
1119 +{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
1120 +
1121 +(% class="western" %)
1122 +**Products**
1123 +
1124 +(% class="western" %)
1125 +This resource is for manipulating products resource. A product can be created, updated or searched.
1126 +
549 549  |(((
1128 +(% class="western" %)
550 550  **Method**
551 551  )))|(((
1131 +(% class="western" %)
552 552  **Url**
553 553  )))|(((
1134 +(% class="western" %)
554 554  **Action**
555 555  )))
556 556  |(((
1138 +(% class="western" %)
557 557  GET
558 558  )))|(((
1141 +(% class="western" %)
559 559  /products
560 560  )))|(((
1144 +(% class="western" %)
561 561  Get all product details
562 562  )))
563 563  |(((
1148 +(% class="western" %)
564 564  GET
565 565  )))|(((
1151 +(% class="western" %)
566 566  /products/5
567 567  )))|(((
1154 +(% class="western" %)
568 568  Get product id 5
569 569  )))
570 570  |(((
1158 +(% class="western" %)
571 571  GET
572 572  )))|(((
1161 +(% class="western" %)
573 573  /products/lookup?Title=productname
574 574  )))|(((
1164 +(% class="western" %)
575 575  Lookup products by Title
576 576  )))
577 577  |(((
1168 +(% class="western" %)
578 578  POST
579 579  )))|(((
1171 +(% class="western" %)
580 580  /products
581 581  )))|(((
1174 +(% class="western" %)
582 582  JSON of the Products type object needs to be sent as post data. Id field should not be sent.
583 583  )))
584 584  |(((
1178 +(% class="western" %)
585 585  PUT
586 586  )))|(((
1181 +(% class="western" %)
587 587  /products/5
588 588  )))|(((
1184 +(% class="western" %)
589 589  JSON of the Products type object needs to be sent as post data. Id field is mandatory for update.
590 590  )))
591 591  |(((
1188 +(% class="western" %)
592 592  POST
593 593  )))|(((
1191 +(% class="western" %)
594 594  /products/attachResource
595 595  )))|(((
596 -JSON of the Product and Resource ids to be sent as post data. Both fields are mandatory.
597 -Example:
598 -\\{"ProductID":"65","ResourceID":"121"}
1194 +(% class="western" %)
1195 +JSON of the Product and Resource ids to be sent as post data.
1196 +
1197 +(% class="western" %)
1198 +Both fields are mandatory.
1199 +
1200 +(% class="western" %)
1201 +Example:
1202 +
1203 +(% class="western" %)
1204 +{"ProductID":"65","ResourceID":”121"}
599 599  )))
600 600  
1207 +
601 601  
602 -\\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\
1209 +(% class="western" %)
1210 +**GET method should be used to lookup products.**
603 603  
604 604  |(((
1213 +(% class="western" %)
605 605  **Request**
606 606  )))|(((
1216 +(% class="western" %)
607 607  **Type**
608 608  )))|(((
1219 +(% class="western" %)
609 609  **Description**
610 610  )))
611 611  |(((
1223 +(% class="western" %)
612 612  Lookup params
613 613  )))|(((
1226 +(% class="western" %)
614 614  String
615 615  )))|(((
616 -URL encoded key value string parameter for the lookup. Params:
1229 +(% class="western" %)
1230 +URL encoded key value string parameter for the lookup.
1231 +
1232 +(% class="western" %)
1233 +Params:
1234 +
1235 +(% class="western" %)
617 617  Name: Name of the Product for lookup (String)
618 618  )))
619 619  
1239 +|(((
1240 +(% class="western" %)
1241 +**Response**
1242 +)))|(((
1243 +(% class="western" %)
1244 +**Type**
1245 +)))|(((
1246 +(% class="western" %)
1247 +**Description**
1248 +)))
1249 +|(((
1250 +(% class="western" %)
1251 +Products
1252 +)))|(((
1253 +(% class="western" %)
1254 +Products
1255 +)))|(((
1256 +(% class="western" %)
1257 +Returns found product details.
1258 +)))
620 620  
621 -**Response** **Type** **Description**
622 622  
623 -\\**POST** **method** **should** **be** **used** **to** **create** **products.**\\
624 624  
1262 +(% class="western" %)
1263 +**POST method should be used to create products.**
1264 +
625 625  |(((
1266 +(% class="western" %)
626 626  **Request**
627 627  )))|(((
1269 +(% class="western" %)
628 628  **Type**
629 629  )))|(((
1272 +(% class="western" %)
630 630  **Description**
631 631  )))
632 632  |(((
1276 +(% class="western" %)
633 633  Products
634 634  )))|(((
1279 +(% class="western" %)
635 635  Products
636 636  )))|(((
637 -Product details in json to be sent as post data. Id should not be set. Example:
1282 +(% class="western" %)
1283 +Product details in json to be sent as post data. Id should not be set.
1284 +
1285 +(% class="western" %)
1286 +Example:
1287 +
1288 +(% class="western" %)
638 638  {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
639 639  )))
640 640  
641 -\\
642 -
643 643  |(((
1293 +(% class="western" %)
644 644  **Response**
645 645  )))|(((
1296 +(% class="western" %)
646 646  **Type**
647 647  )))|(((
1299 +(% class="western" %)
648 648  **Description**
649 649  )))
650 650  |(((
1303 +(% class="western" %)
651 651  ProductId
652 652  )))|(((
1306 +(% class="western" %)
653 653  int
654 654  )))|(((
1309 +(% class="western" %)
655 655  Product Id of the newly created product.
656 656  )))
657 657  
1313 +
658 658  
659 -\\PUT method should be used to update an individual product given the product info.\\
1315 +(% class="western" %)
1316 +PUT method should be used to update an individual product given the product info.
660 660  
661 661  |(((
1319 +(% class="western" %)
662 662  **Request**
663 663  )))|(((
1322 +(% class="western" %)
664 664  **Type**
665 665  )))|(((
1325 +(% class="western" %)
666 666  **Description**
667 667  )))
668 668  |(((
1329 +(% class="western" %)
669 669  Products
670 670  )))|(((
1332 +(% class="western" %)
671 671  Product
672 672  )))|(((
673 -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.
674 -\\**Possible** **Request** **Params**: Title, Description, PrimaryFormId, ResourceID
675 -\\**Example**:
676 -\\{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
677 -)))
1335 +(% class="western" %)
1336 +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.
678 678  
679 -\\
1338 +(% class="western" %)
1339 +**Possible Request Params**: Title, Description, PrimaryFormId, ResourceID
680 680  
1341 +(% class="western" %)
1342 +**Example**:
1343 +
1344 +(% class="western" %)
1345 +{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1346 +)))
1347 +
681 681  |(((
1349 +(% class="western" %)
682 682  **Response**
683 683  )))|(((
1352 +(% class="western" %)
684 684  **Type**
685 685  )))|(((
1355 +(% class="western" %)
686 686  **Description**
687 687  )))
688 688  |(((
1359 +(% class="western" %)
689 689  ProductId
690 690  )))|(((
1362 +(% class="western" %)
691 691  Int
692 692  )))|(((
1365 +(% class="western" %)
693 693  Product id of the updated product.
694 694  )))
695 695  
1369 +
696 696  
697 -\\**Terms**
698 -This resource is for manipulating terms resource. A term can be created, updated or searched.\\
1371 +(% class="western" %)
1372 +**Terms**
699 699  
1374 +(% class="western" %)
1375 +This resource is for manipulating terms resource. A term can be created, updated or searched.
1376 +
700 700  |(((
1378 +(% class="western" %)
701 701  **Method**
702 702  )))|(((
1381 +(% class="western" %)
703 703  **Url**
704 704  )))|(((
1384 +(% class="western" %)
705 705  **Action**
706 706  )))
707 707  |(((
1388 +(% class="western" %)
708 708  GET
709 709  )))|(((
1391 +(% class="western" %)
710 710  /terms/5
711 711  )))|(((
1394 +(% class="western" %)
712 712  Get term id 5
713 713  )))
714 714  |(((
1398 +(% class="western" %)
715 715  GET
716 716  )))|(((
1401 +(% class="western" %)
717 717  /terms/lookup?Name=termname
718 718  )))|(((
1404 +(% class="western" %)
719 719  Lookup terms by Name
720 720  )))
721 721  |(((
1408 +(% class="western" %)
722 722  POST
723 723  )))|(((
1411 +(% class="western" %)
724 724  /terms
725 725  )))|(((
1414 +(% class="western" %)
726 726  JSON of the terms type object needs to be sent as post data. Id field should not be sent.
727 727  )))
728 728  |(((
1418 +(% class="western" %)
729 729  PUT
730 730  )))|(((
1421 +(% class="western" %)
731 731  /terms/5
732 732  )))|(((
1424 +(% class="western" %)
733 733  JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
734 734  )))
735 735  
1428 +
736 736  
737 -\\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\
1430 +(% class="western" %)
1431 +**GET method should be used to lookup products.**
738 738  
739 739  |(((
1434 +(% class="western" %)
740 740  **Request**
741 741  )))|(((
1437 +(% class="western" %)
742 742  **Type**
743 743  )))|(((
1440 +(% class="western" %)
744 744  **Description**
745 745  )))
746 746  |(((
1444 +(% class="western" %)
747 747  Lookup params
748 748  )))|(((
1447 +(% class="western" %)
749 749  String
750 750  )))|(((
751 -URL encoded key value string parameter for the lookup. Params:
1450 +(% class="western" %)
1451 +URL encoded key value string parameter for the lookup.
1452 +
1453 +(% class="western" %)
1454 +Params:
1455 +
1456 +(% class="western" %)
752 752  Name: Name of the term for lookup (String)
753 753  )))
754 754  
755 -\\
756 -
757 757  |(((
1461 +(% class="western" %)
758 758  **Response**
759 759  )))|(((
1464 +(% class="western" %)
760 760  **Type**
761 761  )))|(((
1467 +(% class="western" %)
762 762  **Description**
763 763  )))
764 764  |(((
1471 +(% class="western" %)
765 765  Terms
766 766  )))|(((
1474 +(% class="western" %)
767 767  Terms
768 768  )))|(((
1477 +(% class="western" %)
769 769  Returns found term details.
770 770  )))
771 771  
772 -\\
1481 +
773 773  
1483 +(% class="western" %)
1484 +**POST method should be used to create products.**
1485 +
774 774  |(((
1487 +(% class="western" %)
775 775  **Request**
776 776  )))|(((
1490 +(% class="western" %)
777 777  **Type**
778 778  )))|(((
1493 +(% class="western" %)
779 779  **Description**
780 780  )))
781 781  |(((
1497 +(% class="western" %)
782 782  Terms
783 783  )))|(((
1500 +(% class="western" %)
784 784  Terms
785 785  )))|(((
786 -Term details in json to be sent as post data. Id should not be set.
787 -\\**Possible** **Request** **Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt
788 -\\**Example**:
789 -\\{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
790 -)))
1503 +(% class="western" %)
1504 +Term details in json to be sent as post data. Id should not be set.
791 791  
792 -\\
1506 +(% class="western" %)
1507 +**Possible Request Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt
793 793  
1509 +(% class="western" %)
1510 +**Example**:
1511 +
1512 +(% class="western" %)
1513 +{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1514 +)))
1515 +
794 794  |(((
1517 +(% class="western" %)
795 795  **Response**
796 796  )))|(((
1520 +(% class="western" %)
797 797  **Type**
798 798  )))|(((
1523 +(% class="western" %)
799 799  **Description**
800 800  )))
801 801  |(((
1527 +(% class="western" %)
802 802  TermId
803 803  )))|(((
1530 +(% class="western" %)
804 804  int
805 805  )))|(((
1533 +(% class="western" %)
806 806  Term Id of the newly created term.
807 807  )))
808 808  
1537 +
809 809  
810 -\\PUT method should be used to update an individual term given the term info.\\
1539 +(% class="western" %)
1540 +PUT method should be used to update an individual term given the term info.
811 811  
812 812  |(((
1543 +(% class="western" %)
813 813  **Request**
814 814  )))|(((
1546 +(% class="western" %)
815 815  **Type**
816 816  )))|(((
1549 +(% class="western" %)
817 817  **Description**
818 818  )))
819 819  |(((
1553 +(% class="western" %)
820 820  Terms
821 821  )))|(((
1556 +(% class="western" %)
822 822  Term
823 823  )))|(((
824 -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.
825 -\\\\**Example**:
826 -\\{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
827 -)))
1559 +(% class="western" %)
1560 +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.
828 828  
829 -\\
1562 +(% class="western" %)
1563 +
830 830  
1565 +(% class="western" %)
1566 +**Example**:
1567 +
1568 +(% class="western" %)
1569 +{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1570 +)))
1571 +
831 831  |(((
1573 +(% class="western" %)
832 832  **Response**
833 833  )))|(((
1576 +(% class="western" %)
834 834  **Type**
835 835  )))|(((
1579 +(% class="western" %)
836 836  **Description**
837 837  )))
838 838  |(((
1583 +(% class="western" %)
839 839  TermId
840 840  )))|(((
1586 +(% class="western" %)
841 841  Int
842 842  )))|(((
1589 +(% class="western" %)
843 843  term id of the updated term.
844 844  )))
845 845  
1593 +
846 846  
847 -\\**Resources**
848 -This resource is for manipulating resources resource. A resource can be created, updated or searched.\\
1595 +(% class="western" %)
1596 +**Resources**
849 849  
1598 +(% class="western" %)
1599 +This resource is for manipulating resources resource. A resource can be created, updated or searched.
1600 +
850 850  |(((
1602 +(% class="western" %)
851 851  **Method**
852 852  )))|(((
1605 +(% class="western" %)
853 853  **Url**
854 854  )))|(((
1608 +(% class="western" %)
855 855  **Action**
856 856  )))
857 857  |(((
1612 +(% class="western" %)
858 858  GET
859 859  )))|(((
1615 +(% class="western" %)
860 860  /resources/5
861 861  )))|(((
1618 +(% class="western" %)
862 862  Get resource id 5
863 863  )))
864 864  |(((
1622 +(% class="western" %)
865 865  GET
866 866  )))|(((
1625 +(% class="western" %)
867 867  /resources/lookup?Name=resourcename
868 868  )))|(((
1628 +(% class="western" %)
869 869  Lookup resources by Name
870 870  )))
871 871  |(((
1632 +(% class="western" %)
872 872  POST
873 873  )))|(((
1635 +(% class="western" %)
874 874  /resources
875 875  )))|(((
1638 +(% class="western" %)
876 876  JSON of the resources type object needs to be sent as post data. Id field should not be sent.
877 877  )))
878 878  |(((
1642 +(% class="western" %)
879 879  PUT
880 880  )))|(((
1645 +(% class="western" %)
881 881  /resources/5
882 882  )))|(((
1648 +(% class="western" %)
883 883  JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
884 884  )))
885 885  
1652 +
886 886  
887 -\\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\
1654 +(% class="western" %)
1655 +**GET method should be used to lookup products.**
888 888  
889 889  |(((
1658 +(% class="western" %)
890 890  **Request**
891 891  )))|(((
1661 +(% class="western" %)
892 892  **Type**
893 893  )))|(((
1664 +(% class="western" %)
894 894  **Description**
895 895  )))
896 896  |(((
1668 +(% class="western" %)
897 897  Lookup params
898 898  )))|(((
1671 +(% class="western" %)
899 899  String
900 900  )))|(((
901 -URL encoded key value string parameter for the lookup. Params:
1674 +(% class="western" %)
1675 +URL encoded key value string parameter for the lookup.
1676 +
1677 +(% class="western" %)
1678 +Params:
1679 +
1680 +(% class="western" %)
902 902  Name: Name of the resource for lookup (String)
903 903  )))
904 904  
905 -\\
906 -
907 907  |(((
1685 +(% class="western" %)
908 908  **Response**
909 909  )))|(((
1688 +(% class="western" %)
910 910  **Type**
911 911  )))|(((
1691 +(% class="western" %)
912 912  **Description**
913 913  )))
914 914  |(((
1695 +(% class="western" %)
915 915  Resources
916 916  )))|(((
1698 +(% class="western" %)
917 917  Resources
918 918  )))|(((
1701 +(% class="western" %)
919 919  Returns found resource details.
920 920  )))
921 921  
922 -\\
1705 +
923 923  
1707 +(% class="western" %)
1708 +**POST method should be used to create products.**
1709 +
924 924  |(((
1711 +(% class="western" %)
925 925  **Request**
926 926  )))|(((
1714 +(% class="western" %)
927 927  **Type**
928 928  )))|(((
1717 +(% class="western" %)
929 929  **Description**
930 930  )))
931 931  |(((
1721 +(% class="western" %)
932 932  Resources
933 933  )))|(((
1724 +(% class="western" %)
934 934  Resources
935 935  )))|(((
936 -resource details in json to be sent as post data. Id should not be set. **Possible** **Request** **Params**: Name, Description, Type, Value **Example**:
937 -{"Name":"Test123","Description":Testss","Type":3,"Value":"/digital/"}
938 -)))
1727 +(% class="western" %)
1728 +resource details in json to be sent as post data. Id should not be set.
939 939  
940 -\\
1730 +(% class="western" %)
1731 +**Possible Request Params**: Name, Description, Type, Value
941 941  
1733 +(% class="western" %)
1734 +**Example**:
1735 +
1736 +(% class="western" %)
1737 +{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1738 +)))
1739 +
942 942  |(((
1741 +(% class="western" %)
943 943  **Response**
944 944  )))|(((
1744 +(% class="western" %)
945 945  **Type**
946 946  )))|(((
1747 +(% class="western" %)
947 947  **Description**
948 948  )))
949 949  |(((
1751 +(% class="western" %)
950 950  ResourceId
951 951  )))|(((
1754 +(% class="western" %)
952 952  int
953 953  )))|(((
1757 +(% class="western" %)
954 954  Resource Id of the newly created resource.
955 955  )))
956 956  
1761 +
957 957  
958 -\\PUT method should be used to update an individual resource given the resource info.\\
1763 +(% class="western" %)
1764 +PUT method should be used to update an individual resource given the resource info.
959 959  
960 960  |(((
1767 +(% class="western" %)
961 961  **Request**
962 962  )))|(((
1770 +(% class="western" %)
963 963  **Type**
964 964  )))|(((
1773 +(% class="western" %)
965 965  **Description**
966 966  )))
967 967  |(((
1777 +(% class="western" %)
968 968  Resources
969 969  )))|(((
1780 +(% class="western" %)
970 970  Resource
971 971  )))|(((
972 -Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated.
973 -\\\\Example:
974 -\\{"Name":"Test123","Description":Testss","Type":3,"Value":"/digital/"}
975 -)))
1783 +(% class="western" %)
1784 +Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated.
976 976  
977 -\\
1786 +(% class="western" %)
1787 +
978 978  
1789 +(% class="western" %)
1790 +Example:
1791 +
1792 +(% class="western" %)
1793 +{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1794 +)))
1795 +
979 979  |(((
1797 +(% class="western" %)
980 980  **Response**
981 981  )))|(((
1800 +(% class="western" %)
982 982  **Type**
983 983  )))|(((
1803 +(% class="western" %)
984 984  **Description**
985 985  )))
986 986  |(((
1807 +(% class="western" %)
987 987  ResourceId
988 988  )))|(((
1810 +(% class="western" %)
989 989  Int
990 990  )))|(((
1813 +(% class="western" %)
991 991  resource id of the updated resource.
992 992  )))
993 993  
1817 +
994 994  
995 -\\\\\\\\\\**Sources**
996 -This resource is for manipulating sources resource. A source can be created, updated or searched.\\
1819 +(% class="western" %)
1820 +
997 997  
1822 +(% class="western" %)
1823 +
1824 +
1825 +(% class="western" %)
1826 +**Sources**
1827 +
1828 +(% class="western" %)
1829 +This resource is for manipulating sources resource. A source can be created, updated or searched.
1830 +
998 998  |(((
1832 +(% class="western" %)
999 999  **Method**
1000 1000  )))|(((
1835 +(% class="western" %)
1001 1001  **Url**
1002 1002  )))|(((
1838 +(% class="western" %)
1003 1003  **Action**
1004 1004  )))
1005 1005  |(((
1842 +(% class="western" %)
1006 1006  GET
1007 1007  )))|(((
1845 +(% class="western" %)
1008 1008  /sources/1
1009 1009  )))|(((
1848 +(% class="western" %)
1010 1010  Get source id 1.
1011 1011  )))
1012 1012  |(((
1852 +(% class="western" %)
1013 1013  GET
1014 1014  )))|(((
1855 +(% class="western" %)
1015 1015  /sources/lookup?Source=sourcename
1016 1016  )))|(((
1858 +(% class="western" %)
1017 1017  Lookup sources by source.
1018 1018  )))
1019 1019  |(((
1862 +(% class="western" %)
1020 1020  POST
1021 1021  )))|(((
1865 +(% class="western" %)
1022 1022  /sources
1023 1023  )))|(((
1868 +(% class="western" %)
1024 1024  JSON of the Sources type object needs to be sent as post data. Id field should not be sent.
1025 1025  )))
1026 1026  |(((
1872 +(% class="western" %)
1027 1027  PUT
1028 1028  )))|(((
1875 +(% class="western" %)
1029 1029  /sources
1030 1030  )))|(((
1878 +(% class="western" %)
1031 1031  JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
1032 1032  )))
1033 1033  
1882 +
1034 1034  
1035 -\\**Sources** **can** **be** **looked** **up** **given** **the** **code** **or** **Id.** **GET** **method** **should** **be** **used** **for** **lookup.**\\
1884 +(% class="western" %)
1885 +**Sources can be looked up given the code or Id. GET method should be used for lookup.**
1036 1036  
1037 1037  |(((
1888 +(% class="western" %)
1038 1038  **Request**
1039 1039  )))|(((
1891 +(% class="western" %)
1040 1040  **Type**
1041 1041  )))|(((
1894 +(% class="western" %)
1042 1042  **Description**
1043 1043  )))
1044 1044  |(((
1898 +(% class="western" %)
1045 1045  Lookup params
1046 1046  )))|(((
1901 +(% class="western" %)
1047 1047  String
1048 1048  )))|(((
1049 -URL encoded key value string parameter for the lookup. Params:
1904 +(% class="western" %)
1905 +URL encoded key value string parameter for the lookup.
1906 +
1907 +(% class="western" %)
1908 +Params:
1909 +
1910 +(% class="western" %)
1050 1050  Source: Source value (String)
1051 1051  )))
1052 1052  
1053 -\\
1054 -
1055 1055  |(((
1915 +(% class="western" %)
1056 1056  **Response**
1057 1057  )))|(((
1918 +(% class="western" %)
1058 1058  **Type**
1059 1059  )))|(((
1921 +(% class="western" %)
1060 1060  **Description**
1061 1061  )))
1062 1062  |(((
1925 +(% class="western" %)
1063 1063  Sources
1064 1064  )))|(((
1928 +(% class="western" %)
1065 1065  Sources
1066 1066  )))|(((
1931 +(% class="western" %)
1067 1067  Returns found source details.
1068 1068  )))
1069 1069  
1935 +
1070 1070  
1071 -POST method should be used to create an individual source given the source parameters.\\
1937 +(% class="western" %)
1938 +
1072 1072  
1940 +(% class="western" %)
1941 +POST method should be used to create an individual source given the source parameters.
1942 +
1073 1073  |(((
1944 +(% class="western" %)
1074 1074  **Request**
1075 1075  )))|(((
1947 +(% class="western" %)
1076 1076  **Type**
1077 1077  )))|(((
1950 +(% class="western" %)
1078 1078  **Description**
1079 1079  )))
1080 1080  |(((
1954 +(% class="western" %)
1081 1081  Sources
1082 1082  )))|(((
1957 +(% class="western" %)
1083 1083  Sources
1084 1084  )))|(((
1960 +(% class="western" %)
1085 1085  Defines the contents that makes up the source. Id parameters should not be set.
1086 1086  )))
1087 1087  
1088 -\\
1089 -
1090 1090  |(((
1965 +(% class="western" %)
1091 1091  **Response**
1092 1092  )))|(((
1968 +(% class="western" %)
1093 1093  **Type**
1094 1094  )))|(((
1971 +(% class="western" %)
1095 1095  **Description**
1096 1096  )))
1097 1097  |(((
1975 +(% class="western" %)
1098 1098  SourceId
1099 1099  )))|(((
1978 +(% class="western" %)
1100 1100  int
1101 1101  )))|(((
1981 +(% class="western" %)
1102 1102  Returns created source code id.
1103 1103  )))
1104 1104  
1985 +
1105 1105  
1106 -\\**PUT** **method** **can** **be** **used** **to** **update** **an** **individual** **source** **given** **the** **id.**\\
1987 +(% class="western" %)
1988 +**PUT method can be used to update an individual source given the id.**
1107 1107  
1108 1108  |(((
1991 +(% class="western" %)
1109 1109  **Request**
1110 1110  )))|(((
1994 +(% class="western" %)
1111 1111  **Type**
1112 1112  )))|(((
1997 +(% class="western" %)
1113 1113  **Description**
1114 1114  )))
1115 1115  |(((
2001 +(% class="western" %)
1116 1116  Sources
1117 1117  )))|(((
2004 +(% class="western" %)
1118 1118  Sources
1119 1119  )))|(((
2007 +(% class="western" %)
1120 1120  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.
1121 1121  )))
1122 1122  
1123 -\\
1124 -
1125 1125  |(((
2012 +(% class="western" %)
1126 1126  **Response**
1127 1127  )))|(((
2015 +(% class="western" %)
1128 1128  **Type**
1129 1129  )))|(((
2018 +(% class="western" %)
1130 1130  **Description**
1131 1131  )))
1132 1132  |(((
2022 +(% class="western" %)
1133 1133  SourceId
1134 1134  )))|(((
2025 +(% class="western" %)
1135 1135  int
1136 1136  )))|(((
2028 +(% class="western" %)
1137 1137  Returns updated source id.
1138 1138  )))
1139 1139  
2032 +
1140 1140  
1141 -\\\\\\**Transactions**
1142 -This resource is for manipulating transactions resource. A transaction can be created or searched.\\
2034 +(% class="western" %)
2035 +
1143 1143  
2037 +(% class="western" %)
2038 +**Transactions**
2039 +
2040 +(% class="western" %)
2041 +This resource is for manipulating transactions resource. A transaction can be created or searched.
2042 +
1144 1144  |(((
2044 +(% class="western" %)
1145 1145  **Method**
1146 1146  )))|(((
2047 +(% class="western" %)
1147 1147  **Url**
1148 1148  )))|(((
2050 +(% class="western" %)
1149 1149  **Action**
1150 1150  )))
1151 1151  |(((
2054 +(% class="western" %)
1152 1152  GET
1153 1153  )))|(((
2057 +(% class="western" %)
1154 1154  /transactions
1155 1155  )))|(((
2060 +(% class="western" %)
1156 1156  List all transactions
1157 1157  )))
1158 1158  |(((
2064 +(% class="western" %)
1159 1159  GET
1160 1160  )))|(((
2067 +(% class="western" %)
1161 1161  /transactions/lookup?UserId=1
1162 1162  )))|(((
2070 +(% class="western" %)
1163 1163  Lookup all transaction of UserId = 1
1164 1164  )))
1165 1165  |(((
2074 +(% class="western" %)
1166 1166  POST
1167 1167  )))|(((
2077 +(% class="western" %)
1168 1168  /transactions
1169 1169  )))|(((
2080 +(% class="western" %)
1170 1170  JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
1171 1171  )))
1172 1172  
2084 +
1173 1173  
1174 -\\\\\\Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.\\
2086 +(% class="western" %)
2087 +
1175 1175  
2089 +(% class="western" %)
2090 +Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2091 +
1176 1176  |(((
2093 +(% class="western" %)
1177 1177  **Request**
1178 1178  )))|(((
2096 +(% class="western" %)
1179 1179  **Type**
1180 1180  )))|(((
2099 +(% class="western" %)
1181 1181  **Description**
1182 1182  )))
1183 1183  |(((
2103 +(% class="western" %)
1184 1184  Lookup params
1185 1185  )))|(((
2106 +(% class="western" %)
1186 1186  String
1187 1187  )))|(((
1188 -URL encoded key value string parameter for the lookup. Params:
1189 -UserId: Id of the user whose transaction is to be looked up (Int)
1190 -StartDate: Date from which the start should happen. Only valid when UserId is set. (Date) EndDate: When the search should end. Only valid when UserId is set. (Date)
2109 +(% class="western" %)
2110 +URL encoded key value string parameter for the lookup.
2111 +
2112 +(% class="western" %)
2113 +Params:
2114 +
2115 +(% class="western" %)
2116 +UserId: Id of the user whose transaction is to be looked up (Int)
2117 +
2118 +(% class="western" %)
2119 +StartDate: Date from which the start should happen. Only valid when UserId is set. (Date)
2120 +
2121 +(% class="western" %)
2122 +EndDate: When the search should end. Only valid when UserId is set. (Date)
1191 1191  )))
1192 1192  
2125 +
1193 1193  
1194 -\\\\\\
2127 +
1195 1195  
1196 1196  |(((
2130 +(% class="western" %)
1197 1197  **Response**
1198 1198  )))|(((
2133 +(% class="western" %)
1199 1199  **Type**
1200 1200  )))|(((
2136 +(% class="western" %)
1201 1201  **Description**
1202 1202  )))
1203 1203  |(((
2140 +(% class="western" %)
1204 1204  Transactions
1205 1205  )))|(((
2143 +(% class="western" %)
1206 1206  Transactions
1207 1207  )))|(((
2146 +(% class="western" %)
1208 1208  Returns all transaction that satisfies the search criteria.
1209 1209  )))
1210 1210  
2150 +
1211 1211  
1212 -\\POST method can be used to create user transaction. Transaction info needs to be sent as request and a TransactionId will be returned when thetransaction is created.\\
2152 +(% class="western" %)
2153 +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.
1213 1213  
1214 1214  |(((
2156 +(% class="western" %)
1215 1215  **Request**
1216 1216  )))|(((
2159 +(% class="western" %)
1217 1217  **Type**
1218 1218  )))|(((
2162 +(% class="western" %)
1219 1219  **Description**
1220 1220  )))
1221 1221  |(((
2166 +(% class="western" %)
1222 1222  Transactions
1223 1223  )))|(((
2169 +(% class="western" %)
1224 1224  Transactions
1225 1225  )))|(((
2172 +(% class="western" %)
1226 1226  Contains fields that define a transaction. Id field should not be set.
1227 1227  )))
1228 1228  
1229 -\\
1230 -
1231 1231  |(((
2177 +(% class="western" %)
1232 1232  **Response**
1233 1233  )))|(((
2180 +(% class="western" %)
1234 1234  **Type**
1235 1235  )))|(((
2183 +(% class="western" %)
1236 1236  **Description**
1237 1237  )))
1238 1238  |(((
2187 +(% class="western" %)
1239 1239  TransactionId
1240 1240  )))|(((
2190 +(% class="western" %)
1241 1241  int
1242 1242  )))|(((
2193 +(% class="western" %)
1243 1243  Returns transactionId of the newly created transaction.
1244 1244  )))
1245 1245  
2197 +
1246 1246  
1247 -\\**Stats**
1248 -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
1249 - sub-resource. So, for telemarketing it could be **/stats/telemarketing** endpoint, for videos it can be **/stats/videos**, for webinar it could be **/stats/we** **binars** etc. Right now we only have telemarketing sub-resource.
1250 -\\\\\\\\\\\\\\\\**Telemarketing**
1251 -\\This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.\\
2199 +(% class="western" %)
2200 +**Stats**
1252 1252  
2202 +(% class="western" %)
2203 +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.
2204 +
2205 +(% class="western" %)
2206 +
2207 +
2208 +(% class="western" %)
2209 +
2210 +
2211 +(% class="western" %)
2212 +
2213 +
2214 +(% class="western" %)
2215 +
2216 +
2217 +(% class="western" %)
2218 +
2219 +
2220 +(% class="western" %)
2221 +**Telemarketing**
2222 +
2223 +(% class="western" %)
2224 +
2225 +This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2226 +
1253 1253  |(((
2228 +(% class="western" %)
1254 1254  **Method**
1255 1255  )))|(((
2231 +(% class="western" %)
1256 1256  **Url**
1257 1257  )))|(((
2234 +(% class="western" %)
1258 1258  **Action**
1259 1259  )))
1260 1260  |(((
2238 +(% class="western" %)
1261 1261  GET
1262 1262  )))|(((
2241 +(% class="western" %)
1263 1263  /stats/telemarketing
1264 1264  )))|(((
2244 +(% class="western" %)
1265 1265  List telemarketing stats
1266 1266  )))
1267 1267  |(((
2248 +(% class="western" %)
1268 1268  GET
1269 1269  )))|(((
2251 +(% class="western" %)
1270 1270  /stats/telemarketing/1000
1271 1271  )))|(((
2254 +(% class="western" %)
1272 1272  Get telemarketing stat whose id is 1000 in the system.
1273 1273  )))
1274 1274  |(((
2258 +(% class="western" %)
1275 1275  POST
1276 1276  )))|(((
2261 +(% class="western" %)
1277 1277  /stats/telemarketing
1278 1278  )))|(((
2264 +(% class="western" %)
1279 1279  JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
1280 1280  )))
1281 1281  
2268 +
1282 1282  
1283 -\\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.
1284 -**Request** **Type** **Description**\\
2270 +(% class="western" %)
2271 +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.
1285 1285  
1286 1286  |(((
1287 -Telemarketing
2274 +(% class="western" %)
2275 +**Request**
1288 1288  )))|(((
1289 -Telemarketing
2277 +(% class="western" %)
2278 +**Type**
1290 1290  )))|(((
1291 -Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section.
2280 +(% class="western" %)
2281 +**Description**
1292 1292  )))
1293 1293  |(((
1294 -
2284 +(% class="western" %)
2285 +Telemarketing
1295 1295  )))|(((
1296 -
2287 +(% class="western" %)
2288 +Telemarketing
1297 1297  )))|(((
1298 -
1299 -)))|(((
2290 +(% class="western" %)
2291 +Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section.
2292 +
2293 +(% class="western" %)
1300 1300  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.
1301 -)))
1302 -|(((
1303 -
1304 -)))|(((
1305 -
1306 -)))|(((
1307 -
1308 -)))|(((
2295 +
2296 +(% class="western" %)
1309 1309  E.g
1310 -)))
1311 -|(((
1312 -
1313 -)))|(((
1314 -
1315 -)))|(((
1316 -
1317 -)))|(((
2298 +
2299 +(% class="western" %)
1318 1318  {
1319 -)))
1320 -|(((
1321 -<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd8549bf-7710-433a-9bfa-2d563e29983f"><ac:plain-text-body><![CDATA[
1322 -)))|(((
1323 -
1324 -)))|(((
1325 -
1326 -)))|(((
1327 -
1328 -)))|(((
2301 +
2302 +(% class="western" %)
1329 1329  "Telemarketing":[
1330 -)))|(((
1331 -]]></ac:plain-text-body></ac:structured-macro>
1332 -)))
1333 -|(((
1334 -
1335 -)))|(((
1336 -
1337 -)))|(((
1338 -
1339 -)))|(((
2304 +
2305 +(% class="western" %)
1340 1340  {
1341 -)))
1342 -|(((
1343 -
1344 -)))|(((
1345 -
1346 -)))|(((
1347 -
1348 -)))|(((
2307 +
2308 +(% class="western" %)
1349 1349  "OCID":"5000",
1350 -)))
1351 -|(((
1352 -
1353 -)))|(((
1354 -
1355 -)))|(((
1356 -
1357 -)))|(((
2310 +
2311 +(% class="western" %)
1358 1358  "Date": "2016-01-01",
1359 -)))
1360 -|(((
1361 -
1362 -)))|(((
1363 -
1364 -)))|(((
1365 -
1366 -)))|(((
2313 +
2314 +(% class="western" %)
1367 1367  "Time": "10:10:10",
1368 -)))
1369 -|(((
1370 -
1371 -)))|(((
1372 -
1373 -)))|(((
1374 -
1375 -)))|(((
2316 +
2317 +(% class="western" %)
1376 1376  "ResourceId":"250",
1377 -)))
1378 -|(((
1379 -
1380 -)))|(((
1381 -
1382 -)))|(((
1383 -
1384 -)))|(((
1385 -[["PageUrl": "http:~~/~~/www.one-count.com/detail/a.php",>>url:http://www.one-count.com/detail/a.php||shape="rect"]]
1386 -)))
1387 -|(((
1388 -
1389 -)))|(((
1390 -
1391 -)))|(((
1392 -
1393 -)))|(((
2319 +
2320 +(% class="western" %)
2321 +"PageUrl": "[[http:~~/~~/www.one-count.com/detail/a.php>>url:http://www.one-count.com/detail/a.php||shape="rect" class="western"]]",
2322 +
2323 +(% class="western" %)
1394 1394  "PageTitle":"tests"
1395 -)))
1396 -|(((
1397 -
1398 -)))|(((
1399 -
1400 -)))|(((
1401 -
1402 -)))|(((
2325 +
2326 +(% class="western" %)
1403 1403  }
1404 -)))
1405 -|(((
1406 -
1407 -)))|(((
1408 -
1409 -)))|(((
1410 -
1411 -)))|(((
2328 +
2329 +(% class="western" %)
1412 1412  ]
2331 +
2332 +(% class="western" %)
2333 +}
1413 1413  )))
1414 1414  |(((
2336 +(% class="western" %)
1415 1415  
1416 1416  )))|(((
2339 +(% class="western" %)
1417 1417  
1418 1418  )))|(((
2342 +(% class="western" %)
1419 1419  
1420 -)))|(((
1421 -}
1422 1422  )))
1423 1423  
1424 -\\
1425 -
1426 1426  |(((
2347 +(% class="western" %)
1427 1427  **Response**
1428 1428  )))|(((
2350 +(% class="western" %)
1429 1429  **Type**
1430 1430  )))|(((
2353 +(% class="western" %)
1431 1431  **Description**
1432 1432  )))
1433 1433  |(((
2357 +(% class="western" %)
1434 1434  Ids
1435 1435  )))|(((
2360 +(% class="western" %)
1436 1436  String
1437 1437  )))|(((
2363 +(% class="western" %)
1438 1438  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
1439 1439  )))
1440 1440  
2367 +
1441 1441  
1442 -\\**Reference**
1443 -**Type:** **Questions**\\
2369 +(% class="western" %)
2370 +**Reference**
1444 1444  
2372 +(% class="western" %)
2373 +**Type: Questions**
2374 +
1445 1445  |(((
1446 -**Property**
1447 -**Name**
2376 +(% class="western" %)
2377 +**Property Name**
1448 1448  )))|(((
2379 +(% class="western" %)
1449 1449  **Type**
1450 1450  )))|(((
2382 +(% class="western" %)
1451 1451  **Description**
1452 1452  )))
1453 1453  |(((
2386 +(% class="western" %)
1454 1454  Id
1455 1455  )))|(((
2389 +(% class="western" %)
1456 1456  Int
1457 1457  )))|(((
2392 +(% class="western" %)
1458 1458  Id of the question.
1459 1459  )))
1460 1460  |(((
2396 +(% class="western" %)
1461 1461  Text
1462 1462  )))|(((
2399 +(% class="western" %)
1463 1463  String
1464 1464  )))|(((
2402 +(% class="western" %)
1465 1465  Text of the question.
1466 1466  )))
1467 1467  |(((
2406 +(% class="western" %)
1468 1468  Type
1469 1469  )))|(((
2409 +(% class="western" %)
1470 1470  Int
1471 1471  )))|(((
1472 -Determines which type of question it is. Textbox, checkbox, select, radio. There can be 6 types of questions.
1473 -type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
1474 -type=2 means textarea type question or long response type question.
1475 -type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
1476 -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.
1477 -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.
1478 -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
1479 -checkbox question.
2412 +(% class="western" %)
2413 +Determines which type of question it is. Textbox, checkbox, select, radio.
2414 +There can be 6 types of questions.
2415 + type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2416 + type=2 means textarea type question or long response type question.
2417 + type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2418 + 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.
2419 + 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.
2420 + 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.
1480 1480  )))
1481 1481  |(((
2423 +(% class="western" %)
1482 1482  Choices
1483 1483  )))|(((
2426 +(% class="western" %)
1484 1484  choices
1485 1485  )))|(((
2429 +(% class="western" %)
1486 1486  If multiple choice question this field will have the choices.
1487 1487  )))
1488 1488  |(((
2433 +(% class="western" %)
1489 1489  Alias
1490 1490  )))|(((
2436 +(% class="western" %)
1491 1491  String
1492 1492  )))|(((
2439 +(% class="western" %)
1493 1493  Alias for admin purpose.
1494 1494  )))
1495 1495  
2443 +
1496 1496  
1497 -\\**Type:** **Choices**\\
2445 +(% class="western" %)
2446 +
1498 1498  
2448 +(% class="western" %)
2449 +
2450 +
2451 +(% class="western" %)
2452 +**Type: Choices**
2453 +
1499 1499  |(((
1500 -**Property** **Name**
2455 +(% class="western" %)
2456 +**Property Name**
1501 1501  )))|(((
2458 +(% class="western" %)
1502 1502  **Type**
1503 1503  )))|(((
2461 +(% class="western" %)
1504 1504  **Description**
1505 1505  )))
1506 1506  |(((
2465 +(% class="western" %)
1507 1507  Id
1508 1508  )))|(((
2468 +(% class="western" %)
1509 1509  int
1510 1510  )))|(((
2471 +(% class="western" %)
1511 1511  Id of the choice.
1512 1512  )))
1513 1513  |(((
2475 +(% class="western" %)
1514 1514  Text
1515 1515  )))|(((
2478 +(% class="western" %)
1516 1516  string
1517 1517  )))|(((
2481 +(% class="western" %)
1518 1518  Display text of choice.
1519 1519  )))
1520 1520  |(((
2485 +(% class="western" %)
1521 1521  Value
1522 1522  )))|(((
2488 +(% class="western" %)
1523 1523  String
1524 1524  )))|(((
2491 +(% class="western" %)
1525 1525  Value stored in db.
1526 1526  )))
1527 1527  |(((
2495 +(% class="western" %)
1528 1528  Order
1529 1529  )))|(((
2498 +(% class="western" %)
1530 1530  Int
1531 1531  )))|(((
2501 +(% class="western" %)
1532 1532  Display order.
1533 1533  )))
1534 1534  |(((
2505 +(% class="western" %)
1535 1535  QuestionId
1536 1536  )))|(((
2508 +(% class="western" %)
1537 1537  Int
1538 1538  )))|(((
2511 +(% class="western" %)
1539 1539  Tied to which question id.
1540 1540  )))
1541 1541  
2515 +
1542 1542  
1543 -\\**Type:** **Users**\\
2517 +(% class="western" %)
2518 +**Type: Users**
1544 1544  
1545 1545  |(((
1546 -**Property** **Name**
2521 +(% class="western" %)
2522 +**Property Name**
1547 1547  )))|(((
2524 +(% class="western" %)
1548 1548  **Type**
1549 1549  )))|(((
2527 +(% class="western" %)
1550 1550  **Description**
1551 1551  )))
1552 1552  |(((
2531 +(% class="western" %)
1553 1553  Id
1554 1554  )))|(((
2534 +(% class="western" %)
1555 1555  Int
1556 1556  )))|(((
2537 +(% class="western" %)
1557 1557  ID of the user in ONEcount.
1558 1558  )))
1559 1559  |(((
2541 +(% class="western" %)
1560 1560  PartnerId
1561 1561  )))|(((
2544 +(% class="western" %)
1562 1562  Int
1563 1563  )))|(((
2547 +(% class="western" %)
1564 1564  ID of the user in partners system (e.g. id of your system).
1565 1565  )))
1566 1566  |(((
2551 +(% class="western" %)
1567 1567  Demo
1568 1568  )))|(((
2554 +(% class="western" %)
1569 1569  Demo
1570 1570  )))|(((
2557 +(% class="western" %)
1571 1571  Object of user's demo question ids and respective response values.
1572 1572  )))
1573 1573  |(((
2561 +(% class="western" %)
1574 1574  RequestDate
1575 1575  )))|(((
2564 +(% class="western" %)
1576 1576  Date
1577 1577  )))|(((
2567 +(% class="western" %)
1578 1578  Request date.
1579 1579  )))
1580 1580  
2571 +
1581 1581  
1582 -\\**Type:** **Demo**\\
2573 +(% class="western" %)
2574 +**Type: Demo**
1583 1583  
1584 1584  |(((
1585 -**Property** **Name**
2577 +(% class="western" %)
2578 +**Property Name**
1586 1586  )))|(((
2580 +(% class="western" %)
1587 1587  **Type**
1588 1588  )))|(((
2583 +(% class="western" %)
1589 1589  **Description**
1590 1590  )))
1591 1591  |(((
2587 +(% class="western" %)
1592 1592  QuestionId (e.g 6)
1593 1593  )))|(((
2590 +(% class="western" %)
1594 1594  String
1595 1595  )))|(((
1596 -6 is the value of "Id" property of question resource(Text = "First Name")
2593 +(% class="western" %)
2594 +6 is the value of “Id” property of question resource(Text = “First Name”)
1597 1597  )))
1598 1598  |(((
2597 +(% class="western" %)
1599 1599  QuestionId (e.g 7)
1600 1600  )))|(((
2600 +(% class="western" %)
1601 1601  String
1602 1602  )))|(((
1603 -7 is the value of "Id" property of question resource(Text = "Last Name")
2603 +(% class="western" %)
2604 +7 is the value of “Id” property of question resource(Text = “Last Name”)
1604 1604  )))
1605 1605  |(((
2607 +(% class="western" %)
1606 1606  ...
1607 1607  )))|(((
2610 +(% class="western" %)
1608 1608  ...
1609 1609  )))|(((
2613 +(% class="western" %)
1610 1610  ...
1611 1611  )))
1612 1612  
2617 +
1613 1613  
1614 -\\**Type:** **Transactions**\\
2619 +(% class="western" %)
2620 +**Type: Transactions**
1615 1615  
1616 1616  |(((
1617 -**Property** **Name**
2623 +(% class="western" %)
2624 +**Property Name**
1618 1618  )))|(((
2626 +(% class="western" %)
1619 1619  **Type**
1620 1620  )))|(((
2629 +(% class="western" %)
1621 1621  **Description**
1622 1622  )))
1623 1623  |(((
2633 +(% class="western" %)
1624 1624  Id
1625 1625  )))|(((
2636 +(% class="western" %)
1626 1626  Int
1627 1627  )))|(((
2639 +(% class="western" %)
1628 1628  ID of the transaction.
1629 1629  )))
1630 1630  |(((
2643 +(% class="western" %)
1631 1631  UserId
1632 1632  )))|(((
2646 +(% class="western" %)
1633 1633  Int
1634 1634  )))|(((
2649 +(% class="western" %)
1635 1635  Id of user in ONEcount.
1636 1636  )))
1637 1637  |(((
2653 +(% class="western" %)
1638 1638  TermId
1639 1639  )))|(((
2656 +(% class="western" %)
1640 1640  Int
1641 1641  )))|(((
2659 +(% class="western" %)
1642 1642  TermId in ONEcount.
1643 1643  )))
1644 1644  |(((
2663 +(% class="western" %)
1645 1645  ProductStatus
1646 1646  )))|(((
2666 +(% class="western" %)
1647 1647  Int
1648 1648  )))|(((
2669 +(% class="western" %)
1649 1649  Status ID.
1650 1650  )))
1651 1651  |(((
2673 +(% class="western" %)
1652 1652  SubscriptionType
1653 1653  )))|(((
2676 +(% class="western" %)
1654 1654  Char
1655 1655  )))|(((
2679 +(% class="western" %)
1656 1656  Can be n,r or u for new, renew or unsubscribe.
1657 1657  )))
1658 1658  |(((
2683 +(% class="western" %)
1659 1659  TransactionDate
1660 1660  )))|(((
2686 +(% class="western" %)
1661 1661  Date
1662 1662  )))|(((
2689 +(% class="western" %)
1663 1663  Date when the transaction occurred.
1664 1664  )))
1665 1665  |(((
2693 +(% class="western" %)
1666 1666  TransactionTime
1667 1667  )))|(((
2696 +(% class="western" %)
1668 1668  Time
1669 1669  )))|(((
2699 +(% class="western" %)
1670 1670  Time of transaction.
1671 1671  )))
1672 1672  |(((
2703 +(% class="western" %)
1673 1673  RequestDate
1674 1674  )))|(((
2706 +(% class="western" %)
1675 1675  Date
1676 1676  )))|(((
2709 +(% class="western" %)
1677 1677  The effective request date for the transaction.
1678 1678  )))
1679 1679  |(((
2713 +(% class="western" %)
1680 1680  UserIP
1681 1681  )))|(((
2716 +(% class="western" %)
1682 1682  String
1683 1683  )))|(((
2719 +(% class="western" %)
1684 1684  IP of the user.
1685 1685  )))
1686 1686  |(((
2723 +(% class="western" %)
1687 1687  Source
1688 1688  )))|(((
2726 +(% class="western" %)
1689 1689  String
1690 1690  )))|(((
2729 +(% class="western" %)
1691 1691  The transaction needs to be tied to a source code this will define it.
1692 1692  )))
1693 1693  |(((
2733 +(% class="western" %)
1694 1694  MediaFilePath
1695 1695  )))|(((
2736 +(% class="western" %)
1696 1696  String
1697 1697  )))|(((
2739 +(% class="western" %)
1698 1698  The url of media associated with that transaction. Eg image, audio.
1699 1699  )))
1700 -
1701 -\\
1702 -
1703 1703  |(((
2743 +(% class="western" %)
1704 1704  ExpireDate
1705 1705  )))|(((
2746 +(% class="western" %)
1706 1706  Date
1707 1707  )))|(((
2749 +(% class="western" %)
1708 1708  Date when the subscription expires.
1709 1709  )))
1710 1710  |(((
2753 +(% class="western" %)
1711 1711  Amount
1712 1712  )))|(((
2756 +(% class="western" %)
1713 1713  Float
1714 1714  )))|(((
2759 +(% class="western" %)
1715 1715  If there is amount (USD) included in transaction.
1716 1716  )))
1717 1717  
2763 +
1718 1718  
1719 -\\**Type:** **Sources**\\
2765 +(% class="western" %)
2766 +**Type: Sources**
1720 1720  
1721 1721  |(((
1722 -**Property** **Name**
2769 +(% class="western" %)
2770 +**Property Name**
1723 1723  )))|(((
2772 +(% class="western" %)
1724 1724  **Type**
1725 1725  )))|(((
2775 +(% class="western" %)
1726 1726  **Description**
1727 1727  )))
1728 1728  |(((
2779 +(% class="western" %)
1729 1729  Id
1730 1730  )))|(((
2782 +(% class="western" %)
1731 1731  Int
1732 1732  )))|(((
2785 +(% class="western" %)
1733 1733  Id of the source.
1734 1734  )))
1735 1735  |(((
2789 +(% class="western" %)
1736 1736  Source
1737 1737  )))|(((
2792 +(% class="western" %)
1738 1738  String
1739 1739  )))|(((
2795 +(% class="western" %)
1740 1740  Value of the source.
1741 1741  )))
1742 1742  |(((
2799 +(% class="western" %)
1743 1743  Description
1744 1744  )))|(((
2802 +(% class="western" %)
1745 1745  Text
1746 1746  )))|(((
2805 +(% class="western" %)
1747 1747  Description of the source.
1748 1748  )))
1749 1749  |(((
2809 +(% class="western" %)
1750 1750  ParentId
1751 1751  )))|(((
2812 +(% class="western" %)
1752 1752  int
1753 1753  )))|(((
2815 +(% class="western" %)
1754 1754  If this is a child source then list the parent source id.
1755 1755  )))
1756 1756  
2819 +
1757 1757  
1758 -\\\\\\**Type:** **Products**\\
2821 +(% class="western" %)
2822 +
1759 1759  
2824 +(% class="western" %)
2825 +**Type: Products**
2826 +
1760 1760  |(((
1761 -**Property** **Name**
2828 +(% class="western" %)
2829 +**Property Name**
1762 1762  )))|(((
2831 +(% class="western" %)
1763 1763  **Type**
1764 1764  )))|(((
2834 +(% class="western" %)
1765 1765  **Description**
1766 1766  )))
1767 1767  |(((
2838 +(% class="western" %)
1768 1768  Id
1769 1769  )))|(((
2841 +(% class="western" %)
1770 1770  Int
1771 1771  )))|(((
2844 +(% class="western" %)
1772 1772  Specify only for update.
1773 1773  )))
1774 1774  |(((
2848 +(% class="western" %)
1775 1775  Name
1776 1776  )))|(((
2851 +(% class="western" %)
1777 1777  String
1778 1778  )))|(((
2854 +(% class="western" %)
1779 1779  Name of the Product.
1780 1780  )))
1781 1781  |(((
2858 +(% class="western" %)
1782 1782  Description
1783 1783  )))|(((
2861 +(% class="western" %)
1784 1784  Text
1785 1785  )))|(((
2864 +(% class="western" %)
1786 1786  Description of the product.
1787 1787  )))
1788 1788  |(((
2868 +(% class="western" %)
1789 1789  Terms
1790 1790  )))|(((
2871 +(% class="western" %)
1791 1791  Terms
1792 1792  )))|(((
2874 +(% class="western" %)
1793 1793  (Array of) Terms associated with the product.
1794 1794  )))
1795 1795  
2878 +
1796 1796  
1797 -\\**Type:** **Terms**\\
2880 +(% class="western" %)
2881 +**Type: Terms**
1798 1798  
1799 1799  |(((
1800 -**Property** **Name**
2884 +(% class="western" %)
2885 +**Property Name**
1801 1801  )))|(((
2887 +(% class="western" %)
1802 1802  **Type**
1803 1803  )))|(((
2890 +(% class="western" %)
1804 1804  **Description**
1805 1805  )))
1806 1806  |(((
2894 +(% class="western" %)
1807 1807  Id
1808 1808  )))|(((
2897 +(% class="western" %)
1809 1809  int
1810 1810  )))|(((
2900 +(% class="western" %)
1811 1811  Id of the term.
1812 1812  )))
1813 1813  |(((
2904 +(% class="western" %)
1814 1814  Name
1815 1815  )))|(((
2907 +(% class="western" %)
1816 1816  string
1817 1817  )))|(((
2910 +(% class="western" %)
1818 1818  Name of the Term.
1819 1819  )))
1820 1820  |(((
2914 +(% class="western" %)
1821 1821  Description
1822 1822  )))|(((
2917 +(% class="western" %)
1823 1823  text
1824 1824  )))|(((
2920 +(% class="western" %)
1825 1825  Description of the term.
1826 1826  )))
1827 1827  |(((
2924 +(% class="western" %)
1828 1828  Duration
1829 1829  )))|(((
2927 +(% class="western" %)
1830 1830  int
1831 1831  )))|(((
2930 +(% class="western" %)
1832 1832  Duration of term validity.
1833 1833  )))
1834 1834  |(((
2934 +(% class="western" %)
1835 1835  DurationUnit
1836 1836  )))|(((
2937 +(% class="western" %)
1837 1837  sting
1838 1838  )))|(((
2940 +(% class="western" %)
1839 1839  Y (year), M (Month), D (Days).
1840 1840  )))
1841 1841  |(((
2944 +(% class="western" %)
1842 1842  ProductId
1843 1843  )))|(((
2947 +(% class="western" %)
1844 1844  int
1845 1845  )))|(((
2950 +(% class="western" %)
1846 1846  Id of the product the term is tied to.
1847 1847  )))
1848 1848  |(((
2954 +(% class="western" %)
1849 1849  Price
1850 1850  )))|(((
2957 +(% class="western" %)
1851 1851  float
1852 1852  )))|(((
2960 +(% class="western" %)
1853 1853  If there is price (USD) for the term.
1854 1854  )))
1855 1855  
2964 +
1856 1856  
1857 -\\**Type:** **Resources**\\
2966 +(% class="western" %)
2967 +**Type: Resources**
1858 1858  
1859 1859  |(((
1860 -**Property** **Name**
2970 +(% class="western" %)
2971 +**Property Name**
1861 1861  )))|(((
2973 +(% class="western" %)
1862 1862  **Type**
1863 1863  )))|(((
2976 +(% class="western" %)
1864 1864  **Description**
1865 1865  )))
1866 1866  |(((
2980 +(% class="western" %)
1867 1867  Id
1868 1868  )))|(((
2983 +(% class="western" %)
1869 1869  Int
1870 1870  )))|(((
2986 +(% class="western" %)
1871 1871  Specify only for update.
1872 1872  )))
1873 1873  |(((
2990 +(% class="western" %)
1874 1874  Name
1875 1875  )))|(((
2993 +(% class="western" %)
1876 1876  String
1877 1877  )))|(((
2996 +(% class="western" %)
1878 1878  Name of the Resource.
1879 1879  )))
1880 1880  |(((
3000 +(% class="western" %)
1881 1881  Description
1882 1882  )))|(((
3003 +(% class="western" %)
1883 1883  Text
1884 1884  )))|(((
3006 +(% class="western" %)
1885 1885  Description of the Resource.
1886 1886  )))
1887 -
1888 -\\
1889 -
1890 1890  |(((
3010 +(% class="western" %)
1891 1891  Type
1892 1892  )))|(((
3013 +(% class="western" %)
1893 1893  Int
1894 1894  )))|(((
1895 -Type Options
1896 -\\**0** : File
1897 -\\**2** **:** Newsletter
1898 -\\**3** **:** Section
1899 -\\**4** **:** Page
1900 -\\**5** **:** Function
3016 +(% class="western" %)
3017 +Type Options
3018 +
3019 +(% class="western" %)
3020 +**0** : File
3021 +
3022 +(% class="western" %)
3023 +**2 : **Newsletter
3024 +
3025 +(% class="western" %)
3026 +**3 : **Section
3027 +
3028 +(% class="western" %)
3029 +**4 : **Page
3030 +
3031 +(% class="western" %)
3032 +**5 : **Function
1901 1901  )))
1902 1902  |(((
3035 +(% class="western" %)
1903 1903  Value
1904 1904  )))|(((
3038 +(% class="western" %)
1905 1905  String
1906 1906  )))|(((
1907 -Value of Resource Type.
1908 -\\Example : if the Type sent is 3 then Value would be **/digital/**
1909 -\\For Function type resource it can be blank.
3041 +(% class="western" %)
3042 +Value of Resource Type.
3043 +
3044 +(% class="western" %)
3045 +Example : if the Type sent is 3 then Value would be **/digital/**
3046 +
3047 +(% class="western" %)
3048 +For Function type resource leave it blank.
1910 1910  )))
3050 +|(((
3051 +(% class="western" %)
3052 +limit
3053 +)))|(((
3054 +(% class="western" %)
3055 +Int
3056 +)))|(((
3057 +(% class="western" %)
3058 +Default limit is 25 but all the data needs to be pulled then pass limit=0.
3059 +)))
1911 1911  
3061 +
1912 1912  
1913 -\\**Type:** **Telemarketing**\\
3063 +(% class="western" %)
3064 +**Type: Telemarketing**
1914 1914  
1915 1915  |(((
1916 -**Property** **Name**
3067 +(% class="western" %)
3068 +**Property Name**
1917 1917  )))|(((
3070 +(% class="western" %)
1918 1918  **Type**
1919 1919  )))|(((
3073 +(% class="western" %)
1920 1920  **Description**
1921 1921  )))
1922 1922  |(((
3077 +(% class="western" %)
1923 1923  Id
1924 1924  )))|(((
3080 +(% class="western" %)
1925 1925  int
1926 1926  )))|(((
3083 +(% class="western" %)
1927 1927  Id of the telemarketing stat. This is autogenerated from the system and can be used to lookup the stat.
1928 1928  )))
1929 1929  |(((
3087 +(% class="western" %)
1930 1930  OCID
1931 1931  )))|(((
3090 +(% class="western" %)
1932 1932  int
1933 1933  )))|(((
3093 +(% class="western" %)
1934 1934  Onecount ID of the user.
1935 1935  )))
1936 1936  |(((
3097 +(% class="western" %)
1937 1937  Date
1938 1938  )))|(((
3100 +(% class="western" %)
1939 1939  Date
1940 1940  )))|(((
3103 +(% class="western" %)
1941 1941  Date when the stat occurred. Format: yyyy-mm-dd
1942 1942  )))
1943 1943  |(((
3107 +(% class="western" %)
1944 1944  Time
1945 1945  )))|(((
3110 +(% class="western" %)
1946 1946  Time
1947 1947  )))|(((
3113 +(% class="western" %)
1948 1948  Time of stat. Format: h:m:s (24 hour format)
1949 1949  )))
1950 1950  |(((
3117 +(% class="western" %)
1951 1951  ResourceId
1952 1952  )))|(((
3120 +(% class="western" %)
1953 1953  int
1954 1954  )))|(((
1955 -Id of resource currently being sent for the sat. If the resource type is page type resource then need to send
3123 +(% class="western" %)
3124 +Id of resource currently being sent for the sat. If the resource type is page type resource then need to send
3125 +
3126 +(% class="western" %)
1956 1956  PageTitle otherwise it will follow the process described in PageTitle.
1957 1957  )))
1958 1958  |(((
3130 +(% class="western" %)
1959 1959  PageUrl
1960 1960  )))|(((
3133 +(% class="western" %)
1961 1961  string
1962 1962  )))|(((
3136 +(% class="western" %)
1963 1963  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.
1964 1964  )))
1965 1965  |(((
3140 +(% class="western" %)
1966 1966  PageTitle
1967 1967  )))|(((
3143 +(% class="western" %)
1968 1968  string
1969 1969  )))|(((
1970 -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.
1971 -\\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.
3146 +(% class="western" %)
3147 +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.
3148 +
3149 +(% class="western" %)
3150 +
3151 +
3152 +(% class="western" %)
3153 +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.
1972 1972  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3538997
1 +3538998
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3538997/sonish-APIDocument-230317-1008-18
1 +https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18