Wiki source code of sonish-APIDocument-230317-1008-18
Version 1.1 by sonish on 2017/04/03 16:25
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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** | ||
| 15 | |||
| 16 | |||
| 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);" %){(%%) | ||
| 83 | |||
| 84 | \\\\\\(% style="color: rgb(51,51,51);" %)},(%%) | ||
| 85 | (% style="color: rgb(51,51,51);" %){(%%) | ||
| 86 | \\\\\\\\(% style="color: rgb(51,51,51);" %)}(%%) | ||
| 87 | (% style="color: rgb(51,51,51);" %)]}]}(%%) | ||
| 88 | (% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"123",(%%) | ||
| 89 | (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Physician",(%%) (% style="color: rgb(51,51,51);" %)"Value":(%%) (% style="color: rgb(51,51,51);" %)"PH",(%%) (% style="color: rgb(51,51,51);" %)"Order":(%%) (% style="color: rgb(51,51,51);" %)"1",(%%) (% style="color: rgb(51,51,51);" %)"QuestionId":(%%) (% style="color: rgb(51,51,51);" %)"5"(%%) | ||
| 90 | \\(% style="color: rgb(51,51,51);" %)"Id":(%%) (% style="color: rgb(51,51,51);" %)"124",(%%) | ||
| 91 | (% style="color: rgb(51,51,51);" %)"Text":(%%) (% style="color: rgb(51,51,51);" %)"Nurse(%%) (% style="color: rgb(51,51,51);" %)Practioner",(%%) (% style="color: rgb(51,51,51);" %)"Value":(%%) (% style="color: rgb(51,51,51);" %)"NP",(%%) | ||
| 92 | (% style="color: rgb(51,51,51);" %)"Order":(%%) (% style="color: rgb(51,51,51);" %)"2",(%%) (% style="color: rgb(51,51,51);" %)"QuestionId":(%%) (% style="color: rgb(51,51,51);" %)"5"(%%) | ||
| 93 | |||
| 94 | **Resources** | ||
| 95 | Resources are the available entities that can be accessed/modified via API. Each resource can be created, updated or requested by using the corresponding http method described above. | ||
| 96 | questions users products terms resources sources transactions | ||
| 97 | **Questions** | ||
| 98 | This resource is for manipulating questions resource. Questions in ONEcount means any question that is asked to the subscriber. It could be anyquestions that appears on customer forms or print forms that gets answered by a subscriber. Questions api call will allow creation, update and search of question in ONEcount. To add a new questions to the system you'll make a POST api call to the questions resource. | ||
| 99 | The data that is sent should be in JSON format and of type questions as described in References section. The type property of questions object is described below. Questions object will only need a choices block if the question is a multiple choice question(type=4 or 5 or 6) | ||
| 100 | There can be 6 types of questions:\\ | ||
| 101 | |||
| 102 | |((( | ||
| 103 | **Type** | ||
| 104 | )))|((( | ||
| 105 | **Description** | ||
| 106 | ))) | ||
| 107 | |((( | ||
| 108 | 1 | ||
| 109 | )))|((( | ||
| 110 | Textbox type questions or short response type question. The response length needs to be less than 255 characters. | ||
| 111 | ))) | ||
| 112 | |((( | ||
| 113 | 2 | ||
| 114 | )))|((( | ||
| 115 | Textarea type question or long response type question. | ||
| 116 | ))) | ||
| 117 | |((( | ||
| 118 | 3 | ||
| 119 | )))|((( | ||
| 120 | Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as | ||
| 121 | *. | ||
| 122 | ))) | ||
| 123 | |((( | ||
| 124 | 4 | ||
| 125 | )))|((( | ||
| 126 | Select or dropdown type questions. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the select question. | ||
| 127 | ))) | ||
| 128 | |((( | ||
| 129 | 5 | ||
| 130 | )))|((( | ||
| 131 | Radio button type question. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the radio question. | ||
| 132 | ))) | ||
| 133 | |((( | ||
| 134 | 6 | ||
| 135 | )))|((( | ||
| 136 | Checkbox type question. This is a multiple choice, multi response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the checkbox question. | ||
| 137 | ))) | ||
| 138 | |||
| 139 | \\ | ||
| 140 | |||
| 141 | |((( | ||
| 142 | **Method** | ||
| 143 | )))|((( | ||
| 144 | **Url** | ||
| 145 | )))|((( | ||
| 146 | **Action** | ||
| 147 | ))) | ||
| 148 | |((( | ||
| 149 | GET | ||
| 150 | )))|((( | ||
| 151 | /questions | ||
| 152 | )))|((( | ||
| 153 | List all questions | ||
| 154 | ))) | ||
| 155 | |((( | ||
| 156 | GET | ||
| 157 | )))|((( | ||
| 158 | /questions/1 | ||
| 159 | )))|((( | ||
| 160 | Returns question id 1 | ||
| 161 | ))) | ||
| 162 | |((( | ||
| 163 | GET | ||
| 164 | )))|((( | ||
| 165 | /questions/lookup?Text=Email | ||
| 166 | )))|((( | ||
| 167 | Returns all questions with "Email" in question text | ||
| 168 | ))) | ||
| 169 | |((( | ||
| 170 | POST | ||
| 171 | )))|((( | ||
| 172 | /questions | ||
| 173 | )))|((( | ||
| 174 | Create a new question | ||
| 175 | \\JSON of the Questions type object needs to be sent as post data. Id field should not be sent. | ||
| 176 | ))) | ||
| 177 | |((( | ||
| 178 | PUT | ||
| 179 | )))|((( | ||
| 180 | /questions | ||
| 181 | )))|((( | ||
| 182 | Update a question | ||
| 183 | \\JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update. | ||
| 184 | ))) | ||
| 185 | |||
| 186 | |||
| 187 | \\**GET** **method** **can** **be** **used** **to** **lookup** **questions.**\\ | ||
| 188 | |||
| 189 | |((( | ||
| 190 | **Request** | ||
| 191 | )))|((( | ||
| 192 | **Type** | ||
| 193 | )))|((( | ||
| 194 | **Description** | ||
| 195 | ))) | ||
| 196 | |((( | ||
| 197 | Lookup params | ||
| 198 | )))|((( | ||
| 199 | String | ||
| 200 | )))|((( | ||
| 201 | URL encoded key value string parameters for the question that a user is trying to search. Params: | ||
| 202 | Text: Word or phrase that should be present in the question text (String) | ||
| 203 | \\Type: Look up the question type. | ||
| 204 | ))) | ||
| 205 | |||
| 206 | \\ | ||
| 207 | |||
| 208 | |((( | ||
| 209 | **Response** | ||
| 210 | )))|((( | ||
| 211 | **Type** | ||
| 212 | )))|((( | ||
| 213 | **Description** | ||
| 214 | ))) | ||
| 215 | |((( | ||
| 216 | Questions | ||
| 217 | )))|((( | ||
| 218 | Questions | ||
| 219 | )))|((( | ||
| 220 | Returns found question details. | ||
| 221 | ))) | ||
| 222 | |||
| 223 | |||
| 224 | \\**POST** **method** **should** **be** **used** **to** **create** **questions.** **The** **data** **that** **is** **sent** **should** **be** **in** **JSON** **format** **and** **of** **type** **questions** **as** **described** **in** **references** **section.** **Questions** **object** **will** **only** **need** **a** **choices** **block** **if** **the** **question** **is** **a** **multiple** **choice** **question** **(type=4** **or** **5** **or** **6).**\\ | ||
| 225 | |||
| 226 | |((( | ||
| 227 | **Request** | ||
| 228 | )))|((( | ||
| 229 | **Type** | ||
| 230 | )))|((( | ||
| 231 | **Description** | ||
| 232 | ))) | ||
| 233 | |((( | ||
| 234 | Questions | ||
| 235 | )))|((( | ||
| 236 | Questions | ||
| 237 | )))|((( | ||
| 238 | This defines the question contents and possible responses. | ||
| 239 | ))) | ||
| 240 | |||
| 241 | \\ | ||
| 242 | |||
| 243 | |((( | ||
| 244 | **Response** | ||
| 245 | )))|((( | ||
| 246 | **Type** | ||
| 247 | )))|((( | ||
| 248 | **Description** | ||
| 249 | ))) | ||
| 250 | |((( | ||
| 251 | QuestionId | ||
| 252 | )))|((( | ||
| 253 | Int | ||
| 254 | )))|((( | ||
| 255 | Returns ONEcount question id on successful creation of the question. | ||
| 256 | ))) | ||
| 257 | |||
| 258 | PUT method should be used to update question.\\ | ||
| 259 | |||
| 260 | |((( | ||
| 261 | **Request** | ||
| 262 | )))|((( | ||
| 263 | **Type** | ||
| 264 | )))|((( | ||
| 265 | **Description** | ||
| 266 | ))) | ||
| 267 | |((( | ||
| 268 | Questions | ||
| 269 | )))|((( | ||
| 270 | Questions | ||
| 271 | )))|((( | ||
| 272 | This defines the question contents and responses. | ||
| 273 | ))) | ||
| 274 | |||
| 275 | \\ | ||
| 276 | |||
| 277 | |((( | ||
| 278 | **Response** | ||
| 279 | )))|((( | ||
| 280 | **Type** | ||
| 281 | )))|((( | ||
| 282 | **Description** | ||
| 283 | ))) | ||
| 284 | |((( | ||
| 285 | QuestionId | ||
| 286 | )))|((( | ||
| 287 | Int | ||
| 288 | )))|((( | ||
| 289 | Returns ONEcount question id on successful update of the question. | ||
| 290 | ))) | ||
| 291 | |||
| 292 | |||
| 293 | |||
| 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 | \\ | ||
| 312 | "Id": "6", | ||
| 313 | \\ | ||
| 314 | "Text": "FirstName", "Type": "1", | ||
| 315 | "Alias": "FName" | ||
| 316 | \\ | ||
| 317 | \} | ||
| 318 | \\ | ||
| 319 | \] | ||
| 320 | \\ | ||
| 321 | \} | ||
| 322 | \\ | ||
| 323 | \\ | ||
| 324 | *Users* | ||
| 325 | \\ | ||
| 326 | Users means the customers of your system. Users can be added, updated and searched for using the users resource from the api. For lookup, If a return parameter is specified Users object will have those fields. If nothing is specified by default only UserId is returned. | ||
| 327 | \\ | ||
| 328 | Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added. | ||
| 329 | \\ | ||
| 330 | In this case the provided demographic information in users object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated. | ||
| 331 | \\ | ||
| 332 | If username and password is not one of the parameters being passed, then a random username and password will be generated for the user while creating his user account in ONEcount. | ||
| 333 | \\ | ||
| 334 | Return parameter will have the comma separated list of question Ids that is requested back from the API. | ||
| 335 | \\ | ||
| 336 | Return is an optional parameter in request. If return is not requested then by default, only UserId (which is ONEcount ID) will be returned in the | ||
| 337 | Users object. | ||
| 338 | \\ | ||
| 339 | \\ | ||
| 340 | \\ | ||
| 341 | *Method* *Url* *Action*\\ | ||
| 342 | {{/unmigrated-wiki-markup}} | ||
| 343 | |||
| 344 | |((( | ||
| 345 | GET | ||
| 346 | )))|((( | ||
| 347 | /users | ||
| 348 | )))|((( | ||
| 349 | Get users data limiting 25. | ||
| 350 | ))) | ||
| 351 | |((( | ||
| 352 | GET | ||
| 353 | )))|((( | ||
| 354 | /users/1 | ||
| 355 | )))|((( | ||
| 356 | Get data for user id 1. The user id can be a numeric value or a hash | ||
| 357 | ))) | ||
| 358 | |((( | ||
| 359 | GET | ||
| 360 | )))|((( | ||
| 361 | /users/lookup?1=user1@ | ||
| 362 | [[(% style="color: rgb(0,51,102);" %)email.com(%%)&return=1,2>>url:http://email.com||shape="rect"]] | ||
| 363 | )))|((( | ||
| 364 | Lookup for user whose question id (1) is equal to supplied value. The users object returned will have value of questions 1 & 2. Here for example assumed to be firstname and last name. | ||
| 365 | \\Return parameter defines a csv of question id that are requested back in response. | ||
| 366 | ))) | ||
| 367 | |((( | ||
| 368 | POST | ||
| 369 | )))|((( | ||
| 370 | /users | ||
| 371 | )))|((( | ||
| 372 | Create a new users | ||
| 373 | \\Parameters required to create the user needs to be sent as post data in JSON format. | ||
| 374 | ))) | ||
| 375 | |((( | ||
| 376 | PUT | ||
| 377 | )))|((( | ||
| 378 | /users/1 | ||
| 379 | )))|((( | ||
| 380 | Update user id 1. The user id can be a numeric value or a hash | ||
| 381 | \\Parameters required to update the user needs to be sent as post data in JSON format. | ||
| 382 | ))) | ||
| 383 | |((( | ||
| 384 | GET | ||
| 385 | )))|((( | ||
| 386 | /users/1/partners/2 | ||
| 387 | )))|((( | ||
| 388 | Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash. | ||
| 389 | ))) | ||
| 390 | |((( | ||
| 391 | POST | ||
| 392 | )))|((( | ||
| 393 | /users/login | ||
| 394 | )))|((( | ||
| 395 | Check to see user exist with username/email and password. | ||
| 396 | \\Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param. | ||
| 397 | \\Example: | ||
| 398 | \\[[{"u":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","e":"abc@[[(% style="color: rgb(0,51,102);" %)one-count.com(%%)","p":"1234"}>>url:http://one-count.com||shape="rect"]] OR | ||
| 399 | [[{"u":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","p":"1234"} OR | ||
| 400 | [[{"e":"(% style="color: rgb(0,51,102);" %)abc@one-count.com>>mailto:abc@one-count.com||shape="rect"]](%%)","p":"1234"} | ||
| 401 | \\**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found. | ||
| 402 | ))) | ||
| 403 | |||
| 404 | |||
| 405 | \\**GET** **method** **should** **be** **used** **to** **lookup** **users.**\\ | ||
| 406 | |||
| 407 | |((( | ||
| 408 | **Request** | ||
| 409 | )))|((( | ||
| 410 | **Type** | ||
| 411 | )))|((( | ||
| 412 | **Description** | ||
| 413 | ))) | ||
| 414 | |((( | ||
| 415 | Lookup params | ||
| 416 | )))|((( | ||
| 417 | String | ||
| 418 | )))|((( | ||
| 419 | URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in | ||
| 420 | Users object. | ||
| 421 | \\Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[(% style="color: rgb(0,51,102);" %)email.com>>url:http://email.com||shape="rect"]](%%) | ||
| 422 | \\return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId | ||
| 423 | (String) | ||
| 424 | ))) | ||
| 425 | |||
| 426 | |||
| 427 | \\\\\\ | ||
| 428 | |||
| 429 | |((( | ||
| 430 | **Response** | ||
| 431 | )))|((( | ||
| 432 | **Type** | ||
| 433 | )))|((( | ||
| 434 | **Description** | ||
| 435 | ))) | ||
| 436 | |((( | ||
| 437 | Users | ||
| 438 | )))|((( | ||
| 439 | (% style="color: rgb(51,51,51);" %)**Users** | ||
| 440 | )))|((( | ||
| 441 | Found users returned with the demo field requested in return parameter in json format. | ||
| 442 | ))) | ||
| 443 | |||
| 444 | |||
| 445 | \\**POST** **method** **should** **be** **used** **to** **create** **users.**\\ | ||
| 446 | |||
| 447 | |((( | ||
| 448 | **Request** | ||
| 449 | )))|((( | ||
| 450 | **Type** | ||
| 451 | )))|((( | ||
| 452 | **Description** | ||
| 453 | ))) | ||
| 454 | |((( | ||
| 455 | Users | ||
| 456 | )))|((( | ||
| 457 | Users | ||
| 458 | )))|((( | ||
| 459 | Users object that contains information about user to create. PartnerId Needs to be specified. | ||
| 460 | ))) | ||
| 461 | |((( | ||
| 462 | Transactions | ||
| 463 | )))|((( | ||
| 464 | Transactions | ||
| 465 | )))|((( | ||
| 466 | (Array of) transaction object specifying parts of the transaction to be added to the new user. UserId and TransactionId, SubscriptionType will be ignored if specified. As this is new user and new transaction is being added. | ||
| 467 | ))) | ||
| 468 | |((( | ||
| 469 | DedupeColumns | ||
| 470 | )))|((( | ||
| 471 | String | ||
| 472 | )))|((( | ||
| 473 | CSV of question id's that should be considered to find duplicate. | ||
| 474 | ))) | ||
| 475 | |||
| 476 | \\ | ||
| 477 | |||
| 478 | |((( | ||
| 479 | **Response** | ||
| 480 | )))|((( | ||
| 481 | **Type** | ||
| 482 | )))|((( | ||
| 483 | **Description** | ||
| 484 | ))) | ||
| 485 | |((( | ||
| 486 | Users | ||
| 487 | )))|((( | ||
| 488 | (% style="color: rgb(51,51,51);" %)**Users** | ||
| 489 | )))|((( | ||
| 490 | Created users returned with the demo field requested in return parameter in json format. If return was not specified only | ||
| 491 | UserId will be returned. | ||
| 492 | ))) | ||
| 493 | |||
| 494 | |||
| 495 | \\**PUT** **method** **should** **be** **used** **to** **update** **users.**\\ | ||
| 496 | |||
| 497 | |((( | ||
| 498 | **Request** | ||
| 499 | )))|((( | ||
| 500 | **Type** | ||
| 501 | )))|((( | ||
| 502 | **Description** | ||
| 503 | ))) | ||
| 504 | |((( | ||
| 505 | Users | ||
| 506 | )))|((( | ||
| 507 | Users | ||
| 508 | )))|((( | ||
| 509 | Users object with update fields. Return property has csv of questions id requested back in Users object. | ||
| 510 | ))) | ||
| 511 | |((( | ||
| 512 | Return | ||
| 513 | )))|((( | ||
| 514 | String | ||
| 515 | )))|((( | ||
| 516 | CSV of ONEcount QuestionId's requested back in Users object in response | ||
| 517 | ))) | ||
| 518 | |((( | ||
| 519 | RequestDate | ||
| 520 | )))|((( | ||
| 521 | Date | ||
| 522 | )))|((( | ||
| 523 | RequestDate to use for the demo update. If not provided current date will be used. | ||
| 524 | ))) | ||
| 525 | |||
| 526 | \\ | ||
| 527 | |||
| 528 | |((( | ||
| 529 | **Response** | ||
| 530 | )))|((( | ||
| 531 | **Type** | ||
| 532 | )))|((( | ||
| 533 | **Description** | ||
| 534 | ))) | ||
| 535 | |((( | ||
| 536 | Users | ||
| 537 | )))|((( | ||
| 538 | (% style="color: rgb(51,51,51);" %)**Users** | ||
| 539 | )))|((( | ||
| 540 | Updated user returned with the demo field requested in return parameter in json format. | ||
| 541 | ))) | ||
| 542 | |||
| 543 | |||
| 544 | \\\\\\Create new users. Here in this example the JSON for request is passed in userFile.json file. | ||
| 545 | (% style="color: rgb(51,51,51);" %)curl(%%) (% style="color: rgb(51,51,51);" %)-X(%%) (% style="color: rgb(51,51,51);" %)POST(%%) (% style="color: rgb(51,51,51);" %)-H(%%) (% style="color: rgb(51,51,51);" %)"Appkey:(%%) (% style="color: rgb(51,51,51);" %)xxx"(%%) (% style="color: rgb(51,51,51);" %)-H(%%) (% style="color: rgb(51,51,51);" %)"Content-Type:(%%) (% style="color: rgb(51,51,51);" %)application/json"(%%) (% style="color: rgb(51,51,51);" %)–data-binary(%%) (% style="color: rgb(51,51,51);" %)-d(%%) (% style="color: rgb(51,51,51);" %)'@userFile.json'(%%) (% style="color: rgb(51,51,51);" %)[[https:~~/~~/api.onecount.net/v2/users>>url:https://api.onecount.net/v2/users||rel="nofollow" shape="rect" class="external-link"]](%%) (mailto~:@userFile.json) | ||
| 546 | **Products** | ||
| 547 | This resource is for manipulating products resource. A product can be created, updated or searched.\\ | ||
| 548 | |||
| 549 | |((( | ||
| 550 | **Method** | ||
| 551 | )))|((( | ||
| 552 | **Url** | ||
| 553 | )))|((( | ||
| 554 | **Action** | ||
| 555 | ))) | ||
| 556 | |((( | ||
| 557 | GET | ||
| 558 | )))|((( | ||
| 559 | /products | ||
| 560 | )))|((( | ||
| 561 | Get all product details | ||
| 562 | ))) | ||
| 563 | |((( | ||
| 564 | GET | ||
| 565 | )))|((( | ||
| 566 | /products/5 | ||
| 567 | )))|((( | ||
| 568 | Get product id 5 | ||
| 569 | ))) | ||
| 570 | |((( | ||
| 571 | GET | ||
| 572 | )))|((( | ||
| 573 | /products/lookup?Title=productname | ||
| 574 | )))|((( | ||
| 575 | Lookup products by Title | ||
| 576 | ))) | ||
| 577 | |((( | ||
| 578 | POST | ||
| 579 | )))|((( | ||
| 580 | /products | ||
| 581 | )))|((( | ||
| 582 | JSON of the Products type object needs to be sent as post data. Id field should not be sent. | ||
| 583 | ))) | ||
| 584 | |((( | ||
| 585 | PUT | ||
| 586 | )))|((( | ||
| 587 | /products/5 | ||
| 588 | )))|((( | ||
| 589 | JSON of the Products type object needs to be sent as post data. Id field is mandatory for update. | ||
| 590 | ))) | ||
| 591 | |((( | ||
| 592 | POST | ||
| 593 | )))|((( | ||
| 594 | /products/attachResource | ||
| 595 | )))|((( | ||
| 596 | JSON of the Product and Resource ids to be sent as post data. Both fields are mandatory. | ||
| 597 | Example: | ||
| 598 | \\{"ProductID":"65","ResourceID":"121"} | ||
| 599 | ))) | ||
| 600 | |||
| 601 | |||
| 602 | \\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\ | ||
| 603 | |||
| 604 | |((( | ||
| 605 | **Request** | ||
| 606 | )))|((( | ||
| 607 | **Type** | ||
| 608 | )))|((( | ||
| 609 | **Description** | ||
| 610 | ))) | ||
| 611 | |((( | ||
| 612 | Lookup params | ||
| 613 | )))|((( | ||
| 614 | String | ||
| 615 | )))|((( | ||
| 616 | URL encoded key value string parameter for the lookup. Params: | ||
| 617 | Name: Name of the Product for lookup (String) | ||
| 618 | ))) | ||
| 619 | |||
| 620 | |||
| 621 | **Response** **Type** **Description** | ||
| 622 | |||
| 623 | \\**POST** **method** **should** **be** **used** **to** **create** **products.**\\ | ||
| 624 | |||
| 625 | |((( | ||
| 626 | **Request** | ||
| 627 | )))|((( | ||
| 628 | **Type** | ||
| 629 | )))|((( | ||
| 630 | **Description** | ||
| 631 | ))) | ||
| 632 | |((( | ||
| 633 | Products | ||
| 634 | )))|((( | ||
| 635 | Products | ||
| 636 | )))|((( | ||
| 637 | Product details in json to be sent as post data. Id should not be set. Example: | ||
| 638 | {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17} | ||
| 639 | ))) | ||
| 640 | |||
| 641 | \\ | ||
| 642 | |||
| 643 | |((( | ||
| 644 | **Response** | ||
| 645 | )))|((( | ||
| 646 | **Type** | ||
| 647 | )))|((( | ||
| 648 | **Description** | ||
| 649 | ))) | ||
| 650 | |((( | ||
| 651 | ProductId | ||
| 652 | )))|((( | ||
| 653 | int | ||
| 654 | )))|((( | ||
| 655 | Product Id of the newly created product. | ||
| 656 | ))) | ||
| 657 | |||
| 658 | |||
| 659 | \\PUT method should be used to update an individual product given the product info.\\ | ||
| 660 | |||
| 661 | |((( | ||
| 662 | **Request** | ||
| 663 | )))|((( | ||
| 664 | **Type** | ||
| 665 | )))|((( | ||
| 666 | **Description** | ||
| 667 | ))) | ||
| 668 | |((( | ||
| 669 | Products | ||
| 670 | )))|((( | ||
| 671 | Product | ||
| 672 | )))|((( | ||
| 673 | Product details to be updated in json format to be sent with request. Id property needs to be set to identify the product to be updated. If you send term and resource along with product creation then it will automatically attach term to product and resource to product. | ||
| 674 | \\**Possible** **Request** **Params**: Title, Description, PrimaryFormId, ResourceID | ||
| 675 | \\**Example**: | ||
| 676 | \\{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17} | ||
| 677 | ))) | ||
| 678 | |||
| 679 | \\ | ||
| 680 | |||
| 681 | |((( | ||
| 682 | **Response** | ||
| 683 | )))|((( | ||
| 684 | **Type** | ||
| 685 | )))|((( | ||
| 686 | **Description** | ||
| 687 | ))) | ||
| 688 | |((( | ||
| 689 | ProductId | ||
| 690 | )))|((( | ||
| 691 | Int | ||
| 692 | )))|((( | ||
| 693 | Product id of the updated product. | ||
| 694 | ))) | ||
| 695 | |||
| 696 | |||
| 697 | \\**Terms** | ||
| 698 | This resource is for manipulating terms resource. A term can be created, updated or searched.\\ | ||
| 699 | |||
| 700 | |((( | ||
| 701 | **Method** | ||
| 702 | )))|((( | ||
| 703 | **Url** | ||
| 704 | )))|((( | ||
| 705 | **Action** | ||
| 706 | ))) | ||
| 707 | |((( | ||
| 708 | GET | ||
| 709 | )))|((( | ||
| 710 | /terms/5 | ||
| 711 | )))|((( | ||
| 712 | Get term id 5 | ||
| 713 | ))) | ||
| 714 | |((( | ||
| 715 | GET | ||
| 716 | )))|((( | ||
| 717 | /terms/lookup?Name=termname | ||
| 718 | )))|((( | ||
| 719 | Lookup terms by Name | ||
| 720 | ))) | ||
| 721 | |((( | ||
| 722 | POST | ||
| 723 | )))|((( | ||
| 724 | /terms | ||
| 725 | )))|((( | ||
| 726 | JSON of the terms type object needs to be sent as post data. Id field should not be sent. | ||
| 727 | ))) | ||
| 728 | |((( | ||
| 729 | PUT | ||
| 730 | )))|((( | ||
| 731 | /terms/5 | ||
| 732 | )))|((( | ||
| 733 | JSON of the terms type object needs to be sent as post data. Id field is mandatory for update. | ||
| 734 | ))) | ||
| 735 | |||
| 736 | |||
| 737 | \\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\ | ||
| 738 | |||
| 739 | |((( | ||
| 740 | **Request** | ||
| 741 | )))|((( | ||
| 742 | **Type** | ||
| 743 | )))|((( | ||
| 744 | **Description** | ||
| 745 | ))) | ||
| 746 | |((( | ||
| 747 | Lookup params | ||
| 748 | )))|((( | ||
| 749 | String | ||
| 750 | )))|((( | ||
| 751 | URL encoded key value string parameter for the lookup. Params: | ||
| 752 | Name: Name of the term for lookup (String) | ||
| 753 | ))) | ||
| 754 | |||
| 755 | \\ | ||
| 756 | |||
| 757 | |((( | ||
| 758 | **Response** | ||
| 759 | )))|((( | ||
| 760 | **Type** | ||
| 761 | )))|((( | ||
| 762 | **Description** | ||
| 763 | ))) | ||
| 764 | |((( | ||
| 765 | Terms | ||
| 766 | )))|((( | ||
| 767 | Terms | ||
| 768 | )))|((( | ||
| 769 | Returns found term details. | ||
| 770 | ))) | ||
| 771 | |||
| 772 | \\ | ||
| 773 | |||
| 774 | |((( | ||
| 775 | **Request** | ||
| 776 | )))|((( | ||
| 777 | **Type** | ||
| 778 | )))|((( | ||
| 779 | **Description** | ||
| 780 | ))) | ||
| 781 | |((( | ||
| 782 | Terms | ||
| 783 | )))|((( | ||
| 784 | Terms | ||
| 785 | )))|((( | ||
| 786 | Term details in json to be sent as post data. Id should not be set. | ||
| 787 | \\**Possible** **Request** **Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt | ||
| 788 | \\**Example**: | ||
| 789 | \\{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17} | ||
| 790 | ))) | ||
| 791 | |||
| 792 | \\ | ||
| 793 | |||
| 794 | |((( | ||
| 795 | **Response** | ||
| 796 | )))|((( | ||
| 797 | **Type** | ||
| 798 | )))|((( | ||
| 799 | **Description** | ||
| 800 | ))) | ||
| 801 | |((( | ||
| 802 | TermId | ||
| 803 | )))|((( | ||
| 804 | int | ||
| 805 | )))|((( | ||
| 806 | Term Id of the newly created term. | ||
| 807 | ))) | ||
| 808 | |||
| 809 | |||
| 810 | \\PUT method should be used to update an individual term given the term info.\\ | ||
| 811 | |||
| 812 | |((( | ||
| 813 | **Request** | ||
| 814 | )))|((( | ||
| 815 | **Type** | ||
| 816 | )))|((( | ||
| 817 | **Description** | ||
| 818 | ))) | ||
| 819 | |((( | ||
| 820 | Terms | ||
| 821 | )))|((( | ||
| 822 | Term | ||
| 823 | )))|((( | ||
| 824 | Term details to be updated in json format to be sent with request. Id property needs to be set to identify the term to be updated. | ||
| 825 | \\\\**Example**: | ||
| 826 | \\{"Name":"Test123","Description":Testss","Duration":10,"ProductId":17} | ||
| 827 | ))) | ||
| 828 | |||
| 829 | \\ | ||
| 830 | |||
| 831 | |((( | ||
| 832 | **Response** | ||
| 833 | )))|((( | ||
| 834 | **Type** | ||
| 835 | )))|((( | ||
| 836 | **Description** | ||
| 837 | ))) | ||
| 838 | |((( | ||
| 839 | TermId | ||
| 840 | )))|((( | ||
| 841 | Int | ||
| 842 | )))|((( | ||
| 843 | term id of the updated term. | ||
| 844 | ))) | ||
| 845 | |||
| 846 | |||
| 847 | \\**Resources** | ||
| 848 | This resource is for manipulating resources resource. A resource can be created, updated or searched.\\ | ||
| 849 | |||
| 850 | |((( | ||
| 851 | **Method** | ||
| 852 | )))|((( | ||
| 853 | **Url** | ||
| 854 | )))|((( | ||
| 855 | **Action** | ||
| 856 | ))) | ||
| 857 | |((( | ||
| 858 | GET | ||
| 859 | )))|((( | ||
| 860 | /resources/5 | ||
| 861 | )))|((( | ||
| 862 | Get resource id 5 | ||
| 863 | ))) | ||
| 864 | |((( | ||
| 865 | GET | ||
| 866 | )))|((( | ||
| 867 | /resources/lookup?Name=resourcename | ||
| 868 | )))|((( | ||
| 869 | Lookup resources by Name | ||
| 870 | ))) | ||
| 871 | |((( | ||
| 872 | POST | ||
| 873 | )))|((( | ||
| 874 | /resources | ||
| 875 | )))|((( | ||
| 876 | JSON of the resources type object needs to be sent as post data. Id field should not be sent. | ||
| 877 | ))) | ||
| 878 | |((( | ||
| 879 | PUT | ||
| 880 | )))|((( | ||
| 881 | /resources/5 | ||
| 882 | )))|((( | ||
| 883 | JSON of the resources type object needs to be sent as post data. Id field is mandatory for update. | ||
| 884 | ))) | ||
| 885 | |||
| 886 | |||
| 887 | \\**GET** **method** **should** **be** **used** **to** **lookup** **products.**\\ | ||
| 888 | |||
| 889 | |((( | ||
| 890 | **Request** | ||
| 891 | )))|((( | ||
| 892 | **Type** | ||
| 893 | )))|((( | ||
| 894 | **Description** | ||
| 895 | ))) | ||
| 896 | |((( | ||
| 897 | Lookup params | ||
| 898 | )))|((( | ||
| 899 | String | ||
| 900 | )))|((( | ||
| 901 | URL encoded key value string parameter for the lookup. Params: | ||
| 902 | Name: Name of the resource for lookup (String) | ||
| 903 | ))) | ||
| 904 | |||
| 905 | \\ | ||
| 906 | |||
| 907 | |((( | ||
| 908 | **Response** | ||
| 909 | )))|((( | ||
| 910 | **Type** | ||
| 911 | )))|((( | ||
| 912 | **Description** | ||
| 913 | ))) | ||
| 914 | |((( | ||
| 915 | Resources | ||
| 916 | )))|((( | ||
| 917 | Resources | ||
| 918 | )))|((( | ||
| 919 | Returns found resource details. | ||
| 920 | ))) | ||
| 921 | |||
| 922 | \\ | ||
| 923 | |||
| 924 | |((( | ||
| 925 | **Request** | ||
| 926 | )))|((( | ||
| 927 | **Type** | ||
| 928 | )))|((( | ||
| 929 | **Description** | ||
| 930 | ))) | ||
| 931 | |((( | ||
| 932 | Resources | ||
| 933 | )))|((( | ||
| 934 | Resources | ||
| 935 | )))|((( | ||
| 936 | resource details in json to be sent as post data. Id should not be set. **Possible** **Request** **Params**: Name, Description, Type, Value **Example**: | ||
| 937 | {"Name":"Test123","Description":Testss","Type":3,"Value":"/digital/"} | ||
| 938 | ))) | ||
| 939 | |||
| 940 | \\ | ||
| 941 | |||
| 942 | |((( | ||
| 943 | **Response** | ||
| 944 | )))|((( | ||
| 945 | **Type** | ||
| 946 | )))|((( | ||
| 947 | **Description** | ||
| 948 | ))) | ||
| 949 | |((( | ||
| 950 | ResourceId | ||
| 951 | )))|((( | ||
| 952 | int | ||
| 953 | )))|((( | ||
| 954 | Resource Id of the newly created resource. | ||
| 955 | ))) | ||
| 956 | |||
| 957 | |||
| 958 | \\PUT method should be used to update an individual resource given the resource info.\\ | ||
| 959 | |||
| 960 | |((( | ||
| 961 | **Request** | ||
| 962 | )))|((( | ||
| 963 | **Type** | ||
| 964 | )))|((( | ||
| 965 | **Description** | ||
| 966 | ))) | ||
| 967 | |((( | ||
| 968 | Resources | ||
| 969 | )))|((( | ||
| 970 | Resource | ||
| 971 | )))|((( | ||
| 972 | Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated. | ||
| 973 | \\\\Example: | ||
| 974 | \\{"Name":"Test123","Description":Testss","Type":3,"Value":"/digital/"} | ||
| 975 | ))) | ||
| 976 | |||
| 977 | \\ | ||
| 978 | |||
| 979 | |((( | ||
| 980 | **Response** | ||
| 981 | )))|((( | ||
| 982 | **Type** | ||
| 983 | )))|((( | ||
| 984 | **Description** | ||
| 985 | ))) | ||
| 986 | |((( | ||
| 987 | ResourceId | ||
| 988 | )))|((( | ||
| 989 | Int | ||
| 990 | )))|((( | ||
| 991 | resource id of the updated resource. | ||
| 992 | ))) | ||
| 993 | |||
| 994 | |||
| 995 | \\\\\\\\\\**Sources** | ||
| 996 | This resource is for manipulating sources resource. A source can be created, updated or searched.\\ | ||
| 997 | |||
| 998 | |((( | ||
| 999 | **Method** | ||
| 1000 | )))|((( | ||
| 1001 | **Url** | ||
| 1002 | )))|((( | ||
| 1003 | **Action** | ||
| 1004 | ))) | ||
| 1005 | |((( | ||
| 1006 | GET | ||
| 1007 | )))|((( | ||
| 1008 | /sources/1 | ||
| 1009 | )))|((( | ||
| 1010 | Get source id 1. | ||
| 1011 | ))) | ||
| 1012 | |((( | ||
| 1013 | GET | ||
| 1014 | )))|((( | ||
| 1015 | /sources/lookup?Source=sourcename | ||
| 1016 | )))|((( | ||
| 1017 | Lookup sources by source. | ||
| 1018 | ))) | ||
| 1019 | |((( | ||
| 1020 | POST | ||
| 1021 | )))|((( | ||
| 1022 | /sources | ||
| 1023 | )))|((( | ||
| 1024 | JSON of the Sources type object needs to be sent as post data. Id field should not be sent. | ||
| 1025 | ))) | ||
| 1026 | |((( | ||
| 1027 | PUT | ||
| 1028 | )))|((( | ||
| 1029 | /sources | ||
| 1030 | )))|((( | ||
| 1031 | JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update. | ||
| 1032 | ))) | ||
| 1033 | |||
| 1034 | |||
| 1035 | \\**Sources** **can** **be** **looked** **up** **given** **the** **code** **or** **Id.** **GET** **method** **should** **be** **used** **for** **lookup.**\\ | ||
| 1036 | |||
| 1037 | |((( | ||
| 1038 | **Request** | ||
| 1039 | )))|((( | ||
| 1040 | **Type** | ||
| 1041 | )))|((( | ||
| 1042 | **Description** | ||
| 1043 | ))) | ||
| 1044 | |((( | ||
| 1045 | Lookup params | ||
| 1046 | )))|((( | ||
| 1047 | String | ||
| 1048 | )))|((( | ||
| 1049 | URL encoded key value string parameter for the lookup. Params: | ||
| 1050 | Source: Source value (String) | ||
| 1051 | ))) | ||
| 1052 | |||
| 1053 | \\ | ||
| 1054 | |||
| 1055 | |((( | ||
| 1056 | **Response** | ||
| 1057 | )))|((( | ||
| 1058 | **Type** | ||
| 1059 | )))|((( | ||
| 1060 | **Description** | ||
| 1061 | ))) | ||
| 1062 | |((( | ||
| 1063 | Sources | ||
| 1064 | )))|((( | ||
| 1065 | Sources | ||
| 1066 | )))|((( | ||
| 1067 | Returns found source details. | ||
| 1068 | ))) | ||
| 1069 | |||
| 1070 | |||
| 1071 | POST method should be used to create an individual source given the source parameters.\\ | ||
| 1072 | |||
| 1073 | |((( | ||
| 1074 | **Request** | ||
| 1075 | )))|((( | ||
| 1076 | **Type** | ||
| 1077 | )))|((( | ||
| 1078 | **Description** | ||
| 1079 | ))) | ||
| 1080 | |((( | ||
| 1081 | Sources | ||
| 1082 | )))|((( | ||
| 1083 | Sources | ||
| 1084 | )))|((( | ||
| 1085 | Defines the contents that makes up the source. Id parameters should not be set. | ||
| 1086 | ))) | ||
| 1087 | |||
| 1088 | \\ | ||
| 1089 | |||
| 1090 | |((( | ||
| 1091 | **Response** | ||
| 1092 | )))|((( | ||
| 1093 | **Type** | ||
| 1094 | )))|((( | ||
| 1095 | **Description** | ||
| 1096 | ))) | ||
| 1097 | |((( | ||
| 1098 | SourceId | ||
| 1099 | )))|((( | ||
| 1100 | int | ||
| 1101 | )))|((( | ||
| 1102 | Returns created source code id. | ||
| 1103 | ))) | ||
| 1104 | |||
| 1105 | |||
| 1106 | \\**PUT** **method** **can** **be** **used** **to** **update** **an** **individual** **source** **given** **the** **id.**\\ | ||
| 1107 | |||
| 1108 | |((( | ||
| 1109 | **Request** | ||
| 1110 | )))|((( | ||
| 1111 | **Type** | ||
| 1112 | )))|((( | ||
| 1113 | **Description** | ||
| 1114 | ))) | ||
| 1115 | |((( | ||
| 1116 | Sources | ||
| 1117 | )))|((( | ||
| 1118 | Sources | ||
| 1119 | )))|((( | ||
| 1120 | Defines the contents that makes up the source. The id parameter needs to be set which will identify the id of the source to be updated. | ||
| 1121 | ))) | ||
| 1122 | |||
| 1123 | \\ | ||
| 1124 | |||
| 1125 | |((( | ||
| 1126 | **Response** | ||
| 1127 | )))|((( | ||
| 1128 | **Type** | ||
| 1129 | )))|((( | ||
| 1130 | **Description** | ||
| 1131 | ))) | ||
| 1132 | |((( | ||
| 1133 | SourceId | ||
| 1134 | )))|((( | ||
| 1135 | int | ||
| 1136 | )))|((( | ||
| 1137 | Returns updated source id. | ||
| 1138 | ))) | ||
| 1139 | |||
| 1140 | |||
| 1141 | \\\\\\**Transactions** | ||
| 1142 | This resource is for manipulating transactions resource. A transaction can be created or searched.\\ | ||
| 1143 | |||
| 1144 | |((( | ||
| 1145 | **Method** | ||
| 1146 | )))|((( | ||
| 1147 | **Url** | ||
| 1148 | )))|((( | ||
| 1149 | **Action** | ||
| 1150 | ))) | ||
| 1151 | |((( | ||
| 1152 | GET | ||
| 1153 | )))|((( | ||
| 1154 | /transactions | ||
| 1155 | )))|((( | ||
| 1156 | List all transactions | ||
| 1157 | ))) | ||
| 1158 | |((( | ||
| 1159 | GET | ||
| 1160 | )))|((( | ||
| 1161 | /transactions/lookup?UserId=1 | ||
| 1162 | )))|((( | ||
| 1163 | Lookup all transaction of UserId = 1 | ||
| 1164 | ))) | ||
| 1165 | |((( | ||
| 1166 | POST | ||
| 1167 | )))|((( | ||
| 1168 | /transactions | ||
| 1169 | )))|((( | ||
| 1170 | JSON of the Transactions type object needs to be sent as post data. Id field should not be sent. | ||
| 1171 | ))) | ||
| 1172 | |||
| 1173 | |||
| 1174 | \\\\\\Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.\\ | ||
| 1175 | |||
| 1176 | |((( | ||
| 1177 | **Request** | ||
| 1178 | )))|((( | ||
| 1179 | **Type** | ||
| 1180 | )))|((( | ||
| 1181 | **Description** | ||
| 1182 | ))) | ||
| 1183 | |((( | ||
| 1184 | Lookup params | ||
| 1185 | )))|((( | ||
| 1186 | String | ||
| 1187 | )))|((( | ||
| 1188 | URL encoded key value string parameter for the lookup. Params: | ||
| 1189 | UserId: Id of the user whose transaction is to be looked up (Int) | ||
| 1190 | StartDate: Date from which the start should happen. Only valid when UserId is set. (Date) EndDate: When the search should end. Only valid when UserId is set. (Date) | ||
| 1191 | ))) | ||
| 1192 | |||
| 1193 | |||
| 1194 | \\\\\\ | ||
| 1195 | |||
| 1196 | |((( | ||
| 1197 | **Response** | ||
| 1198 | )))|((( | ||
| 1199 | **Type** | ||
| 1200 | )))|((( | ||
| 1201 | **Description** | ||
| 1202 | ))) | ||
| 1203 | |((( | ||
| 1204 | Transactions | ||
| 1205 | )))|((( | ||
| 1206 | Transactions | ||
| 1207 | )))|((( | ||
| 1208 | Returns all transaction that satisfies the search criteria. | ||
| 1209 | ))) | ||
| 1210 | |||
| 1211 | |||
| 1212 | \\POST method can be used to create user transaction. Transaction info needs to be sent as request and a TransactionId will be returned when thetransaction is created.\\ | ||
| 1213 | |||
| 1214 | |((( | ||
| 1215 | **Request** | ||
| 1216 | )))|((( | ||
| 1217 | **Type** | ||
| 1218 | )))|((( | ||
| 1219 | **Description** | ||
| 1220 | ))) | ||
| 1221 | |((( | ||
| 1222 | Transactions | ||
| 1223 | )))|((( | ||
| 1224 | Transactions | ||
| 1225 | )))|((( | ||
| 1226 | Contains fields that define a transaction. Id field should not be set. | ||
| 1227 | ))) | ||
| 1228 | |||
| 1229 | \\ | ||
| 1230 | |||
| 1231 | |((( | ||
| 1232 | **Response** | ||
| 1233 | )))|((( | ||
| 1234 | **Type** | ||
| 1235 | )))|((( | ||
| 1236 | **Description** | ||
| 1237 | ))) | ||
| 1238 | |((( | ||
| 1239 | TransactionId | ||
| 1240 | )))|((( | ||
| 1241 | int | ||
| 1242 | )))|((( | ||
| 1243 | Returns transactionId of the newly created transaction. | ||
| 1244 | ))) | ||
| 1245 | |||
| 1246 | |||
| 1247 | \\**Stats** | ||
| 1248 | Stats resource can be used to submit any type of stat collected on the third party systems. Each type of stat will be represented by a | ||
| 1249 | sub-resource. So, for telemarketing it could be **/stats/telemarketing** endpoint, for videos it can be **/stats/videos**, for webinar it could be **/stats/we** **binars** etc. Right now we only have telemarketing sub-resource. | ||
| 1250 | \\\\\\\\\\\\\\\\**Telemarketing** | ||
| 1251 | \\This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.\\ | ||
| 1252 | |||
| 1253 | |((( | ||
| 1254 | **Method** | ||
| 1255 | )))|((( | ||
| 1256 | **Url** | ||
| 1257 | )))|((( | ||
| 1258 | **Action** | ||
| 1259 | ))) | ||
| 1260 | |((( | ||
| 1261 | GET | ||
| 1262 | )))|((( | ||
| 1263 | /stats/telemarketing | ||
| 1264 | )))|((( | ||
| 1265 | List telemarketing stats | ||
| 1266 | ))) | ||
| 1267 | |((( | ||
| 1268 | GET | ||
| 1269 | )))|((( | ||
| 1270 | /stats/telemarketing/1000 | ||
| 1271 | )))|((( | ||
| 1272 | Get telemarketing stat whose id is 1000 in the system. | ||
| 1273 | ))) | ||
| 1274 | |((( | ||
| 1275 | POST | ||
| 1276 | )))|((( | ||
| 1277 | /stats/telemarketing | ||
| 1278 | )))|((( | ||
| 1279 | JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent. | ||
| 1280 | ))) | ||
| 1281 | |||
| 1282 | |||
| 1283 | \\POST method can be used to create telemarketing stat. Telemarketing info needs to be sent as request and an Id will be returned when the transaction is created. | ||
| 1284 | **Request** **Type** **Description**\\ | ||
| 1285 | |||
| 1286 | |((( | ||
| 1287 | Telemarketing | ||
| 1288 | )))|((( | ||
| 1289 | Telemarketing | ||
| 1290 | )))|((( | ||
| 1291 | Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section. | ||
| 1292 | ))) | ||
| 1293 | |((( | ||
| 1294 | |||
| 1295 | )))|((( | ||
| 1296 | |||
| 1297 | )))|((( | ||
| 1298 | |||
| 1299 | )))|((( | ||
| 1300 | Workflow: OCID: This id is required field. This represents the unique id of the user in onecount system. This id can be looked up from the /user/lookup resource if the ocid is not known by providing user demographic questions, if not found new user needs to be created in the onecount system by posting the user demographic from /user resource. If the ocid is found send the demo data to user resource (PUT) to update the demographic information. | ||
| 1301 | ))) | ||
| 1302 | |((( | ||
| 1303 | |||
| 1304 | )))|((( | ||
| 1305 | |||
| 1306 | )))|((( | ||
| 1307 | |||
| 1308 | )))|((( | ||
| 1309 | E.g | ||
| 1310 | ))) | ||
| 1311 | |((( | ||
| 1312 | |||
| 1313 | )))|((( | ||
| 1314 | |||
| 1315 | )))|((( | ||
| 1316 | |||
| 1317 | )))|((( | ||
| 1318 | { | ||
| 1319 | ))) | ||
| 1320 | |((( | ||
| 1321 | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd8549bf-7710-433a-9bfa-2d563e29983f"><ac:plain-text-body><![CDATA[ | ||
| 1322 | )))|((( | ||
| 1323 | |||
| 1324 | )))|((( | ||
| 1325 | |||
| 1326 | )))|((( | ||
| 1327 | |||
| 1328 | )))|((( | ||
| 1329 | "Telemarketing":[ | ||
| 1330 | )))|((( | ||
| 1331 | ]]></ac:plain-text-body></ac:structured-macro> | ||
| 1332 | ))) | ||
| 1333 | |((( | ||
| 1334 | |||
| 1335 | )))|((( | ||
| 1336 | |||
| 1337 | )))|((( | ||
| 1338 | |||
| 1339 | )))|((( | ||
| 1340 | { | ||
| 1341 | ))) | ||
| 1342 | |((( | ||
| 1343 | |||
| 1344 | )))|((( | ||
| 1345 | |||
| 1346 | )))|((( | ||
| 1347 | |||
| 1348 | )))|((( | ||
| 1349 | "OCID":"5000", | ||
| 1350 | ))) | ||
| 1351 | |((( | ||
| 1352 | |||
| 1353 | )))|((( | ||
| 1354 | |||
| 1355 | )))|((( | ||
| 1356 | |||
| 1357 | )))|((( | ||
| 1358 | "Date": "2016-01-01", | ||
| 1359 | ))) | ||
| 1360 | |((( | ||
| 1361 | |||
| 1362 | )))|((( | ||
| 1363 | |||
| 1364 | )))|((( | ||
| 1365 | |||
| 1366 | )))|((( | ||
| 1367 | "Time": "10:10:10", | ||
| 1368 | ))) | ||
| 1369 | |((( | ||
| 1370 | |||
| 1371 | )))|((( | ||
| 1372 | |||
| 1373 | )))|((( | ||
| 1374 | |||
| 1375 | )))|((( | ||
| 1376 | "ResourceId":"250", | ||
| 1377 | ))) | ||
| 1378 | |((( | ||
| 1379 | |||
| 1380 | )))|((( | ||
| 1381 | |||
| 1382 | )))|((( | ||
| 1383 | |||
| 1384 | )))|((( | ||
| 1385 | [["PageUrl": "http:~~/~~/www.one-count.com/detail/a.php",>>url:http://www.one-count.com/detail/a.php||shape="rect"]] | ||
| 1386 | ))) | ||
| 1387 | |((( | ||
| 1388 | |||
| 1389 | )))|((( | ||
| 1390 | |||
| 1391 | )))|((( | ||
| 1392 | |||
| 1393 | )))|((( | ||
| 1394 | "PageTitle":"tests" | ||
| 1395 | ))) | ||
| 1396 | |((( | ||
| 1397 | |||
| 1398 | )))|((( | ||
| 1399 | |||
| 1400 | )))|((( | ||
| 1401 | |||
| 1402 | )))|((( | ||
| 1403 | } | ||
| 1404 | ))) | ||
| 1405 | |((( | ||
| 1406 | |||
| 1407 | )))|((( | ||
| 1408 | |||
| 1409 | )))|((( | ||
| 1410 | |||
| 1411 | )))|((( | ||
| 1412 | ] | ||
| 1413 | ))) | ||
| 1414 | |((( | ||
| 1415 | |||
| 1416 | )))|((( | ||
| 1417 | |||
| 1418 | )))|((( | ||
| 1419 | |||
| 1420 | )))|((( | ||
| 1421 | } | ||
| 1422 | ))) | ||
| 1423 | |||
| 1424 | \\ | ||
| 1425 | |||
| 1426 | |((( | ||
| 1427 | **Response** | ||
| 1428 | )))|((( | ||
| 1429 | **Type** | ||
| 1430 | )))|((( | ||
| 1431 | **Description** | ||
| 1432 | ))) | ||
| 1433 | |((( | ||
| 1434 | Ids | ||
| 1435 | )))|((( | ||
| 1436 | String | ||
| 1437 | )))|((( | ||
| 1438 | Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format. | ||
| 1439 | ))) | ||
| 1440 | |||
| 1441 | |||
| 1442 | \\**Reference** | ||
| 1443 | **Type:** **Questions**\\ | ||
| 1444 | |||
| 1445 | |((( | ||
| 1446 | **Property** | ||
| 1447 | **Name** | ||
| 1448 | )))|((( | ||
| 1449 | **Type** | ||
| 1450 | )))|((( | ||
| 1451 | **Description** | ||
| 1452 | ))) | ||
| 1453 | |((( | ||
| 1454 | Id | ||
| 1455 | )))|((( | ||
| 1456 | Int | ||
| 1457 | )))|((( | ||
| 1458 | Id of the question. | ||
| 1459 | ))) | ||
| 1460 | |((( | ||
| 1461 | Text | ||
| 1462 | )))|((( | ||
| 1463 | String | ||
| 1464 | )))|((( | ||
| 1465 | Text of the question. | ||
| 1466 | ))) | ||
| 1467 | |((( | ||
| 1468 | Type | ||
| 1469 | )))|((( | ||
| 1470 | Int | ||
| 1471 | )))|((( | ||
| 1472 | Determines which type of question it is. Textbox, checkbox, select, radio. There can be 6 types of questions. | ||
| 1473 | type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters. | ||
| 1474 | type=2 means textarea type question or long response type question. | ||
| 1475 | type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as * | ||
| 1476 | type = 4 means select or dropdown type questions. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the select question. | ||
| 1477 | type=5 means radio button type question. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the radio question. | ||
| 1478 | type=6 means checkbox type question. This is a multiple choice, multi response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the | ||
| 1479 | checkbox question. | ||
| 1480 | ))) | ||
| 1481 | |((( | ||
| 1482 | Choices | ||
| 1483 | )))|((( | ||
| 1484 | choices | ||
| 1485 | )))|((( | ||
| 1486 | If multiple choice question this field will have the choices. | ||
| 1487 | ))) | ||
| 1488 | |((( | ||
| 1489 | Alias | ||
| 1490 | )))|((( | ||
| 1491 | String | ||
| 1492 | )))|((( | ||
| 1493 | Alias for admin purpose. | ||
| 1494 | ))) | ||
| 1495 | |||
| 1496 | |||
| 1497 | \\**Type:** **Choices**\\ | ||
| 1498 | |||
| 1499 | |((( | ||
| 1500 | **Property** **Name** | ||
| 1501 | )))|((( | ||
| 1502 | **Type** | ||
| 1503 | )))|((( | ||
| 1504 | **Description** | ||
| 1505 | ))) | ||
| 1506 | |((( | ||
| 1507 | Id | ||
| 1508 | )))|((( | ||
| 1509 | int | ||
| 1510 | )))|((( | ||
| 1511 | Id of the choice. | ||
| 1512 | ))) | ||
| 1513 | |((( | ||
| 1514 | Text | ||
| 1515 | )))|((( | ||
| 1516 | string | ||
| 1517 | )))|((( | ||
| 1518 | Display text of choice. | ||
| 1519 | ))) | ||
| 1520 | |((( | ||
| 1521 | Value | ||
| 1522 | )))|((( | ||
| 1523 | String | ||
| 1524 | )))|((( | ||
| 1525 | Value stored in db. | ||
| 1526 | ))) | ||
| 1527 | |((( | ||
| 1528 | Order | ||
| 1529 | )))|((( | ||
| 1530 | Int | ||
| 1531 | )))|((( | ||
| 1532 | Display order. | ||
| 1533 | ))) | ||
| 1534 | |((( | ||
| 1535 | QuestionId | ||
| 1536 | )))|((( | ||
| 1537 | Int | ||
| 1538 | )))|((( | ||
| 1539 | Tied to which question id. | ||
| 1540 | ))) | ||
| 1541 | |||
| 1542 | |||
| 1543 | \\**Type:** **Users**\\ | ||
| 1544 | |||
| 1545 | |((( | ||
| 1546 | **Property** **Name** | ||
| 1547 | )))|((( | ||
| 1548 | **Type** | ||
| 1549 | )))|((( | ||
| 1550 | **Description** | ||
| 1551 | ))) | ||
| 1552 | |((( | ||
| 1553 | Id | ||
| 1554 | )))|((( | ||
| 1555 | Int | ||
| 1556 | )))|((( | ||
| 1557 | ID of the user in ONEcount. | ||
| 1558 | ))) | ||
| 1559 | |((( | ||
| 1560 | PartnerId | ||
| 1561 | )))|((( | ||
| 1562 | Int | ||
| 1563 | )))|((( | ||
| 1564 | ID of the user in partners system (e.g. id of your system). | ||
| 1565 | ))) | ||
| 1566 | |((( | ||
| 1567 | Demo | ||
| 1568 | )))|((( | ||
| 1569 | Demo | ||
| 1570 | )))|((( | ||
| 1571 | Object of user's demo question ids and respective response values. | ||
| 1572 | ))) | ||
| 1573 | |((( | ||
| 1574 | RequestDate | ||
| 1575 | )))|((( | ||
| 1576 | Date | ||
| 1577 | )))|((( | ||
| 1578 | Request date. | ||
| 1579 | ))) | ||
| 1580 | |||
| 1581 | |||
| 1582 | \\**Type:** **Demo**\\ | ||
| 1583 | |||
| 1584 | |((( | ||
| 1585 | **Property** **Name** | ||
| 1586 | )))|((( | ||
| 1587 | **Type** | ||
| 1588 | )))|((( | ||
| 1589 | **Description** | ||
| 1590 | ))) | ||
| 1591 | |((( | ||
| 1592 | QuestionId (e.g 6) | ||
| 1593 | )))|((( | ||
| 1594 | String | ||
| 1595 | )))|((( | ||
| 1596 | 6 is the value of "Id" property of question resource(Text = "First Name") | ||
| 1597 | ))) | ||
| 1598 | |((( | ||
| 1599 | QuestionId (e.g 7) | ||
| 1600 | )))|((( | ||
| 1601 | String | ||
| 1602 | )))|((( | ||
| 1603 | 7 is the value of "Id" property of question resource(Text = "Last Name") | ||
| 1604 | ))) | ||
| 1605 | |((( | ||
| 1606 | ... | ||
| 1607 | )))|((( | ||
| 1608 | ... | ||
| 1609 | )))|((( | ||
| 1610 | ... | ||
| 1611 | ))) | ||
| 1612 | |||
| 1613 | |||
| 1614 | \\**Type:** **Transactions**\\ | ||
| 1615 | |||
| 1616 | |((( | ||
| 1617 | **Property** **Name** | ||
| 1618 | )))|((( | ||
| 1619 | **Type** | ||
| 1620 | )))|((( | ||
| 1621 | **Description** | ||
| 1622 | ))) | ||
| 1623 | |((( | ||
| 1624 | Id | ||
| 1625 | )))|((( | ||
| 1626 | Int | ||
| 1627 | )))|((( | ||
| 1628 | ID of the transaction. | ||
| 1629 | ))) | ||
| 1630 | |((( | ||
| 1631 | UserId | ||
| 1632 | )))|((( | ||
| 1633 | Int | ||
| 1634 | )))|((( | ||
| 1635 | Id of user in ONEcount. | ||
| 1636 | ))) | ||
| 1637 | |((( | ||
| 1638 | TermId | ||
| 1639 | )))|((( | ||
| 1640 | Int | ||
| 1641 | )))|((( | ||
| 1642 | TermId in ONEcount. | ||
| 1643 | ))) | ||
| 1644 | |((( | ||
| 1645 | ProductStatus | ||
| 1646 | )))|((( | ||
| 1647 | Int | ||
| 1648 | )))|((( | ||
| 1649 | Status ID. | ||
| 1650 | ))) | ||
| 1651 | |((( | ||
| 1652 | SubscriptionType | ||
| 1653 | )))|((( | ||
| 1654 | Char | ||
| 1655 | )))|((( | ||
| 1656 | Can be n,r or u for new, renew or unsubscribe. | ||
| 1657 | ))) | ||
| 1658 | |((( | ||
| 1659 | TransactionDate | ||
| 1660 | )))|((( | ||
| 1661 | Date | ||
| 1662 | )))|((( | ||
| 1663 | Date when the transaction occurred. | ||
| 1664 | ))) | ||
| 1665 | |((( | ||
| 1666 | TransactionTime | ||
| 1667 | )))|((( | ||
| 1668 | Time | ||
| 1669 | )))|((( | ||
| 1670 | Time of transaction. | ||
| 1671 | ))) | ||
| 1672 | |((( | ||
| 1673 | RequestDate | ||
| 1674 | )))|((( | ||
| 1675 | Date | ||
| 1676 | )))|((( | ||
| 1677 | The effective request date for the transaction. | ||
| 1678 | ))) | ||
| 1679 | |((( | ||
| 1680 | UserIP | ||
| 1681 | )))|((( | ||
| 1682 | String | ||
| 1683 | )))|((( | ||
| 1684 | IP of the user. | ||
| 1685 | ))) | ||
| 1686 | |((( | ||
| 1687 | Source | ||
| 1688 | )))|((( | ||
| 1689 | String | ||
| 1690 | )))|((( | ||
| 1691 | The transaction needs to be tied to a source code this will define it. | ||
| 1692 | ))) | ||
| 1693 | |((( | ||
| 1694 | MediaFilePath | ||
| 1695 | )))|((( | ||
| 1696 | String | ||
| 1697 | )))|((( | ||
| 1698 | The url of media associated with that transaction. Eg image, audio. | ||
| 1699 | ))) | ||
| 1700 | |||
| 1701 | \\ | ||
| 1702 | |||
| 1703 | |((( | ||
| 1704 | ExpireDate | ||
| 1705 | )))|((( | ||
| 1706 | Date | ||
| 1707 | )))|((( | ||
| 1708 | Date when the subscription expires. | ||
| 1709 | ))) | ||
| 1710 | |((( | ||
| 1711 | Amount | ||
| 1712 | )))|((( | ||
| 1713 | Float | ||
| 1714 | )))|((( | ||
| 1715 | If there is amount (USD) included in transaction. | ||
| 1716 | ))) | ||
| 1717 | |||
| 1718 | |||
| 1719 | \\**Type:** **Sources**\\ | ||
| 1720 | |||
| 1721 | |((( | ||
| 1722 | **Property** **Name** | ||
| 1723 | )))|((( | ||
| 1724 | **Type** | ||
| 1725 | )))|((( | ||
| 1726 | **Description** | ||
| 1727 | ))) | ||
| 1728 | |((( | ||
| 1729 | Id | ||
| 1730 | )))|((( | ||
| 1731 | Int | ||
| 1732 | )))|((( | ||
| 1733 | Id of the source. | ||
| 1734 | ))) | ||
| 1735 | |((( | ||
| 1736 | Source | ||
| 1737 | )))|((( | ||
| 1738 | String | ||
| 1739 | )))|((( | ||
| 1740 | Value of the source. | ||
| 1741 | ))) | ||
| 1742 | |((( | ||
| 1743 | Description | ||
| 1744 | )))|((( | ||
| 1745 | Text | ||
| 1746 | )))|((( | ||
| 1747 | Description of the source. | ||
| 1748 | ))) | ||
| 1749 | |((( | ||
| 1750 | ParentId | ||
| 1751 | )))|((( | ||
| 1752 | int | ||
| 1753 | )))|((( | ||
| 1754 | If this is a child source then list the parent source id. | ||
| 1755 | ))) | ||
| 1756 | |||
| 1757 | |||
| 1758 | \\\\\\**Type:** **Products**\\ | ||
| 1759 | |||
| 1760 | |((( | ||
| 1761 | **Property** **Name** | ||
| 1762 | )))|((( | ||
| 1763 | **Type** | ||
| 1764 | )))|((( | ||
| 1765 | **Description** | ||
| 1766 | ))) | ||
| 1767 | |((( | ||
| 1768 | Id | ||
| 1769 | )))|((( | ||
| 1770 | Int | ||
| 1771 | )))|((( | ||
| 1772 | Specify only for update. | ||
| 1773 | ))) | ||
| 1774 | |((( | ||
| 1775 | Name | ||
| 1776 | )))|((( | ||
| 1777 | String | ||
| 1778 | )))|((( | ||
| 1779 | Name of the Product. | ||
| 1780 | ))) | ||
| 1781 | |((( | ||
| 1782 | Description | ||
| 1783 | )))|((( | ||
| 1784 | Text | ||
| 1785 | )))|((( | ||
| 1786 | Description of the product. | ||
| 1787 | ))) | ||
| 1788 | |((( | ||
| 1789 | Terms | ||
| 1790 | )))|((( | ||
| 1791 | Terms | ||
| 1792 | )))|((( | ||
| 1793 | (Array of) Terms associated with the product. | ||
| 1794 | ))) | ||
| 1795 | |||
| 1796 | |||
| 1797 | \\**Type:** **Terms**\\ | ||
| 1798 | |||
| 1799 | |((( | ||
| 1800 | **Property** **Name** | ||
| 1801 | )))|((( | ||
| 1802 | **Type** | ||
| 1803 | )))|((( | ||
| 1804 | **Description** | ||
| 1805 | ))) | ||
| 1806 | |((( | ||
| 1807 | Id | ||
| 1808 | )))|((( | ||
| 1809 | int | ||
| 1810 | )))|((( | ||
| 1811 | Id of the term. | ||
| 1812 | ))) | ||
| 1813 | |((( | ||
| 1814 | Name | ||
| 1815 | )))|((( | ||
| 1816 | string | ||
| 1817 | )))|((( | ||
| 1818 | Name of the Term. | ||
| 1819 | ))) | ||
| 1820 | |((( | ||
| 1821 | Description | ||
| 1822 | )))|((( | ||
| 1823 | text | ||
| 1824 | )))|((( | ||
| 1825 | Description of the term. | ||
| 1826 | ))) | ||
| 1827 | |((( | ||
| 1828 | Duration | ||
| 1829 | )))|((( | ||
| 1830 | int | ||
| 1831 | )))|((( | ||
| 1832 | Duration of term validity. | ||
| 1833 | ))) | ||
| 1834 | |((( | ||
| 1835 | DurationUnit | ||
| 1836 | )))|((( | ||
| 1837 | sting | ||
| 1838 | )))|((( | ||
| 1839 | Y (year), M (Month), D (Days). | ||
| 1840 | ))) | ||
| 1841 | |((( | ||
| 1842 | ProductId | ||
| 1843 | )))|((( | ||
| 1844 | int | ||
| 1845 | )))|((( | ||
| 1846 | Id of the product the term is tied to. | ||
| 1847 | ))) | ||
| 1848 | |((( | ||
| 1849 | Price | ||
| 1850 | )))|((( | ||
| 1851 | float | ||
| 1852 | )))|((( | ||
| 1853 | If there is price (USD) for the term. | ||
| 1854 | ))) | ||
| 1855 | |||
| 1856 | |||
| 1857 | \\**Type:** **Resources**\\ | ||
| 1858 | |||
| 1859 | |((( | ||
| 1860 | **Property** **Name** | ||
| 1861 | )))|((( | ||
| 1862 | **Type** | ||
| 1863 | )))|((( | ||
| 1864 | **Description** | ||
| 1865 | ))) | ||
| 1866 | |((( | ||
| 1867 | Id | ||
| 1868 | )))|((( | ||
| 1869 | Int | ||
| 1870 | )))|((( | ||
| 1871 | Specify only for update. | ||
| 1872 | ))) | ||
| 1873 | |((( | ||
| 1874 | Name | ||
| 1875 | )))|((( | ||
| 1876 | String | ||
| 1877 | )))|((( | ||
| 1878 | Name of the Resource. | ||
| 1879 | ))) | ||
| 1880 | |((( | ||
| 1881 | Description | ||
| 1882 | )))|((( | ||
| 1883 | Text | ||
| 1884 | )))|((( | ||
| 1885 | Description of the Resource. | ||
| 1886 | ))) | ||
| 1887 | |||
| 1888 | \\ | ||
| 1889 | |||
| 1890 | |((( | ||
| 1891 | Type | ||
| 1892 | )))|((( | ||
| 1893 | Int | ||
| 1894 | )))|((( | ||
| 1895 | Type Options | ||
| 1896 | \\**0** : File | ||
| 1897 | \\**2** **:** Newsletter | ||
| 1898 | \\**3** **:** Section | ||
| 1899 | \\**4** **:** Page | ||
| 1900 | \\**5** **:** Function | ||
| 1901 | ))) | ||
| 1902 | |((( | ||
| 1903 | Value | ||
| 1904 | )))|((( | ||
| 1905 | String | ||
| 1906 | )))|((( | ||
| 1907 | Value of Resource Type. | ||
| 1908 | \\Example : if the Type sent is 3 then Value would be **/digital/** | ||
| 1909 | \\For Function type resource it can be blank. | ||
| 1910 | ))) | ||
| 1911 | |||
| 1912 | |||
| 1913 | \\**Type:** **Telemarketing**\\ | ||
| 1914 | |||
| 1915 | |((( | ||
| 1916 | **Property** **Name** | ||
| 1917 | )))|((( | ||
| 1918 | **Type** | ||
| 1919 | )))|((( | ||
| 1920 | **Description** | ||
| 1921 | ))) | ||
| 1922 | |((( | ||
| 1923 | Id | ||
| 1924 | )))|((( | ||
| 1925 | int | ||
| 1926 | )))|((( | ||
| 1927 | Id of the telemarketing stat. This is autogenerated from the system and can be used to lookup the stat. | ||
| 1928 | ))) | ||
| 1929 | |((( | ||
| 1930 | OCID | ||
| 1931 | )))|((( | ||
| 1932 | int | ||
| 1933 | )))|((( | ||
| 1934 | Onecount ID of the user. | ||
| 1935 | ))) | ||
| 1936 | |((( | ||
| 1937 | Date | ||
| 1938 | )))|((( | ||
| 1939 | Date | ||
| 1940 | )))|((( | ||
| 1941 | Date when the stat occurred. Format: yyyy-mm-dd | ||
| 1942 | ))) | ||
| 1943 | |((( | ||
| 1944 | Time | ||
| 1945 | )))|((( | ||
| 1946 | Time | ||
| 1947 | )))|((( | ||
| 1948 | Time of stat. Format: h:m:s (24 hour format) | ||
| 1949 | ))) | ||
| 1950 | |((( | ||
| 1951 | ResourceId | ||
| 1952 | )))|((( | ||
| 1953 | int | ||
| 1954 | )))|((( | ||
| 1955 | Id of resource currently being sent for the sat. If the resource type is page type resource then need to send | ||
| 1956 | PageTitle otherwise it will follow the process described in PageTitle. | ||
| 1957 | ))) | ||
| 1958 | |((( | ||
| 1959 | PageUrl | ||
| 1960 | )))|((( | ||
| 1961 | string | ||
| 1962 | )))|((( | ||
| 1963 | Page Url belongs to resource that is being sent with this request. If the resource is file type then it needs to be path to that file and if the resource is section it needs to be section. Basically the value here needs to exact what is defined while creating resource. | ||
| 1964 | ))) | ||
| 1965 | |((( | ||
| 1966 | PageTitle | ||
| 1967 | )))|((( | ||
| 1968 | string | ||
| 1969 | )))|((( | ||
| 1970 | Page title that belongs to the page url that is being sent. If not provided it try to pull the title from the page but if unsuccessful then it will set it as blank. | ||
| 1971 | \\If the page url already exists and it doesn't match with the one that is being sent then it will throw conflict error with the title in our system. | ||
| 1972 | ))) |