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

From version 6.1
edited by Admin
on 2017/04/05 10:47
Change comment: There is no comment for this version
To version 1.1
edited by sonish
on 2017/04/03 16:25
Change comment: There is no comment for this version

Summary

Details

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