apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/google",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1310         "type": "json"
1311       }
1312     ],
1313     "name": "Local_login",
1314     "group": "Authentication",
1315     "parameter": {
1316       "fields": {
1317         "Body": [
1318           {
1319             "group": "Body",
1320             "type": "String",
1321             "optional": false,
1322             "field": "name",
1323             "description": ""
1324           },
1325           {
1326             "group": "Body",
1327             "type": "String",
1328             "optional": false,
1329             "field": "password",
1330             "description": ""
1331           }
1332         ]
1333       }
1334     },
1335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336     "version": "0.0.0",
1337     "filename": "server/api/authGoogle/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/local",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1348         "type": "json"
1349       }
1350     ],
1351     "name": "Local_login",
1352     "group": "Authentication",
1353     "parameter": {
1354       "fields": {
1355         "Body": [
1356           {
1357             "group": "Body",
1358             "type": "String",
1359             "optional": false,
1360             "field": "name",
1361             "description": ""
1362           },
1363           {
1364             "group": "Body",
1365             "type": "String",
1366             "optional": false,
1367             "field": "password",
1368             "description": ""
1369           }
1370         ]
1371       }
1372     },
1373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1374     "version": "0.0.0",
1375     "filename": "server/api/authLocal/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/auth/activedirectory",
1381     "title": "Creates a new User token",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "Local_login",
1390     "group": "Authentication",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": false,
1405             "field": "password",
1406             "description": ""
1407           }
1408         ]
1409       }
1410     },
1411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1412     "version": "0.0.0",
1413     "filename": "server/api/authActiveDirectory/index.js",
1414     "groupTitle": "Authentication"
1415   },
1416   {
1417     "type": "post",
1418     "url": "/api/automations",
1419     "title": "Creates a new Automation",
1420     "examples": [
1421       {
1422         "title": "Example usage:",
1423         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1424         "type": "json"
1425       }
1426     ],
1427     "name": "CreateAutomations",
1428     "group": "Automations",
1429     "parameter": {
1430       "fields": {
1431         "Body": [
1432           {
1433             "group": "Body",
1434             "type": "String",
1435             "optional": false,
1436             "field": "name",
1437             "description": ""
1438           },
1439           {
1440             "group": "Body",
1441             "type": "String",
1442             "optional": true,
1443             "field": "channel",
1444             "description": ""
1445           },
1446           {
1447             "group": "Body",
1448             "type": "String",
1449             "optional": true,
1450             "field": "description",
1451             "description": ""
1452           },
1453           {
1454             "group": "Body",
1455             "type": "Boolean",
1456             "optional": true,
1457             "field": "status",
1458             "description": ""
1459           },
1460           {
1461             "group": "Body",
1462             "type": "Integer",
1463             "optional": true,
1464             "field": "timeout",
1465             "description": ""
1466           }
1467         ]
1468       }
1469     },
1470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1471     "version": "0.0.0",
1472     "filename": "server/api/automation/index.js",
1473     "groupTitle": "Automations"
1474   },
1475   {
1476     "type": "delete",
1477     "url": "/api/automations/{id}",
1478     "title": "Deletes a Automation",
1479     "examples": [
1480       {
1481         "title": "Example usage:",
1482         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1483         "type": "json"
1484       }
1485     ],
1486     "name": "DeleteAutomations",
1487     "group": "Automations",
1488     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1489     "version": "0.0.0",
1490     "filename": "server/api/automation/index.js",
1491     "groupTitle": "Automations"
1492   },
1493   {
1494     "type": "get",
1495     "url": "/api/automations",
1496     "title": "Gets a list of Automations",
1497     "examples": [
1498       {
1499         "title": "Example usage:",
1500         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1501         "type": "json"
1502       }
1503     ],
1504     "name": "GetAutomations",
1505     "group": "Automations",
1506     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1507     "version": "0.0.0",
1508     "filename": "server/api/automation/index.js",
1509     "groupTitle": "Automations"
1510   },
1511   {
1512     "type": "get",
1513     "url": "/api/automations/{id}",
1514     "title": "Gets a single Automation",
1515     "examples": [
1516       {
1517         "title": "Example usage:",
1518         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1519         "type": "json"
1520       }
1521     ],
1522     "name": "ShowAutomations",
1523     "group": "Automations",
1524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1525     "version": "0.0.0",
1526     "filename": "server/api/automation/index.js",
1527     "groupTitle": "Automations"
1528   },
1529   {
1530     "type": "post",
1531     "url": "/api/automations/{id}/actions",
1532     "title": "Creates new actions",
1533     "examples": [
1534       {
1535         "title": "Example usage:",
1536         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1537         "type": "json"
1538       }
1539     ],
1540     "name": "addActions",
1541     "group": "Automations",
1542     "parameter": {
1543       "fields": {
1544         "Body": [
1545           {
1546             "group": "Body",
1547             "type": "Virtual",
1548             "optional": true,
1549             "field": "name",
1550             "description": ""
1551           },
1552           {
1553             "group": "Body",
1554             "type": "String",
1555             "optional": false,
1556             "field": "action",
1557             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1558           },
1559           {
1560             "group": "Body",
1561             "type": "String",
1562             "optional": true,
1563             "field": "data1",
1564             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1565           },
1566           {
1567             "group": "Body",
1568             "type": "String",
1569             "optional": true,
1570             "field": "data2",
1571             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1572           },
1573           {
1574             "group": "Body",
1575             "type": "String",
1576             "optional": true,
1577             "field": "data3",
1578             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1579           },
1580           {
1581             "group": "Body",
1582             "type": "String",
1583             "optional": true,
1584             "field": "data4",
1585             "description": ""
1586           },
1587           {
1588             "group": "Body",
1589             "type": "String",
1590             "optional": true,
1591             "field": "data5",
1592             "description": ""
1593           },
1594           {
1595             "group": "Body",
1596             "type": "String",
1597             "optional": true,
1598             "field": "data6",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "Text",
1604             "optional": true,
1605             "field": "data7",
1606             "description": ""
1607           }
1608         ]
1609       }
1610     },
1611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1612     "version": "0.0.0",
1613     "filename": "server/api/automation/index.js",
1614     "groupTitle": "Automations"
1615   },
1616   {
1617     "type": "post",
1618     "url": "/api/automations/{id}/conditions",
1619     "title": "Creates new conditions",
1620     "examples": [
1621       {
1622         "title": "Example usage:",
1623         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1624         "type": "json"
1625       }
1626     ],
1627     "name": "addConditions",
1628     "group": "Automations",
1629     "parameter": {
1630       "fields": {
1631         "Body": [
1632           {
1633             "group": "Body",
1634             "type": "Virtual",
1635             "optional": true,
1636             "field": "name",
1637             "description": ""
1638           },
1639           {
1640             "group": "Body",
1641             "type": "String",
1642             "optional": false,
1643             "field": "field",
1644             "description": ""
1645           },
1646           {
1647             "group": "Body",
1648             "type": "String",
1649             "optional": false,
1650             "field": "operator",
1651             "description": ""
1652           },
1653           {
1654             "group": "Body",
1655             "type": "String",
1656             "optional": false,
1657             "field": "value",
1658             "description": ""
1659           }
1660         ]
1661       }
1662     },
1663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1664     "version": "0.0.0",
1665     "filename": "server/api/automation/index.js",
1666     "groupTitle": "Automations"
1667   },
1668   {
1669     "type": "get",
1670     "url": "/api/automations/{id}/actions",
1671     "title": "Gets Automation Actions",
1672     "examples": [
1673       {
1674         "title": "Example usage:",
1675         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1676         "type": "json"
1677       }
1678     ],
1679     "name": "getActions",
1680     "group": "Automations",
1681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1682     "version": "0.0.0",
1683     "filename": "server/api/automation/index.js",
1684     "groupTitle": "Automations"
1685   },
1686   {
1687     "type": "get",
1688     "url": "/api/automations/{id}/conditions",
1689     "title": "Gets Automation Conditions",
1690     "examples": [
1691       {
1692         "title": "Example usage:",
1693         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1694         "type": "json"
1695       }
1696     ],
1697     "name": "getConditions",
1698     "group": "Automations",
1699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1700     "version": "0.0.0",
1701     "filename": "server/api/automation/index.js",
1702     "groupTitle": "Automations"
1703   },
1704   {
1705     "type": "put",
1706     "url": "/api/automations/{id}",
1707     "title": "Update an existing Automation",
1708     "examples": [
1709       {
1710         "title": "Example usage:",
1711         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1712         "type": "json"
1713       }
1714     ],
1715     "name": "updateAutomations",
1716     "group": "Automations",
1717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1718     "version": "0.0.0",
1719     "filename": "server/api/automation/index.js",
1720     "groupTitle": "Automations"
1721   },
1722   {
1723     "type": "post",
1724     "url": "/api/canned_answers",
1725     "title": "Create a new canned answer",
1726     "examples": [
1727       {
1728         "title": "Example usage:",
1729         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1730         "type": "json"
1731       }
1732     ],
1733     "name": "Create",
1734     "group": "Canned_Answers",
1735     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1736     "version": "0.0.0",
1737     "filename": "server/api/cannedAnswer/index.js",
1738     "groupTitle": "Canned_Answers"
1739   },
1740   {
1741     "type": "delete",
1742     "url": "/api/canned_answers/{id}",
1743     "title": "Deletes a Canned Answer",
1744     "examples": [
1745       {
1746         "title": "Example usage:",
1747         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1748         "type": "json"
1749       }
1750     ],
1751     "name": "DeleteCanned_Answers",
1752     "group": "Canned_Answers",
1753     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1754     "version": "0.0.0",
1755     "filename": "server/api/cannedAnswer/index.js",
1756     "groupTitle": "Canned_Answers"
1757   },
1758   {
1759     "type": "get",
1760     "url": "/api/canned_answers",
1761     "title": "Gets a list of Canned Answers",
1762     "examples": [
1763       {
1764         "title": "Example usage:",
1765         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1766         "type": "json"
1767       }
1768     ],
1769     "name": "GetCanned_Answers",
1770     "group": "Canned_Answers",
1771     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1772     "version": "0.0.0",
1773     "filename": "server/api/cannedAnswer/index.js",
1774     "groupTitle": "Canned_Answers"
1775   },
1776   {
1777     "type": "get",
1778     "url": "/api/canned_answers/{id}",
1779     "title": "Gets a single Canned Answer",
1780     "examples": [
1781       {
1782         "title": "Example usage:",
1783         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1784         "type": "json"
1785       }
1786     ],
1787     "name": "ShowCanned_Answers",
1788     "group": "Canned_Answers",
1789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1790     "version": "0.0.0",
1791     "filename": "server/api/cannedAnswer/index.js",
1792     "groupTitle": "Canned_Answers"
1793   },
1794   {
1795     "type": "put",
1796     "url": "/api/canned_answers/{id}",
1797     "title": "Update an existing Canned Answer",
1798     "examples": [
1799       {
1800         "title": "Example usage:",
1801         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1802         "type": "json"
1803       }
1804     ],
1805     "name": "updateCanned_Answers",
1806     "group": "Canned_Answers",
1807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1808     "version": "0.0.0",
1809     "filename": "server/api/cannedAnswer/index.js",
1810     "groupTitle": "Canned_Answers"
1811   },
1812   {
1813     "type": "get",
1814     "url": "/chat/internal/users",
1815     "title": "Gets Users Last Messages",
1816     "examples": [
1817       {
1818         "title": "Example usage:",
1819         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1820         "type": "json"
1821       }
1822     ],
1823     "name": "getLastUsersMessages",
1824     "group": "ChatInternalMessage",
1825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1826     "version": "0.0.0",
1827     "filename": "server/api/chatInternalMessage/index.js",
1828     "groupTitle": "ChatInternalMessage"
1829   },
1830   {
1831     "type": "delete",
1832     "url": "/api/chat/applications/{id}",
1833     "title": "Deletes a Application",
1834     "examples": [
1835       {
1836         "title": "Example usage:",
1837         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1838         "type": "json"
1839       }
1840     ],
1841     "name": "DeleteApplications",
1842     "group": "Chat_Applications",
1843     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1844     "version": "0.0.0",
1845     "filename": "server/api/chatApplication/index.js",
1846     "groupTitle": "Chat_Applications"
1847   },
1848   {
1849     "type": "get",
1850     "url": "/api/chat/applications/{id}",
1851     "title": "Gets a single Application",
1852     "examples": [
1853       {
1854         "title": "Example usage:",
1855         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1856         "type": "json"
1857       }
1858     ],
1859     "name": "ShowApplications",
1860     "group": "Chat_Applications",
1861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1862     "version": "0.0.0",
1863     "filename": "server/api/chatApplication/index.js",
1864     "groupTitle": "Chat_Applications"
1865   },
1866   {
1867     "type": "put",
1868     "url": "/api/chat/applications/{id}",
1869     "title": "Update an existing Application",
1870     "examples": [
1871       {
1872         "title": "Example usage:",
1873         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1874         "type": "json"
1875       }
1876     ],
1877     "name": "updateApplications",
1878     "group": "Chat_Applications",
1879     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1880     "version": "0.0.0",
1881     "filename": "server/api/chatApplication/index.js",
1882     "groupTitle": "Chat_Applications"
1883   },
1884   {
1885     "type": "post",
1886     "url": "/api/chat/groups",
1887     "title": "Creates a new Group",
1888     "examples": [
1889       {
1890         "title": "Example usage:",
1891         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1892         "type": "json"
1893       }
1894     ],
1895     "name": "CreateGroups",
1896     "group": "Chat_Groups",
1897     "parameter": {
1898       "fields": {
1899         "Body": [
1900           {
1901             "group": "Body",
1902             "type": "String",
1903             "optional": false,
1904             "field": "name",
1905             "description": ""
1906           },
1907           {
1908             "group": "Body",
1909             "type": "String",
1910             "optional": true,
1911             "field": "description",
1912             "description": ""
1913           },
1914           {
1915             "group": "Body",
1916             "type": "Boolean",
1917             "optional": true,
1918             "field": "write",
1919             "description": ""
1920           }
1921         ]
1922       }
1923     },
1924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1925     "version": "0.0.0",
1926     "filename": "server/api/chatGroup/index.js",
1927     "groupTitle": "Chat_Groups"
1928   },
1929   {
1930     "type": "delete",
1931     "url": "/api/chat/groups/{id}",
1932     "title": "Deletes a Group",
1933     "examples": [
1934       {
1935         "title": "Example usage:",
1936         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1937         "type": "json"
1938       }
1939     ],
1940     "name": "DeleteGroups",
1941     "group": "Chat_Groups",
1942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1943     "version": "0.0.0",
1944     "filename": "server/api/chatGroup/index.js",
1945     "groupTitle": "Chat_Groups"
1946   },
1947   {
1948     "type": "get",
1949     "url": "/api/chat/groups/describe",
1950     "title": "Gets table info about Groups",
1951     "examples": [
1952       {
1953         "title": "Example usage:",
1954         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1955         "type": "json"
1956       }
1957     ],
1958     "name": "DescribeGroups",
1959     "group": "Chat_Groups",
1960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1961     "version": "0.0.0",
1962     "filename": "server/api/chatGroup/index.js",
1963     "groupTitle": "Chat_Groups"
1964   },
1965   {
1966     "type": "get",
1967     "url": "/api/chat/groups",
1968     "title": "Gets a list of Groups",
1969     "examples": [
1970       {
1971         "title": "Example usage:",
1972         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1973         "type": "json"
1974       }
1975     ],
1976     "name": "GetGroups",
1977     "group": "Chat_Groups",
1978     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1979     "version": "0.0.0",
1980     "filename": "server/api/chatGroup/index.js",
1981     "groupTitle": "Chat_Groups"
1982   },
1983   {
1984     "type": "delete",
1985     "url": "/api/chat/groups/{id}/members",
1986     "title": "Removes members from a group",
1987     "examples": [
1988       {
1989         "title": "Example usage:",
1990         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1991         "type": "json"
1992       }
1993     ],
1994     "name": "RemoveMembers",
1995     "group": "Chat_Groups",
1996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1997     "version": "0.0.0",
1998     "filename": "server/api/chatGroup/index.js",
1999     "groupTitle": "Chat_Groups"
2000   },
2001   {
2002     "type": "get",
2003     "url": "/api/chat/groups/{id}",
2004     "title": "Gets a single Group",
2005     "examples": [
2006       {
2007         "title": "Example usage:",
2008         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2009         "type": "json"
2010       }
2011     ],
2012     "name": "ShowGroups",
2013     "group": "Chat_Groups",
2014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2015     "version": "0.0.0",
2016     "filename": "server/api/chatGroup/index.js",
2017     "groupTitle": "Chat_Groups"
2018   },
2019   {
2020     "type": "post",
2021     "url": "/api/chat/groups/{id}/members",
2022     "title": "Add members to chat group",
2023     "examples": [
2024       {
2025         "title": "Example usage:",
2026         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2027         "type": "json"
2028       }
2029     ],
2030     "name": "addMembers",
2031     "group": "Chat_Groups",
2032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2033     "version": "0.0.0",
2034     "filename": "server/api/chatGroup/index.js",
2035     "groupTitle": "Chat_Groups"
2036   },
2037   {
2038     "type": "post",
2039     "url": "/api/chat/groups/{id}/messages",
2040     "title": "Creates a new group message",
2041     "examples": [
2042       {
2043         "title": "Example usage:",
2044         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2045         "type": "json"
2046       }
2047     ],
2048     "name": "addMessage",
2049     "group": "Chat_Groups",
2050     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2051     "version": "0.0.0",
2052     "filename": "server/api/chatGroup/index.js",
2053     "groupTitle": "Chat_Groups"
2054   },
2055   {
2056     "type": "get",
2057     "url": "/api/chat/groups/{id}/members",
2058     "title": "Gets Members",
2059     "examples": [
2060       {
2061         "title": "Example usage:",
2062         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2063         "type": "json"
2064       }
2065     ],
2066     "name": "getMembers",
2067     "group": "Chat_Groups",
2068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2069     "version": "0.0.0",
2070     "filename": "server/api/chatGroup/index.js",
2071     "groupTitle": "Chat_Groups"
2072   },
2073   {
2074     "type": "get",
2075     "url": "/api/chat/groups/{id}/messages",
2076     "title": "Gets Messages",
2077     "examples": [
2078       {
2079         "title": "Example usage:",
2080         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2081         "type": "json"
2082       }
2083     ],
2084     "name": "getMessages",
2085     "group": "Chat_Groups",
2086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2087     "version": "0.0.0",
2088     "filename": "server/api/chatGroup/index.js",
2089     "groupTitle": "Chat_Groups"
2090   },
2091   {
2092     "type": "get",
2093     "url": "/api/chat/groups/{id}/unread",
2094     "title": "Get unread chat group messages",
2095     "examples": [
2096       {
2097         "title": "Example usage:",
2098         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2099         "type": "json"
2100       }
2101     ],
2102     "name": "getUread",
2103     "group": "Chat_Groups",
2104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2105     "version": "0.0.0",
2106     "filename": "server/api/chatGroup/index.js",
2107     "groupTitle": "Chat_Groups"
2108   },
2109   {
2110     "type": "put",
2111     "url": "/api/chat/groups/{id}",
2112     "title": "Update an existing Group",
2113     "examples": [
2114       {
2115         "title": "Example usage:",
2116         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2117         "type": "json"
2118       }
2119     ],
2120     "name": "updateGroups",
2121     "group": "Chat_Groups",
2122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2123     "version": "0.0.0",
2124     "filename": "server/api/chatGroup/index.js",
2125     "groupTitle": "Chat_Groups"
2126   },
2127   {
2128     "type": "post",
2129     "url": "/api/chat/interactions/{id}/tags",
2130     "title": "Add tags to the interaction",
2131     "examples": [
2132       {
2133         "title": "Example usage:",
2134         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2135         "type": "json"
2136       }
2137     ],
2138     "name": "AddTags",
2139     "group": "Chat_Interactions",
2140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2141     "version": "0.0.0",
2142     "filename": "server/api/chatInteraction/index.js",
2143     "groupTitle": "Chat_Interactions"
2144   },
2145   {
2146     "type": "post",
2147     "url": "/api/chat/interactions",
2148     "title": "Creates a new Interaction",
2149     "examples": [
2150       {
2151         "title": "Example usage:",
2152         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2153         "type": "json"
2154       }
2155     ],
2156     "name": "CreateInteractions",
2157     "group": "Chat_Interactions",
2158     "parameter": {
2159       "fields": {
2160         "Body": [
2161           {
2162             "group": "Body",
2163             "type": "Boolean",
2164             "optional": true,
2165             "field": "closed",
2166             "description": ""
2167           },
2168           {
2169             "group": "Body",
2170             "type": "Integer",
2171             "optional": true,
2172             "field": "ratingValue",
2173             "description": ""
2174           },
2175           {
2176             "group": "Body",
2177             "type": "String",
2178             "allowedValues": [
2179               "\"star\"",
2180               "\"thumb\""
2181             ],
2182             "optional": true,
2183             "field": "ratingType",
2184             "description": ""
2185           },
2186           {
2187             "group": "Body",
2188             "type": "Text",
2189             "optional": true,
2190             "field": "ratingMessage",
2191             "description": ""
2192           },
2193           {
2194             "group": "Body",
2195             "type": "Text",
2196             "optional": true,
2197             "field": "pathTranscript",
2198             "description": ""
2199           },
2200           {
2201             "group": "Body",
2202             "type": "String",
2203             "optional": true,
2204             "field": "mailTranscript",
2205             "description": ""
2206           },
2207           {
2208             "group": "Body",
2209             "type": "String",
2210             "optional": true,
2211             "field": "closedAt",
2212             "description": ""
2213           },
2214           {
2215             "group": "Body",
2216             "type": "String",
2217             "optional": true,
2218             "field": "disposition",
2219             "description": ""
2220           },
2221           {
2222             "group": "Body",
2223             "type": "String",
2224             "optional": true,
2225             "field": "secondDisposition",
2226             "description": ""
2227           },
2228           {
2229             "group": "Body",
2230             "type": "String",
2231             "optional": true,
2232             "field": "thirdDisposition",
2233             "description": ""
2234           },
2235           {
2236             "group": "Body",
2237             "type": "String",
2238             "optional": true,
2239             "field": "note",
2240             "description": ""
2241           },
2242           {
2243             "group": "Body",
2244             "type": "String",
2245             "optional": true,
2246             "field": "browserName",
2247             "description": ""
2248           },
2249           {
2250             "group": "Body",
2251             "type": "String",
2252             "optional": true,
2253             "field": "browserVersion",
2254             "description": ""
2255           },
2256           {
2257             "group": "Body",
2258             "type": "String",
2259             "optional": true,
2260             "field": "osName",
2261             "description": ""
2262           },
2263           {
2264             "group": "Body",
2265             "type": "String",
2266             "optional": true,
2267             "field": "osVersion",
2268             "description": ""
2269           },
2270           {
2271             "group": "Body",
2272             "type": "String",
2273             "optional": true,
2274             "field": "deviceModel",
2275             "description": ""
2276           },
2277           {
2278             "group": "Body",
2279             "type": "String",
2280             "optional": true,
2281             "field": "deviceVendor",
2282             "description": ""
2283           },
2284           {
2285             "group": "Body",
2286             "type": "String",
2287             "optional": true,
2288             "field": "deviceType",
2289             "description": ""
2290           },
2291           {
2292             "group": "Body",
2293             "type": "Text",
2294             "optional": true,
2295             "field": "referer",
2296             "description": ""
2297           },
2298           {
2299             "group": "Body",
2300             "type": "String",
2301             "optional": true,
2302             "field": "customerIp",
2303             "description": ""
2304           },
2305           {
2306             "group": "Body",
2307             "type": "Text",
2308             "optional": true,
2309             "field": "formData",
2310             "description": ""
2311           },
2312           {
2313             "group": "Body",
2314             "type": "String",
2315             "optional": true,
2316             "field": "read1stAt",
2317             "description": ""
2318           },
2319           {
2320             "group": "Body",
2321             "type": "String",
2322             "optional": true,
2323             "field": "lastMsgAt",
2324             "description": ""
2325           },
2326           {
2327             "group": "Body",
2328             "type": "String",
2329             "allowedValues": [
2330               "\"in\"",
2331               "\"out\""
2332             ],
2333             "optional": false,
2334             "field": "lastMsgDirection",
2335             "description": ""
2336           },
2337           {
2338             "group": "Body",
2339             "type": "String",
2340             "optional": true,
2341             "field": "closeReason",
2342             "description": ""
2343           },
2344           {
2345             "group": "Body",
2346             "type": "String",
2347             "optional": true,
2348             "field": "customerPort",
2349             "description": ""
2350           },
2351           {
2352             "group": "Body",
2353             "type": "Text",
2354             "optional": true,
2355             "field": "vidaooSessionId",
2356             "description": ""
2357           },
2358           {
2359             "group": "Body",
2360             "type": "Boolean",
2361             "optional": true,
2362             "field": "autoreplyExecuted",
2363             "description": ""
2364           }
2365         ]
2366       }
2367     },
2368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2369     "version": "0.0.0",
2370     "filename": "server/api/chatInteraction/index.js",
2371     "groupTitle": "Chat_Interactions"
2372   },
2373   {
2374     "type": "delete",
2375     "url": "/api/chat/interactions/{id}",
2376     "title": "Deletes a Interaction",
2377     "examples": [
2378       {
2379         "title": "Example usage:",
2380         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2381         "type": "json"
2382       }
2383     ],
2384     "name": "DeleteInteractions",
2385     "group": "Chat_Interactions",
2386     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2387     "version": "0.0.0",
2388     "filename": "server/api/chatInteraction/index.js",
2389     "groupTitle": "Chat_Interactions"
2390   },
2391   {
2392     "type": "get",
2393     "url": "/api/chat/interactions/describe",
2394     "title": "Gets table info about Interactions",
2395     "examples": [
2396       {
2397         "title": "Example usage:",
2398         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2399         "type": "json"
2400       }
2401     ],
2402     "name": "DescribeInteractions",
2403     "group": "Chat_Interactions",
2404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2405     "version": "0.0.0",
2406     "filename": "server/api/chatInteraction/index.js",
2407     "groupTitle": "Chat_Interactions"
2408   },
2409   {
2410     "type": "get",
2411     "url": "/api/chat/interactions",
2412     "title": "Gets a list of Interactions",
2413     "examples": [
2414       {
2415         "title": "Example usage:",
2416         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2417         "type": "json"
2418       }
2419     ],
2420     "name": "GetInteractions",
2421     "group": "Chat_Interactions",
2422     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2423     "version": "0.0.0",
2424     "filename": "server/api/chatInteraction/index.js",
2425     "groupTitle": "Chat_Interactions"
2426   },
2427   {
2428     "type": "delete",
2429     "url": "/api/chat/interactions/{id}/tags",
2430     "title": "Removes tags from interaction",
2431     "examples": [
2432       {
2433         "title": "Example usage:",
2434         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2435         "type": "json"
2436       }
2437     ],
2438     "name": "RemoveTags",
2439     "group": "Chat_Interactions",
2440     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2441     "version": "0.0.0",
2442     "filename": "server/api/chatInteraction/index.js",
2443     "groupTitle": "Chat_Interactions"
2444   },
2445   {
2446     "type": "get",
2447     "url": "/api/chat/interactions/{id}",
2448     "title": "Gets a single Interaction",
2449     "examples": [
2450       {
2451         "title": "Example usage:",
2452         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2453         "type": "json"
2454       }
2455     ],
2456     "name": "ShowInteractions",
2457     "group": "Chat_Interactions",
2458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2459     "version": "0.0.0",
2460     "filename": "server/api/chatInteraction/index.js",
2461     "groupTitle": "Chat_Interactions"
2462   },
2463   {
2464     "type": "put",
2465     "url": "/api/chat/interactions/{id}/abandon",
2466     "title": "Abandon interaction",
2467     "examples": [
2468       {
2469         "title": "Example usage:",
2470         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2471         "type": "json"
2472       }
2473     ],
2474     "name": "abandon",
2475     "group": "Chat_Interactions",
2476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2477     "version": "0.0.0",
2478     "filename": "server/api/chatInteraction/index.js",
2479     "groupTitle": "Chat_Interactions"
2480   },
2481   {
2482     "type": "put",
2483     "url": "/api/chat/interactions/{id}/close",
2484     "title": "Close Interaction",
2485     "examples": [
2486       {
2487         "title": "Example usage:",
2488         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2489         "type": "json"
2490       }
2491     ],
2492     "name": "addMessage",
2493     "group": "Chat_Interactions",
2494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2495     "version": "0.0.0",
2496     "filename": "server/api/chatInteraction/index.js",
2497     "groupTitle": "Chat_Interactions"
2498   },
2499   {
2500     "type": "post",
2501     "url": "/api/chat/interactions/{id}/messages",
2502     "title": "Creates new messages",
2503     "examples": [
2504       {
2505         "title": "Example usage:",
2506         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2507         "type": "json"
2508       }
2509     ],
2510     "name": "addMessage",
2511     "group": "Chat_Interactions",
2512     "parameter": {
2513       "fields": {
2514         "Body": [
2515           {
2516             "group": "Body",
2517             "type": "Text",
2518             "optional": false,
2519             "field": "body",
2520             "description": ""
2521           },
2522           {
2523             "group": "Body",
2524             "type": "Boolean",
2525             "optional": true,
2526             "field": "read",
2527             "description": ""
2528           },
2529           {
2530             "group": "Body",
2531             "type": "Boolean",
2532             "optional": true,
2533             "field": "secret",
2534             "description": ""
2535           },
2536           {
2537             "group": "Body",
2538             "type": "String",
2539             "allowedValues": [
2540               "\"in\"",
2541               "\"out\""
2542             ],
2543             "optional": false,
2544             "field": "direction",
2545             "description": ""
2546           },
2547           {
2548             "group": "Body",
2549             "type": "String",
2550             "optional": true,
2551             "field": "readAt",
2552             "description": ""
2553           },
2554           {
2555             "group": "Body",
2556             "type": "String",
2557             "optional": true,
2558             "field": "providerName",
2559             "description": ""
2560           },
2561           {
2562             "group": "Body",
2563             "type": "Text",
2564             "optional": true,
2565             "field": "providerResponse",
2566             "description": ""
2567           }
2568         ]
2569       }
2570     },
2571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2572     "version": "0.0.0",
2573     "filename": "server/api/chatInteraction/index.js",
2574     "groupTitle": "Chat_Interactions"
2575   },
2576   {
2577     "type": "post",
2578     "url": "/api/chat/interactions/{id}/attachment_upload",
2579     "title": "Add attachment",
2580     "examples": [
2581       {
2582         "title": "Example usage:",
2583         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2584         "type": "json"
2585       }
2586     ],
2587     "name": "attachmentUpload",
2588     "group": "Chat_Interactions",
2589     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2590     "version": "0.0.0",
2591     "filename": "server/api/chatInteraction/index.js",
2592     "groupTitle": "Chat_Interactions"
2593   },
2594   {
2595     "type": "post",
2596     "url": "/api/chat/interactions/{id}/vidaoo",
2597     "title": "Create Vidaoo Session",
2598     "examples": [
2599       {
2600         "title": "Example usage:",
2601         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2602         "type": "json"
2603       }
2604     ],
2605     "name": "createVidaooSession",
2606     "group": "Chat_Interactions",
2607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2608     "version": "0.0.0",
2609     "filename": "server/api/chatInteraction/index.js",
2610     "groupTitle": "Chat_Interactions"
2611   },
2612   {
2613     "type": "put",
2614     "url": "/api/chat/interactions/{id}/custom_update",
2615     "title": "Update interaction",
2616     "examples": [
2617       {
2618         "title": "Example usage:",
2619         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2620         "type": "json"
2621       }
2622     ],
2623     "name": "customUpdate",
2624     "group": "Chat_Interactions",
2625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2626     "version": "0.0.0",
2627     "filename": "server/api/chatInteraction/index.js",
2628     "groupTitle": "Chat_Interactions"
2629   },
2630   {
2631     "type": "get",
2632     "url": "/api/chat/interactions/{id}/download",
2633     "title": "Gets interaction",
2634     "examples": [
2635       {
2636         "title": "Example usage:",
2637         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2638         "type": "json"
2639       }
2640     ],
2641     "name": "download",
2642     "group": "Chat_Interactions",
2643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2644     "version": "0.0.0",
2645     "filename": "server/api/chatInteraction/index.js",
2646     "groupTitle": "Chat_Interactions"
2647   },
2648   {
2649     "type": "get",
2650     "url": "/api/chat/interactions/{id}/messages",
2651     "title": "Gets interaction messages",
2652     "examples": [
2653       {
2654         "title": "Example usage:",
2655         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2656         "type": "json"
2657       }
2658     ],
2659     "name": "getMessages",
2660     "group": "Chat_Interactions",
2661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2662     "version": "0.0.0",
2663     "filename": "server/api/chatInteraction/index.js",
2664     "groupTitle": "Chat_Interactions"
2665   },
2666   {
2667     "type": "get",
2668     "url": "/api/chat/interactions/{id}/my_messages",
2669     "title": "Gets interaction messages",
2670     "examples": [
2671       {
2672         "title": "Example usage:",
2673         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2674         "type": "json"
2675       }
2676     ],
2677     "name": "getMyMessages",
2678     "group": "Chat_Interactions",
2679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2680     "version": "0.0.0",
2681     "filename": "server/api/chatInteraction/index.js",
2682     "groupTitle": "Chat_Interactions"
2683   },
2684   {
2685     "type": "put",
2686     "url": "/api/chat/interactions/{id}",
2687     "title": "Update an existing Interaction",
2688     "examples": [
2689       {
2690         "title": "Example usage:",
2691         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2692         "type": "json"
2693       }
2694     ],
2695     "name": "updateInteractions",
2696     "group": "Chat_Interactions",
2697     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInteraction/index.js",
2700     "groupTitle": "Chat_Interactions"
2701   },
2702   {
2703     "type": "post",
2704     "url": "/api/chat/internal/messages",
2705     "title": "Creates a new Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "CreateMessages",
2714     "group": "Chat_Internal_Messages",
2715     "parameter": {
2716       "fields": {
2717         "Body": [
2718           {
2719             "group": "Body",
2720             "type": "Text",
2721             "optional": false,
2722             "field": "body",
2723             "description": ""
2724           },
2725           {
2726             "group": "Body",
2727             "type": "Boolean",
2728             "optional": true,
2729             "field": "read",
2730             "description": ""
2731           },
2732           {
2733             "group": "Body",
2734             "type": "Integer",
2735             "optional": true,
2736             "field": "ChatInternalMessageId",
2737             "description": ""
2738           }
2739         ]
2740       }
2741     },
2742     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2743     "version": "0.0.0",
2744     "filename": "server/api/chatInternalMessage/index.js",
2745     "groupTitle": "Chat_Internal_Messages"
2746   },
2747   {
2748     "type": "delete",
2749     "url": "/api/chat/internal/messages/{id}",
2750     "title": "Deletes a Message",
2751     "examples": [
2752       {
2753         "title": "Example usage:",
2754         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2755         "type": "json"
2756       }
2757     ],
2758     "name": "DeleteMessages",
2759     "group": "Chat_Internal_Messages",
2760     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2761     "version": "0.0.0",
2762     "filename": "server/api/chatInternalMessage/index.js",
2763     "groupTitle": "Chat_Internal_Messages"
2764   },
2765   {
2766     "type": "get",
2767     "url": "/api/chat/internal/messages/describe",
2768     "title": "Gets table info about Messages",
2769     "examples": [
2770       {
2771         "title": "Example usage:",
2772         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2773         "type": "json"
2774       }
2775     ],
2776     "name": "DescribeMessages",
2777     "group": "Chat_Internal_Messages",
2778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2779     "version": "0.0.0",
2780     "filename": "server/api/chatInternalMessage/index.js",
2781     "groupTitle": "Chat_Internal_Messages"
2782   },
2783   {
2784     "type": "get",
2785     "url": "/api/chat/internal/messages",
2786     "title": "Gets a list of Messages",
2787     "examples": [
2788       {
2789         "title": "Example usage:",
2790         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2791         "type": "json"
2792       }
2793     ],
2794     "name": "GetMessages",
2795     "group": "Chat_Internal_Messages",
2796     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2797     "version": "0.0.0",
2798     "filename": "server/api/chatInternalMessage/index.js",
2799     "groupTitle": "Chat_Internal_Messages"
2800   },
2801   {
2802     "type": "get",
2803     "url": "/api/chat/internal/messages/{id}",
2804     "title": "Gets a single Message",
2805     "examples": [
2806       {
2807         "title": "Example usage:",
2808         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2809         "type": "json"
2810       }
2811     ],
2812     "name": "ShowMessages",
2813     "group": "Chat_Internal_Messages",
2814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2815     "version": "0.0.0",
2816     "filename": "server/api/chatInternalMessage/index.js",
2817     "groupTitle": "Chat_Internal_Messages"
2818   },
2819   {
2820     "type": "put",
2821     "url": "/api/chat/internal/messages/{id}",
2822     "title": "Update an existing Message",
2823     "examples": [
2824       {
2825         "title": "Example usage:",
2826         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2827         "type": "json"
2828       }
2829     ],
2830     "name": "updateMessages",
2831     "group": "Chat_Internal_Messages",
2832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2833     "version": "0.0.0",
2834     "filename": "server/api/chatInternalMessage/index.js",
2835     "groupTitle": "Chat_Internal_Messages"
2836   },
2837   {
2838     "type": "post",
2839     "url": "/api/chat/messages",
2840     "title": "Creates a new Message",
2841     "examples": [
2842       {
2843         "title": "Example usage:",
2844         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2845         "type": "json"
2846       }
2847     ],
2848     "name": "CreateMessages",
2849     "group": "Chat_Messages",
2850     "parameter": {
2851       "fields": {
2852         "Body": [
2853           {
2854             "group": "Body",
2855             "type": "Text",
2856             "optional": false,
2857             "field": "body",
2858             "description": ""
2859           },
2860           {
2861             "group": "Body",
2862             "type": "Boolean",
2863             "optional": true,
2864             "field": "read",
2865             "description": ""
2866           },
2867           {
2868             "group": "Body",
2869             "type": "Boolean",
2870             "optional": true,
2871             "field": "secret",
2872             "description": ""
2873           },
2874           {
2875             "group": "Body",
2876             "type": "String",
2877             "allowedValues": [
2878               "\"in\"",
2879               "\"out\""
2880             ],
2881             "optional": false,
2882             "field": "direction",
2883             "description": ""
2884           },
2885           {
2886             "group": "Body",
2887             "type": "String",
2888             "optional": true,
2889             "field": "readAt",
2890             "description": ""
2891           },
2892           {
2893             "group": "Body",
2894             "type": "String",
2895             "optional": true,
2896             "field": "providerName",
2897             "description": ""
2898           },
2899           {
2900             "group": "Body",
2901             "type": "Text",
2902             "optional": true,
2903             "field": "providerResponse",
2904             "description": ""
2905           }
2906         ]
2907       }
2908     },
2909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2910     "version": "0.0.0",
2911     "filename": "server/api/chatMessage/index.js",
2912     "groupTitle": "Chat_Messages"
2913   },
2914   {
2915     "type": "delete",
2916     "url": "/api/chat/messages/{id}",
2917     "title": "Deletes a Message",
2918     "examples": [
2919       {
2920         "title": "Example usage:",
2921         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2922         "type": "json"
2923       }
2924     ],
2925     "name": "DeleteMessages",
2926     "group": "Chat_Messages",
2927     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2928     "version": "0.0.0",
2929     "filename": "server/api/chatMessage/index.js",
2930     "groupTitle": "Chat_Messages"
2931   },
2932   {
2933     "type": "get",
2934     "url": "/api/chat/messages/describe",
2935     "title": "Gets table info about Messages",
2936     "examples": [
2937       {
2938         "title": "Example usage:",
2939         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2940         "type": "json"
2941       }
2942     ],
2943     "name": "DescribeMessages",
2944     "group": "Chat_Messages",
2945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2946     "version": "0.0.0",
2947     "filename": "server/api/chatMessage/index.js",
2948     "groupTitle": "Chat_Messages"
2949   },
2950   {
2951     "type": "get",
2952     "url": "/api/chat/messages",
2953     "title": "Gets a list of Messages",
2954     "examples": [
2955       {
2956         "title": "Example usage:",
2957         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2958         "type": "json"
2959       }
2960     ],
2961     "name": "GetMessages",
2962     "group": "Chat_Messages",
2963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2964     "version": "0.0.0",
2965     "filename": "server/api/chatMessage/index.js",
2966     "groupTitle": "Chat_Messages"
2967   },
2968   {
2969     "type": "get",
2970     "url": "/api/chat/messages/{id}",
2971     "title": "Gets a single Message",
2972     "examples": [
2973       {
2974         "title": "Example usage:",
2975         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2976         "type": "json"
2977       }
2978     ],
2979     "name": "ShowMessages",
2980     "group": "Chat_Messages",
2981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2982     "version": "0.0.0",
2983     "filename": "server/api/chatMessage/index.js",
2984     "groupTitle": "Chat_Messages"
2985   },
2986   {
2987     "type": "put",
2988     "url": "/api/chat/messages/{id}",
2989     "title": "Update an existing Message",
2990     "examples": [
2991       {
2992         "title": "Example usage:",
2993         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2994         "type": "json"
2995       }
2996     ],
2997     "name": "updateMessages",
2998     "group": "Chat_Messages",
2999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3000     "version": "0.0.0",
3001     "filename": "server/api/chatMessage/index.js",
3002     "groupTitle": "Chat_Messages"
3003   },
3004   {
3005     "type": "post",
3006     "url": "/api/chat/offline_messages",
3007     "title": "Creates a new OfflineMessage",
3008     "examples": [
3009       {
3010         "title": "Example usage:",
3011         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3012         "type": "json"
3013       }
3014     ],
3015     "name": "CreateOfflineMessages",
3016     "group": "Chat_Offline_Messages",
3017     "parameter": {
3018       "fields": {
3019         "Body": [
3020           {
3021             "group": "Body",
3022             "type": "Text",
3023             "optional": false,
3024             "field": "body",
3025             "description": ""
3026           }
3027         ]
3028       }
3029     },
3030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3031     "version": "0.0.0",
3032     "filename": "server/api/chatOfflineMessage/index.js",
3033     "groupTitle": "Chat_Offline_Messages"
3034   },
3035   {
3036     "type": "delete",
3037     "url": "/api/chat/offline_messages/{id}",
3038     "title": "Deletes a OfflineMessage",
3039     "examples": [
3040       {
3041         "title": "Example usage:",
3042         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3043         "type": "json"
3044       }
3045     ],
3046     "name": "DeleteOfflineMessages",
3047     "group": "Chat_Offline_Messages",
3048     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3049     "version": "0.0.0",
3050     "filename": "server/api/chatOfflineMessage/index.js",
3051     "groupTitle": "Chat_Offline_Messages"
3052   },
3053   {
3054     "type": "get",
3055     "url": "/api/chat/offline_messages/describe",
3056     "title": "Gets table info about OfflineMessages",
3057     "examples": [
3058       {
3059         "title": "Example usage:",
3060         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3061         "type": "json"
3062       }
3063     ],
3064     "name": "DescribeOfflineMessages",
3065     "group": "Chat_Offline_Messages",
3066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3067     "version": "0.0.0",
3068     "filename": "server/api/chatOfflineMessage/index.js",
3069     "groupTitle": "Chat_Offline_Messages"
3070   },
3071   {
3072     "type": "get",
3073     "url": "/api/chat/offline_messages",
3074     "title": "Gets a list of OfflineMessages",
3075     "examples": [
3076       {
3077         "title": "Example usage:",
3078         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3079         "type": "json"
3080       }
3081     ],
3082     "name": "GetOfflineMessages",
3083     "group": "Chat_Offline_Messages",
3084     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3085     "version": "0.0.0",
3086     "filename": "server/api/chatOfflineMessage/index.js",
3087     "groupTitle": "Chat_Offline_Messages"
3088   },
3089   {
3090     "type": "get",
3091     "url": "/api/chat/offline_messages/{id}",
3092     "title": "Gets a single OfflineMessage",
3093     "examples": [
3094       {
3095         "title": "Example usage:",
3096         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3097         "type": "json"
3098       }
3099     ],
3100     "name": "ShowOfflineMessages",
3101     "group": "Chat_Offline_Messages",
3102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3103     "version": "0.0.0",
3104     "filename": "server/api/chatOfflineMessage/index.js",
3105     "groupTitle": "Chat_Offline_Messages"
3106   },
3107   {
3108     "type": "put",
3109     "url": "/api/chat/offline_messages/{id}",
3110     "title": "Update an existing OfflineMessage",
3111     "examples": [
3112       {
3113         "title": "Example usage:",
3114         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3115         "type": "json"
3116       }
3117     ],
3118     "name": "updateOfflineMessages",
3119     "group": "Chat_Offline_Messages",
3120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3121     "version": "0.0.0",
3122     "filename": "server/api/chatOfflineMessage/index.js",
3123     "groupTitle": "Chat_Offline_Messages"
3124   },
3125   {
3126     "type": "post",
3127     "url": "/api/chat/proactive_actions",
3128     "title": "Creates a new Proactive Action",
3129     "examples": [
3130       {
3131         "title": "Example usage:",
3132         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3133         "type": "json"
3134       }
3135     ],
3136     "name": "CreateProactive_Actions",
3137     "group": "Chat_Proactive_Actions",
3138     "parameter": {
3139       "fields": {
3140         "Body": [
3141           {
3142             "group": "Body",
3143             "type": "String",
3144             "optional": false,
3145             "field": "name",
3146             "description": ""
3147           },
3148           {
3149             "group": "Body",
3150             "type": "String",
3151             "allowedValues": [
3152               "\"mouseOver\"",
3153               "\"timeout\""
3154             ],
3155             "optional": true,
3156             "field": "type",
3157             "description": ""
3158           },
3159           {
3160             "group": "Body",
3161             "type": "String",
3162             "optional": true,
3163             "field": "selector",
3164             "description": ""
3165           },
3166           {
3167             "group": "Body",
3168             "type": "Integer",
3169             "optional": true,
3170             "field": "timeout",
3171             "description": ""
3172           }
3173         ]
3174       }
3175     },
3176     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3177     "version": "0.0.0",
3178     "filename": "server/api/chatProactiveAction/index.js",
3179     "groupTitle": "Chat_Proactive_Actions"
3180   },
3181   {
3182     "type": "delete",
3183     "url": "/api/chat/proactive_actions/{id}",
3184     "title": "Deletes a Proactive Action",
3185     "examples": [
3186       {
3187         "title": "Example usage:",
3188         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3189         "type": "json"
3190       }
3191     ],
3192     "name": "DeleteProactive_Actions",
3193     "group": "Chat_Proactive_Actions",
3194     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3195     "version": "0.0.0",
3196     "filename": "server/api/chatProactiveAction/index.js",
3197     "groupTitle": "Chat_Proactive_Actions"
3198   },
3199   {
3200     "type": "get",
3201     "url": "/api/chat/proactive_actions/{id}",
3202     "title": "Gets a single Proactive Action",
3203     "examples": [
3204       {
3205         "title": "Example usage:",
3206         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3207         "type": "json"
3208       }
3209     ],
3210     "name": "ShowProactive_Actions",
3211     "group": "Chat_Proactive_Actions",
3212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3213     "version": "0.0.0",
3214     "filename": "server/api/chatProactiveAction/index.js",
3215     "groupTitle": "Chat_Proactive_Actions"
3216   },
3217   {
3218     "type": "put",
3219     "url": "/api/chat/proactive_actions/{id}",
3220     "title": "Update an existing Proactive Action",
3221     "examples": [
3222       {
3223         "title": "Example usage:",
3224         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3225         "type": "json"
3226       }
3227     ],
3228     "name": "updateProactive_Actions",
3229     "group": "Chat_Proactive_Actions",
3230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3231     "version": "0.0.0",
3232     "filename": "server/api/chatProactiveAction/index.js",
3233     "groupTitle": "Chat_Proactive_Actions"
3234   },
3235   {
3236     "type": "post",
3237     "url": "/api/chat/reports/queue",
3238     "title": "Creates a new Chat Queue Report",
3239     "examples": [
3240       {
3241         "title": "Example usage:",
3242         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3243         "type": "json"
3244       }
3245     ],
3246     "name": "CreateChat_Queue_Reports",
3247     "group": "Chat_Queue_Reports",
3248     "parameter": {
3249       "fields": {
3250         "Body": [
3251           {
3252             "group": "Body",
3253             "type": "String",
3254             "optional": false,
3255             "field": "uniqueid",
3256             "description": ""
3257           },
3258           {
3259             "group": "Body",
3260             "type": "String",
3261             "optional": true,
3262             "field": "from",
3263             "description": ""
3264           },
3265           {
3266             "group": "Body",
3267             "type": "String",
3268             "optional": true,
3269             "field": "joinAt",
3270             "description": ""
3271           },
3272           {
3273             "group": "Body",
3274             "type": "String",
3275             "optional": true,
3276             "field": "leaveAt",
3277             "description": ""
3278           },
3279           {
3280             "group": "Body",
3281             "type": "String",
3282             "optional": true,
3283             "field": "acceptAt",
3284             "description": ""
3285           },
3286           {
3287             "group": "Body",
3288             "type": "String",
3289             "optional": true,
3290             "field": "exitAt",
3291             "description": ""
3292           },
3293           {
3294             "group": "Body",
3295             "type": "String",
3296             "optional": true,
3297             "field": "reason",
3298             "description": ""
3299           }
3300         ]
3301       }
3302     },
3303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3304     "version": "0.0.0",
3305     "filename": "server/api/chatQueueReport/index.js",
3306     "groupTitle": "Chat_Queue_Reports"
3307   },
3308   {
3309     "type": "delete",
3310     "url": "/api/chat/reports/queue/{id}",
3311     "title": "Deletes a Chat Queue Report",
3312     "examples": [
3313       {
3314         "title": "Example usage:",
3315         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3316         "type": "json"
3317       }
3318     ],
3319     "name": "DeleteChat_Queue_Reports",
3320     "group": "Chat_Queue_Reports",
3321     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3322     "version": "0.0.0",
3323     "filename": "server/api/chatQueueReport/index.js",
3324     "groupTitle": "Chat_Queue_Reports"
3325   },
3326   {
3327     "type": "get",
3328     "url": "/api/chat/reports/queue/describe",
3329     "title": "Gets table info about Chat Queue Reports",
3330     "examples": [
3331       {
3332         "title": "Example usage:",
3333         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3334         "type": "json"
3335       }
3336     ],
3337     "name": "DescribeChat_Queue_Reports",
3338     "group": "Chat_Queue_Reports",
3339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3340     "version": "0.0.0",
3341     "filename": "server/api/chatQueueReport/index.js",
3342     "groupTitle": "Chat_Queue_Reports"
3343   },
3344   {
3345     "type": "get",
3346     "url": "/api/chat/reports/queue",
3347     "title": "Gets a list of Chat Queue Reports",
3348     "examples": [
3349       {
3350         "title": "Example usage:",
3351         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3352         "type": "json"
3353       }
3354     ],
3355     "name": "GetChat_Queue_Reports",
3356     "group": "Chat_Queue_Reports",
3357     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3358     "version": "0.0.0",
3359     "filename": "server/api/chatQueueReport/index.js",
3360     "groupTitle": "Chat_Queue_Reports"
3361   },
3362   {
3363     "type": "get",
3364     "url": "/api/chat/reports/queue/{id}",
3365     "title": "Gets a single Chat Queue Report",
3366     "examples": [
3367       {
3368         "title": "Example usage:",
3369         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3370         "type": "json"
3371       }
3372     ],
3373     "name": "ShowChat_Queue_Reports",
3374     "group": "Chat_Queue_Reports",
3375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3376     "version": "0.0.0",
3377     "filename": "server/api/chatQueueReport/index.js",
3378     "groupTitle": "Chat_Queue_Reports"
3379   },
3380   {
3381     "type": "put",
3382     "url": "/api/chat/reports/queue/{id}",
3383     "title": "Update an existing Chat Queue Report",
3384     "examples": [
3385       {
3386         "title": "Example usage:",
3387         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3388         "type": "json"
3389       }
3390     ],
3391     "name": "updateChat_Queue_Reports",
3392     "group": "Chat_Queue_Reports",
3393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3394     "version": "0.0.0",
3395     "filename": "server/api/chatQueueReport/index.js",
3396     "groupTitle": "Chat_Queue_Reports"
3397   },
3398   {
3399     "type": "post",
3400     "url": "/api/chat/queues/{id}/users",
3401     "title": "Add agents to a queue",
3402     "examples": [
3403       {
3404         "title": "Example usage:",
3405         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3406         "type": "json"
3407       }
3408     ],
3409     "name": "AddAgents",
3410     "group": "Chat_Queues",
3411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3412     "version": "0.0.0",
3413     "filename": "server/api/chatQueue/index.js",
3414     "groupTitle": "Chat_Queues"
3415   },
3416   {
3417     "type": "post",
3418     "url": "/api/chat/queues/{id}/teams",
3419     "title": "Add teams to a queue",
3420     "examples": [
3421       {
3422         "title": "Example usage:",
3423         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3424         "type": "json"
3425       }
3426     ],
3427     "name": "AddTeams",
3428     "group": "Chat_Queues",
3429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3430     "version": "0.0.0",
3431     "filename": "server/api/chatQueue/index.js",
3432     "groupTitle": "Chat_Queues"
3433   },
3434   {
3435     "type": "post",
3436     "url": "/api/chat/queues",
3437     "title": "Creates a new Queue",
3438     "examples": [
3439       {
3440         "title": "Example usage:",
3441         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3442         "type": "json"
3443       }
3444     ],
3445     "name": "CreateQueues",
3446     "group": "Chat_Queues",
3447     "parameter": {
3448       "fields": {
3449         "Body": [
3450           {
3451             "group": "Body",
3452             "type": "String",
3453             "optional": false,
3454             "field": "name",
3455             "description": ""
3456           },
3457           {
3458             "group": "Body",
3459             "type": "String",
3460             "optional": true,
3461             "field": "description",
3462             "description": ""
3463           },
3464           {
3465             "group": "Body",
3466             "type": "Integer",
3467             "optional": true,
3468             "field": "timeout",
3469             "description": ""
3470           },
3471           {
3472             "group": "Body",
3473             "type": "String",
3474             "allowedValues": [
3475               "\"rrmemory\"",
3476               "\"beepall\"",
3477               "\"roundrobin\""
3478             ],
3479             "optional": true,
3480             "field": "strategy",
3481             "description": ""
3482           }
3483         ]
3484       }
3485     },
3486     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3487     "version": "0.0.0",
3488     "filename": "server/api/chatQueue/index.js",
3489     "groupTitle": "Chat_Queues"
3490   },
3491   {
3492     "type": "delete",
3493     "url": "/api/chat/queues/{id}",
3494     "title": "Deletes a Queue",
3495     "examples": [
3496       {
3497         "title": "Example usage:",
3498         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3499         "type": "json"
3500       }
3501     ],
3502     "name": "DeleteQueues",
3503     "group": "Chat_Queues",
3504     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3505     "version": "0.0.0",
3506     "filename": "server/api/chatQueue/index.js",
3507     "groupTitle": "Chat_Queues"
3508   },
3509   {
3510     "type": "get",
3511     "url": "/api/chat/queues/describe",
3512     "title": "Gets table info about Queues",
3513     "examples": [
3514       {
3515         "title": "Example usage:",
3516         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3517         "type": "json"
3518       }
3519     ],
3520     "name": "DescribeQueues",
3521     "group": "Chat_Queues",
3522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3523     "version": "0.0.0",
3524     "filename": "server/api/chatQueue/index.js",
3525     "groupTitle": "Chat_Queues"
3526   },
3527   {
3528     "type": "get",
3529     "url": "/api/chat/queues/{id}/users",
3530     "title": "Gets queue agents",
3531     "examples": [
3532       {
3533         "title": "Example usage:",
3534         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3535         "type": "json"
3536       }
3537     ],
3538     "name": "GetAgents",
3539     "group": "Chat_Queues",
3540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3541     "version": "0.0.0",
3542     "filename": "server/api/chatQueue/index.js",
3543     "groupTitle": "Chat_Queues"
3544   },
3545   {
3546     "type": "get",
3547     "url": "/api/chat/queues/{id}/members",
3548     "title": "GetMembers",
3549     "examples": [
3550       {
3551         "title": "Example usage:",
3552         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3553         "type": "json"
3554       }
3555     ],
3556     "name": "GetMembers",
3557     "group": "Chat_Queues",
3558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3559     "version": "0.0.0",
3560     "filename": "server/api/chatQueue/index.js",
3561     "groupTitle": "Chat_Queues"
3562   },
3563   {
3564     "type": "get",
3565     "url": "/api/chat/queues",
3566     "title": "Gets a list of Queues",
3567     "examples": [
3568       {
3569         "title": "Example usage:",
3570         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3571         "type": "json"
3572       }
3573     ],
3574     "name": "GetQueues",
3575     "group": "Chat_Queues",
3576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3577     "version": "0.0.0",
3578     "filename": "server/api/chatQueue/index.js",
3579     "groupTitle": "Chat_Queues"
3580   },
3581   {
3582     "type": "get",
3583     "url": "/api/chat/queues/{id}/teams",
3584     "title": "Gets queues list",
3585     "examples": [
3586       {
3587         "title": "Example usage:",
3588         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3589         "type": "json"
3590       }
3591     ],
3592     "name": "GetTeams",
3593     "group": "Chat_Queues",
3594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3595     "version": "0.0.0",
3596     "filename": "server/api/chatQueue/index.js",
3597     "groupTitle": "Chat_Queues"
3598   },
3599   {
3600     "type": "delete",
3601     "url": "/api/chat/queues/{id}/users",
3602     "title": "Removes agents from a queue",
3603     "examples": [
3604       {
3605         "title": "Example usage:",
3606         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3607         "type": "json"
3608       }
3609     ],
3610     "name": "RemoveAgents",
3611     "group": "Chat_Queues",
3612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3613     "version": "0.0.0",
3614     "filename": "server/api/chatQueue/index.js",
3615     "groupTitle": "Chat_Queues"
3616   },
3617   {
3618     "type": "get",
3619     "url": "/api/chat/queues/{id}",
3620     "title": "Gets a single Queue",
3621     "examples": [
3622       {
3623         "title": "Example usage:",
3624         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3625         "type": "json"
3626       }
3627     ],
3628     "name": "ShowQueues",
3629     "group": "Chat_Queues",
3630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3631     "version": "0.0.0",
3632     "filename": "server/api/chatQueue/index.js",
3633     "groupTitle": "Chat_Queues"
3634   },
3635   {
3636     "type": "put",
3637     "url": "/api/chat/queues/{id}",
3638     "title": "Update an existing Queue",
3639     "examples": [
3640       {
3641         "title": "Example usage:",
3642         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3643         "type": "json"
3644       }
3645     ],
3646     "name": "updateQueues",
3647     "group": "Chat_Queues",
3648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3649     "version": "0.0.0",
3650     "filename": "server/api/chatQueue/index.js",
3651     "groupTitle": "Chat_Queues"
3652   },
3653   {
3654     "type": "post",
3655     "url": "/api/chat/reports/transfer",
3656     "title": "Creates a new Chat Transfer Report",
3657     "examples": [
3658       {
3659         "title": "Example usage:",
3660         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3661         "type": "json"
3662       }
3663     ],
3664     "name": "CreateChat_Transfer_Reports",
3665     "group": "Chat_Transfer_Reports",
3666     "parameter": {
3667       "fields": {
3668         "Body": [
3669           {
3670             "group": "Body",
3671             "type": "String",
3672             "optional": false,
3673             "field": "uniqueid",
3674             "description": ""
3675           },
3676           {
3677             "group": "Body",
3678             "type": "String",
3679             "allowedValues": [
3680               "\"account\"",
3681               "\"agent\"",
3682               "\"queue\""
3683             ],
3684             "optional": false,
3685             "field": "type",
3686             "description": ""
3687           },
3688           {
3689             "group": "Body",
3690             "type": "String",
3691             "optional": false,
3692             "field": "transferredAt",
3693             "description": ""
3694           }
3695         ]
3696       }
3697     },
3698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3699     "version": "0.0.0",
3700     "filename": "server/api/chatTransferReport/index.js",
3701     "groupTitle": "Chat_Transfer_Reports"
3702   },
3703   {
3704     "type": "delete",
3705     "url": "/api/chat/reports/transfer/{id}",
3706     "title": "Deletes a Chat Transfer Report",
3707     "examples": [
3708       {
3709         "title": "Example usage:",
3710         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3711         "type": "json"
3712       }
3713     ],
3714     "name": "DeleteChat_Transfer_Reports",
3715     "group": "Chat_Transfer_Reports",
3716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717     "version": "0.0.0",
3718     "filename": "server/api/chatTransferReport/index.js",
3719     "groupTitle": "Chat_Transfer_Reports"
3720   },
3721   {
3722     "type": "get",
3723     "url": "/api/chat/reports/transfer/describe",
3724     "title": "Gets table info about Chat Transfer Reports",
3725     "examples": [
3726       {
3727         "title": "Example usage:",
3728         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3729         "type": "json"
3730       }
3731     ],
3732     "name": "DescribeChat_Transfer_Reports",
3733     "group": "Chat_Transfer_Reports",
3734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3735     "version": "0.0.0",
3736     "filename": "server/api/chatTransferReport/index.js",
3737     "groupTitle": "Chat_Transfer_Reports"
3738   },
3739   {
3740     "type": "get",
3741     "url": "/api/chat/reports/transfer",
3742     "title": "Gets a list of Chat Transfer Reports",
3743     "examples": [
3744       {
3745         "title": "Example usage:",
3746         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3747         "type": "json"
3748       }
3749     ],
3750     "name": "GetChat_Transfer_Reports",
3751     "group": "Chat_Transfer_Reports",
3752     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3753     "version": "0.0.0",
3754     "filename": "server/api/chatTransferReport/index.js",
3755     "groupTitle": "Chat_Transfer_Reports"
3756   },
3757   {
3758     "type": "get",
3759     "url": "/api/chat/reports/transfer/{id}",
3760     "title": "Gets a single Chat Transfer Report",
3761     "examples": [
3762       {
3763         "title": "Example usage:",
3764         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3765         "type": "json"
3766       }
3767     ],
3768     "name": "ShowChat_Transfer_Reports",
3769     "group": "Chat_Transfer_Reports",
3770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3771     "version": "0.0.0",
3772     "filename": "server/api/chatTransferReport/index.js",
3773     "groupTitle": "Chat_Transfer_Reports"
3774   },
3775   {
3776     "type": "put",
3777     "url": "/api/chat/reports/transfer/{id}",
3778     "title": "Update an existing Chat Transfer Report",
3779     "examples": [
3780       {
3781         "title": "Example usage:",
3782         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3783         "type": "json"
3784       }
3785     ],
3786     "name": "updateChat_Transfer_Reports",
3787     "group": "Chat_Transfer_Reports",
3788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3789     "version": "0.0.0",
3790     "filename": "server/api/chatTransferReport/index.js",
3791     "groupTitle": "Chat_Transfer_Reports"
3792   },
3793   {
3794     "type": "post",
3795     "url": "/api/chat/websites/{id}/users",
3796     "title": "Add agents to a website",
3797     "examples": [
3798       {
3799         "title": "Example usage:",
3800         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3801         "type": "json"
3802       }
3803     ],
3804     "name": "AddAgents",
3805     "group": "Chat_Websites",
3806     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3807     "version": "0.0.0",
3808     "filename": "server/api/chatWebsite/index.js",
3809     "groupTitle": "Chat_Websites"
3810   },
3811   {
3812     "type": "post",
3813     "url": "/api/chat/websites",
3814     "title": "Creates a new Website",
3815     "examples": [
3816       {
3817         "title": "Example usage:",
3818         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3819         "type": "json"
3820       }
3821     ],
3822     "name": "CreateWebsites",
3823     "group": "Chat_Websites",
3824     "parameter": {
3825       "fields": {
3826         "Body": [
3827           {
3828             "group": "Body",
3829             "type": "String",
3830             "optional": false,
3831             "field": "name",
3832             "description": ""
3833           },
3834           {
3835             "group": "Body",
3836             "type": "String",
3837             "optional": false,
3838             "field": "address",
3839             "description": ""
3840           },
3841           {
3842             "group": "Body",
3843             "type": "String",
3844             "optional": true,
3845             "field": "description",
3846             "description": ""
3847           },
3848           {
3849             "group": "Body",
3850             "type": "String",
3851             "optional": true,
3852             "field": "mapKey",
3853             "description": ""
3854           },
3855           {
3856             "group": "Body",
3857             "type": "String",
3858             "optional": true,
3859             "field": "mapKeyOffline",
3860             "description": ""
3861           },
3862           {
3863             "group": "Body",
3864             "type": "String",
3865             "optional": false,
3866             "field": "key",
3867             "description": ""
3868           },
3869           {
3870             "group": "Body",
3871             "type": "String",
3872             "optional": true,
3873             "field": "agentAlias",
3874             "description": ""
3875           },
3876           {
3877             "group": "Body",
3878             "type": "String",
3879             "optional": true,
3880             "field": "customerAlias",
3881             "description": ""
3882           },
3883           {
3884             "group": "Body",
3885             "type": "String",
3886             "optional": false,
3887             "field": "color",
3888             "description": ""
3889           },
3890           {
3891             "group": "Body",
3892             "type": "String",
3893             "optional": false,
3894             "field": "color_button",
3895             "description": ""
3896           },
3897           {
3898             "group": "Body",
3899             "type": "String",
3900             "optional": false,
3901             "field": "textColor",
3902             "description": ""
3903           },
3904           {
3905             "group": "Body",
3906             "type": "Integer",
3907             "optional": true,
3908             "field": "fontSize",
3909             "description": ""
3910           },
3911           {
3912             "group": "Body",
3913             "type": "String",
3914             "optional": true,
3915             "field": "remote",
3916             "description": ""
3917           },
3918           {
3919             "group": "Body",
3920             "type": "Boolean",
3921             "optional": true,
3922             "field": "animation",
3923             "description": ""
3924           },
3925           {
3926             "group": "Body",
3927             "type": "String",
3928             "allowedValues": [
3929               "\"rounded\"",
3930               "\"squared\""
3931             ],
3932             "optional": true,
3933             "field": "header_shape",
3934             "description": ""
3935           },
3936           {
3937             "group": "Body",
3938             "type": "String",
3939             "optional": true,
3940             "field": "header_online",
3941             "description": ""
3942           },
3943           {
3944             "group": "Body",
3945             "type": "String",
3946             "optional": true,
3947             "field": "start_chat_button",
3948             "description": ""
3949           },
3950           {
3951             "group": "Body",
3952             "type": "String",
3953             "optional": true,
3954             "field": "offline_chat_button",
3955             "description": ""
3956           },
3957           {
3958             "group": "Body",
3959             "type": "String",
3960             "optional": true,
3961             "field": "header_offline",
3962             "description": ""
3963           },
3964           {
3965             "group": "Body",
3966             "type": "Boolean",
3967             "optional": true,
3968             "field": "download_transcript",
3969             "description": ""
3970           },
3971           {
3972             "group": "Body",
3973             "type": "Integer",
3974             "optional": true,
3975             "field": "timeout",
3976             "description": ""
3977           },
3978           {
3979             "group": "Body",
3980             "type": "String",
3981             "optional": true,
3982             "field": "whiteLabel",
3983             "description": ""
3984           },
3985           {
3986             "group": "Body",
3987             "type": "Boolean",
3988             "optional": true,
3989             "field": "defaultWhiteLabel",
3990             "description": ""
3991           },
3992           {
3993             "group": "Body",
3994             "type": "Text",
3995             "optional": true,
3996             "field": "sitepic",
3997             "description": ""
3998           },
3999           {
4000             "group": "Body",
4001             "type": "String",
4002             "optional": true,
4003             "field": "closingQuestion",
4004             "description": ""
4005           },
4006           {
4007             "group": "Body",
4008             "type": "String",
4009             "optional": true,
4010             "field": "formSubmitSuccessMessage",
4011             "description": ""
4012           },
4013           {
4014             "group": "Body",
4015             "type": "String",
4016             "optional": true,
4017             "field": "formSubmitFailureMessage",
4018             "description": ""
4019           },
4020           {
4021             "group": "Body",
4022             "type": "String",
4023             "optional": true,
4024             "field": "noteTitle",
4025             "description": ""
4026           },
4027           {
4028             "group": "Body",
4029             "type": "String",
4030             "optional": true,
4031             "field": "placeholderMessage",
4032             "description": ""
4033           },
4034           {
4035             "group": "Body",
4036             "type": "String",
4037             "optional": true,
4038             "field": "closingMessage",
4039             "description": ""
4040           },
4041           {
4042             "group": "Body",
4043             "type": "String",
4044             "optional": true,
4045             "field": "closingMessageButton",
4046             "description": ""
4047           },
4048           {
4049             "group": "Body",
4050             "type": "String",
4051             "optional": true,
4052             "field": "skipMessageButton",
4053             "description": ""
4054           },
4055           {
4056             "group": "Body",
4057             "type": "Boolean",
4058             "optional": true,
4059             "field": "conditionAgreement",
4060             "description": ""
4061           },
4062           {
4063             "group": "Body",
4064             "type": "Boolean",
4065             "optional": true,
4066             "field": "enableRating",
4067             "description": ""
4068           },
4069           {
4070             "group": "Body",
4071             "type": "Boolean",
4072             "optional": true,
4073             "field": "enableFeedback",
4074             "description": ""
4075           },
4076           {
4077             "group": "Body",
4078             "type": "Boolean",
4079             "optional": true,
4080             "field": "enableSendButton",
4081             "description": ""
4082           },
4083           {
4084             "group": "Body",
4085             "type": "String",
4086             "optional": true,
4087             "field": "feedbackTitle",
4088             "description": ""
4089           },
4090           {
4091             "group": "Body",
4092             "type": "String",
4093             "allowedValues": [
4094               "\"star\"",
4095               "\"thumb\""
4096             ],
4097             "optional": true,
4098             "field": "ratingType",
4099             "description": ""
4100           },
4101           {
4102             "group": "Body",
4103             "type": "Integer",
4104             "optional": true,
4105             "field": "ratingStarsNumber",
4106             "description": ""
4107           },
4108           {
4109             "group": "Body",
4110             "type": "Text",
4111             "optional": true,
4112             "field": "onlineForm",
4113             "description": ""
4114           },
4115           {
4116             "group": "Body",
4117             "type": "Text",
4118             "optional": true,
4119             "field": "offlineForm",
4120             "description": ""
4121           },
4122           {
4123             "group": "Body",
4124             "type": "String",
4125             "optional": true,
4126             "field": "token",
4127             "description": ""
4128           },
4129           {
4130             "group": "Body",
4131             "type": "Boolean",
4132             "optional": true,
4133             "field": "autoclose",
4134             "description": ""
4135           },
4136           {
4137             "group": "Body",
4138             "type": "Boolean",
4139             "optional": true,
4140             "field": "enableCustomerWriting",
4141             "description": ""
4142           },
4143           {
4144             "group": "Body",
4145             "type": "Boolean",
4146             "optional": true,
4147             "field": "forwardTranscript",
4148             "description": ""
4149           },
4150           {
4151             "group": "Body",
4152             "type": "String",
4153             "optional": true,
4154             "field": "forwardTranscriptMessage",
4155             "description": ""
4156           },
4157           {
4158             "group": "Body",
4159             "type": "Boolean",
4160             "optional": true,
4161             "field": "forwardOffline",
4162             "description": ""
4163           },
4164           {
4165             "group": "Body",
4166             "type": "String",
4167             "optional": true,
4168             "field": "forwardOfflineAddress",
4169             "description": ""
4170           },
4171           {
4172             "group": "Body",
4173             "type": "String",
4174             "optional": true,
4175             "field": "waitingTitle",
4176             "description": ""
4177           },
4178           {
4179             "group": "Body",
4180             "type": "String",
4181             "optional": true,
4182             "field": "waitingMessage",
4183             "description": ""
4184           },
4185           {
4186             "group": "Body",
4187             "type": "String",
4188             "optional": true,
4189             "field": "offlineMessageSubject",
4190             "description": ""
4191           },
4192           {
4193             "group": "Body",
4194             "type": "String",
4195             "optional": true,
4196             "field": "offlineMessageBody",
4197             "description": ""
4198           },
4199           {
4200             "group": "Body",
4201             "type": "Boolean",
4202             "optional": true,
4203             "field": "enableUnmanagedNote",
4204             "description": ""
4205           },
4206           {
4207             "group": "Body",
4208             "type": "String",
4209             "optional": true,
4210             "field": "unmanagedMessage",
4211             "description": ""
4212           },
4213           {
4214             "group": "Body",
4215             "type": "String",
4216             "optional": true,
4217             "field": "skipUnmanaged",
4218             "description": ""
4219           },
4220           {
4221             "group": "Body",
4222             "type": "String",
4223             "optional": true,
4224             "field": "sendUnmanaged",
4225             "description": ""
4226           },
4227           {
4228             "group": "Body",
4229             "type": "Boolean",
4230             "optional": true,
4231             "field": "enableCustomerAttachment",
4232             "description": ""
4233           },
4234           {
4235             "group": "Body",
4236             "type": "Boolean",
4237             "optional": true,
4238             "field": "enableCustomerCheckmarks",
4239             "description": ""
4240           },
4241           {
4242             "group": "Body",
4243             "type": "Text",
4244             "optional": true,
4245             "field": "agentAvatar",
4246             "description": ""
4247           },
4248           {
4249             "group": "Body",
4250             "type": "Boolean",
4251             "optional": true,
4252             "field": "showAgentAvatar",
4253             "description": ""
4254           },
4255           {
4256             "group": "Body",
4257             "type": "String",
4258             "optional": true,
4259             "field": "timezone",
4260             "description": ""
4261           },
4262           {
4263             "group": "Body",
4264             "type": "Text",
4265             "optional": true,
4266             "field": "notificationTemplate",
4267             "description": ""
4268           },
4269           {
4270             "group": "Body",
4271             "type": "Boolean",
4272             "optional": true,
4273             "field": "notificationSound",
4274             "description": ""
4275           },
4276           {
4277             "group": "Body",
4278             "type": "Boolean",
4279             "optional": true,
4280             "field": "notificationShake",
4281             "description": ""
4282           },
4283           {
4284             "group": "Body",
4285             "type": "Boolean",
4286             "optional": true,
4287             "field": "hideWhenOffline",
4288             "description": ""
4289           },
4290           {
4291             "group": "Body",
4292             "type": "String",
4293             "optional": true,
4294             "field": "agentIdentifier",
4295             "description": ""
4296           },
4297           {
4298             "group": "Body",
4299             "type": "Integer",
4300             "optional": true,
4301             "field": "waitForTheAssignedAgent",
4302             "description": ""
4303           },
4304           {
4305             "group": "Body",
4306             "type": "String",
4307             "optional": true,
4308             "field": "alignment",
4309             "description": ""
4310           },
4311           {
4312             "group": "Body",
4313             "type": "Integer",
4314             "optional": true,
4315             "field": "verticalAlignment",
4316             "description": ""
4317           },
4318           {
4319             "group": "Body",
4320             "type": "String",
4321             "optional": true,
4322             "field": "labelText",
4323             "description": ""
4324           },
4325           {
4326             "group": "Body",
4327             "type": "String",
4328             "optional": true,
4329             "field": "messagesAlignment",
4330             "description": ""
4331           },
4332           {
4333             "group": "Body",
4334             "type": "String",
4335             "optional": true,
4336             "field": "defaultTitle",
4337             "description": ""
4338           },
4339           {
4340             "group": "Body",
4341             "type": "Text",
4342             "optional": true,
4343             "field": "customerAvatar",
4344             "description": ""
4345           },
4346           {
4347             "group": "Body",
4348             "type": "Boolean",
4349             "optional": true,
4350             "field": "showCustomerAvatar",
4351             "description": ""
4352           },
4353           {
4354             "group": "Body",
4355             "type": "Integer",
4356             "optional": true,
4357             "field": "messageFontSize",
4358             "description": ""
4359           },
4360           {
4361             "group": "Body",
4362             "type": "String",
4363             "optional": false,
4364             "field": "backgroundColor",
4365             "description": ""
4366           },
4367           {
4368             "group": "Body",
4369             "type": "Boolean",
4370             "optional": true,
4371             "field": "queueTransfer",
4372             "description": ""
4373           },
4374           {
4375             "group": "Body",
4376             "type": "Integer",
4377             "optional": true,
4378             "field": "queueTransferTimeout",
4379             "description": ""
4380           },
4381           {
4382             "group": "Body",
4383             "type": "Boolean",
4384             "optional": true,
4385             "field": "agentTransfer",
4386             "description": ""
4387           },
4388           {
4389             "group": "Body",
4390             "type": "Integer",
4391             "optional": true,
4392             "field": "agentTransferTimeout",
4393             "description": ""
4394           },
4395           {
4396             "group": "Body",
4397             "type": "String",
4398             "optional": true,
4399             "field": "systemAlias",
4400             "description": ""
4401           },
4402           {
4403             "group": "Body",
4404             "type": "Text",
4405             "optional": true,
4406             "field": "systemAvatar",
4407             "description": ""
4408           },
4409           {
4410             "group": "Body",
4411             "type": "Integer",
4412             "optional": true,
4413             "field": "mandatoryDispositionPauseId",
4414             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4415           },
4416           {
4417             "group": "Body",
4418             "type": "Boolean",
4419             "optional": true,
4420             "field": "mandatoryDisposition",
4421             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4422           },
4423           {
4424             "group": "Body",
4425             "type": "Boolean",
4426             "optional": true,
4427             "field": "vidaooEscalation",
4428             "description": ""
4429           },
4430           {
4431             "group": "Body",
4432             "type": "String",
4433             "optional": true,
4434             "field": "vidaooApiKey",
4435             "description": ""
4436           },
4437           {
4438             "group": "Body",
4439             "type": "String",
4440             "optional": false,
4441             "field": "vidaooTopic",
4442             "description": ""
4443           },
4444           {
4445             "group": "Body",
4446             "type": "String",
4447             "optional": true,
4448             "field": "vidaooNote",
4449             "description": ""
4450           },
4451           {
4452             "group": "Body",
4453             "type": "Text",
4454             "optional": true,
4455             "field": "vidaooMetadata",
4456             "description": ""
4457           },
4458           {
4459             "group": "Body",
4460             "type": "Boolean",
4461             "optional": true,
4462             "field": "openNewInteraction",
4463             "description": ""
4464           },
4465           {
4466             "group": "Body",
4467             "type": "Text",
4468             "optional": true,
4469             "field": "subjectOffline",
4470             "description": ""
4471           }
4472         ]
4473       }
4474     },
4475     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4476     "version": "0.0.0",
4477     "filename": "server/api/chatWebsite/index.js",
4478     "groupTitle": "Chat_Websites"
4479   },
4480   {
4481     "type": "delete",
4482     "url": "/api/chat/websites/{id}",
4483     "title": "Deletes a Website",
4484     "examples": [
4485       {
4486         "title": "Example usage:",
4487         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4488         "type": "json"
4489       }
4490     ],
4491     "name": "DeleteWebsites",
4492     "group": "Chat_Websites",
4493     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4494     "version": "0.0.0",
4495     "filename": "server/api/chatWebsite/index.js",
4496     "groupTitle": "Chat_Websites"
4497   },
4498   {
4499     "type": "get",
4500     "url": "/api/chat/websites/describe",
4501     "title": "Gets table info about Websites",
4502     "examples": [
4503       {
4504         "title": "Example usage:",
4505         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4506         "type": "json"
4507       }
4508     ],
4509     "name": "DescribeWebsites",
4510     "group": "Chat_Websites",
4511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4512     "version": "0.0.0",
4513     "filename": "server/api/chatWebsite/index.js",
4514     "groupTitle": "Chat_Websites"
4515   },
4516   {
4517     "type": "get",
4518     "url": "/api/chat/websites/{id}/users",
4519     "title": "Gets agents from website",
4520     "examples": [
4521       {
4522         "title": "Example usage:",
4523         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4524         "type": "json"
4525       }
4526     ],
4527     "name": "GetAgents",
4528     "group": "Chat_Websites",
4529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4530     "version": "0.0.0",
4531     "filename": "server/api/chatWebsite/index.js",
4532     "groupTitle": "Chat_Websites"
4533   },
4534   {
4535     "type": "get",
4536     "url": "/api/chat/websites",
4537     "title": "Gets a list of Websites",
4538     "examples": [
4539       {
4540         "title": "Example usage:",
4541         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4542         "type": "json"
4543       }
4544     ],
4545     "name": "GetWebsites",
4546     "group": "Chat_Websites",
4547     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4548     "version": "0.0.0",
4549     "filename": "server/api/chatWebsite/index.js",
4550     "groupTitle": "Chat_Websites"
4551   },
4552   {
4553     "type": "delete",
4554     "url": "/api/chat/websites/{id}/users",
4555     "title": "Removes agents from a website",
4556     "examples": [
4557       {
4558         "title": "Example usage:",
4559         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4560         "type": "json"
4561       }
4562     ],
4563     "name": "RemoveAgents",
4564     "group": "Chat_Websites",
4565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4566     "version": "0.0.0",
4567     "filename": "server/api/chatWebsite/index.js",
4568     "groupTitle": "Chat_Websites"
4569   },
4570   {
4571     "type": "delete",
4572     "url": "/api/chat/websites/{id}/canned_answers",
4573     "title": "Removes canned answers from account",
4574     "examples": [
4575       {
4576         "title": "Example usage:",
4577         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4578         "type": "json"
4579       }
4580     ],
4581     "name": "RemoveAnswers",
4582     "group": "Chat_Websites",
4583     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4584     "version": "0.0.0",
4585     "filename": "server/api/chatWebsite/index.js",
4586     "groupTitle": "Chat_Websites"
4587   },
4588   {
4589     "type": "delete",
4590     "url": "/api/chat/websites/{id}/dispositions",
4591     "title": "Removes canned answers from account",
4592     "examples": [
4593       {
4594         "title": "Example usage:",
4595         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4596         "type": "json"
4597       }
4598     ],
4599     "name": "RemoveDispositions",
4600     "group": "Chat_Websites",
4601     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4602     "version": "0.0.0",
4603     "filename": "server/api/chatWebsite/index.js",
4604     "groupTitle": "Chat_Websites"
4605   },
4606   {
4607     "type": "get",
4608     "url": "/api/chat/websites/{id}",
4609     "title": "Gets a single Website",
4610     "examples": [
4611       {
4612         "title": "Example usage:",
4613         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4614         "type": "json"
4615       }
4616     ],
4617     "name": "ShowWebsites",
4618     "group": "Chat_Websites",
4619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4620     "version": "0.0.0",
4621     "filename": "server/api/chatWebsite/index.js",
4622     "groupTitle": "Chat_Websites"
4623   },
4624   {
4625     "type": "put",
4626     "url": "/api/chat/messages/{id}/accept",
4627     "title": "Accepts message",
4628     "examples": [
4629       {
4630         "title": "Example usage:",
4631         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4632         "type": "json"
4633       }
4634     ],
4635     "name": "acceptMessage",
4636     "group": "Chat_Websites",
4637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638     "version": "0.0.0",
4639     "filename": "server/api/chatMessage/index.js",
4640     "groupTitle": "Chat_Websites"
4641   },
4642   {
4643     "type": "post",
4644     "url": "/api/chat/websites/{id}/canned_answers",
4645     "title": "Creates new canned answer",
4646     "examples": [
4647       {
4648         "title": "Example usage:",
4649         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4650         "type": "json"
4651       }
4652     ],
4653     "name": "addAnswer",
4654     "group": "Chat_Websites",
4655     "parameter": {
4656       "fields": {
4657         "Body": [
4658           {
4659             "group": "Body",
4660             "type": "String",
4661             "optional": false,
4662             "field": "key",
4663             "description": ""
4664           },
4665           {
4666             "group": "Body",
4667             "type": "Text",
4668             "optional": false,
4669             "field": "value",
4670             "description": ""
4671           },
4672           {
4673             "group": "Body",
4674             "type": "String",
4675             "optional": true,
4676             "field": "description",
4677             "description": ""
4678           },
4679           {
4680             "group": "Body",
4681             "type": "Virtual",
4682             "optional": true,
4683             "field": "name",
4684             "description": ""
4685           }
4686         ]
4687       }
4688     },
4689     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4690     "version": "0.0.0",
4691     "filename": "server/api/chatWebsite/index.js",
4692     "groupTitle": "Chat_Websites"
4693   },
4694   {
4695     "type": "post",
4696     "url": "/api/chat/websites/{id}/applications",
4697     "title": "Creates new applications",
4698     "examples": [
4699       {
4700         "title": "Example usage:",
4701         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4702         "type": "json"
4703       }
4704     ],
4705     "name": "addApplications",
4706     "group": "Chat_Websites",
4707     "parameter": {
4708       "fields": {
4709         "Body": [
4710           {
4711             "group": "Body",
4712             "type": "Integer",
4713             "optional": false,
4714             "field": "priority",
4715             "description": ""
4716           },
4717           {
4718             "group": "Body",
4719             "type": "String",
4720             "optional": false,
4721             "field": "app",
4722             "description": ""
4723           },
4724           {
4725             "group": "Body",
4726             "type": "Text",
4727             "optional": true,
4728             "field": "appdata",
4729             "description": ""
4730           },
4731           {
4732             "group": "Body",
4733             "type": "String",
4734             "optional": true,
4735             "field": "description",
4736             "description": ""
4737           },
4738           {
4739             "group": "Body",
4740             "type": "String",
4741             "optional": true,
4742             "field": "interval",
4743             "description": ""
4744           }
4745         ]
4746       }
4747     },
4748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4749     "version": "0.0.0",
4750     "filename": "server/api/chatWebsite/index.js",
4751     "groupTitle": "Chat_Websites"
4752   },
4753   {
4754     "type": "post",
4755     "url": "/api/chat/websites/{id}/avatar",
4756     "title": "Add avatar",
4757     "examples": [
4758       {
4759         "title": "Example usage:",
4760         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4761         "type": "json"
4762       }
4763     ],
4764     "name": "addAvatar",
4765     "group": "Chat_Websites",
4766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4767     "version": "0.0.0",
4768     "filename": "server/api/chatWebsite/index.js",
4769     "groupTitle": "Chat_Websites"
4770   },
4771   {
4772     "type": "post",
4773     "url": "/api/chat/websites/{id}/customer_avatar",
4774     "title": "Add customer avatar",
4775     "examples": [
4776       {
4777         "title": "Example usage:",
4778         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4779         "type": "json"
4780       }
4781     ],
4782     "name": "addCustomerAvatar",
4783     "group": "Chat_Websites",
4784     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4785     "version": "0.0.0",
4786     "filename": "server/api/chatWebsite/index.js",
4787     "groupTitle": "Chat_Websites"
4788   },
4789   {
4790     "type": "post",
4791     "url": "/api/chat/websites/{id}/dispositions",
4792     "title": "Creates new disposition",
4793     "examples": [
4794       {
4795         "title": "Example usage:",
4796         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4797         "type": "json"
4798       }
4799     ],
4800     "name": "addDisposition",
4801     "group": "Chat_Websites",
4802     "parameter": {
4803       "fields": {
4804         "Body": [
4805           {
4806             "group": "Body",
4807             "type": "String",
4808             "optional": false,
4809             "field": "name",
4810             "description": ""
4811           },
4812           {
4813             "group": "Body",
4814             "type": "String",
4815             "allowedValues": [
4816               "\"first\"",
4817               "\"second\"",
4818               "\"third\""
4819             ],
4820             "optional": false,
4821             "field": "level",
4822             "description": ""
4823           },
4824           {
4825             "group": "Body",
4826             "type": "String",
4827             "optional": true,
4828             "field": "description",
4829             "description": ""
4830           }
4831         ]
4832       }
4833     },
4834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4835     "version": "0.0.0",
4836     "filename": "server/api/chatWebsite/index.js",
4837     "groupTitle": "Chat_Websites"
4838   },
4839   {
4840     "type": "post",
4841     "url": "/api/chat/accounts/{id}/interactions",
4842     "title": "Creates new interactions",
4843     "examples": [
4844       {
4845         "title": "Example usage:",
4846         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4847         "type": "json"
4848       }
4849     ],
4850     "name": "addInteraction",
4851     "group": "Chat_Websites",
4852     "parameter": {
4853       "fields": {
4854         "Body": [
4855           {
4856             "group": "Body",
4857             "type": "Boolean",
4858             "optional": true,
4859             "field": "closed",
4860             "description": ""
4861           },
4862           {
4863             "group": "Body",
4864             "type": "Integer",
4865             "optional": true,
4866             "field": "ratingValue",
4867             "description": ""
4868           },
4869           {
4870             "group": "Body",
4871             "type": "String",
4872             "allowedValues": [
4873               "\"star\"",
4874               "\"thumb\""
4875             ],
4876             "optional": true,
4877             "field": "ratingType",
4878             "description": ""
4879           },
4880           {
4881             "group": "Body",
4882             "type": "Text",
4883             "optional": true,
4884             "field": "ratingMessage",
4885             "description": ""
4886           },
4887           {
4888             "group": "Body",
4889             "type": "Text",
4890             "optional": true,
4891             "field": "pathTranscript",
4892             "description": ""
4893           },
4894           {
4895             "group": "Body",
4896             "type": "String",
4897             "optional": true,
4898             "field": "mailTranscript",
4899             "description": ""
4900           },
4901           {
4902             "group": "Body",
4903             "type": "String",
4904             "optional": true,
4905             "field": "closedAt",
4906             "description": ""
4907           },
4908           {
4909             "group": "Body",
4910             "type": "String",
4911             "optional": true,
4912             "field": "disposition",
4913             "description": ""
4914           },
4915           {
4916             "group": "Body",
4917             "type": "String",
4918             "optional": true,
4919             "field": "secondDisposition",
4920             "description": ""
4921           },
4922           {
4923             "group": "Body",
4924             "type": "String",
4925             "optional": true,
4926             "field": "thirdDisposition",
4927             "description": ""
4928           },
4929           {
4930             "group": "Body",
4931             "type": "String",
4932             "optional": true,
4933             "field": "note",
4934             "description": ""
4935           },
4936           {
4937             "group": "Body",
4938             "type": "String",
4939             "optional": true,
4940             "field": "browserName",
4941             "description": ""
4942           },
4943           {
4944             "group": "Body",
4945             "type": "String",
4946             "optional": true,
4947             "field": "browserVersion",
4948             "description": ""
4949           },
4950           {
4951             "group": "Body",
4952             "type": "String",
4953             "optional": true,
4954             "field": "osName",
4955             "description": ""
4956           },
4957           {
4958             "group": "Body",
4959             "type": "String",
4960             "optional": true,
4961             "field": "osVersion",
4962             "description": ""
4963           },
4964           {
4965             "group": "Body",
4966             "type": "String",
4967             "optional": true,
4968             "field": "deviceModel",
4969             "description": ""
4970           },
4971           {
4972             "group": "Body",
4973             "type": "String",
4974             "optional": true,
4975             "field": "deviceVendor",
4976             "description": ""
4977           },
4978           {
4979             "group": "Body",
4980             "type": "String",
4981             "optional": true,
4982             "field": "deviceType",
4983             "description": ""
4984           },
4985           {
4986             "group": "Body",
4987             "type": "Text",
4988             "optional": true,
4989             "field": "referer",
4990             "description": ""
4991           },
4992           {
4993             "group": "Body",
4994             "type": "String",
4995             "optional": true,
4996             "field": "customerIp",
4997             "description": ""
4998           },
4999           {
5000             "group": "Body",
5001             "type": "Text",
5002             "optional": true,
5003             "field": "formData",
5004             "description": ""
5005           },
5006           {
5007             "group": "Body",
5008             "type": "String",
5009             "optional": true,
5010             "field": "read1stAt",
5011             "description": ""
5012           },
5013           {
5014             "group": "Body",
5015             "type": "String",
5016             "optional": true,
5017             "field": "lastMsgAt",
5018             "description": ""
5019           },
5020           {
5021             "group": "Body",
5022             "type": "String",
5023             "allowedValues": [
5024               "\"in\"",
5025               "\"out\""
5026             ],
5027             "optional": false,
5028             "field": "lastMsgDirection",
5029             "description": ""
5030           },
5031           {
5032             "group": "Body",
5033             "type": "String",
5034             "optional": true,
5035             "field": "closeReason",
5036             "description": ""
5037           },
5038           {
5039             "group": "Body",
5040             "type": "String",
5041             "optional": true,
5042             "field": "customerPort",
5043             "description": ""
5044           },
5045           {
5046             "group": "Body",
5047             "type": "Text",
5048             "optional": true,
5049             "field": "vidaooSessionId",
5050             "description": ""
5051           },
5052           {
5053             "group": "Body",
5054             "type": "Boolean",
5055             "optional": true,
5056             "field": "autoreplyExecuted",
5057             "description": ""
5058           }
5059         ]
5060       }
5061     },
5062     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5063     "version": "0.0.0",
5064     "filename": "server/api/chatWebsite/index.js",
5065     "groupTitle": "Chat_Websites"
5066   },
5067   {
5068     "type": "post",
5069     "url": "/api/chat/websites/{id}/logo",
5070     "title": "Add logo",
5071     "examples": [
5072       {
5073         "title": "Example usage:",
5074         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5075         "type": "json"
5076       }
5077     ],
5078     "name": "addLogo",
5079     "group": "Chat_Websites",
5080     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5081     "version": "0.0.0",
5082     "filename": "server/api/chatWebsite/index.js",
5083     "groupTitle": "Chat_Websites"
5084   },
5085   {
5086     "type": "post",
5087     "url": "/api/chat/websites/{id}/proactive_actions",
5088     "title": "Creates new Proactive Actions",
5089     "examples": [
5090       {
5091         "title": "Example usage:",
5092         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5093         "type": "json"
5094       }
5095     ],
5096     "name": "addProactiveActions",
5097     "group": "Chat_Websites",
5098     "parameter": {
5099       "fields": {
5100         "Body": [
5101           {
5102             "group": "Body",
5103             "type": "String",
5104             "optional": false,
5105             "field": "name",
5106             "description": ""
5107           },
5108           {
5109             "group": "Body",
5110             "type": "String",
5111             "allowedValues": [
5112               "\"mouseOver\"",
5113               "\"timeout\""
5114             ],
5115             "optional": true,
5116             "field": "type",
5117             "description": ""
5118           },
5119           {
5120             "group": "Body",
5121             "type": "String",
5122             "optional": true,
5123             "field": "selector",
5124             "description": ""
5125           },
5126           {
5127             "group": "Body",
5128             "type": "Integer",
5129             "optional": true,
5130             "field": "timeout",
5131             "description": ""
5132           }
5133         ]
5134       }
5135     },
5136     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5137     "version": "0.0.0",
5138     "filename": "server/api/chatWebsite/index.js",
5139     "groupTitle": "Chat_Websites"
5140   },
5141   {
5142     "type": "post",
5143     "url": "/api/chat/websites/{id}/system_avatar",
5144     "title": "Add system avatar",
5145     "examples": [
5146       {
5147         "title": "Example usage:",
5148         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5149         "type": "json"
5150       }
5151     ],
5152     "name": "addSystemAvatar",
5153     "group": "Chat_Websites",
5154     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5155     "version": "0.0.0",
5156     "filename": "server/api/chatWebsite/index.js",
5157     "groupTitle": "Chat_Websites"
5158   },
5159   {
5160     "type": "get",
5161     "url": "/api/chat/websites/{id}/canned_answers",
5162     "title": "Gets account canned answers",
5163     "examples": [
5164       {
5165         "title": "Example usage:",
5166         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5167         "type": "json"
5168       }
5169     ],
5170     "name": "getAnswers",
5171     "group": "Chat_Websites",
5172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5173     "version": "0.0.0",
5174     "filename": "server/api/chatWebsite/index.js",
5175     "groupTitle": "Chat_Websites"
5176   },
5177   {
5178     "type": "get",
5179     "url": "/api/chat/websites/{id}/applications",
5180     "title": "Gets Website Applications",
5181     "examples": [
5182       {
5183         "title": "Example usage:",
5184         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5185         "type": "json"
5186       }
5187     ],
5188     "name": "getApplications",
5189     "group": "Chat_Websites",
5190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5191     "version": "0.0.0",
5192     "filename": "server/api/chatWebsite/index.js",
5193     "groupTitle": "Chat_Websites"
5194   },
5195   {
5196     "type": "get",
5197     "url": "/api/chat/websites/{id}/avatar",
5198     "title": "Get avatar",
5199     "examples": [
5200       {
5201         "title": "Example usage:",
5202         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5203         "type": "json"
5204       }
5205     ],
5206     "name": "getAvatar",
5207     "group": "Chat_Websites",
5208     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5209     "version": "0.0.0",
5210     "filename": "server/api/chatWebsite/index.js",
5211     "groupTitle": "Chat_Websites"
5212   },
5213   {
5214     "type": "get",
5215     "url": "/api/chat/websites/{id}/customer_avatar",
5216     "title": "Get Customer Avatar",
5217     "examples": [
5218       {
5219         "title": "Example usage:",
5220         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5221         "type": "json"
5222       }
5223     ],
5224     "name": "getCustomerAvatar",
5225     "group": "Chat_Websites",
5226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5227     "version": "0.0.0",
5228     "filename": "server/api/chatWebsite/index.js",
5229     "groupTitle": "Chat_Websites"
5230   },
5231   {
5232     "type": "get",
5233     "url": "/api/chat/websites/{id}/dispositions",
5234     "title": "Gets account dispositions",
5235     "examples": [
5236       {
5237         "title": "Example usage:",
5238         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5239         "type": "json"
5240       }
5241     ],
5242     "name": "getDispositions",
5243     "group": "Chat_Websites",
5244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5245     "version": "0.0.0",
5246     "filename": "server/api/chatWebsite/index.js",
5247     "groupTitle": "Chat_Websites"
5248   },
5249   {
5250     "type": "get",
5251     "url": "/api/chat/websites/{id}/fields",
5252     "title": "Gets Website Fields",
5253     "examples": [
5254       {
5255         "title": "Example usage:",
5256         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5257         "type": "json"
5258       }
5259     ],
5260     "name": "getFields",
5261     "group": "Chat_Websites",
5262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5263     "version": "0.0.0",
5264     "filename": "server/api/chatWebsite/index.js",
5265     "groupTitle": "Chat_Websites"
5266   },
5267   {
5268     "type": "get",
5269     "url": "/api/chat/websites/{id}/interactions",
5270     "title": "Gets Website Interactions",
5271     "examples": [
5272       {
5273         "title": "Example usage:",
5274         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5275         "type": "json"
5276       }
5277     ],
5278     "name": "getInteraction",
5279     "group": "Chat_Websites",
5280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5281     "version": "0.0.0",
5282     "filename": "server/api/chatWebsite/index.js",
5283     "groupTitle": "Chat_Websites"
5284   },
5285   {
5286     "type": "get",
5287     "url": "/api/chat/websites/{id}/logo",
5288     "title": "Get logo",
5289     "examples": [
5290       {
5291         "title": "Example usage:",
5292         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5293         "type": "json"
5294       }
5295     ],
5296     "name": "getLogo",
5297     "group": "Chat_Websites",
5298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5299     "version": "0.0.0",
5300     "filename": "server/api/chatWebsite/index.js",
5301     "groupTitle": "Chat_Websites"
5302   },
5303   {
5304     "type": "get",
5305     "url": "/api/chat/websites/{id}/offline_messages",
5306     "title": "Gets Website Offline Messages",
5307     "examples": [
5308       {
5309         "title": "Example usage:",
5310         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5311         "type": "json"
5312       }
5313     ],
5314     "name": "getOfflineMessages",
5315     "group": "Chat_Websites",
5316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5317     "version": "0.0.0",
5318     "filename": "server/api/chatWebsite/index.js",
5319     "groupTitle": "Chat_Websites"
5320   },
5321   {
5322     "type": "get",
5323     "url": "/api/chat/websites/{id}/proactive_actions",
5324     "title": "Gets Website Proactive Actions",
5325     "examples": [
5326       {
5327         "title": "Example usage:",
5328         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5329         "type": "json"
5330       }
5331     ],
5332     "name": "getProactiveActions",
5333     "group": "Chat_Websites",
5334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5335     "version": "0.0.0",
5336     "filename": "server/api/chatWebsite/index.js",
5337     "groupTitle": "Chat_Websites"
5338   },
5339   {
5340     "type": "get",
5341     "url": "/api/chat/websites/{id}/snippet",
5342     "title": "Gets Website Snippet",
5343     "examples": [
5344       {
5345         "title": "Example usage:",
5346         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5347         "type": "json"
5348       }
5349     ],
5350     "name": "getSnippet",
5351     "group": "Chat_Websites",
5352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5353     "version": "0.0.0",
5354     "filename": "server/api/chatWebsite/index.js",
5355     "groupTitle": "Chat_Websites"
5356   },
5357   {
5358     "type": "get",
5359     "url": "/api/chat/websites/{id}/system_avatar",
5360     "title": "Get System Avatar",
5361     "examples": [
5362       {
5363         "title": "Example usage:",
5364         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5365         "type": "json"
5366       }
5367     ],
5368     "name": "getSystemAvatar",
5369     "group": "Chat_Websites",
5370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5371     "version": "0.0.0",
5372     "filename": "server/api/chatWebsite/index.js",
5373     "groupTitle": "Chat_Websites"
5374   },
5375   {
5376     "type": "post",
5377     "url": "/api/chat/websites/{id}/notify",
5378     "title": "Notify new message",
5379     "examples": [
5380       {
5381         "title": "Example usage:",
5382         "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5383         "type": "json"
5384       }
5385     ],
5386     "name": "notify",
5387     "group": "Chat_Websites",
5388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5389     "version": "0.0.0",
5390     "filename": "server/api/chatWebsite/index.js",
5391     "groupTitle": "Chat_Websites"
5392   },
5393   {
5394     "type": "post",
5395     "url": "/api/chat/websites/{id}/offline",
5396     "title": "Offline message",
5397     "examples": [
5398       {
5399         "title": "Example usage:",
5400         "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5401         "type": "json"
5402       }
5403     ],
5404     "name": "offline",
5405     "group": "Chat_Websites",
5406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5407     "version": "0.0.0",
5408     "filename": "server/api/chatWebsite/index.js",
5409     "groupTitle": "Chat_Websites"
5410   },
5411   {
5412     "type": "put",
5413     "url": "/api/chat/messages/{id}/reject",
5414     "title": "Rejects message",
5415     "examples": [
5416       {
5417         "title": "Example usage:",
5418         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5419         "type": "json"
5420       }
5421     ],
5422     "name": "rejectMessage",
5423     "group": "Chat_Websites",
5424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5425     "version": "0.0.0",
5426     "filename": "server/api/chatMessage/index.js",
5427     "groupTitle": "Chat_Websites"
5428   },
5429   {
5430     "type": "put",
5431     "url": "/api/chat/websites/{id}",
5432     "title": "Update an existing Website",
5433     "examples": [
5434       {
5435         "title": "Example usage:",
5436         "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5437         "type": "json"
5438       }
5439     ],
5440     "name": "updateWebsites",
5441     "group": "Chat_Websites",
5442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5443     "version": "0.0.0",
5444     "filename": "server/api/chatWebsite/index.js",
5445     "groupTitle": "Chat_Websites"
5446   },
5447   {
5448     "type": "post",
5449     "url": "/api/cloudProviders",
5450     "title": "Creates a new CloudProvider",
5451     "examples": [
5452       {
5453         "title": "Example usage:",
5454         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5455         "type": "json"
5456       }
5457     ],
5458     "name": "CreateCloudProviders",
5459     "group": "CloudProviders",
5460     "parameter": {
5461       "fields": {
5462         "Body": [
5463           {
5464             "group": "Body",
5465             "type": "String",
5466             "optional": false,
5467             "field": "name",
5468             "description": ""
5469           },
5470           {
5471             "group": "Body",
5472             "type": "String",
5473             "allowedValues": [
5474               "\"AmazonAWS\"",
5475               "\"Google\""
5476             ],
5477             "optional": false,
5478             "field": "service",
5479             "description": ""
5480           },
5481           {
5482             "group": "Body",
5483             "type": "String",
5484             "optional": true,
5485             "field": "data1",
5486             "description": ""
5487           },
5488           {
5489             "group": "Body",
5490             "type": "String",
5491             "optional": true,
5492             "field": "data2",
5493             "description": ""
5494           }
5495         ]
5496       }
5497     },
5498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5499     "version": "0.0.0",
5500     "filename": "server/api/cloudProvider/index.js",
5501     "groupTitle": "CloudProviders"
5502   },
5503   {
5504     "type": "delete",
5505     "url": "/api/cloudProviders/{id}",
5506     "title": "Deletes a CloudProvider",
5507     "examples": [
5508       {
5509         "title": "Example usage:",
5510         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5511         "type": "json"
5512       }
5513     ],
5514     "name": "DeleteCloudProviders",
5515     "group": "CloudProviders",
5516     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5517     "version": "0.0.0",
5518     "filename": "server/api/cloudProvider/index.js",
5519     "groupTitle": "CloudProviders"
5520   },
5521   {
5522     "type": "get",
5523     "url": "/api/cloudProviders",
5524     "title": "Gets a list of CloudProviders",
5525     "examples": [
5526       {
5527         "title": "Example usage:",
5528         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5529         "type": "json"
5530       }
5531     ],
5532     "name": "GetCloudProviders",
5533     "group": "CloudProviders",
5534     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5535     "version": "0.0.0",
5536     "filename": "server/api/cloudProvider/index.js",
5537     "groupTitle": "CloudProviders"
5538   },
5539   {
5540     "type": "get",
5541     "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5542     "title": "Generates the Microsoft Identity platform authorization url",
5543     "examples": [
5544       {
5545         "title": "Example usage:",
5546         "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5547         "type": "json"
5548       }
5549     ],
5550     "name": "Oauth2MicrosoftAuthorize",
5551     "group": "CloudProviders",
5552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5553     "version": "0.0.0",
5554     "filename": "server/api/cloudProvider/index.js",
5555     "groupTitle": "CloudProviders"
5556   },
5557   {
5558     "type": "post",
5559     "url": "/api/cloudProviders/oauth2/microsoft/callback",
5560     "title": "Receives an authorization code from Microsoft Identity platform",
5561     "name": "Oauth2MicrosoftCallback",
5562     "group": "CloudProviders",
5563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5564     "version": "0.0.0",
5565     "filename": "server/api/cloudProvider/index.js",
5566     "groupTitle": "CloudProviders"
5567   },
5568   {
5569     "type": "get",
5570     "url": "/api/cloudProviders/{id}",
5571     "title": "Gets a single CloudProvider",
5572     "examples": [
5573       {
5574         "title": "Example usage:",
5575         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5576         "type": "json"
5577       }
5578     ],
5579     "name": "ShowCloudProviders",
5580     "group": "CloudProviders",
5581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5582     "version": "0.0.0",
5583     "filename": "server/api/cloudProvider/index.js",
5584     "groupTitle": "CloudProviders"
5585   },
5586   {
5587     "type": "put",
5588     "url": "/api/cloudProviders/{id}",
5589     "title": "Update an existing CloudProvider",
5590     "examples": [
5591       {
5592         "title": "Example usage:",
5593         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5594         "type": "json"
5595       }
5596     ],
5597     "name": "updateCloudProviders",
5598     "group": "CloudProviders",
5599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5600     "version": "0.0.0",
5601     "filename": "server/api/cloudProvider/index.js",
5602     "groupTitle": "CloudProviders"
5603   },
5604   {
5605     "type": "post",
5606     "url": "/api/cm/companies",
5607     "title": "Creates a new Company",
5608     "examples": [
5609       {
5610         "title": "Example usage:",
5611         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5612         "type": "json"
5613       }
5614     ],
5615     "name": "CreateCompanies",
5616     "group": "Cm_Companies",
5617     "parameter": {
5618       "fields": {
5619         "Body": [
5620           {
5621             "group": "Body",
5622             "type": "String",
5623             "optional": false,
5624             "field": "name",
5625             "description": ""
5626           },
5627           {
5628             "group": "Body",
5629             "type": "String",
5630             "optional": true,
5631             "field": "vat",
5632             "description": ""
5633           },
5634           {
5635             "group": "Body",
5636             "type": "String",
5637             "optional": true,
5638             "field": "companyId",
5639             "description": ""
5640           },
5641           {
5642             "group": "Body",
5643             "type": "String",
5644             "optional": true,
5645             "field": "website",
5646             "description": ""
5647           },
5648           {
5649             "group": "Body",
5650             "type": "String",
5651             "optional": true,
5652             "field": "phone",
5653             "description": ""
5654           },
5655           {
5656             "group": "Body",
5657             "type": "String",
5658             "optional": true,
5659             "field": "fax",
5660             "description": ""
5661           },
5662           {
5663             "group": "Body",
5664             "type": "String",
5665             "optional": true,
5666             "field": "type",
5667             "description": ""
5668           },
5669           {
5670             "group": "Body",
5671             "type": "String",
5672             "optional": true,
5673             "field": "street",
5674             "description": ""
5675           },
5676           {
5677             "group": "Body",
5678             "type": "String",
5679             "optional": true,
5680             "field": "postalCode",
5681             "description": ""
5682           },
5683           {
5684             "group": "Body",
5685             "type": "String",
5686             "optional": true,
5687             "field": "city",
5688             "description": ""
5689           },
5690           {
5691             "group": "Body",
5692             "type": "String",
5693             "optional": true,
5694             "field": "country",
5695             "description": ""
5696           },
5697           {
5698             "group": "Body",
5699             "type": "String",
5700             "optional": true,
5701             "field": "email",
5702             "description": ""
5703           },
5704           {
5705             "group": "Body",
5706             "type": "String",
5707             "optional": true,
5708             "field": "emailDomain",
5709             "description": ""
5710           },
5711           {
5712             "group": "Body",
5713             "type": "String",
5714             "optional": true,
5715             "field": "sStreet",
5716             "description": ""
5717           },
5718           {
5719             "group": "Body",
5720             "type": "String",
5721             "optional": true,
5722             "field": "sPostalCode",
5723             "description": ""
5724           },
5725           {
5726             "group": "Body",
5727             "type": "String",
5728             "optional": true,
5729             "field": "sCity",
5730             "description": ""
5731           },
5732           {
5733             "group": "Body",
5734             "type": "String",
5735             "optional": true,
5736             "field": "sCountry",
5737             "description": ""
5738           },
5739           {
5740             "group": "Body",
5741             "type": "String",
5742             "optional": true,
5743             "field": "description",
5744             "description": ""
5745           }
5746         ]
5747       }
5748     },
5749     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5750     "version": "0.0.0",
5751     "filename": "server/api/cmCompany/index.js",
5752     "groupTitle": "Cm_Companies"
5753   },
5754   {
5755     "type": "delete",
5756     "url": "/api/cm/companies/{id}",
5757     "title": "Deletes a Company",
5758     "examples": [
5759       {
5760         "title": "Example usage:",
5761         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5762         "type": "json"
5763       }
5764     ],
5765     "name": "DeleteCompanies",
5766     "group": "Cm_Companies",
5767     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5768     "version": "0.0.0",
5769     "filename": "server/api/cmCompany/index.js",
5770     "groupTitle": "Cm_Companies"
5771   },
5772   {
5773     "type": "get",
5774     "url": "/api/cm/companies/describe",
5775     "title": "Gets table info about Companies",
5776     "examples": [
5777       {
5778         "title": "Example usage:",
5779         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5780         "type": "json"
5781       }
5782     ],
5783     "name": "DescribeCompanies",
5784     "group": "Cm_Companies",
5785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5786     "version": "0.0.0",
5787     "filename": "server/api/cmCompany/index.js",
5788     "groupTitle": "Cm_Companies"
5789   },
5790   {
5791     "type": "get",
5792     "url": "/api/cm/companies",
5793     "title": "Gets a list of Companies",
5794     "examples": [
5795       {
5796         "title": "Example usage:",
5797         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5798         "type": "json"
5799       }
5800     ],
5801     "name": "GetCompanies",
5802     "group": "Cm_Companies",
5803     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5804     "version": "0.0.0",
5805     "filename": "server/api/cmCompany/index.js",
5806     "groupTitle": "Cm_Companies"
5807   },
5808   {
5809     "type": "get",
5810     "url": "/api/cm/companies/{id}",
5811     "title": "Gets a single Company",
5812     "examples": [
5813       {
5814         "title": "Example usage:",
5815         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5816         "type": "json"
5817       }
5818     ],
5819     "name": "ShowCompanies",
5820     "group": "Cm_Companies",
5821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5822     "version": "0.0.0",
5823     "filename": "server/api/cmCompany/index.js",
5824     "groupTitle": "Cm_Companies"
5825   },
5826   {
5827     "type": "post",
5828     "url": "/api/cm/companies/{id}/contacts",
5829     "title": "Creates new contacts",
5830     "examples": [
5831       {
5832         "title": "Example usage:",
5833         "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5834         "type": "json"
5835       }
5836     ],
5837     "name": "addContacts",
5838     "group": "Cm_Companies",
5839     "parameter": {
5840       "fields": {
5841         "Body": [
5842           {
5843             "group": "Body",
5844             "type": "String",
5845             "optional": false,
5846             "field": "firstName",
5847             "description": ""
5848           },
5849           {
5850             "group": "Body",
5851             "type": "String",
5852             "optional": true,
5853             "field": "lastName",
5854             "description": ""
5855           },
5856           {
5857             "group": "Body",
5858             "type": "String",
5859             "optional": true,
5860             "field": "street",
5861             "description": ""
5862           },
5863           {
5864             "group": "Body",
5865             "type": "String",
5866             "optional": true,
5867             "field": "postalCode",
5868             "description": ""
5869           },
5870           {
5871             "group": "Body",
5872             "type": "String",
5873             "optional": true,
5874             "field": "city",
5875             "description": ""
5876           },
5877           {
5878             "group": "Body",
5879             "type": "String",
5880             "optional": true,
5881             "field": "country",
5882             "description": ""
5883           },
5884           {
5885             "group": "Body",
5886             "type": "String",
5887             "optional": true,
5888             "field": "dateOfBirth",
5889             "description": ""
5890           },
5891           {
5892             "group": "Body",
5893             "type": "Text",
5894             "optional": true,
5895             "field": "description",
5896             "description": ""
5897           },
5898           {
5899             "group": "Body",
5900             "type": "String",
5901             "optional": true,
5902             "field": "phone",
5903             "description": ""
5904           },
5905           {
5906             "group": "Body",
5907             "type": "String",
5908             "optional": true,
5909             "field": "mobile",
5910             "description": ""
5911           },
5912           {
5913             "group": "Body",
5914             "type": "String",
5915             "optional": true,
5916             "field": "fax",
5917             "description": ""
5918           },
5919           {
5920             "group": "Body",
5921             "type": "String",
5922             "optional": true,
5923             "field": "email",
5924             "description": ""
5925           },
5926           {
5927             "group": "Body",
5928             "type": "String",
5929             "optional": true,
5930             "field": "url",
5931             "description": ""
5932           },
5933           {
5934             "group": "Body",
5935             "type": "String",
5936             "optional": true,
5937             "field": "facebook",
5938             "description": ""
5939           },
5940           {
5941             "group": "Body",
5942             "type": "String",
5943             "optional": true,
5944             "field": "fb_data",
5945             "description": ""
5946           },
5947           {
5948             "group": "Body",
5949             "type": "String",
5950             "optional": true,
5951             "field": "twitter",
5952             "description": ""
5953           },
5954           {
5955             "group": "Body",
5956             "type": "String",
5957             "optional": true,
5958             "field": "skype",
5959             "description": ""
5960           },
5961           {
5962             "group": "Body",
5963             "type": "String",
5964             "optional": true,
5965             "field": "teams",
5966             "description": ""
5967           },
5968           {
5969             "group": "Body",
5970             "type": "String",
5971             "optional": true,
5972             "field": "viber",
5973             "description": ""
5974           },
5975           {
5976             "group": "Body",
5977             "type": "String",
5978             "optional": true,
5979             "field": "line",
5980             "description": ""
5981           },
5982           {
5983             "group": "Body",
5984             "type": "String",
5985             "optional": true,
5986             "field": "wechat",
5987             "description": ""
5988           },
5989           {
5990             "group": "Body",
5991             "type": "String",
5992             "optional": true,
5993             "field": "telegram",
5994             "description": ""
5995           },
5996           {
5997             "group": "Body",
5998             "type": "Integer",
5999             "optional": true,
6000             "field": "UserId",
6001             "description": ""
6002           },
6003           {
6004             "group": "Body",
6005             "type": "Integer",
6006             "optional": true,
6007             "field": "priority",
6008             "description": ""
6009           },
6010           {
6011             "group": "Body",
6012             "type": "String",
6013             "optional": true,
6014             "field": "scheduledat",
6015             "description": ""
6016           }
6017         ]
6018       }
6019     },
6020     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6021     "version": "0.0.0",
6022     "filename": "server/api/cmCompany/index.js",
6023     "groupTitle": "Cm_Companies"
6024   },
6025   {
6026     "type": "get",
6027     "url": "/api/cm/companies/{id}/contacts",
6028     "title": "Gets List Contacts",
6029     "examples": [
6030       {
6031         "title": "Example usage:",
6032         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6033         "type": "json"
6034       }
6035     ],
6036     "name": "getContacts",
6037     "group": "Cm_Companies",
6038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6039     "version": "0.0.0",
6040     "filename": "server/api/cmCompany/index.js",
6041     "groupTitle": "Cm_Companies"
6042   },
6043   {
6044     "type": "put",
6045     "url": "/api/cm/companies/{id}",
6046     "title": "Update an existing Company",
6047     "examples": [
6048       {
6049         "title": "Example usage:",
6050         "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6051         "type": "json"
6052       }
6053     ],
6054     "name": "updateCompanies",
6055     "group": "Cm_Companies",
6056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6057     "version": "0.0.0",
6058     "filename": "server/api/cmCompany/index.js",
6059     "groupTitle": "Cm_Companies"
6060   },
6061   {
6062     "type": "delete",
6063     "url": "/api/cm/contacts/{id}",
6064     "title": "Deletes a Contact",
6065     "examples": [
6066       {
6067         "title": "Example usage:",
6068         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6069         "type": "json"
6070       }
6071     ],
6072     "name": "DeleteContacts",
6073     "group": "Cm_Contacts",
6074     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6075     "version": "0.0.0",
6076     "filename": "server/api/cmContact/index.js",
6077     "groupTitle": "Cm_Contacts"
6078   },
6079   {
6080     "type": "get",
6081     "url": "/api/cm/contacts/describe",
6082     "title": "Gets table info about Contacts",
6083     "examples": [
6084       {
6085         "title": "Example usage:",
6086         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6087         "type": "json"
6088       }
6089     ],
6090     "name": "DescribeContacts",
6091     "group": "Cm_Contacts",
6092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6093     "version": "0.0.0",
6094     "filename": "server/api/cmContact/index.js",
6095     "groupTitle": "Cm_Contacts"
6096   },
6097   {
6098     "type": "get",
6099     "url": "/api/cm/contacts",
6100     "title": "Gets a list of Contacts",
6101     "examples": [
6102       {
6103         "title": "Example usage:",
6104         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6105         "type": "json"
6106       }
6107     ],
6108     "name": "GetContacts",
6109     "group": "Cm_Contacts",
6110     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6111     "version": "0.0.0",
6112     "filename": "server/api/cmContact/index.js",
6113     "groupTitle": "Cm_Contacts"
6114   },
6115   {
6116     "type": "get",
6117     "url": "/api/cm/contacts/{id}/finals",
6118     "title": "Gets contact hopper finals",
6119     "examples": [
6120       {
6121         "title": "Example usage:",
6122         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6123         "type": "json"
6124       }
6125     ],
6126     "name": "GetHopperFinals",
6127     "group": "Cm_Contacts",
6128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6129     "version": "0.0.0",
6130     "filename": "server/api/cmContact/index.js",
6131     "groupTitle": "Cm_Contacts"
6132   },
6133   {
6134     "type": "get",
6135     "url": "/api/cm/contacts/{id}/hopper_histories",
6136     "title": "Gets contact hopper histories",
6137     "examples": [
6138       {
6139         "title": "Example usage:",
6140         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6141         "type": "json"
6142       }
6143     ],
6144     "name": "GetHopperHistories",
6145     "group": "Cm_Contacts",
6146     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6147     "version": "0.0.0",
6148     "filename": "server/api/cmContact/index.js",
6149     "groupTitle": "Cm_Contacts"
6150   },
6151   {
6152     "type": "get",
6153     "url": "/api/cm/contacts/{id}/hoppers",
6154     "title": "Gets contact hoppers",
6155     "examples": [
6156       {
6157         "title": "Example usage:",
6158         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6159         "type": "json"
6160       }
6161     ],
6162     "name": "GetHoppers",
6163     "group": "Cm_Contacts",
6164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6165     "version": "0.0.0",
6166     "filename": "server/api/cmContact/index.js",
6167     "groupTitle": "Cm_Contacts"
6168   },
6169   {
6170     "type": "post",
6171     "url": "/api/cm/contacts/create_many",
6172     "title": "Create Contacts",
6173     "examples": [
6174       {
6175         "title": "Example usage:",
6176         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6177         "type": "json"
6178       }
6179     ],
6180     "name": "bulkCreate",
6181     "group": "Cm_Contacts",
6182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6183     "version": "0.0.0",
6184     "filename": "server/api/cmContact/index.js",
6185     "groupTitle": "Cm_Contacts"
6186   },
6187   {
6188     "type": "post",
6189     "url": "/api/cm/contacts",
6190     "title": "Create Contact",
6191     "examples": [
6192       {
6193         "title": "Example usage:",
6194         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6195         "type": "json"
6196       }
6197     ],
6198     "name": "create",
6199     "group": "Cm_Contacts",
6200     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6201     "version": "0.0.0",
6202     "filename": "server/api/cmContact/index.js",
6203     "groupTitle": "Cm_Contacts"
6204   },
6205   {
6206     "type": "get",
6207     "url": "/api/cm/contacts/{id}/journey",
6208     "title": "Gets customer journey",
6209     "examples": [
6210       {
6211         "title": "Example usage:",
6212         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6213         "type": "json"
6214       }
6215     ],
6216     "name": "getJourney",
6217     "group": "Cm_Contacts",
6218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6219     "version": "0.0.0",
6220     "filename": "server/api/cmContact/index.js",
6221     "groupTitle": "Cm_Contacts"
6222   },
6223   {
6224     "type": "get",
6225     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6226     "title": "Gets contact hopper blacks",
6227     "examples": [
6228       {
6229         "title": "Example usage:",
6230         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6231         "type": "json"
6232       }
6233     ],
6234     "name": "getJscriptySessions",
6235     "group": "Cm_Contacts",
6236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6237     "version": "0.0.0",
6238     "filename": "server/api/cmContact/index.js",
6239     "groupTitle": "Cm_Contacts"
6240   },
6241   {
6242     "type": "get",
6243     "url": "/api/cm/contacts/{id}/tags",
6244     "title": "Gets configurations tags",
6245     "examples": [
6246       {
6247         "title": "Example usage:",
6248         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6249         "type": "json"
6250       }
6251     ],
6252     "name": "getTags",
6253     "group": "Cm_Contacts",
6254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6255     "version": "0.0.0",
6256     "filename": "server/api/cmContact/index.js",
6257     "groupTitle": "Cm_Contacts"
6258   },
6259   {
6260     "type": "post",
6261     "url": "/api/cm/contacts/merge",
6262     "title": "Merge Contact",
6263     "examples": [
6264       {
6265         "title": "Example usage:",
6266         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6267         "type": "json"
6268       }
6269     ],
6270     "name": "merge",
6271     "group": "Cm_Contacts",
6272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6273     "version": "0.0.0",
6274     "filename": "server/api/cmContact/index.js",
6275     "groupTitle": "Cm_Contacts"
6276   },
6277   {
6278     "type": "post",
6279     "url": "/api/cm/contacts/{id}/tags",
6280     "title": "Sets new tags",
6281     "examples": [
6282       {
6283         "title": "Example usage:",
6284         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6285         "type": "json"
6286       }
6287     ],
6288     "name": "setTags",
6289     "group": "Cm_Contacts",
6290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6291     "version": "0.0.0",
6292     "filename": "server/api/cmContact/index.js",
6293     "groupTitle": "Cm_Contacts"
6294   },
6295   {
6296     "type": "get",
6297     "url": "/api/cm/contacts/{id}",
6298     "title": "Gets a single Contact",
6299     "examples": [
6300       {
6301         "title": "Example usage:",
6302         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6303         "type": "json"
6304       }
6305     ],
6306     "name": "show",
6307     "group": "Cm_Contacts",
6308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6309     "version": "0.0.0",
6310     "filename": "server/api/cmContact/index.js",
6311     "groupTitle": "Cm_Contacts"
6312   },
6313   {
6314     "type": "put",
6315     "url": "/api/cm/contacts/{id}",
6316     "title": "Update a single Contact",
6317     "examples": [
6318       {
6319         "title": "Example usage:",
6320         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6321         "type": "json"
6322       }
6323     ],
6324     "name": "update",
6325     "group": "Cm_Contacts",
6326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6327     "version": "0.0.0",
6328     "filename": "server/api/cmContact/index.js",
6329     "groupTitle": "Cm_Contacts"
6330   },
6331   {
6332     "type": "delete",
6333     "url": "/api/cm/custom_fields/{id}",
6334     "title": "Deletes a Custom Field",
6335     "examples": [
6336       {
6337         "title": "Example usage:",
6338         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6339         "type": "json"
6340       }
6341     ],
6342     "name": "DeleteCustom_Fields",
6343     "group": "Cm_Custom_Fields",
6344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6345     "version": "0.0.0",
6346     "filename": "server/api/cmCustomField/index.js",
6347     "groupTitle": "Cm_Custom_Fields"
6348   },
6349   {
6350     "type": "get",
6351     "url": "/api/cm/custom_fields",
6352     "title": "Gets a list of Custom Fields",
6353     "examples": [
6354       {
6355         "title": "Example usage:",
6356         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6357         "type": "json"
6358       }
6359     ],
6360     "name": "GetCustom_Fields",
6361     "group": "Cm_Custom_Fields",
6362     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/custom_fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/custom_fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/custom_fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/custom_fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/custom_fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6363     "version": "0.0.0",
6364     "filename": "server/api/cmCustomField/index.js",
6365     "groupTitle": "Cm_Custom_Fields"
6366   },
6367   {
6368     "type": "get",
6369     "url": "/api/cm/custom_fields/{id}",
6370     "title": "Gets a single Custom Field",
6371     "examples": [
6372       {
6373         "title": "Example usage:",
6374         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6375         "type": "json"
6376       }
6377     ],
6378     "name": "ShowCustom_Fields",
6379     "group": "Cm_Custom_Fields",
6380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6381     "version": "0.0.0",
6382     "filename": "server/api/cmCustomField/index.js",
6383     "groupTitle": "Cm_Custom_Fields"
6384   },
6385   {
6386     "type": "put",
6387     "url": "/api/cm/custom_fields/{id}",
6388     "title": "Update an existing Custom Field",
6389     "examples": [
6390       {
6391         "title": "Example usage:",
6392         "content": "curl https://{domain}/api/cm/custom_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6393         "type": "json"
6394       }
6395     ],
6396     "name": "updateCustom_Fields",
6397     "group": "Cm_Custom_Fields",
6398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6399     "version": "0.0.0",
6400     "filename": "server/api/cmCustomField/index.js",
6401     "groupTitle": "Cm_Custom_Fields"
6402   },
6403   {
6404     "type": "post",
6405     "url": "/api/cm/hopper",
6406     "title": "Creates a new Hopper",
6407     "examples": [
6408       {
6409         "title": "Example usage:",
6410         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6411         "type": "json"
6412       }
6413     ],
6414     "name": "CreateHopper",
6415     "group": "Cm_Hopper",
6416     "parameter": {
6417       "fields": {
6418         "Body": [
6419           {
6420             "group": "Body",
6421             "type": "String",
6422             "optional": false,
6423             "field": "phone",
6424             "description": ""
6425           },
6426           {
6427             "group": "Body",
6428             "type": "Boolean",
6429             "optional": true,
6430             "field": "active",
6431             "description": ""
6432           },
6433           {
6434             "group": "Body",
6435             "type": "String",
6436             "optional": true,
6437             "field": "scheduledat",
6438             "description": ""
6439           },
6440           {
6441             "group": "Body",
6442             "type": "Integer",
6443             "optional": true,
6444             "field": "countbusyretry",
6445             "description": ""
6446           },
6447           {
6448             "group": "Body",
6449             "type": "Integer",
6450             "optional": true,
6451             "field": "countcongestionretry",
6452             "description": ""
6453           },
6454           {
6455             "group": "Body",
6456             "type": "Integer",
6457             "optional": true,
6458             "field": "countnoanswerretry",
6459             "description": ""
6460           },
6461           {
6462             "group": "Body",
6463             "type": "Boolean",
6464             "optional": true,
6465             "field": "callback",
6466             "description": ""
6467           },
6468           {
6469             "group": "Body",
6470             "type": "String",
6471             "optional": true,
6472             "field": "callbackuniqueid",
6473             "description": ""
6474           },
6475           {
6476             "group": "Body",
6477             "type": "String",
6478             "optional": true,
6479             "field": "callbackat",
6480             "description": ""
6481           },
6482           {
6483             "group": "Body",
6484             "type": "Integer",
6485             "optional": true,
6486             "field": "priority",
6487             "description": ""
6488           },
6489           {
6490             "group": "Body",
6491             "type": "Boolean",
6492             "optional": true,
6493             "field": "recallme",
6494             "description": ""
6495           },
6496           {
6497             "group": "Body",
6498             "type": "Integer",
6499             "optional": true,
6500             "field": "ContactId",
6501             "description": ""
6502           },
6503           {
6504             "group": "Body",
6505             "type": "Integer",
6506             "optional": true,
6507             "field": "ListId",
6508             "description": ""
6509           },
6510           {
6511             "group": "Body",
6512             "type": "Integer",
6513             "optional": true,
6514             "field": "UserId",
6515             "description": ""
6516           },
6517           {
6518             "group": "Body",
6519             "type": "Integer",
6520             "optional": true,
6521             "field": "VoiceQueueId",
6522             "description": ""
6523           },
6524           {
6525             "group": "Body",
6526             "type": "Integer",
6527             "optional": true,
6528             "field": "CampaignId",
6529             "description": ""
6530           },
6531           {
6532             "group": "Body",
6533             "type": "Integer",
6534             "optional": true,
6535             "field": "countnosuchnumberretry",
6536             "description": ""
6537           },
6538           {
6539             "group": "Body",
6540             "type": "Integer",
6541             "optional": true,
6542             "field": "countdropretry",
6543             "description": ""
6544           },
6545           {
6546             "group": "Body",
6547             "type": "Integer",
6548             "optional": true,
6549             "field": "countabandonedretry",
6550             "description": ""
6551           },
6552           {
6553             "group": "Body",
6554             "type": "Integer",
6555             "optional": true,
6556             "field": "countmachineretry",
6557             "description": ""
6558           },
6559           {
6560             "group": "Body",
6561             "type": "Integer",
6562             "optional": true,
6563             "field": "countagentrejectretry",
6564             "description": ""
6565           }
6566         ]
6567       }
6568     },
6569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6570     "version": "0.0.0",
6571     "filename": "server/api/cmHopper/index.js",
6572     "groupTitle": "Cm_Hopper"
6573   },
6574   {
6575     "type": "get",
6576     "url": "/api/cm/hopper/describe",
6577     "title": "Gets table info about Hopper",
6578     "examples": [
6579       {
6580         "title": "Example usage:",
6581         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6582         "type": "json"
6583       }
6584     ],
6585     "name": "DescribeHopper",
6586     "group": "Cm_Hopper",
6587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6588     "version": "0.0.0",
6589     "filename": "server/api/cmHopper/index.js",
6590     "groupTitle": "Cm_Hopper"
6591   },
6592   {
6593     "type": "get",
6594     "url": "/api/cm/hopper",
6595     "title": "Gets a list of Hopper",
6596     "examples": [
6597       {
6598         "title": "Example usage:",
6599         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6600         "type": "json"
6601       }
6602     ],
6603     "name": "GetHopper",
6604     "group": "Cm_Hopper",
6605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6606     "version": "0.0.0",
6607     "filename": "server/api/cmHopper/index.js",
6608     "groupTitle": "Cm_Hopper"
6609   },
6610   {
6611     "type": "get",
6612     "url": "/api/cm/hopper/{id}",
6613     "title": "Gets a single Hopper",
6614     "examples": [
6615       {
6616         "title": "Example usage:",
6617         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6618         "type": "json"
6619       }
6620     ],
6621     "name": "ShowHopper",
6622     "group": "Cm_Hopper",
6623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6624     "version": "0.0.0",
6625     "filename": "server/api/cmHopper/index.js",
6626     "groupTitle": "Cm_Hopper"
6627   },
6628   {
6629     "type": "delete",
6630     "url": "/api/cm/hopper_black/{id}",
6631     "title": "Deletes a Hopper Black",
6632     "examples": [
6633       {
6634         "title": "Example usage:",
6635         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6636         "type": "json"
6637       }
6638     ],
6639     "name": "DeleteHopper_Black",
6640     "group": "Cm_Hopper_Black",
6641     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6642     "version": "0.0.0",
6643     "filename": "server/api/cmHopperBlack/index.js",
6644     "groupTitle": "Cm_Hopper_Black"
6645   },
6646   {
6647     "type": "get",
6648     "url": "/api/cm/hopper_black/describe",
6649     "title": "Gets table info about Hopper Black",
6650     "examples": [
6651       {
6652         "title": "Example usage:",
6653         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6654         "type": "json"
6655       }
6656     ],
6657     "name": "DescribeHopper_Black",
6658     "group": "Cm_Hopper_Black",
6659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6660     "version": "0.0.0",
6661     "filename": "server/api/cmHopperBlack/index.js",
6662     "groupTitle": "Cm_Hopper_Black"
6663   },
6664   {
6665     "type": "get",
6666     "url": "/api/cm/hopper_black",
6667     "title": "Gets a list of Hopper Black",
6668     "examples": [
6669       {
6670         "title": "Example usage:",
6671         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6672         "type": "json"
6673       }
6674     ],
6675     "name": "GetHopper_Black",
6676     "group": "Cm_Hopper_Black",
6677     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_black?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_black?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_black?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_black?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_black?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6678     "version": "0.0.0",
6679     "filename": "server/api/cmHopperBlack/index.js",
6680     "groupTitle": "Cm_Hopper_Black"
6681   },
6682   {
6683     "type": "get",
6684     "url": "/api/cm/hopper_black/{id}",
6685     "title": "Gets a single Hopper Black",
6686     "examples": [
6687       {
6688         "title": "Example usage:",
6689         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6690         "type": "json"
6691       }
6692     ],
6693     "name": "ShowHopper_Black",
6694     "group": "Cm_Hopper_Black",
6695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6696     "version": "0.0.0",
6697     "filename": "server/api/cmHopperBlack/index.js",
6698     "groupTitle": "Cm_Hopper_Black"
6699   },
6700   {
6701     "type": "put",
6702     "url": "/api/cm/hopper_black/{id}",
6703     "title": "Update an existing Hopper Black",
6704     "examples": [
6705       {
6706         "title": "Example usage:",
6707         "content": "curl https://{domain}/api/cm/hopper_black/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6708         "type": "json"
6709       }
6710     ],
6711     "name": "updateHopper_Black",
6712     "group": "Cm_Hopper_Black",
6713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6714     "version": "0.0.0",
6715     "filename": "server/api/cmHopperBlack/index.js",
6716     "groupTitle": "Cm_Hopper_Black"
6717   },
6718   {
6719     "type": "post",
6720     "url": "/api/cm/hopper_final/checkContactHopper",
6721     "title": "Check if contact is in hopper",
6722     "examples": [
6723       {
6724         "title": "Example usage:",
6725         "content": "curl https://{domain}/api/hopper_final/checkContactHopper -d '{\"VoiceQueueId\": \"VoiceQueueId\", \"CampaignId\": \"CampaignId\", \"ContactId\": \"ContactId\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6726         "type": "json"
6727       }
6728     ],
6729     "name": "/checkContactHopper",
6730     "group": "Cm_Hopper_Final",
6731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6732     "version": "0.0.0",
6733     "filename": "server/api/cmHopperFinal/index.js",
6734     "groupTitle": "Cm_Hopper_Final"
6735   },
6736   {
6737     "type": "get",
6738     "url": "/api/cm/hopper_final/describe",
6739     "title": "Gets table info about HopperFinal",
6740     "examples": [
6741       {
6742         "title": "Example usage:",
6743         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6744         "type": "json"
6745       }
6746     ],
6747     "name": "DescribeHopperFinal",
6748     "group": "Cm_Hopper_Final",
6749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6750     "version": "0.0.0",
6751     "filename": "server/api/cmHopperFinal/index.js",
6752     "groupTitle": "Cm_Hopper_Final"
6753   },
6754   {
6755     "type": "get",
6756     "url": "/api/cm/hopper_final",
6757     "title": "Gets a list of HopperFinal",
6758     "examples": [
6759       {
6760         "title": "Example usage:",
6761         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6762         "type": "json"
6763       }
6764     ],
6765     "name": "GetHopperFinal",
6766     "group": "Cm_Hopper_Final",
6767     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_final?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_final?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_final?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_final?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_final?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6768     "version": "0.0.0",
6769     "filename": "server/api/cmHopperFinal/index.js",
6770     "groupTitle": "Cm_Hopper_Final"
6771   },
6772   {
6773     "type": "get",
6774     "url": "/api/cm/hopper_final/{id}",
6775     "title": "Gets a single HopperFinal",
6776     "examples": [
6777       {
6778         "title": "Example usage:",
6779         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6780         "type": "json"
6781       }
6782     ],
6783     "name": "ShowHopperFinal",
6784     "group": "Cm_Hopper_Final",
6785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6786     "version": "0.0.0",
6787     "filename": "server/api/cmHopperFinal/index.js",
6788     "groupTitle": "Cm_Hopper_Final"
6789   },
6790   {
6791     "type": "get",
6792     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6793     "title": "Return number contacts for attributes",
6794     "examples": [
6795       {
6796         "title": "Example usage:",
6797         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6798         "type": "json"
6799       }
6800     ],
6801     "name": "countContactsIvrCampaignHopperFinal",
6802     "group": "Cm_Hopper_Final",
6803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6804     "version": "0.0.0",
6805     "filename": "server/api/cmHopperFinal/index.js",
6806     "groupTitle": "Cm_Hopper_Final"
6807   },
6808   {
6809     "type": "get",
6810     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6811     "title": "Return number contacts for attributes",
6812     "examples": [
6813       {
6814         "title": "Example usage:",
6815         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6816         "type": "json"
6817       }
6818     ],
6819     "name": "countContactsQueueCampaignHopperFinal",
6820     "group": "Cm_Hopper_Final",
6821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6822     "version": "0.0.0",
6823     "filename": "server/api/cmHopperFinal/index.js",
6824     "groupTitle": "Cm_Hopper_Final"
6825   },
6826   {
6827     "type": "post",
6828     "url": "/api/cm/hopper_final/campaign/{id}",
6829     "title": "Move contacts in hopper",
6830     "examples": [
6831       {
6832         "title": "Example usage:",
6833         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6834         "type": "json"
6835       }
6836     ],
6837     "name": "moveContactsIvrCampaignHopperFinal",
6838     "group": "Cm_Hopper_Final",
6839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6840     "version": "0.0.0",
6841     "filename": "server/api/cmHopperFinal/index.js",
6842     "groupTitle": "Cm_Hopper_Final"
6843   },
6844   {
6845     "type": "post",
6846     "url": "/api/cm/hopper_final/voice/queue/{id}",
6847     "title": "Move contacts in hopper",
6848     "examples": [
6849       {
6850         "title": "Example usage:",
6851         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6852         "type": "json"
6853       }
6854     ],
6855     "name": "moveContactsQueueCampaignHopperFinal",
6856     "group": "Cm_Hopper_Final",
6857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6858     "version": "0.0.0",
6859     "filename": "server/api/cmHopperFinal/index.js",
6860     "groupTitle": "Cm_Hopper_Final"
6861   },
6862   {
6863     "type": "put",
6864     "url": "/api/cm/hopper_final/{id}",
6865     "title": "Update a single hopper final",
6866     "examples": [
6867       {
6868         "title": "Example usage:",
6869         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6870         "type": "json"
6871       }
6872     ],
6873     "name": "update",
6874     "group": "Cm_Hopper_Final",
6875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6876     "version": "0.0.0",
6877     "filename": "server/api/cmHopperFinal/index.js",
6878     "groupTitle": "Cm_Hopper_Final"
6879   },
6880   {
6881     "type": "post",
6882     "url": "/api/cm/hopper_history",
6883     "title": "Creates a new HopperHistory",
6884     "examples": [
6885       {
6886         "title": "Example usage:",
6887         "content": "curl https://{domain}/api/cm/hopper_history -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6888         "type": "json"
6889       }
6890     ],
6891     "name": "CreateHopperHistory",
6892     "group": "Cm_Hopper_History",
6893     "parameter": {
6894       "fields": {
6895         "Body": [
6896           {
6897             "group": "Body",
6898             "type": "Integer",
6899             "optional": true,
6900             "field": "state",
6901             "description": ""
6902           },
6903           {
6904             "group": "Body",
6905             "type": "String",
6906             "optional": true,
6907             "field": "statedesc",
6908             "description": ""
6909           },
6910           {
6911             "group": "Body",
6912             "type": "String",
6913             "optional": true,
6914             "field": "scheduledat",
6915             "description": ""
6916           },
6917           {
6918             "group": "Body",
6919             "type": "Integer",
6920             "optional": true,
6921             "field": "countbusyretry",
6922             "description": ""
6923           },
6924           {
6925             "group": "Body",
6926             "type": "Integer",
6927             "optional": true,
6928             "field": "countcongestionretry",
6929             "description": ""
6930           },
6931           {
6932             "group": "Body",
6933             "type": "Integer",
6934             "optional": true,
6935             "field": "countnoanswerretry",
6936             "description": ""
6937           },
6938           {
6939             "group": "Body",
6940             "type": "Integer",
6941             "optional": true,
6942             "field": "countglobal",
6943             "description": ""
6944           },
6945           {
6946             "group": "Body",
6947             "type": "String",
6948             "optional": true,
6949             "field": "uniqueid",
6950             "description": ""
6951           },
6952           {
6953             "group": "Body",
6954             "type": "String",
6955             "optional": true,
6956             "field": "originatecalleridnum",
6957             "description": ""
6958           },
6959           {
6960             "group": "Body",
6961             "type": "String",
6962             "optional": true,
6963             "field": "originatecalleridname",
6964             "description": ""
6965           },
6966           {
6967             "group": "Body",
6968             "type": "String",
6969             "optional": true,
6970             "field": "calleridnum",
6971             "description": ""
6972           },
6973           {
6974             "group": "Body",
6975             "type": "String",
6976             "optional": true,
6977             "field": "calleridname",
6978             "description": ""
6979           },
6980           {
6981             "group": "Body",
6982             "type": "String",
6983             "optional": true,
6984             "field": "starttime",
6985             "description": ""
6986           },
6987           {
6988             "group": "Body",
6989             "type": "String",
6990             "optional": true,
6991             "field": "responsetime",
6992             "description": ""
6993           },
6994           {
6995             "group": "Body",
6996             "type": "String",
6997             "optional": true,
6998             "field": "answertime",
6999             "description": ""
7000           },
7001           {
7002             "group": "Body",
7003             "type": "String",
7004             "optional": true,
7005             "field": "droptime",
7006             "description": ""
7007           },
7008           {
7009             "group": "Body",
7010             "type": "String",
7011             "optional": true,
7012             "field": "endtime",
7013             "description": ""
7014           },
7015           {
7016             "group": "Body",
7017             "type": "Integer",
7018             "optional": true,
7019             "field": "ringtime",
7020             "description": ""
7021           },
7022           {
7023             "group": "Body",
7024             "type": "Integer",
7025             "optional": true,
7026             "field": "holdtime",
7027             "description": ""
7028           },
7029           {
7030             "group": "Body",
7031             "type": "Integer",
7032             "optional": true,
7033             "field": "talktime",
7034             "description": ""
7035           },
7036           {
7037             "group": "Body",
7038             "type": "Integer",
7039             "optional": true,
7040             "field": "followuptime",
7041             "description": ""
7042           },
7043           {
7044             "group": "Body",
7045             "type": "String",
7046             "optional": true,
7047             "field": "dropreason",
7048             "description": ""
7049           },
7050           {
7051             "group": "Body",
7052             "type": "String",
7053             "optional": true,
7054             "field": "campaign",
7055             "description": ""
7056           },
7057           {
7058             "group": "Body",
7059             "type": "String",
7060             "optional": true,
7061             "field": "campaigntype",
7062             "description": ""
7063           },
7064           {
7065             "group": "Body",
7066             "type": "String",
7067             "optional": true,
7068             "field": "membername",
7069             "description": ""
7070           },
7071           {
7072             "group": "Body",
7073             "type": "String",
7074             "optional": true,
7075             "field": "reason",
7076             "description": ""
7077           },
7078           {
7079             "group": "Body",
7080             "type": "Boolean",
7081             "optional": true,
7082             "field": "amd",
7083             "description": ""
7084           },
7085           {
7086             "group": "Body",
7087             "type": "Boolean",
7088             "optional": true,
7089             "field": "fax",
7090             "description": ""
7091           },
7092           {
7093             "group": "Body",
7094             "type": "Boolean",
7095             "optional": true,
7096             "field": "callback",
7097             "description": ""
7098           },
7099           {
7100             "group": "Body",
7101             "type": "String",
7102             "optional": true,
7103             "field": "callbackuniqueid",
7104             "description": ""
7105           },
7106           {
7107             "group": "Body",
7108             "type": "String",
7109             "optional": true,
7110             "field": "callbackat",
7111             "description": ""
7112           },
7113           {
7114             "group": "Body",
7115             "type": "Boolean",
7116             "optional": true,
7117             "field": "recallme",
7118             "description": ""
7119           },
7120           {
7121             "group": "Body",
7122             "type": "String",
7123             "optional": true,
7124             "field": "editedat",
7125             "description": ""
7126           },
7127           {
7128             "group": "Body",
7129             "type": "Boolean",
7130             "optional": true,
7131             "field": "edited",
7132             "description": ""
7133           },
7134           {
7135             "group": "Body",
7136             "type": "Integer",
7137             "optional": true,
7138             "field": "countnosuchnumberretry",
7139             "description": ""
7140           },
7141           {
7142             "group": "Body",
7143             "type": "Integer",
7144             "optional": true,
7145             "field": "countdropretry",
7146             "description": ""
7147           },
7148           {
7149             "group": "Body",
7150             "type": "Integer",
7151             "optional": true,
7152             "field": "countabandonedretry",
7153             "description": ""
7154           },
7155           {
7156             "group": "Body",
7157             "type": "Integer",
7158             "optional": true,
7159             "field": "countmachineretry",
7160             "description": ""
7161           },
7162           {
7163             "group": "Body",
7164             "type": "Integer",
7165             "optional": true,
7166             "field": "countagentrejectretry",
7167             "description": ""
7168           }
7169         ]
7170       }
7171     },
7172     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7173     "version": "0.0.0",
7174     "filename": "server/api/cmHopperHistory/index.js",
7175     "groupTitle": "Cm_Hopper_History"
7176   },
7177   {
7178     "type": "get",
7179     "url": "/api/cm/hopper_history/describe",
7180     "title": "Gets table info about HopperHistory",
7181     "examples": [
7182       {
7183         "title": "Example usage:",
7184         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7185         "type": "json"
7186       }
7187     ],
7188     "name": "DescribeHopperHistory",
7189     "group": "Cm_Hopper_History",
7190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7191     "version": "0.0.0",
7192     "filename": "server/api/cmHopperHistory/index.js",
7193     "groupTitle": "Cm_Hopper_History"
7194   },
7195   {
7196     "type": "get",
7197     "url": "/api/cm/hopper_history",
7198     "title": "Gets a list of HopperHistory",
7199     "examples": [
7200       {
7201         "title": "Example usage:",
7202         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7203         "type": "json"
7204       }
7205     ],
7206     "name": "GetHopperHistory",
7207     "group": "Cm_Hopper_History",
7208     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_history?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_history?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_history?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_history?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_history?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7209     "version": "0.0.0",
7210     "filename": "server/api/cmHopperHistory/index.js",
7211     "groupTitle": "Cm_Hopper_History"
7212   },
7213   {
7214     "type": "get",
7215     "url": "/api/cm/hopper_history/{id}",
7216     "title": "Gets a single HopperHistory",
7217     "examples": [
7218       {
7219         "title": "Example usage:",
7220         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7221         "type": "json"
7222       }
7223     ],
7224     "name": "ShowHopperHistory",
7225     "group": "Cm_Hopper_History",
7226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7227     "version": "0.0.0",
7228     "filename": "server/api/cmHopperHistory/index.js",
7229     "groupTitle": "Cm_Hopper_History"
7230   },
7231   {
7232     "type": "put",
7233     "url": "/api/cm/hopper_history/{id}",
7234     "title": "Update a single hopper history",
7235     "examples": [
7236       {
7237         "title": "Example usage:",
7238         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7239         "type": "json"
7240       }
7241     ],
7242     "name": "update",
7243     "group": "Cm_Hopper_History",
7244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7245     "version": "0.0.0",
7246     "filename": "server/api/cmHopperHistory/index.js",
7247     "groupTitle": "Cm_Hopper_History"
7248   },
7249   {
7250     "type": "delete",
7251     "url": "/api/cm/hopper/{id}",
7252     "title": "Delete Hopper",
7253     "examples": [
7254       {
7255         "title": "Example usage:",
7256         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7257         "type": "json"
7258       }
7259     ],
7260     "name": "destroy",
7261     "group": "Cm_Hopper",
7262     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7263     "version": "0.0.0",
7264     "filename": "server/api/cmHopper/index.js",
7265     "groupTitle": "Cm_Hopper"
7266   },
7267   {
7268     "type": "get",
7269     "url": "/api/cm/hopper/opencontacts",
7270     "title": "Gets Open Contacts",
7271     "examples": [
7272       {
7273         "title": "Example usage:",
7274         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7275         "type": "json"
7276       }
7277     ],
7278     "name": "getOpenContacts",
7279     "group": "Cm_Hopper",
7280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7281     "version": "0.0.0",
7282     "filename": "server/api/cmHopper/index.js",
7283     "groupTitle": "Cm_Hopper"
7284   },
7285   {
7286     "type": "post",
7287     "url": "/api/cm/hopper/preview",
7288     "title": "Gets Preview Dialer Contacts",
7289     "examples": [
7290       {
7291         "title": "Example usage:",
7292         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7293         "type": "json"
7294       }
7295     ],
7296     "name": "getPreview",
7297     "group": "Cm_Hopper",
7298     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7299     "version": "0.0.0",
7300     "filename": "server/api/cmHopper/index.js",
7301     "groupTitle": "Cm_Hopper"
7302   },
7303   {
7304     "type": "post",
7305     "url": "/api/cm/hopper/previewrecall",
7306     "title": "Gets Preview Dialer Contacts for Recall",
7307     "examples": [
7308       {
7309         "title": "Example usage:",
7310         "content": "curl https://{domain}/api/cm/hopper/previewrecall -d '{\"hopperId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7311         "type": "json"
7312       }
7313     ],
7314     "name": "getPreviewRecall",
7315     "group": "Cm_Hopper",
7316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7317     "version": "0.0.0",
7318     "filename": "server/api/cmHopper/index.js",
7319     "groupTitle": "Cm_Hopper"
7320   },
7321   {
7322     "type": "put",
7323     "url": "/api/cm/hopper/{id}",
7324     "title": "Update an existing Hopper",
7325     "examples": [
7326       {
7327         "title": "Example usage:",
7328         "content": "curl https://{domain}/api/cm/hopper/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7329         "type": "json"
7330       }
7331     ],
7332     "name": "updateHopper",
7333     "group": "Cm_Hopper",
7334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7335     "version": "0.0.0",
7336     "filename": "server/api/cmHopper/index.js",
7337     "groupTitle": "Cm_Hopper"
7338   },
7339   {
7340     "type": "post",
7341     "url": "/api/cm/lists",
7342     "title": "Creates a new List",
7343     "examples": [
7344       {
7345         "title": "Example usage:",
7346         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7347         "type": "json"
7348       }
7349     ],
7350     "name": "CreateLists",
7351     "group": "Cm_Lists",
7352     "parameter": {
7353       "fields": {
7354         "Body": [
7355           {
7356             "group": "Body",
7357             "type": "String",
7358             "optional": false,
7359             "field": "name",
7360             "description": ""
7361           },
7362           {
7363             "group": "Body",
7364             "type": "String",
7365             "optional": true,
7366             "field": "description",
7367             "description": ""
7368           },
7369           {
7370             "group": "Body",
7371             "type": "String",
7372             "optional": true,
7373             "field": "dialPrefix",
7374             "description": ""
7375           }
7376         ]
7377       }
7378     },
7379     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7380     "version": "0.0.0",
7381     "filename": "server/api/cmList/index.js",
7382     "groupTitle": "Cm_Lists"
7383   },
7384   {
7385     "type": "delete",
7386     "url": "/api/cm/lists/{id}",
7387     "title": "Deletes a List",
7388     "examples": [
7389       {
7390         "title": "Example usage:",
7391         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7392         "type": "json"
7393       }
7394     ],
7395     "name": "DeleteLists",
7396     "group": "Cm_Lists",
7397     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7398     "version": "0.0.0",
7399     "filename": "server/api/cmList/index.js",
7400     "groupTitle": "Cm_Lists"
7401   },
7402   {
7403     "type": "get",
7404     "url": "/api/cm/lists/describe",
7405     "title": "Gets table info about Lists",
7406     "examples": [
7407       {
7408         "title": "Example usage:",
7409         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7410         "type": "json"
7411       }
7412     ],
7413     "name": "DescribeLists",
7414     "group": "Cm_Lists",
7415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7416     "version": "0.0.0",
7417     "filename": "server/api/cmList/index.js",
7418     "groupTitle": "Cm_Lists"
7419   },
7420   {
7421     "type": "get",
7422     "url": "/api/cm/lists/{id}/users",
7423     "title": "Gets agents from list",
7424     "examples": [
7425       {
7426         "title": "Example usage:",
7427         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7428         "type": "json"
7429       }
7430     ],
7431     "name": "GetAgents",
7432     "group": "Cm_Lists",
7433     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7434     "version": "0.0.0",
7435     "filename": "server/api/cmList/index.js",
7436     "groupTitle": "Cm_Lists"
7437   },
7438   {
7439     "type": "get",
7440     "url": "/api/cm/lists",
7441     "title": "Gets a list of Lists",
7442     "examples": [
7443       {
7444         "title": "Example usage:",
7445         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7446         "type": "json"
7447       }
7448     ],
7449     "name": "GetLists",
7450     "group": "Cm_Lists",
7451     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/lists?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/lists?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/lists?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/lists?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/lists?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7452     "version": "0.0.0",
7453     "filename": "server/api/cmList/index.js",
7454     "groupTitle": "Cm_Lists"
7455   },
7456   {
7457     "type": "delete",
7458     "url": "/api/cm/lists/{id}/users",
7459     "title": "Removes agents from a list",
7460     "examples": [
7461       {
7462         "title": "Example usage:",
7463         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7464         "type": "json"
7465       }
7466     ],
7467     "name": "RemoveAgents",
7468     "group": "Cm_Lists",
7469     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7470     "version": "0.0.0",
7471     "filename": "server/api/cmList/index.js",
7472     "groupTitle": "Cm_Lists"
7473   },
7474   {
7475     "type": "delete",
7476     "url": "/api/cm/lists/{id}/dispositions",
7477     "title": "Removes dispositions from account",
7478     "examples": [
7479       {
7480         "title": "Example usage:",
7481         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7482         "type": "json"
7483       }
7484     ],
7485     "name": "RemoveDispositions",
7486     "group": "Cm_Lists",
7487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7488     "version": "0.0.0",
7489     "filename": "server/api/cmList/index.js",
7490     "groupTitle": "Cm_Lists"
7491   },
7492   {
7493     "type": "get",
7494     "url": "/api/cm/lists/{id}",
7495     "title": "Gets a single List",
7496     "examples": [
7497       {
7498         "title": "Example usage:",
7499         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7500         "type": "json"
7501       }
7502     ],
7503     "name": "ShowLists",
7504     "group": "Cm_Lists",
7505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7506     "version": "0.0.0",
7507     "filename": "server/api/cmList/index.js",
7508     "groupTitle": "Cm_Lists"
7509   },
7510   {
7511     "type": "post",
7512     "url": "/api/cm/lists/{id}/users",
7513     "title": "Adds agents to a list",
7514     "examples": [
7515       {
7516         "title": "Example usage:",
7517         "content": "curl https://{domain}/api/cm/lists/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7518         "type": "json"
7519       }
7520     ],
7521     "name": "addAgents",
7522     "group": "Cm_Lists",
7523     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7524     "version": "0.0.0",
7525     "filename": "server/api/cmList/index.js",
7526     "groupTitle": "Cm_Lists"
7527   },
7528   {
7529     "type": "post",
7530     "url": "/api/cm/lists/{id}/contacts",
7531     "title": "Creates new contacts",
7532     "examples": [
7533       {
7534         "title": "Example usage:",
7535         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7536         "type": "json"
7537       }
7538     ],
7539     "name": "addContacts",
7540     "group": "Cm_Lists",
7541     "parameter": {
7542       "fields": {
7543         "Body": [
7544           {
7545             "group": "Body",
7546             "type": "String",
7547             "optional": false,
7548             "field": "firstName",
7549             "description": ""
7550           },
7551           {
7552             "group": "Body",
7553             "type": "String",
7554             "optional": true,
7555             "field": "lastName",
7556             "description": ""
7557           },
7558           {
7559             "group": "Body",
7560             "type": "String",
7561             "optional": true,
7562             "field": "street",
7563             "description": ""
7564           },
7565           {
7566             "group": "Body",
7567             "type": "String",
7568             "optional": true,
7569             "field": "postalCode",
7570             "description": ""
7571           },
7572           {
7573             "group": "Body",
7574             "type": "String",
7575             "optional": true,
7576             "field": "city",
7577             "description": ""
7578           },
7579           {
7580             "group": "Body",
7581             "type": "String",
7582             "optional": true,
7583             "field": "country",
7584             "description": ""
7585           },
7586           {
7587             "group": "Body",
7588             "type": "String",
7589             "optional": true,
7590             "field": "dateOfBirth",
7591             "description": ""
7592           },
7593           {
7594             "group": "Body",
7595             "type": "Text",
7596             "optional": true,
7597             "field": "description",
7598             "description": ""
7599           },
7600           {
7601             "group": "Body",
7602             "type": "String",
7603             "optional": true,
7604             "field": "phone",
7605             "description": ""
7606           },
7607           {
7608             "group": "Body",
7609             "type": "String",
7610             "optional": true,
7611             "field": "mobile",
7612             "description": ""
7613           },
7614           {
7615             "group": "Body",
7616             "type": "String",
7617             "optional": true,
7618             "field": "fax",
7619             "description": ""
7620           },
7621           {
7622             "group": "Body",
7623             "type": "String",
7624             "optional": true,
7625             "field": "email",
7626             "description": ""
7627           },
7628           {
7629             "group": "Body",
7630             "type": "String",
7631             "optional": true,
7632             "field": "url",
7633             "description": ""
7634           },
7635           {
7636             "group": "Body",
7637             "type": "String",
7638             "optional": true,
7639             "field": "facebook",
7640             "description": ""
7641           },
7642           {
7643             "group": "Body",
7644             "type": "String",
7645             "optional": true,
7646             "field": "fb_data",
7647             "description": ""
7648           },
7649           {
7650             "group": "Body",
7651             "type": "String",
7652             "optional": true,
7653             "field": "twitter",
7654             "description": ""
7655           },
7656           {
7657             "group": "Body",
7658             "type": "String",
7659             "optional": true,
7660             "field": "skype",
7661             "description": ""
7662           },
7663           {
7664             "group": "Body",
7665             "type": "String",
7666             "optional": true,
7667             "field": "teams",
7668             "description": ""
7669           },
7670           {
7671             "group": "Body",
7672             "type": "String",
7673             "optional": true,
7674             "field": "viber",
7675             "description": ""
7676           },
7677           {
7678             "group": "Body",
7679             "type": "String",
7680             "optional": true,
7681             "field": "line",
7682             "description": ""
7683           },
7684           {
7685             "group": "Body",
7686             "type": "String",
7687             "optional": true,
7688             "field": "wechat",
7689             "description": ""
7690           },
7691           {
7692             "group": "Body",
7693             "type": "String",
7694             "optional": true,
7695             "field": "telegram",
7696             "description": ""
7697           },
7698           {
7699             "group": "Body",
7700             "type": "Integer",
7701             "optional": true,
7702             "field": "UserId",
7703             "description": ""
7704           },
7705           {
7706             "group": "Body",
7707             "type": "Integer",
7708             "optional": true,
7709             "field": "priority",
7710             "description": ""
7711           },
7712           {
7713             "group": "Body",
7714             "type": "String",
7715             "optional": true,
7716             "field": "scheduledat",
7717             "description": ""
7718           }
7719         ]
7720       }
7721     },
7722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7723     "version": "0.0.0",
7724     "filename": "server/api/cmList/index.js",
7725     "groupTitle": "Cm_Lists"
7726   },
7727   {
7728     "type": "post",
7729     "url": "/api/cm/lists/{id}/fields",
7730     "title": "Creates a new custom field",
7731     "examples": [
7732       {
7733         "title": "Example usage:",
7734         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7735         "type": "json"
7736       }
7737     ],
7738     "name": "addCustomField",
7739     "group": "Cm_Lists",
7740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7741     "version": "0.0.0",
7742     "filename": "server/api/cmList/index.js",
7743     "groupTitle": "Cm_Lists"
7744   },
7745   {
7746     "type": "post",
7747     "url": "/api/cm/lists/{id}/dispositions",
7748     "title": "Creates new disposition",
7749     "examples": [
7750       {
7751         "title": "Example usage:",
7752         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7753         "type": "json"
7754       }
7755     ],
7756     "name": "addDisposition",
7757     "group": "Cm_Lists",
7758     "parameter": {
7759       "fields": {
7760         "Body": [
7761           {
7762             "group": "Body",
7763             "type": "String",
7764             "optional": false,
7765             "field": "name",
7766             "description": ""
7767           },
7768           {
7769             "group": "Body",
7770             "type": "String",
7771             "allowedValues": [
7772               "\"first\"",
7773               "\"second\"",
7774               "\"third\""
7775             ],
7776             "optional": false,
7777             "field": "level",
7778             "description": ""
7779           },
7780           {
7781             "group": "Body",
7782             "type": "String",
7783             "optional": true,
7784             "field": "description",
7785             "description": ""
7786           }
7787         ]
7788       }
7789     },
7790     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7791     "version": "0.0.0",
7792     "filename": "server/api/cmList/index.js",
7793     "groupTitle": "Cm_Lists"
7794   },
7795   {
7796     "type": "get",
7797     "url": "/api/cm/lists/{id}/contacts",
7798     "title": "Gets List Contacts",
7799     "examples": [
7800       {
7801         "title": "Example usage:",
7802         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7803         "type": "json"
7804       }
7805     ],
7806     "name": "getContacts",
7807     "group": "Cm_Lists",
7808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7809     "version": "0.0.0",
7810     "filename": "server/api/cmList/index.js",
7811     "groupTitle": "Cm_Lists"
7812   },
7813   {
7814     "type": "get",
7815     "url": "/api/cm/lists/{id}/fields",
7816     "title": "Gets Custom Fields",
7817     "examples": [
7818       {
7819         "title": "Example usage:",
7820         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7821         "type": "json"
7822       }
7823     ],
7824     "name": "getCustomFields",
7825     "group": "Cm_Lists",
7826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7827     "version": "0.0.0",
7828     "filename": "server/api/cmList/index.js",
7829     "groupTitle": "Cm_Lists"
7830   },
7831   {
7832     "type": "get",
7833     "url": "/api/cm/lists/{id}/dispositions",
7834     "title": "Gets list dispositions",
7835     "examples": [
7836       {
7837         "title": "Example usage:",
7838         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7839         "type": "json"
7840       }
7841     ],
7842     "name": "getDispositions",
7843     "group": "Cm_Lists",
7844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7845     "version": "0.0.0",
7846     "filename": "server/api/cmList/index.js",
7847     "groupTitle": "Cm_Lists"
7848   },
7849   {
7850     "type": "get",
7851     "url": "/api/cm/lists/{id}/contacts/csv",
7852     "title": "Gets CSV List Contacts",
7853     "examples": [
7854       {
7855         "title": "Example usage:",
7856         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7857         "type": "json"
7858       }
7859     ],
7860     "name": "grunt",
7861     "group": "Cm_Lists",
7862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7863     "version": "0.0.0",
7864     "filename": "server/api/cmList/index.js",
7865     "groupTitle": "Cm_Lists"
7866   },
7867   {
7868     "type": "put",
7869     "url": "/api/cm/lists/{id}",
7870     "title": "Update an existing List",
7871     "examples": [
7872       {
7873         "title": "Example usage:",
7874         "content": "curl https://{domain}/api/cm/lists/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7875         "type": "json"
7876       }
7877     ],
7878     "name": "updateLists",
7879     "group": "Cm_Lists",
7880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7881     "version": "0.0.0",
7882     "filename": "server/api/cmList/index.js",
7883     "groupTitle": "Cm_Lists"
7884   },
7885   {
7886     "type": "post",
7887     "url": "/api/cm/contacts/upload/:id",
7888     "title": "Import new contacts by csv",
7889     "examples": [
7890       {
7891         "title": "Example usage:",
7892         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7893         "type": "json"
7894       }
7895     ],
7896     "name": "import",
7897     "group": "Cm_contacts",
7898     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7899     "version": "0.0.0",
7900     "filename": "server/api/cmContact/index.js",
7901     "groupTitle": "Cm_contacts"
7902   },
7903   {
7904     "type": "post",
7905     "url": "/api/cm/contacts/upload",
7906     "title": "Upload csv",
7907     "examples": [
7908       {
7909         "title": "Example usage:",
7910         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7911         "type": "json"
7912       }
7913     ],
7914     "name": "upload",
7915     "group": "Cm_contacts",
7916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7917     "version": "0.0.0",
7918     "filename": "server/api/cmContact/index.js",
7919     "groupTitle": "Cm_contacts"
7920   },
7921   {
7922     "type": "post",
7923     "url": "/api/cm/contacts/csv",
7924     "title": "Create new contacts by csv",
7925     "examples": [
7926       {
7927         "title": "Example usage:",
7928         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7929         "type": "json"
7930       }
7931     ],
7932     "name": "uploadCsv",
7933     "group": "Cm_contacts",
7934     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7935     "version": "0.0.0",
7936     "filename": "server/api/cmContact/index.js",
7937     "groupTitle": "Cm_contacts"
7938   },
7939   {
7940     "type": "delete",
7941     "url": "/api/conditions/{id}",
7942     "title": "Deletes a Condition",
7943     "examples": [
7944       {
7945         "title": "Example usage:",
7946         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7947         "type": "json"
7948       }
7949     ],
7950     "name": "DeleteConditions",
7951     "group": "Conditions",
7952     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7953     "version": "0.0.0",
7954     "filename": "server/api/condition/index.js",
7955     "groupTitle": "Conditions"
7956   },
7957   {
7958     "type": "put",
7959     "url": "/api/conditions/{id}",
7960     "title": "Update an existing Condition",
7961     "examples": [
7962       {
7963         "title": "Example usage:",
7964         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7965         "type": "json"
7966       }
7967     ],
7968     "name": "updateConditions",
7969     "group": "Conditions",
7970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7971     "version": "0.0.0",
7972     "filename": "server/api/condition/index.js",
7973     "groupTitle": "Conditions"
7974   },
7975   {
7976     "type": "post",
7977     "url": "/api/cm/custom_field",
7978     "title": "Create a new custom field",
7979     "examples": [
7980       {
7981         "title": "Example usage:",
7982         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7983         "type": "json"
7984       }
7985     ],
7986     "name": "CreateCustomField",
7987     "group": "Custom_Fields",
7988     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7989     "version": "0.0.0",
7990     "filename": "server/api/cmCustomField/index.js",
7991     "groupTitle": "Custom_Fields"
7992   },
7993   {
7994     "type": "post",
7995     "url": "/api/dashboards/items",
7996     "title": "Create dasboard item",
7997     "examples": [
7998       {
7999         "title": "Example usage:",
8000         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8001         "type": "json"
8002       }
8003     ],
8004     "name": "Create",
8005     "group": "Dashboard_Items",
8006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8007     "version": "0.0.0",
8008     "filename": "server/api/dashboardItem/index.js",
8009     "groupTitle": "Dashboard_Items"
8010   },
8011   {
8012     "type": "delete",
8013     "url": "/api/dashboards/items/{id}",
8014     "title": "Deletes a Dashboard Item",
8015     "examples": [
8016       {
8017         "title": "Example usage:",
8018         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8019         "type": "json"
8020       }
8021     ],
8022     "name": "DeleteDashboard_Items",
8023     "group": "Dashboard_Items",
8024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8025     "version": "0.0.0",
8026     "filename": "server/api/dashboardItem/index.js",
8027     "groupTitle": "Dashboard_Items"
8028   },
8029   {
8030     "type": "get",
8031     "url": "/api/dashboards/items/{id}",
8032     "title": "Gets a single Dashboard Item",
8033     "examples": [
8034       {
8035         "title": "Example usage:",
8036         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8037         "type": "json"
8038       }
8039     ],
8040     "name": "ShowDashboard_Items",
8041     "group": "Dashboard_Items",
8042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8043     "version": "0.0.0",
8044     "filename": "server/api/dashboardItem/index.js",
8045     "groupTitle": "Dashboard_Items"
8046   },
8047   {
8048     "type": "put",
8049     "url": "/api/dashboards/items/{id}",
8050     "title": "Update an existing item",
8051     "examples": [
8052       {
8053         "title": "Example usage:",
8054         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8055         "type": "json"
8056       }
8057     ],
8058     "name": "Update",
8059     "group": "Dashboard_Items",
8060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8061     "version": "0.0.0",
8062     "filename": "server/api/dashboardItem/index.js",
8063     "groupTitle": "Dashboard_Items"
8064   },
8065   {
8066     "type": "post",
8067     "url": "/api/dashboards/clone",
8068     "title": "Clone an existing Dashboard",
8069     "examples": [
8070       {
8071         "title": "Example usage:",
8072         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8073         "type": "json"
8074       }
8075     ],
8076     "name": "CloneDashboards",
8077     "group": "Dashboards",
8078     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8079     "version": "0.0.0",
8080     "filename": "server/api/dashboard/index.js",
8081     "groupTitle": "Dashboards"
8082   },
8083   {
8084     "type": "post",
8085     "url": "/api/dashboards",
8086     "title": "Creates a new Dashboard",
8087     "examples": [
8088       {
8089         "title": "Example usage:",
8090         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8091         "type": "json"
8092       }
8093     ],
8094     "name": "CreateDashboards",
8095     "group": "Dashboards",
8096     "parameter": {
8097       "fields": {
8098         "Body": [
8099           {
8100             "group": "Body",
8101             "type": "String",
8102             "optional": false,
8103             "field": "name",
8104             "description": ""
8105           },
8106           {
8107             "group": "Body",
8108             "type": "String",
8109             "optional": true,
8110             "field": "description",
8111             "description": ""
8112           }
8113         ]
8114       }
8115     },
8116     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8117     "version": "0.0.0",
8118     "filename": "server/api/dashboard/index.js",
8119     "groupTitle": "Dashboards"
8120   },
8121   {
8122     "type": "delete",
8123     "url": "/api/dashboards/{id}",
8124     "title": "Deletes a Dashboard",
8125     "examples": [
8126       {
8127         "title": "Example usage:",
8128         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8129         "type": "json"
8130       }
8131     ],
8132     "name": "DeleteDashboards",
8133     "group": "Dashboards",
8134     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8135     "version": "0.0.0",
8136     "filename": "server/api/dashboard/index.js",
8137     "groupTitle": "Dashboards"
8138   },
8139   {
8140     "type": "get",
8141     "url": "/api/dashboards",
8142     "title": "Gets a list of Dashboards",
8143     "examples": [
8144       {
8145         "title": "Example usage:",
8146         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8147         "type": "json"
8148       }
8149     ],
8150     "name": "GetDashboards",
8151     "group": "Dashboards",
8152     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dashboards?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dashboards?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dashboards?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dashboards?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dashboards?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8153     "version": "0.0.0",
8154     "filename": "server/api/dashboard/index.js",
8155     "groupTitle": "Dashboards"
8156   },
8157   {
8158     "type": "get",
8159     "url": "/api/dashboards/{id}",
8160     "title": "Gets a single Dashboard",
8161     "examples": [
8162       {
8163         "title": "Example usage:",
8164         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8165         "type": "json"
8166       }
8167     ],
8168     "name": "ShowDashboards",
8169     "group": "Dashboards",
8170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8171     "version": "0.0.0",
8172     "filename": "server/api/dashboard/index.js",
8173     "groupTitle": "Dashboards"
8174   },
8175   {
8176     "type": "post",
8177     "url": "/api/dashboards/{id}/items",
8178     "title": "Creates new item",
8179     "examples": [
8180       {
8181         "title": "Example usage:",
8182         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8183         "type": "json"
8184       }
8185     ],
8186     "name": "addItem",
8187     "group": "Dashboards",
8188     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8189     "version": "0.0.0",
8190     "filename": "server/api/dashboard/index.js",
8191     "groupTitle": "Dashboards"
8192   },
8193   {
8194     "type": "get",
8195     "url": "/api/dashboards/{id}/items",
8196     "title": "Gets items",
8197     "examples": [
8198       {
8199         "title": "Example usage:",
8200         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8201         "type": "json"
8202       }
8203     ],
8204     "name": "getItems",
8205     "group": "Dashboards",
8206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8207     "version": "0.0.0",
8208     "filename": "server/api/dashboard/index.js",
8209     "groupTitle": "Dashboards"
8210   },
8211   {
8212     "type": "put",
8213     "url": "/api/dashboards/{id}",
8214     "title": "Update an existing Dashboard",
8215     "examples": [
8216       {
8217         "title": "Example usage:",
8218         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8219         "type": "json"
8220       }
8221     ],
8222     "name": "updateDashboards",
8223     "group": "Dashboards",
8224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8225     "version": "0.0.0",
8226     "filename": "server/api/dashboard/index.js",
8227     "groupTitle": "Dashboards"
8228   },
8229   {
8230     "type": "post",
8231     "url": "/api/integrations/desk/accounts",
8232     "title": "Creates a new Desk Account",
8233     "examples": [
8234       {
8235         "title": "Example usage:",
8236         "content": "curl https://{domain}/api/integrations/desk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8237         "type": "json"
8238       }
8239     ],
8240     "name": "CreateDesk_Accounts",
8241     "group": "Desk_Accounts",
8242     "parameter": {
8243       "fields": {
8244         "Body": [
8245           {
8246             "group": "Body",
8247             "type": "String",
8248             "optional": true,
8249             "field": "name",
8250             "description": ""
8251           },
8252           {
8253             "group": "Body",
8254             "type": "String",
8255             "optional": true,
8256             "field": "description",
8257             "description": ""
8258           },
8259           {
8260             "group": "Body",
8261             "type": "String",
8262             "optional": true,
8263             "field": "username",
8264             "description": ""
8265           },
8266           {
8267             "group": "Body",
8268             "type": "String",
8269             "optional": true,
8270             "field": "remoteUri",
8271             "description": ""
8272           },
8273           {
8274             "group": "Body",
8275             "type": "String",
8276             "allowedValues": [
8277               "\"basic\""
8278             ],
8279             "optional": true,
8280             "field": "authType",
8281             "description": ""
8282           },
8283           {
8284             "group": "Body",
8285             "type": "String",
8286             "optional": true,
8287             "field": "password",
8288             "description": ""
8289           },
8290           {
8291             "group": "Body",
8292             "type": "String",
8293             "optional": true,
8294             "field": "consumerKey",
8295             "description": ""
8296           },
8297           {
8298             "group": "Body",
8299             "type": "String",
8300             "optional": true,
8301             "field": "consumerSecret",
8302             "description": ""
8303           },
8304           {
8305             "group": "Body",
8306             "type": "String",
8307             "optional": true,
8308             "field": "token",
8309             "description": ""
8310           },
8311           {
8312             "group": "Body",
8313             "type": "String",
8314             "optional": true,
8315             "field": "tokenSecret",
8316             "description": ""
8317           },
8318           {
8319             "group": "Body",
8320             "type": "String",
8321             "optional": false,
8322             "field": "serverUrl",
8323             "description": ""
8324           },
8325           {
8326             "group": "Body",
8327             "type": "String",
8328             "allowedValues": [
8329               "\"integrationTab\"",
8330               "\"newTab\""
8331             ],
8332             "optional": true,
8333             "field": "type",
8334             "description": ""
8335           }
8336         ]
8337       }
8338     },
8339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8340     "version": "0.0.0",
8341     "filename": "server/api/intDeskAccount/index.js",
8342     "groupTitle": "Desk_Accounts"
8343   },
8344   {
8345     "type": "delete",
8346     "url": "/api/integrations/desk/accounts/{id}",
8347     "title": "Deletes a Desk Account",
8348     "examples": [
8349       {
8350         "title": "Example usage:",
8351         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8352         "type": "json"
8353       }
8354     ],
8355     "name": "DeleteDesk_Accounts",
8356     "group": "Desk_Accounts",
8357     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8358     "version": "0.0.0",
8359     "filename": "server/api/intDeskAccount/index.js",
8360     "groupTitle": "Desk_Accounts"
8361   },
8362   {
8363     "type": "get",
8364     "url": "/api/integrations/desk/accounts",
8365     "title": "Gets a list of Desk Accounts",
8366     "examples": [
8367       {
8368         "title": "Example usage:",
8369         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8370         "type": "json"
8371       }
8372     ],
8373     "name": "GetDesk_Accounts",
8374     "group": "Desk_Accounts",
8375     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8376     "version": "0.0.0",
8377     "filename": "server/api/intDeskAccount/index.js",
8378     "groupTitle": "Desk_Accounts"
8379   },
8380   {
8381     "type": "get",
8382     "url": "/api/integrations/desk/accounts/{id}",
8383     "title": "Gets a single Desk Account",
8384     "examples": [
8385       {
8386         "title": "Example usage:",
8387         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8388         "type": "json"
8389       }
8390     ],
8391     "name": "ShowDesk_Accounts",
8392     "group": "Desk_Accounts",
8393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8394     "version": "0.0.0",
8395     "filename": "server/api/intDeskAccount/index.js",
8396     "groupTitle": "Desk_Accounts"
8397   },
8398   {
8399     "type": "post",
8400     "url": "/api/integrations/desk/accounts/{id}/configurations",
8401     "title": "Creates new configuration",
8402     "examples": [
8403       {
8404         "title": "Example usage:",
8405         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8406         "type": "json"
8407       }
8408     ],
8409     "name": "addConfiguration",
8410     "group": "Desk_Accounts",
8411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8412     "version": "0.0.0",
8413     "filename": "server/api/intDeskAccount/index.js",
8414     "groupTitle": "Desk_Accounts"
8415   },
8416   {
8417     "type": "get",
8418     "url": "/api/integrations/desk/accounts/{id}/configurations",
8419     "title": "Gets account configurations",
8420     "examples": [
8421       {
8422         "title": "Example usage:",
8423         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8424         "type": "json"
8425       }
8426     ],
8427     "name": "getConfigurations",
8428     "group": "Desk_Accounts",
8429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8430     "version": "0.0.0",
8431     "filename": "server/api/intDeskAccount/index.js",
8432     "groupTitle": "Desk_Accounts"
8433   },
8434   {
8435     "type": "get",
8436     "url": "/api/integrations/desk/accounts/{id}/fields",
8437     "title": "Gets account fields",
8438     "examples": [
8439       {
8440         "title": "Example usage:",
8441         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8442         "type": "json"
8443       }
8444     ],
8445     "name": "getFields",
8446     "group": "Desk_Accounts",
8447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8448     "version": "0.0.0",
8449     "filename": "server/api/intDeskAccount/index.js",
8450     "groupTitle": "Desk_Accounts"
8451   },
8452   {
8453     "type": "put",
8454     "url": "/api/integrations/desk/accounts/{id}",
8455     "title": "Update an existing Desk Account",
8456     "examples": [
8457       {
8458         "title": "Example usage:",
8459         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8460         "type": "json"
8461       }
8462     ],
8463     "name": "updateDesk_Accounts",
8464     "group": "Desk_Accounts",
8465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8466     "version": "0.0.0",
8467     "filename": "server/api/intDeskAccount/index.js",
8468     "groupTitle": "Desk_Accounts"
8469   },
8470   {
8471     "type": "post",
8472     "url": "/api/integrations/desk/configurations",
8473     "title": "Creates a new Desk Configuration",
8474     "examples": [
8475       {
8476         "title": "Example usage:",
8477         "content": "curl https://{domain}/api/integrations/desk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8478         "type": "json"
8479       }
8480     ],
8481     "name": "CreateDesk_Configurations",
8482     "group": "Desk_Configurations",
8483     "parameter": {
8484       "fields": {
8485         "Body": [
8486           {
8487             "group": "Body",
8488             "type": "String",
8489             "optional": true,
8490             "field": "name",
8491             "description": ""
8492           },
8493           {
8494             "group": "Body",
8495             "type": "String",
8496             "optional": true,
8497             "field": "description",
8498             "description": ""
8499           }
8500         ]
8501       }
8502     },
8503     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8504     "version": "0.0.0",
8505     "filename": "server/api/intDeskConfiguration/index.js",
8506     "groupTitle": "Desk_Configurations"
8507   },
8508   {
8509     "type": "delete",
8510     "url": "/api/integrations/desk/configurations/{id}",
8511     "title": "Deletes a Desk Configuration",
8512     "examples": [
8513       {
8514         "title": "Example usage:",
8515         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8516         "type": "json"
8517       }
8518     ],
8519     "name": "DeleteDesk_Configurations",
8520     "group": "Desk_Configurations",
8521     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8522     "version": "0.0.0",
8523     "filename": "server/api/intDeskConfiguration/index.js",
8524     "groupTitle": "Desk_Configurations"
8525   },
8526   {
8527     "type": "get",
8528     "url": "/api/integrations/desk/configurations",
8529     "title": "Gets a list of Desk Configurations",
8530     "examples": [
8531       {
8532         "title": "Example usage:",
8533         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8534         "type": "json"
8535       }
8536     ],
8537     "name": "GetDesk_Configurations",
8538     "group": "Desk_Configurations",
8539     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8540     "version": "0.0.0",
8541     "filename": "server/api/intDeskConfiguration/index.js",
8542     "groupTitle": "Desk_Configurations"
8543   },
8544   {
8545     "type": "get",
8546     "url": "/api/integrations/desk/configurations/{id}",
8547     "title": "Gets a single Desk Configuration",
8548     "examples": [
8549       {
8550         "title": "Example usage:",
8551         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8552         "type": "json"
8553       }
8554     ],
8555     "name": "ShowDesk_Configurations",
8556     "group": "Desk_Configurations",
8557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8558     "version": "0.0.0",
8559     "filename": "server/api/intDeskConfiguration/index.js",
8560     "groupTitle": "Desk_Configurations"
8561   },
8562   {
8563     "type": "get",
8564     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8565     "title": "Gets configurations descriptions",
8566     "examples": [
8567       {
8568         "title": "Example usage:",
8569         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8570         "type": "json"
8571       }
8572     ],
8573     "name": "getDescriptions",
8574     "group": "Desk_Configurations",
8575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8576     "version": "0.0.0",
8577     "filename": "server/api/intDeskConfiguration/index.js",
8578     "groupTitle": "Desk_Configurations"
8579   },
8580   {
8581     "type": "get",
8582     "url": "/api/integrations/desk/configurations/{id}/fields",
8583     "title": "Gets configurations fields",
8584     "examples": [
8585       {
8586         "title": "Example usage:",
8587         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8588         "type": "json"
8589       }
8590     ],
8591     "name": "getFields",
8592     "group": "Desk_Configurations",
8593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8594     "version": "0.0.0",
8595     "filename": "server/api/intDeskConfiguration/index.js",
8596     "groupTitle": "Desk_Configurations"
8597   },
8598   {
8599     "type": "get",
8600     "url": "/api/integrations/desk/configurations/{id}/subjects",
8601     "title": "Gets configurations subjects",
8602     "examples": [
8603       {
8604         "title": "Example usage:",
8605         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8606         "type": "json"
8607       }
8608     ],
8609     "name": "getSubjects",
8610     "group": "Desk_Configurations",
8611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8612     "version": "0.0.0",
8613     "filename": "server/api/intDeskConfiguration/index.js",
8614     "groupTitle": "Desk_Configurations"
8615   },
8616   {
8617     "type": "get",
8618     "url": "/api/integrations/desk/configurations/{id}/tags",
8619     "title": "Gets configurations tags",
8620     "examples": [
8621       {
8622         "title": "Example usage:",
8623         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8624         "type": "json"
8625       }
8626     ],
8627     "name": "getTags",
8628     "group": "Desk_Configurations",
8629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8630     "version": "0.0.0",
8631     "filename": "server/api/intDeskConfiguration/index.js",
8632     "groupTitle": "Desk_Configurations"
8633   },
8634   {
8635     "type": "post",
8636     "url": "/api/integrations/desk/configurations/{id}/tags",
8637     "title": "Sets new tags",
8638     "examples": [
8639       {
8640         "title": "Example usage:",
8641         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8642         "type": "json"
8643       }
8644     ],
8645     "name": "setTags",
8646     "group": "Desk_Configurations",
8647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8648     "version": "0.0.0",
8649     "filename": "server/api/intDeskConfiguration/index.js",
8650     "groupTitle": "Desk_Configurations"
8651   },
8652   {
8653     "type": "put",
8654     "url": "/api/integrations/desk/configurations/{id}",
8655     "title": "Update an existing Desk Configuration",
8656     "examples": [
8657       {
8658         "title": "Example usage:",
8659         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8660         "type": "json"
8661       }
8662     ],
8663     "name": "updateDesk_Configurations",
8664     "group": "Desk_Configurations",
8665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8666     "version": "0.0.0",
8667     "filename": "server/api/intDeskConfiguration/index.js",
8668     "groupTitle": "Desk_Configurations"
8669   },
8670   {
8671     "type": "post",
8672     "url": "/api/integrations/desk/fields",
8673     "title": "Creates a new Desk Field",
8674     "examples": [
8675       {
8676         "title": "Example usage:",
8677         "content": "curl https://{domain}/api/integrations/desk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8678         "type": "json"
8679       }
8680     ],
8681     "name": "CreateDesk_Fields",
8682     "group": "Desk_Fields",
8683     "parameter": {
8684       "fields": {
8685         "Body": [
8686           {
8687             "group": "Body",
8688             "type": "String",
8689             "allowedValues": [
8690               "\"string\"",
8691               "\"variable\"",
8692               "\"customVariable\"",
8693               "\"keyValue\"",
8694               "\"picklist\""
8695             ],
8696             "optional": true,
8697             "field": "type",
8698             "description": ""
8699           },
8700           {
8701             "group": "Body",
8702             "type": "String",
8703             "optional": true,
8704             "field": "content",
8705             "description": ""
8706           },
8707           {
8708             "group": "Body",
8709             "type": "String",
8710             "optional": true,
8711             "field": "key",
8712             "description": ""
8713           },
8714           {
8715             "group": "Body",
8716             "type": "String",
8717             "allowedValues": [
8718               "\"string\"",
8719               "\"variable\"",
8720               "\"customVariable\""
8721             ],
8722             "optional": true,
8723             "field": "keyType",
8724             "description": ""
8725           },
8726           {
8727             "group": "Body",
8728             "type": "String",
8729             "optional": true,
8730             "field": "keyContent",
8731             "description": ""
8732           },
8733           {
8734             "group": "Body",
8735             "type": "String",
8736             "optional": true,
8737             "field": "idField",
8738             "description": ""
8739           },
8740           {
8741             "group": "Body",
8742             "type": "String",
8743             "optional": true,
8744             "field": "nameField",
8745             "description": ""
8746           },
8747           {
8748             "group": "Body",
8749             "type": "Boolean",
8750             "optional": true,
8751             "field": "customField",
8752             "description": ""
8753           },
8754           {
8755             "group": "Body",
8756             "type": "String",
8757             "optional": true,
8758             "field": "variableName",
8759             "description": ""
8760           }
8761         ]
8762       }
8763     },
8764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8765     "version": "0.0.0",
8766     "filename": "server/api/intDeskField/index.js",
8767     "groupTitle": "Desk_Fields"
8768   },
8769   {
8770     "type": "delete",
8771     "url": "/api/integrations/desk/fields/{id}",
8772     "title": "Deletes a Desk Field",
8773     "examples": [
8774       {
8775         "title": "Example usage:",
8776         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8777         "type": "json"
8778       }
8779     ],
8780     "name": "DeleteDesk_Fields",
8781     "group": "Desk_Fields",
8782     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8783     "version": "0.0.0",
8784     "filename": "server/api/intDeskField/index.js",
8785     "groupTitle": "Desk_Fields"
8786   },
8787   {
8788     "type": "get",
8789     "url": "/api/integrations/desk/fields",
8790     "title": "Gets a list of Desk Fields",
8791     "examples": [
8792       {
8793         "title": "Example usage:",
8794         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8795         "type": "json"
8796       }
8797     ],
8798     "name": "GetDesk_Fields",
8799     "group": "Desk_Fields",
8800     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8801     "version": "0.0.0",
8802     "filename": "server/api/intDeskField/index.js",
8803     "groupTitle": "Desk_Fields"
8804   },
8805   {
8806     "type": "get",
8807     "url": "/api/integrations/desk/fields/{id}",
8808     "title": "Gets a single Desk Field",
8809     "examples": [
8810       {
8811         "title": "Example usage:",
8812         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8813         "type": "json"
8814       }
8815     ],
8816     "name": "ShowDesk_Fields",
8817     "group": "Desk_Fields",
8818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8819     "version": "0.0.0",
8820     "filename": "server/api/intDeskField/index.js",
8821     "groupTitle": "Desk_Fields"
8822   },
8823   {
8824     "type": "put",
8825     "url": "/api/integrations/desk/fields/{id}",
8826     "title": "Update an existing Desk Field",
8827     "examples": [
8828       {
8829         "title": "Example usage:",
8830         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8831         "type": "json"
8832       }
8833     ],
8834     "name": "updateDesk_Fields",
8835     "group": "Desk_Fields",
8836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8837     "version": "0.0.0",
8838     "filename": "server/api/intDeskField/index.js",
8839     "groupTitle": "Desk_Fields"
8840   },
8841   {
8842     "type": "post",
8843     "url": "/api/dispositions",
8844     "title": "Creates a new Disposition",
8845     "examples": [
8846       {
8847         "title": "Example usage:",
8848         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8849         "type": "json"
8850       }
8851     ],
8852     "name": "CreateDispositions",
8853     "group": "Dispositions",
8854     "parameter": {
8855       "fields": {
8856         "Body": [
8857           {
8858             "group": "Body",
8859             "type": "String",
8860             "optional": false,
8861             "field": "name",
8862             "description": ""
8863           },
8864           {
8865             "group": "Body",
8866             "type": "String",
8867             "allowedValues": [
8868               "\"first\"",
8869               "\"second\"",
8870               "\"third\""
8871             ],
8872             "optional": false,
8873             "field": "level",
8874             "description": ""
8875           },
8876           {
8877             "group": "Body",
8878             "type": "String",
8879             "optional": true,
8880             "field": "description",
8881             "description": ""
8882           }
8883         ]
8884       }
8885     },
8886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8887     "version": "0.0.0",
8888     "filename": "server/api/disposition/index.js",
8889     "groupTitle": "Dispositions"
8890   },
8891   {
8892     "type": "delete",
8893     "url": "/api/dispositions/{id}",
8894     "title": "Deletes a Disposition",
8895     "examples": [
8896       {
8897         "title": "Example usage:",
8898         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8899         "type": "json"
8900       }
8901     ],
8902     "name": "DeleteDispositions",
8903     "group": "Dispositions",
8904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8905     "version": "0.0.0",
8906     "filename": "server/api/disposition/index.js",
8907     "groupTitle": "Dispositions"
8908   },
8909   {
8910     "type": "get",
8911     "url": "/api/dispositions",
8912     "title": "Gets a list of Dispositions",
8913     "examples": [
8914       {
8915         "title": "Example usage:",
8916         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8917         "type": "json"
8918       }
8919     ],
8920     "name": "GetDispositions",
8921     "group": "Dispositions",
8922     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dispositions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dispositions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dispositions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dispositions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dispositions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8923     "version": "0.0.0",
8924     "filename": "server/api/disposition/index.js",
8925     "groupTitle": "Dispositions"
8926   },
8927   {
8928     "type": "get",
8929     "url": "/api/dispositions/{id}",
8930     "title": "Gets a single Disposition",
8931     "examples": [
8932       {
8933         "title": "Example usage:",
8934         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8935         "type": "json"
8936       }
8937     ],
8938     "name": "ShowDispositions",
8939     "group": "Dispositions",
8940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8941     "version": "0.0.0",
8942     "filename": "server/api/disposition/index.js",
8943     "groupTitle": "Dispositions"
8944   },
8945   {
8946     "type": "put",
8947     "url": "/api/dispositions/{id}",
8948     "title": "Update an existing Disposition",
8949     "examples": [
8950       {
8951         "title": "Example usage:",
8952         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8953         "type": "json"
8954       }
8955     ],
8956     "name": "updateDispositions",
8957     "group": "Dispositions",
8958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8959     "version": "0.0.0",
8960     "filename": "server/api/disposition/index.js",
8961     "groupTitle": "Dispositions"
8962   },
8963   {
8964     "type": "post",
8965     "url": "/api/integrations/dynamics365/accounts",
8966     "title": "Creates a new Dynamics365 Account",
8967     "examples": [
8968       {
8969         "title": "Example usage:",
8970         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8971         "type": "json"
8972       }
8973     ],
8974     "name": "CreateDynamics365_Accounts",
8975     "group": "Dynamics365_Accounts",
8976     "parameter": {
8977       "fields": {
8978         "Body": [
8979           {
8980             "group": "Body",
8981             "type": "String",
8982             "optional": true,
8983             "field": "name",
8984             "description": ""
8985           },
8986           {
8987             "group": "Body",
8988             "type": "String",
8989             "optional": true,
8990             "field": "username",
8991             "description": ""
8992           },
8993           {
8994             "group": "Body",
8995             "type": "String",
8996             "optional": true,
8997             "field": "password",
8998             "description": ""
8999           },
9000           {
9001             "group": "Body",
9002             "type": "String",
9003             "optional": true,
9004             "field": "remoteUri",
9005             "description": ""
9006           },
9007           {
9008             "group": "Body",
9009             "type": "String",
9010             "optional": true,
9011             "field": "tenantId",
9012             "description": ""
9013           },
9014           {
9015             "group": "Body",
9016             "type": "String",
9017             "optional": true,
9018             "field": "clientId",
9019             "description": ""
9020           },
9021           {
9022             "group": "Body",
9023             "type": "String",
9024             "optional": true,
9025             "field": "clientSecret",
9026             "description": ""
9027           },
9028           {
9029             "group": "Body",
9030             "type": "String",
9031             "optional": false,
9032             "field": "serverUrl",
9033             "description": ""
9034           },
9035           {
9036             "group": "Body",
9037             "type": "String",
9038             "optional": true,
9039             "field": "description",
9040             "description": ""
9041           }
9042         ]
9043       }
9044     },
9045     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9046     "version": "0.0.0",
9047     "filename": "server/api/intDynamics365Account/index.js",
9048     "groupTitle": "Dynamics365_Accounts"
9049   },
9050   {
9051     "type": "delete",
9052     "url": "/api/integrations/dynamics365/accounts/{id}",
9053     "title": "Deletes a Dynamics365 Account",
9054     "examples": [
9055       {
9056         "title": "Example usage:",
9057         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9058         "type": "json"
9059       }
9060     ],
9061     "name": "DeleteDynamics365_Accounts",
9062     "group": "Dynamics365_Accounts",
9063     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9064     "version": "0.0.0",
9065     "filename": "server/api/intDynamics365Account/index.js",
9066     "groupTitle": "Dynamics365_Accounts"
9067   },
9068   {
9069     "type": "get",
9070     "url": "/api/integrations/dynamics365/accounts",
9071     "title": "Gets a list of Dynamics365 Accounts",
9072     "examples": [
9073       {
9074         "title": "Example usage:",
9075         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9076         "type": "json"
9077       }
9078     ],
9079     "name": "GetDynamics365_Accounts",
9080     "group": "Dynamics365_Accounts",
9081     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9082     "version": "0.0.0",
9083     "filename": "server/api/intDynamics365Account/index.js",
9084     "groupTitle": "Dynamics365_Accounts"
9085   },
9086   {
9087     "type": "get",
9088     "url": "/api/integrations/dynamics365/accounts/{id}",
9089     "title": "Gets a single Dynamics365 Account",
9090     "examples": [
9091       {
9092         "title": "Example usage:",
9093         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9094         "type": "json"
9095       }
9096     ],
9097     "name": "ShowDynamics365_Accounts",
9098     "group": "Dynamics365_Accounts",
9099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9100     "version": "0.0.0",
9101     "filename": "server/api/intDynamics365Account/index.js",
9102     "groupTitle": "Dynamics365_Accounts"
9103   },
9104   {
9105     "type": "post",
9106     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9107     "title": "Creates new configuration",
9108     "examples": [
9109       {
9110         "title": "Example usage:",
9111         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9112         "type": "json"
9113       }
9114     ],
9115     "name": "addConfiguration",
9116     "group": "Dynamics365_Accounts",
9117     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9118     "version": "0.0.0",
9119     "filename": "server/api/intDynamics365Account/index.js",
9120     "groupTitle": "Dynamics365_Accounts"
9121   },
9122   {
9123     "type": "get",
9124     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9125     "title": "Gets account configurations",
9126     "examples": [
9127       {
9128         "title": "Example usage:",
9129         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9130         "type": "json"
9131       }
9132     ],
9133     "name": "getConfigurations",
9134     "group": "Dynamics365_Accounts",
9135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9136     "version": "0.0.0",
9137     "filename": "server/api/intDynamics365Account/index.js",
9138     "groupTitle": "Dynamics365_Accounts"
9139   },
9140   {
9141     "type": "get",
9142     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9143     "title": "Gets account fields",
9144     "examples": [
9145       {
9146         "title": "Example usage:",
9147         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9148         "type": "json"
9149       }
9150     ],
9151     "name": "getFields",
9152     "group": "Dynamics365_Accounts",
9153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9154     "version": "0.0.0",
9155     "filename": "server/api/intDynamics365Account/index.js",
9156     "groupTitle": "Dynamics365_Accounts"
9157   },
9158   {
9159     "type": "put",
9160     "url": "/api/integrations/dynamics365/accounts/{id}",
9161     "title": "Update an existing Dynamics365 Account",
9162     "examples": [
9163       {
9164         "title": "Example usage:",
9165         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9166         "type": "json"
9167       }
9168     ],
9169     "name": "updateDynamics365_Accounts",
9170     "group": "Dynamics365_Accounts",
9171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9172     "version": "0.0.0",
9173     "filename": "server/api/intDynamics365Account/index.js",
9174     "groupTitle": "Dynamics365_Accounts"
9175   },
9176   {
9177     "type": "post",
9178     "url": "/api/integrations/dynamics365/configurations",
9179     "title": "Creates a new Dynamics365 Configuration",
9180     "examples": [
9181       {
9182         "title": "Example usage:",
9183         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9184         "type": "json"
9185       }
9186     ],
9187     "name": "CreateDynamics365_Configurations",
9188     "group": "Dynamics365_Configurations",
9189     "parameter": {
9190       "fields": {
9191         "Body": [
9192           {
9193             "group": "Body",
9194             "type": "String",
9195             "optional": true,
9196             "field": "name",
9197             "description": ""
9198           },
9199           {
9200             "group": "Body",
9201             "type": "String",
9202             "optional": true,
9203             "field": "description",
9204             "description": ""
9205           },
9206           {
9207             "group": "Body",
9208             "type": "String",
9209             "allowedValues": [
9210               "\"incident\"",
9211               "\"phonecall\""
9212             ],
9213             "optional": true,
9214             "field": "ticketType",
9215             "description": ""
9216           }
9217         ]
9218       }
9219     },
9220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9221     "version": "0.0.0",
9222     "filename": "server/api/intDynamics365Configuration/index.js",
9223     "groupTitle": "Dynamics365_Configurations"
9224   },
9225   {
9226     "type": "delete",
9227     "url": "/api/integrations/dynamics365/configurations/{id}",
9228     "title": "Deletes a Dynamics365 Configuration",
9229     "examples": [
9230       {
9231         "title": "Example usage:",
9232         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9233         "type": "json"
9234       }
9235     ],
9236     "name": "DeleteDynamics365_Configurations",
9237     "group": "Dynamics365_Configurations",
9238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9239     "version": "0.0.0",
9240     "filename": "server/api/intDynamics365Configuration/index.js",
9241     "groupTitle": "Dynamics365_Configurations"
9242   },
9243   {
9244     "type": "get",
9245     "url": "/api/integrations/dynamics365/configurations",
9246     "title": "Gets a list of Dynamics365 Configurations",
9247     "examples": [
9248       {
9249         "title": "Example usage:",
9250         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9251         "type": "json"
9252       }
9253     ],
9254     "name": "GetDynamics365_Configurations",
9255     "group": "Dynamics365_Configurations",
9256     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9257     "version": "0.0.0",
9258     "filename": "server/api/intDynamics365Configuration/index.js",
9259     "groupTitle": "Dynamics365_Configurations"
9260   },
9261   {
9262     "type": "get",
9263     "url": "/api/integrations/dynamics365/configurations/{id}",
9264     "title": "Gets a single Dynamics365 Configuration",
9265     "examples": [
9266       {
9267         "title": "Example usage:",
9268         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9269         "type": "json"
9270       }
9271     ],
9272     "name": "ShowDynamics365_Configurations",
9273     "group": "Dynamics365_Configurations",
9274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9275     "version": "0.0.0",
9276     "filename": "server/api/intDynamics365Configuration/index.js",
9277     "groupTitle": "Dynamics365_Configurations"
9278   },
9279   {
9280     "type": "get",
9281     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9282     "title": "Gets configurations descriptions",
9283     "examples": [
9284       {
9285         "title": "Example usage:",
9286         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9287         "type": "json"
9288       }
9289     ],
9290     "name": "getDescriptions",
9291     "group": "Dynamics365_Configurations",
9292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9293     "version": "0.0.0",
9294     "filename": "server/api/intDynamics365Configuration/index.js",
9295     "groupTitle": "Dynamics365_Configurations"
9296   },
9297   {
9298     "type": "get",
9299     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9300     "title": "Gets configurations fields",
9301     "examples": [
9302       {
9303         "title": "Example usage:",
9304         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9305         "type": "json"
9306       }
9307     ],
9308     "name": "getFields",
9309     "group": "Dynamics365_Configurations",
9310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9311     "version": "0.0.0",
9312     "filename": "server/api/intDynamics365Configuration/index.js",
9313     "groupTitle": "Dynamics365_Configurations"
9314   },
9315   {
9316     "type": "get",
9317     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9318     "title": "Gets configurations subjects",
9319     "examples": [
9320       {
9321         "title": "Example usage:",
9322         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9323         "type": "json"
9324       }
9325     ],
9326     "name": "getSubjects",
9327     "group": "Dynamics365_Configurations",
9328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9329     "version": "0.0.0",
9330     "filename": "server/api/intDynamics365Configuration/index.js",
9331     "groupTitle": "Dynamics365_Configurations"
9332   },
9333   {
9334     "type": "put",
9335     "url": "/api/integrations/dynamics365/configurations/{id}",
9336     "title": "Update an existing Dynamics365 Configuration",
9337     "examples": [
9338       {
9339         "title": "Example usage:",
9340         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9341         "type": "json"
9342       }
9343     ],
9344     "name": "updateDynamics365_Configurations",
9345     "group": "Dynamics365_Configurations",
9346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9347     "version": "0.0.0",
9348     "filename": "server/api/intDynamics365Configuration/index.js",
9349     "groupTitle": "Dynamics365_Configurations"
9350   },
9351   {
9352     "type": "post",
9353     "url": "/api/integrations/dynamics365/fields",
9354     "title": "Creates a new Dynamics365 Field",
9355     "examples": [
9356       {
9357         "title": "Example usage:",
9358         "content": "curl https://{domain}/api/integrations/dynamics365/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9359         "type": "json"
9360       }
9361     ],
9362     "name": "CreateDynamics365_Fields",
9363     "group": "Dynamics365_Fields",
9364     "parameter": {
9365       "fields": {
9366         "Body": [
9367           {
9368             "group": "Body",
9369             "type": "String",
9370             "allowedValues": [
9371               "\"string\"",
9372               "\"variable\"",
9373               "\"customVariable\"",
9374               "\"keyValue\"",
9375               "\"picklist\""
9376             ],
9377             "optional": true,
9378             "field": "type",
9379             "description": ""
9380           },
9381           {
9382             "group": "Body",
9383             "type": "String",
9384             "optional": true,
9385             "field": "content",
9386             "description": ""
9387           },
9388           {
9389             "group": "Body",
9390             "type": "String",
9391             "optional": true,
9392             "field": "key",
9393             "description": ""
9394           },
9395           {
9396             "group": "Body",
9397             "type": "String",
9398             "allowedValues": [
9399               "\"string\"",
9400               "\"variable\"",
9401               "\"customVariable\""
9402             ],
9403             "optional": true,
9404             "field": "keyType",
9405             "description": ""
9406           },
9407           {
9408             "group": "Body",
9409             "type": "String",
9410             "optional": true,
9411             "field": "keyContent",
9412             "description": ""
9413           },
9414           {
9415             "group": "Body",
9416             "type": "String",
9417             "optional": true,
9418             "field": "idField",
9419             "description": ""
9420           },
9421           {
9422             "group": "Body",
9423             "type": "String",
9424             "optional": true,
9425             "field": "nameField",
9426             "description": ""
9427           },
9428           {
9429             "group": "Body",
9430             "type": "Boolean",
9431             "optional": true,
9432             "field": "customField",
9433             "description": ""
9434           },
9435           {
9436             "group": "Body",
9437             "type": "String",
9438             "optional": true,
9439             "field": "variableName",
9440             "description": ""
9441           }
9442         ]
9443       }
9444     },
9445     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9446     "version": "0.0.0",
9447     "filename": "server/api/intDynamics365Field/index.js",
9448     "groupTitle": "Dynamics365_Fields"
9449   },
9450   {
9451     "type": "delete",
9452     "url": "/api/integrations/dynamics365/fields/{id}",
9453     "title": "Deletes a Dynamics365 Field",
9454     "examples": [
9455       {
9456         "title": "Example usage:",
9457         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9458         "type": "json"
9459       }
9460     ],
9461     "name": "DeleteDynamics365_Fields",
9462     "group": "Dynamics365_Fields",
9463     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9464     "version": "0.0.0",
9465     "filename": "server/api/intDynamics365Field/index.js",
9466     "groupTitle": "Dynamics365_Fields"
9467   },
9468   {
9469     "type": "get",
9470     "url": "/api/integrations/dynamics365/fields",
9471     "title": "Gets a list of Dynamics365 Fields",
9472     "examples": [
9473       {
9474         "title": "Example usage:",
9475         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9476         "type": "json"
9477       }
9478     ],
9479     "name": "GetDynamics365_Fields",
9480     "group": "Dynamics365_Fields",
9481     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9482     "version": "0.0.0",
9483     "filename": "server/api/intDynamics365Field/index.js",
9484     "groupTitle": "Dynamics365_Fields"
9485   },
9486   {
9487     "type": "get",
9488     "url": "/api/integrations/dynamics365/fields/{id}",
9489     "title": "Gets a single Dynamics365 Field",
9490     "examples": [
9491       {
9492         "title": "Example usage:",
9493         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9494         "type": "json"
9495       }
9496     ],
9497     "name": "ShowDynamics365_Fields",
9498     "group": "Dynamics365_Fields",
9499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9500     "version": "0.0.0",
9501     "filename": "server/api/intDynamics365Field/index.js",
9502     "groupTitle": "Dynamics365_Fields"
9503   },
9504   {
9505     "type": "put",
9506     "url": "/api/integrations/dynamics365/fields/{id}",
9507     "title": "Update an existing Dynamics365 Field",
9508     "examples": [
9509       {
9510         "title": "Example usage:",
9511         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9512         "type": "json"
9513       }
9514     ],
9515     "name": "updateDynamics365_Fields",
9516     "group": "Dynamics365_Fields",
9517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9518     "version": "0.0.0",
9519     "filename": "server/api/intDynamics365Field/index.js",
9520     "groupTitle": "Dynamics365_Fields"
9521   },
9522   {
9523     "type": "post",
9524     "url": "/api/fax/accounts/{id}/users",
9525     "title": "Add agents to a fax account",
9526     "examples": [
9527       {
9528         "title": "Example usage:",
9529         "content": "curl https://{domain}/api/fax/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9530         "type": "json"
9531       }
9532     ],
9533     "name": "AddAgents",
9534     "group": "Fax_Accounts",
9535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9536     "version": "0.0.0",
9537     "filename": "server/api/faxAccount/index.js",
9538     "groupTitle": "Fax_Accounts"
9539   },
9540   {
9541     "type": "post",
9542     "url": "/api/fax/accounts",
9543     "title": "Creates a new Account",
9544     "examples": [
9545       {
9546         "title": "Example usage:",
9547         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9548         "type": "json"
9549       }
9550     ],
9551     "name": "CreateAccounts",
9552     "group": "Fax_Accounts",
9553     "parameter": {
9554       "fields": {
9555         "Body": [
9556           {
9557             "group": "Body",
9558             "type": "String",
9559             "optional": false,
9560             "field": "name",
9561             "description": ""
9562           },
9563           {
9564             "group": "Body",
9565             "type": "String",
9566             "optional": true,
9567             "field": "description",
9568             "description": ""
9569           },
9570           {
9571             "group": "Body",
9572             "type": "String",
9573             "allowedValues": [
9574               "\"yes\"",
9575               "\"no\""
9576             ],
9577             "optional": true,
9578             "field": "ecm",
9579             "description": ""
9580           },
9581           {
9582             "group": "Body",
9583             "type": "String",
9584             "optional": true,
9585             "field": "headerinfo",
9586             "description": ""
9587           },
9588           {
9589             "group": "Body",
9590             "type": "String",
9591             "optional": true,
9592             "field": "localstationid",
9593             "description": ""
9594           },
9595           {
9596             "group": "Body",
9597             "type": "String",
9598             "allowedValues": [
9599               "\"2400\"",
9600               "\"4800\"",
9601               "\"7200\"",
9602               "\"9600\"",
9603               "\"12000\"",
9604               "\"14400\""
9605             ],
9606             "optional": true,
9607             "field": "minrate",
9608             "description": ""
9609           },
9610           {
9611             "group": "Body",
9612             "type": "String",
9613             "allowedValues": [
9614               "\"2400\"",
9615               "\"4800\"",
9616               "\"7200\"",
9617               "\"9600\"",
9618               "\"12000\"",
9619               "\"14400\""
9620             ],
9621             "optional": true,
9622             "field": "maxrate",
9623             "description": ""
9624           },
9625           {
9626             "group": "Body",
9627             "type": "String",
9628             "optional": true,
9629             "field": "modem",
9630             "description": ""
9631           },
9632           {
9633             "group": "Body",
9634             "type": "String",
9635             "optional": true,
9636             "field": "gateway",
9637             "description": ""
9638           },
9639           {
9640             "group": "Body",
9641             "type": "String",
9642             "optional": true,
9643             "field": "faxdetect",
9644             "description": ""
9645           },
9646           {
9647             "group": "Body",
9648             "type": "Integer",
9649             "optional": true,
9650             "field": "t38timeout",
9651             "description": ""
9652           },
9653           {
9654             "group": "Body",
9655             "type": "String",
9656             "allowedValues": [
9657               "\"SIP\"",
9658               "\"IAX\"",
9659               "\"DADHI\"",
9660               "\"KHOMP\""
9661             ],
9662             "optional": true,
9663             "field": "tech",
9664             "description": ""
9665           },
9666           {
9667             "group": "Body",
9668             "type": "String",
9669             "optional": false,
9670             "field": "key",
9671             "description": ""
9672           },
9673           {
9674             "group": "Body",
9675             "type": "Text",
9676             "optional": true,
9677             "field": "notificationTemplate",
9678             "description": ""
9679           },
9680           {
9681             "group": "Body",
9682             "type": "Boolean",
9683             "optional": true,
9684             "field": "notificationSound",
9685             "description": ""
9686           },
9687           {
9688             "group": "Body",
9689             "type": "Boolean",
9690             "optional": true,
9691             "field": "notificationShake",
9692             "description": ""
9693           },
9694           {
9695             "group": "Body",
9696             "type": "Integer",
9697             "optional": true,
9698             "field": "waitForTheAssignedAgent",
9699             "description": ""
9700           },
9701           {
9702             "group": "Body",
9703             "type": "Boolean",
9704             "optional": true,
9705             "field": "queueTransfer",
9706             "description": ""
9707           },
9708           {
9709             "group": "Body",
9710             "type": "Integer",
9711             "optional": true,
9712             "field": "queueTransferTimeout",
9713             "description": ""
9714           },
9715           {
9716             "group": "Body",
9717             "type": "Boolean",
9718             "optional": true,
9719             "field": "agentTransfer",
9720             "description": ""
9721           },
9722           {
9723             "group": "Body",
9724             "type": "Integer",
9725             "optional": true,
9726             "field": "agentTransferTimeout",
9727             "description": ""
9728           },
9729           {
9730             "group": "Body",
9731             "type": "Integer",
9732             "optional": true,
9733             "field": "mandatoryDispositionPauseId",
9734             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9735           },
9736           {
9737             "group": "Body",
9738             "type": "Boolean",
9739             "optional": true,
9740             "field": "mandatoryDisposition",
9741             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9742           }
9743         ]
9744       }
9745     },
9746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9747     "version": "0.0.0",
9748     "filename": "server/api/faxAccount/index.js",
9749     "groupTitle": "Fax_Accounts"
9750   },
9751   {
9752     "type": "delete",
9753     "url": "/api/fax/accounts/{id}",
9754     "title": "Deletes a Account",
9755     "examples": [
9756       {
9757         "title": "Example usage:",
9758         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9759         "type": "json"
9760       }
9761     ],
9762     "name": "DeleteAccounts",
9763     "group": "Fax_Accounts",
9764     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9765     "version": "0.0.0",
9766     "filename": "server/api/faxAccount/index.js",
9767     "groupTitle": "Fax_Accounts"
9768   },
9769   {
9770     "type": "get",
9771     "url": "/api/fax/accounts/describe",
9772     "title": "Gets table info about Accounts",
9773     "examples": [
9774       {
9775         "title": "Example usage:",
9776         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9777         "type": "json"
9778       }
9779     ],
9780     "name": "DescribeAccounts",
9781     "group": "Fax_Accounts",
9782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9783     "version": "0.0.0",
9784     "filename": "server/api/faxAccount/index.js",
9785     "groupTitle": "Fax_Accounts"
9786   },
9787   {
9788     "type": "get",
9789     "url": "/api/fax/accounts",
9790     "title": "Gets a list of Accounts",
9791     "examples": [
9792       {
9793         "title": "Example usage:",
9794         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9795         "type": "json"
9796       }
9797     ],
9798     "name": "GetAccounts",
9799     "group": "Fax_Accounts",
9800     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9801     "version": "0.0.0",
9802     "filename": "server/api/faxAccount/index.js",
9803     "groupTitle": "Fax_Accounts"
9804   },
9805   {
9806     "type": "get",
9807     "url": "/api/fax/accounts/{id}/users",
9808     "title": "Gets agents from fax account",
9809     "examples": [
9810       {
9811         "title": "Example usage:",
9812         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9813         "type": "json"
9814       }
9815     ],
9816     "name": "GetAgents",
9817     "group": "Fax_Accounts",
9818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9819     "version": "0.0.0",
9820     "filename": "server/api/faxAccount/index.js",
9821     "groupTitle": "Fax_Accounts"
9822   },
9823   {
9824     "type": "delete",
9825     "url": "/api/fax/accounts/{id}/users",
9826     "title": "Removes agents from a fax account",
9827     "examples": [
9828       {
9829         "title": "Example usage:",
9830         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9831         "type": "json"
9832       }
9833     ],
9834     "name": "RemoveAgents",
9835     "group": "Fax_Accounts",
9836     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9837     "version": "0.0.0",
9838     "filename": "server/api/faxAccount/index.js",
9839     "groupTitle": "Fax_Accounts"
9840   },
9841   {
9842     "type": "delete",
9843     "url": "/api/fax/accounts/{id}/canned_answers",
9844     "title": "Removes canned answers from account",
9845     "examples": [
9846       {
9847         "title": "Example usage:",
9848         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9849         "type": "json"
9850       }
9851     ],
9852     "name": "RemoveAnswers",
9853     "group": "Fax_Accounts",
9854     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9855     "version": "0.0.0",
9856     "filename": "server/api/faxAccount/index.js",
9857     "groupTitle": "Fax_Accounts"
9858   },
9859   {
9860     "type": "delete",
9861     "url": "/api/fax/accounts/{id}/dispositions",
9862     "title": "Removes dispositions from account",
9863     "examples": [
9864       {
9865         "title": "Example usage:",
9866         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9867         "type": "json"
9868       }
9869     ],
9870     "name": "RemoveDispositions",
9871     "group": "Fax_Accounts",
9872     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9873     "version": "0.0.0",
9874     "filename": "server/api/faxAccount/index.js",
9875     "groupTitle": "Fax_Accounts"
9876   },
9877   {
9878     "type": "get",
9879     "url": "/api/fax/accounts/{id}",
9880     "title": "Gets a single Account",
9881     "examples": [
9882       {
9883         "title": "Example usage:",
9884         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9885         "type": "json"
9886       }
9887     ],
9888     "name": "ShowAccounts",
9889     "group": "Fax_Accounts",
9890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9891     "version": "0.0.0",
9892     "filename": "server/api/faxAccount/index.js",
9893     "groupTitle": "Fax_Accounts"
9894   },
9895   {
9896     "type": "post",
9897     "url": "/api/fax/accounts/{id}/canned_answers",
9898     "title": "Creates new canned answer",
9899     "examples": [
9900       {
9901         "title": "Example usage:",
9902         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9903         "type": "json"
9904       }
9905     ],
9906     "name": "addAnswer",
9907     "group": "Fax_Accounts",
9908     "parameter": {
9909       "fields": {
9910         "Body": [
9911           {
9912             "group": "Body",
9913             "type": "String",
9914             "optional": false,
9915             "field": "key",
9916             "description": ""
9917           },
9918           {
9919             "group": "Body",
9920             "type": "Text",
9921             "optional": false,
9922             "field": "value",
9923             "description": ""
9924           },
9925           {
9926             "group": "Body",
9927             "type": "String",
9928             "optional": true,
9929             "field": "description",
9930             "description": ""
9931           },
9932           {
9933             "group": "Body",
9934             "type": "Virtual",
9935             "optional": true,
9936             "field": "name",
9937             "description": ""
9938           }
9939         ]
9940       }
9941     },
9942     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9943     "version": "0.0.0",
9944     "filename": "server/api/faxAccount/index.js",
9945     "groupTitle": "Fax_Accounts"
9946   },
9947   {
9948     "type": "post",
9949     "url": "/api/fax/accounts/addaccountapplications",
9950     "title": "Creates new account and applications",
9951     "examples": [
9952       {
9953         "title": "Example usage:",
9954         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9955         "type": "json"
9956       }
9957     ],
9958     "name": "addApplications",
9959     "group": "Fax_Accounts",
9960     "parameter": {
9961       "fields": {
9962         "Body": [
9963           {
9964             "group": "Body",
9965             "type": "Integer",
9966             "optional": false,
9967             "field": "priority",
9968             "description": ""
9969           },
9970           {
9971             "group": "Body",
9972             "type": "String",
9973             "optional": false,
9974             "field": "app",
9975             "description": ""
9976           },
9977           {
9978             "group": "Body",
9979             "type": "Text",
9980             "optional": true,
9981             "field": "appdata",
9982             "description": ""
9983           },
9984           {
9985             "group": "Body",
9986             "type": "String",
9987             "optional": true,
9988             "field": "description",
9989             "description": ""
9990           },
9991           {
9992             "group": "Body",
9993             "type": "String",
9994             "optional": true,
9995             "field": "interval",
9996             "description": ""
9997           }
9998         ]
9999       }
10000     },
10001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10002     "version": "0.0.0",
10003     "filename": "server/api/faxAccount/index.js",
10004     "groupTitle": "Fax_Accounts"
10005   },
10006   {
10007     "type": "post",
10008     "url": "/api/fax/accounts/{id}/applications",
10009     "title": "Creates new applications",
10010     "examples": [
10011       {
10012         "title": "Example usage:",
10013         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10014         "type": "json"
10015       }
10016     ],
10017     "name": "addApplications",
10018     "group": "Fax_Accounts",
10019     "parameter": {
10020       "fields": {
10021         "Body": [
10022           {
10023             "group": "Body",
10024             "type": "Integer",
10025             "optional": false,
10026             "field": "priority",
10027             "description": ""
10028           },
10029           {
10030             "group": "Body",
10031             "type": "String",
10032             "optional": false,
10033             "field": "app",
10034             "description": ""
10035           },
10036           {
10037             "group": "Body",
10038             "type": "Text",
10039             "optional": true,
10040             "field": "appdata",
10041             "description": ""
10042           },
10043           {
10044             "group": "Body",
10045             "type": "String",
10046             "optional": true,
10047             "field": "description",
10048             "description": ""
10049           },
10050           {
10051             "group": "Body",
10052             "type": "String",
10053             "optional": true,
10054             "field": "interval",
10055             "description": ""
10056           }
10057         ]
10058       }
10059     },
10060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10061     "version": "0.0.0",
10062     "filename": "server/api/faxAccount/index.js",
10063     "groupTitle": "Fax_Accounts"
10064   },
10065   {
10066     "type": "post",
10067     "url": "/api/fax/accounts/{id}/dispositions",
10068     "title": "Creates new disposition",
10069     "examples": [
10070       {
10071         "title": "Example usage:",
10072         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10073         "type": "json"
10074       }
10075     ],
10076     "name": "addDisposition",
10077     "group": "Fax_Accounts",
10078     "parameter": {
10079       "fields": {
10080         "Body": [
10081           {
10082             "group": "Body",
10083             "type": "String",
10084             "optional": false,
10085             "field": "name",
10086             "description": ""
10087           },
10088           {
10089             "group": "Body",
10090             "type": "String",
10091             "allowedValues": [
10092               "\"first\"",
10093               "\"second\"",
10094               "\"third\""
10095             ],
10096             "optional": false,
10097             "field": "level",
10098             "description": ""
10099           },
10100           {
10101             "group": "Body",
10102             "type": "String",
10103             "optional": true,
10104             "field": "description",
10105             "description": ""
10106           }
10107         ]
10108       }
10109     },
10110     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10111     "version": "0.0.0",
10112     "filename": "server/api/faxAccount/index.js",
10113     "groupTitle": "Fax_Accounts"
10114   },
10115   {
10116     "type": "post",
10117     "url": "/api/fax/accounts/{id}/interactions",
10118     "title": "Creates new interactions",
10119     "examples": [
10120       {
10121         "title": "Example usage:",
10122         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10123         "type": "json"
10124       }
10125     ],
10126     "name": "addInteraction",
10127     "group": "Fax_Accounts",
10128     "parameter": {
10129       "fields": {
10130         "Body": [
10131           {
10132             "group": "Body",
10133             "type": "Boolean",
10134             "optional": true,
10135             "field": "closed",
10136             "description": ""
10137           },
10138           {
10139             "group": "Body",
10140             "type": "String",
10141             "optional": true,
10142             "field": "closedAt",
10143             "description": ""
10144           },
10145           {
10146             "group": "Body",
10147             "type": "String",
10148             "optional": true,
10149             "field": "disposition",
10150             "description": ""
10151           },
10152           {
10153             "group": "Body",
10154             "type": "String",
10155             "optional": true,
10156             "field": "secondDisposition",
10157             "description": ""
10158           },
10159           {
10160             "group": "Body",
10161             "type": "String",
10162             "optional": true,
10163             "field": "thirdDisposition",
10164             "description": ""
10165           },
10166           {
10167             "group": "Body",
10168             "type": "String",
10169             "optional": true,
10170             "field": "note",
10171             "description": ""
10172           },
10173           {
10174             "group": "Body",
10175             "type": "String",
10176             "optional": true,
10177             "field": "read1stAt",
10178             "description": ""
10179           },
10180           {
10181             "group": "Body",
10182             "type": "String",
10183             "optional": true,
10184             "field": "fax",
10185             "description": ""
10186           },
10187           {
10188             "group": "Body",
10189             "type": "String",
10190             "allowedValues": [
10191               "\"in\"",
10192               "\"out\""
10193             ],
10194             "optional": false,
10195             "field": "firstMsgDirection",
10196             "description": ""
10197           },
10198           {
10199             "group": "Body",
10200             "type": "String",
10201             "optional": true,
10202             "field": "lastMsgAt",
10203             "description": ""
10204           },
10205           {
10206             "group": "Body",
10207             "type": "String",
10208             "allowedValues": [
10209               "\"in\"",
10210               "\"out\""
10211             ],
10212             "optional": false,
10213             "field": "lastMsgDirection",
10214             "description": ""
10215           }
10216         ]
10217       }
10218     },
10219     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10220     "version": "0.0.0",
10221     "filename": "server/api/faxAccount/index.js",
10222     "groupTitle": "Fax_Accounts"
10223   },
10224   {
10225     "type": "get",
10226     "url": "/api/fax/accounts/{id}/canned_answers",
10227     "title": "Gets account canned answers",
10228     "examples": [
10229       {
10230         "title": "Example usage:",
10231         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10232         "type": "json"
10233       }
10234     ],
10235     "name": "getAnswers",
10236     "group": "Fax_Accounts",
10237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10238     "version": "0.0.0",
10239     "filename": "server/api/faxAccount/index.js",
10240     "groupTitle": "Fax_Accounts"
10241   },
10242   {
10243     "type": "get",
10244     "url": "/api/fax/accounts/{id}/applications",
10245     "title": "Gets account pplications",
10246     "examples": [
10247       {
10248         "title": "Example usage:",
10249         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10250         "type": "json"
10251       }
10252     ],
10253     "name": "getApplications",
10254     "group": "Fax_Accounts",
10255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10256     "version": "0.0.0",
10257     "filename": "server/api/faxAccount/index.js",
10258     "groupTitle": "Fax_Accounts"
10259   },
10260   {
10261     "type": "get",
10262     "url": "/api/fax/accounts/{id}/dispositions",
10263     "title": "Gets account dispositions",
10264     "examples": [
10265       {
10266         "title": "Example usage:",
10267         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10268         "type": "json"
10269       }
10270     ],
10271     "name": "getDispositions",
10272     "group": "Fax_Accounts",
10273     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10274     "version": "0.0.0",
10275     "filename": "server/api/faxAccount/index.js",
10276     "groupTitle": "Fax_Accounts"
10277   },
10278   {
10279     "type": "get",
10280     "url": "/api/fax/accounts/{id}/interactions",
10281     "title": "Gets account interactions",
10282     "examples": [
10283       {
10284         "title": "Example usage:",
10285         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10286         "type": "json"
10287       }
10288     ],
10289     "name": "getInteraction",
10290     "group": "Fax_Accounts",
10291     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10292     "version": "0.0.0",
10293     "filename": "server/api/faxAccount/index.js",
10294     "groupTitle": "Fax_Accounts"
10295   },
10296   {
10297     "type": "get",
10298     "url": "/api/fax/accounts/{id}/messages",
10299     "title": "Gets account messages",
10300     "examples": [
10301       {
10302         "title": "Example usage:",
10303         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10304         "type": "json"
10305       }
10306     ],
10307     "name": "getMessages",
10308     "group": "Fax_Accounts",
10309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10310     "version": "0.0.0",
10311     "filename": "server/api/faxAccount/index.js",
10312     "groupTitle": "Fax_Accounts"
10313   },
10314   {
10315     "type": "post",
10316     "url": "/api/fax/accounts/{id}/send",
10317     "title": "Send new fax",
10318     "examples": [
10319       {
10320         "title": "Example usage:",
10321         "content": "curl https://{domain}/api/fax/accounts/{id}/send -d '{from: '\"John Doe\" <123456>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10322         "type": "json"
10323       }
10324     ],
10325     "name": "sendFax",
10326     "group": "Fax_Accounts",
10327     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10328     "version": "0.0.0",
10329     "filename": "server/api/faxAccount/index.js",
10330     "groupTitle": "Fax_Accounts"
10331   },
10332   {
10333     "type": "put",
10334     "url": "/api/fax/accounts/{id}",
10335     "title": "Update an existing Account",
10336     "examples": [
10337       {
10338         "title": "Example usage:",
10339         "content": "curl https://{domain}/api/fax/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10340         "type": "json"
10341       }
10342     ],
10343     "name": "updateAccounts",
10344     "group": "Fax_Accounts",
10345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10346     "version": "0.0.0",
10347     "filename": "server/api/faxAccount/index.js",
10348     "groupTitle": "Fax_Accounts"
10349   },
10350   {
10351     "type": "post",
10352     "url": "/api/fax/accounts/updateaccountapplications",
10353     "title": "Update account and applications",
10354     "examples": [
10355       {
10356         "title": "Example usage:",
10357         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10358         "type": "json"
10359       }
10360     ],
10361     "name": "updateApplications",
10362     "group": "Fax_Accounts",
10363     "parameter": {
10364       "fields": {
10365         "Body": [
10366           {
10367             "group": "Body",
10368             "type": "Integer",
10369             "optional": false,
10370             "field": "priority",
10371             "description": ""
10372           },
10373           {
10374             "group": "Body",
10375             "type": "String",
10376             "optional": false,
10377             "field": "app",
10378             "description": ""
10379           },
10380           {
10381             "group": "Body",
10382             "type": "Text",
10383             "optional": true,
10384             "field": "appdata",
10385             "description": ""
10386           },
10387           {
10388             "group": "Body",
10389             "type": "String",
10390             "optional": true,
10391             "field": "description",
10392             "description": ""
10393           },
10394           {
10395             "group": "Body",
10396             "type": "String",
10397             "optional": true,
10398             "field": "interval",
10399             "description": ""
10400           }
10401         ]
10402       }
10403     },
10404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10405     "version": "0.0.0",
10406     "filename": "server/api/faxAccount/index.js",
10407     "groupTitle": "Fax_Accounts"
10408   },
10409   {
10410     "type": "post",
10411     "url": "/api/fax/applications",
10412     "title": "Creates a new Application",
10413     "examples": [
10414       {
10415         "title": "Example usage:",
10416         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10417         "type": "json"
10418       }
10419     ],
10420     "name": "CreateApplications",
10421     "group": "Fax_Applications",
10422     "parameter": {
10423       "fields": {
10424         "Body": [
10425           {
10426             "group": "Body",
10427             "type": "Integer",
10428             "optional": false,
10429             "field": "priority",
10430             "description": ""
10431           },
10432           {
10433             "group": "Body",
10434             "type": "String",
10435             "optional": false,
10436             "field": "app",
10437             "description": ""
10438           },
10439           {
10440             "group": "Body",
10441             "type": "Text",
10442             "optional": true,
10443             "field": "appdata",
10444             "description": ""
10445           },
10446           {
10447             "group": "Body",
10448             "type": "String",
10449             "optional": true,
10450             "field": "description",
10451             "description": ""
10452           },
10453           {
10454             "group": "Body",
10455             "type": "String",
10456             "optional": true,
10457             "field": "interval",
10458             "description": ""
10459           }
10460         ]
10461       }
10462     },
10463     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10464     "version": "0.0.0",
10465     "filename": "server/api/faxApplication/index.js",
10466     "groupTitle": "Fax_Applications"
10467   },
10468   {
10469     "type": "delete",
10470     "url": "/api/fax/applications/{id}",
10471     "title": "Deletes a Application",
10472     "examples": [
10473       {
10474         "title": "Example usage:",
10475         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10476         "type": "json"
10477       }
10478     ],
10479     "name": "DeleteApplications",
10480     "group": "Fax_Applications",
10481     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10482     "version": "0.0.0",
10483     "filename": "server/api/faxApplication/index.js",
10484     "groupTitle": "Fax_Applications"
10485   },
10486   {
10487     "type": "get",
10488     "url": "/api/fax/applications",
10489     "title": "Gets a list of Applications",
10490     "examples": [
10491       {
10492         "title": "Example usage:",
10493         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10494         "type": "json"
10495       }
10496     ],
10497     "name": "GetApplications",
10498     "group": "Fax_Applications",
10499     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10500     "version": "0.0.0",
10501     "filename": "server/api/faxApplication/index.js",
10502     "groupTitle": "Fax_Applications"
10503   },
10504   {
10505     "type": "get",
10506     "url": "/api/fax/applications/{id}",
10507     "title": "Gets a single Application",
10508     "examples": [
10509       {
10510         "title": "Example usage:",
10511         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10512         "type": "json"
10513       }
10514     ],
10515     "name": "ShowApplications",
10516     "group": "Fax_Applications",
10517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10518     "version": "0.0.0",
10519     "filename": "server/api/faxApplication/index.js",
10520     "groupTitle": "Fax_Applications"
10521   },
10522   {
10523     "type": "put",
10524     "url": "/api/fax/applications/{id}",
10525     "title": "Update an existing Application",
10526     "examples": [
10527       {
10528         "title": "Example usage:",
10529         "content": "curl https://{domain}/api/fax/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10530         "type": "json"
10531       }
10532     ],
10533     "name": "updateApplications",
10534     "group": "Fax_Applications",
10535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10536     "version": "0.0.0",
10537     "filename": "server/api/faxApplication/index.js",
10538     "groupTitle": "Fax_Applications"
10539   },
10540   {
10541     "type": "post",
10542     "url": "/api/fax/interactions/{id}/tags",
10543     "title": "Add tags to the interaction",
10544     "examples": [
10545       {
10546         "title": "Example usage:",
10547         "content": "curl https://{domain}/api/fax/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10548         "type": "json"
10549       }
10550     ],
10551     "name": "AddTags",
10552     "group": "Fax_Interactions",
10553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10554     "version": "0.0.0",
10555     "filename": "server/api/faxInteraction/index.js",
10556     "groupTitle": "Fax_Interactions"
10557   },
10558   {
10559     "type": "post",
10560     "url": "/api/fax/interactions",
10561     "title": "Creates a new Interaction",
10562     "examples": [
10563       {
10564         "title": "Example usage:",
10565         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10566         "type": "json"
10567       }
10568     ],
10569     "name": "CreateInteractions",
10570     "group": "Fax_Interactions",
10571     "parameter": {
10572       "fields": {
10573         "Body": [
10574           {
10575             "group": "Body",
10576             "type": "Boolean",
10577             "optional": true,
10578             "field": "closed",
10579             "description": ""
10580           },
10581           {
10582             "group": "Body",
10583             "type": "String",
10584             "optional": true,
10585             "field": "closedAt",
10586             "description": ""
10587           },
10588           {
10589             "group": "Body",
10590             "type": "String",
10591             "optional": true,
10592             "field": "disposition",
10593             "description": ""
10594           },
10595           {
10596             "group": "Body",
10597             "type": "String",
10598             "optional": true,
10599             "field": "secondDisposition",
10600             "description": ""
10601           },
10602           {
10603             "group": "Body",
10604             "type": "String",
10605             "optional": true,
10606             "field": "thirdDisposition",
10607             "description": ""
10608           },
10609           {
10610             "group": "Body",
10611             "type": "String",
10612             "optional": true,
10613             "field": "note",
10614             "description": ""
10615           },
10616           {
10617             "group": "Body",
10618             "type": "String",
10619             "optional": true,
10620             "field": "read1stAt",
10621             "description": ""
10622           },
10623           {
10624             "group": "Body",
10625             "type": "String",
10626             "optional": true,
10627             "field": "fax",
10628             "description": ""
10629           },
10630           {
10631             "group": "Body",
10632             "type": "String",
10633             "allowedValues": [
10634               "\"in\"",
10635               "\"out\""
10636             ],
10637             "optional": false,
10638             "field": "firstMsgDirection",
10639             "description": ""
10640           },
10641           {
10642             "group": "Body",
10643             "type": "String",
10644             "optional": true,
10645             "field": "lastMsgAt",
10646             "description": ""
10647           },
10648           {
10649             "group": "Body",
10650             "type": "String",
10651             "allowedValues": [
10652               "\"in\"",
10653               "\"out\""
10654             ],
10655             "optional": false,
10656             "field": "lastMsgDirection",
10657             "description": ""
10658           }
10659         ]
10660       }
10661     },
10662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10663     "version": "0.0.0",
10664     "filename": "server/api/faxInteraction/index.js",
10665     "groupTitle": "Fax_Interactions"
10666   },
10667   {
10668     "type": "delete",
10669     "url": "/api/fax/interactions/{id}",
10670     "title": "Deletes a Interaction",
10671     "examples": [
10672       {
10673         "title": "Example usage:",
10674         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10675         "type": "json"
10676       }
10677     ],
10678     "name": "DeleteInteractions",
10679     "group": "Fax_Interactions",
10680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10681     "version": "0.0.0",
10682     "filename": "server/api/faxInteraction/index.js",
10683     "groupTitle": "Fax_Interactions"
10684   },
10685   {
10686     "type": "get",
10687     "url": "/api/fax/interactions/describe",
10688     "title": "Gets table info about Interactions",
10689     "examples": [
10690       {
10691         "title": "Example usage:",
10692         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10693         "type": "json"
10694       }
10695     ],
10696     "name": "DescribeInteractions",
10697     "group": "Fax_Interactions",
10698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10699     "version": "0.0.0",
10700     "filename": "server/api/faxInteraction/index.js",
10701     "groupTitle": "Fax_Interactions"
10702   },
10703   {
10704     "type": "get",
10705     "url": "/api/fax/interactions",
10706     "title": "Gets a list of Interactions",
10707     "examples": [
10708       {
10709         "title": "Example usage:",
10710         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10711         "type": "json"
10712       }
10713     ],
10714     "name": "GetInteractions",
10715     "group": "Fax_Interactions",
10716     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10717     "version": "0.0.0",
10718     "filename": "server/api/faxInteraction/index.js",
10719     "groupTitle": "Fax_Interactions"
10720   },
10721   {
10722     "type": "delete",
10723     "url": "/api/fax/interactions/{id}/tags",
10724     "title": "Removes tags from interaction",
10725     "examples": [
10726       {
10727         "title": "Example usage:",
10728         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10729         "type": "json"
10730       }
10731     ],
10732     "name": "RemoveTags",
10733     "group": "Fax_Interactions",
10734     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10735     "version": "0.0.0",
10736     "filename": "server/api/faxInteraction/index.js",
10737     "groupTitle": "Fax_Interactions"
10738   },
10739   {
10740     "type": "get",
10741     "url": "/api/fax/interactions/{id}",
10742     "title": "Gets a single Interaction",
10743     "examples": [
10744       {
10745         "title": "Example usage:",
10746         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10747         "type": "json"
10748       }
10749     ],
10750     "name": "ShowInteractions",
10751     "group": "Fax_Interactions",
10752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10753     "version": "0.0.0",
10754     "filename": "server/api/faxInteraction/index.js",
10755     "groupTitle": "Fax_Interactions"
10756   },
10757   {
10758     "type": "post",
10759     "url": "/api/fax/interactions/{id}/messages",
10760     "title": "Creates new messages",
10761     "examples": [
10762       {
10763         "title": "Example usage:",
10764         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10765         "type": "json"
10766       }
10767     ],
10768     "name": "addMessage",
10769     "group": "Fax_Interactions",
10770     "parameter": {
10771       "fields": {
10772         "Body": [
10773           {
10774             "group": "Body",
10775             "type": "Text",
10776             "optional": false,
10777             "field": "body",
10778             "description": ""
10779           },
10780           {
10781             "group": "Body",
10782             "type": "Boolean",
10783             "optional": true,
10784             "field": "read",
10785             "description": ""
10786           },
10787           {
10788             "group": "Body",
10789             "type": "String",
10790             "allowedValues": [
10791               "\"in\"",
10792               "\"out\""
10793             ],
10794             "optional": false,
10795             "field": "direction",
10796             "description": ""
10797           },
10798           {
10799             "group": "Body",
10800             "type": "Text",
10801             "optional": true,
10802             "field": "failMessage",
10803             "description": ""
10804           },
10805           {
10806             "group": "Body",
10807             "type": "String",
10808             "optional": true,
10809             "field": "readAt",
10810             "description": ""
10811           }
10812         ]
10813       }
10814     },
10815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10816     "version": "0.0.0",
10817     "filename": "server/api/faxInteraction/index.js",
10818     "groupTitle": "Fax_Interactions"
10819   },
10820   {
10821     "type": "get",
10822     "url": "/api/fax/interactions/{id}/download",
10823     "title": "Get interactions",
10824     "examples": [
10825       {
10826         "title": "Example usage:",
10827         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10828         "type": "json"
10829       }
10830     ],
10831     "name": "download",
10832     "group": "Fax_Interactions",
10833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10834     "version": "0.0.0",
10835     "filename": "server/api/faxInteraction/index.js",
10836     "groupTitle": "Fax_Interactions"
10837   },
10838   {
10839     "type": "get",
10840     "url": "/api/fax/interactions/{id}/messages",
10841     "title": "Gets interaction messages",
10842     "examples": [
10843       {
10844         "title": "Example usage:",
10845         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10846         "type": "json"
10847       }
10848     ],
10849     "name": "getMessages",
10850     "group": "Fax_Interactions",
10851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10852     "version": "0.0.0",
10853     "filename": "server/api/faxInteraction/index.js",
10854     "groupTitle": "Fax_Interactions"
10855   },
10856   {
10857     "type": "put",
10858     "url": "/api/fax/interactions/{id}",
10859     "title": "Update an existing Interaction",
10860     "examples": [
10861       {
10862         "title": "Example usage:",
10863         "content": "curl https://{domain}/api/fax/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10864         "type": "json"
10865       }
10866     ],
10867     "name": "updateInteractions",
10868     "group": "Fax_Interactions",
10869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10870     "version": "0.0.0",
10871     "filename": "server/api/faxInteraction/index.js",
10872     "groupTitle": "Fax_Interactions"
10873   },
10874   {
10875     "type": "get",
10876     "url": "/api/fax/messages/{id}/download",
10877     "title": "Get message",
10878     "examples": [
10879       {
10880         "title": "Example usage:",
10881         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10882         "type": "json"
10883       }
10884     ],
10885     "name": "download",
10886     "group": "Fax_Message",
10887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10888     "version": "0.0.0",
10889     "filename": "server/api/faxMessage/index.js",
10890     "groupTitle": "Fax_Message"
10891   },
10892   {
10893     "type": "delete",
10894     "url": "/api/fax/messages/{id}",
10895     "title": "Deletes a Message",
10896     "examples": [
10897       {
10898         "title": "Example usage:",
10899         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10900         "type": "json"
10901       }
10902     ],
10903     "name": "DeleteMessages",
10904     "group": "Fax_Messages",
10905     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10906     "version": "0.0.0",
10907     "filename": "server/api/faxMessage/index.js",
10908     "groupTitle": "Fax_Messages"
10909   },
10910   {
10911     "type": "get",
10912     "url": "/api/fax/messages/describe",
10913     "title": "Gets table info about Messages",
10914     "examples": [
10915       {
10916         "title": "Example usage:",
10917         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10918         "type": "json"
10919       }
10920     ],
10921     "name": "DescribeMessages",
10922     "group": "Fax_Messages",
10923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10924     "version": "0.0.0",
10925     "filename": "server/api/faxMessage/index.js",
10926     "groupTitle": "Fax_Messages"
10927   },
10928   {
10929     "type": "get",
10930     "url": "/api/fax/messages",
10931     "title": "Gets a list of Messages",
10932     "examples": [
10933       {
10934         "title": "Example usage:",
10935         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10936         "type": "json"
10937       }
10938     ],
10939     "name": "GetMessages",
10940     "group": "Fax_Messages",
10941     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10942     "version": "0.0.0",
10943     "filename": "server/api/faxMessage/index.js",
10944     "groupTitle": "Fax_Messages"
10945   },
10946   {
10947     "type": "get",
10948     "url": "/api/fax/messages/{id}",
10949     "title": "Gets a single Message",
10950     "examples": [
10951       {
10952         "title": "Example usage:",
10953         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10954         "type": "json"
10955       }
10956     ],
10957     "name": "ShowMessages",
10958     "group": "Fax_Messages",
10959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10960     "version": "0.0.0",
10961     "filename": "server/api/faxMessage/index.js",
10962     "groupTitle": "Fax_Messages"
10963   },
10964   {
10965     "type": "put",
10966     "url": "/api/fax/messages/{id}/accept",
10967     "title": "Accepts message",
10968     "examples": [
10969       {
10970         "title": "Example usage:",
10971         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10972         "type": "json"
10973       }
10974     ],
10975     "name": "acceptMessage",
10976     "group": "Fax_Messages",
10977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10978     "version": "0.0.0",
10979     "filename": "server/api/faxMessage/index.js",
10980     "groupTitle": "Fax_Messages"
10981   },
10982   {
10983     "type": "put",
10984     "url": "/api/fax/messages/{id}/reject",
10985     "title": "Rejects message",
10986     "examples": [
10987       {
10988         "title": "Example usage:",
10989         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10990         "type": "json"
10991       }
10992     ],
10993     "name": "rejectMessage",
10994     "group": "Fax_Messages",
10995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10996     "version": "0.0.0",
10997     "filename": "server/api/faxMessage/index.js",
10998     "groupTitle": "Fax_Messages"
10999   },
11000   {
11001     "type": "post",
11002     "url": "/api/fax/messages",
11003     "title": "Create message and send Fax",
11004     "examples": [
11005       {
11006         "title": "Example usage:",
11007         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11008         "type": "json"
11009       }
11010     ],
11011     "name": "rejectMessage",
11012     "group": "Fax_Messages",
11013     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11014     "version": "0.0.0",
11015     "filename": "server/api/faxMessage/index.js",
11016     "groupTitle": "Fax_Messages"
11017   },
11018   {
11019     "type": "put",
11020     "url": "/api/fax/messages/{id}",
11021     "title": "Update an existing Message",
11022     "examples": [
11023       {
11024         "title": "Example usage:",
11025         "content": "curl https://{domain}/api/fax/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11026         "type": "json"
11027       }
11028     ],
11029     "name": "updateMessages",
11030     "group": "Fax_Messages",
11031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11032     "version": "0.0.0",
11033     "filename": "server/api/faxMessage/index.js",
11034     "groupTitle": "Fax_Messages"
11035   },
11036   {
11037     "type": "post",
11038     "url": "/api/fax/reports/queue",
11039     "title": "Creates a new Fax Queue Report",
11040     "examples": [
11041       {
11042         "title": "Example usage:",
11043         "content": "curl https://{domain}/api/fax/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11044         "type": "json"
11045       }
11046     ],
11047     "name": "CreateFax_Queue_Reports",
11048     "group": "Fax_Queue_Reports",
11049     "parameter": {
11050       "fields": {
11051         "Body": [
11052           {
11053             "group": "Body",
11054             "type": "String",
11055             "optional": false,
11056             "field": "uniqueid",
11057             "description": ""
11058           },
11059           {
11060             "group": "Body",
11061             "type": "String",
11062             "optional": true,
11063             "field": "from",
11064             "description": ""
11065           },
11066           {
11067             "group": "Body",
11068             "type": "String",
11069             "optional": true,
11070             "field": "joinAt",
11071             "description": ""
11072           },
11073           {
11074             "group": "Body",
11075             "type": "String",
11076             "optional": true,
11077             "field": "leaveAt",
11078             "description": ""
11079           },
11080           {
11081             "group": "Body",
11082             "type": "String",
11083             "optional": true,
11084             "field": "acceptAt",
11085             "description": ""
11086           },
11087           {
11088             "group": "Body",
11089             "type": "String",
11090             "optional": true,
11091             "field": "exitAt",
11092             "description": ""
11093           },
11094           {
11095             "group": "Body",
11096             "type": "String",
11097             "optional": true,
11098             "field": "reason",
11099             "description": ""
11100           }
11101         ]
11102       }
11103     },
11104     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11105     "version": "0.0.0",
11106     "filename": "server/api/faxQueueReport/index.js",
11107     "groupTitle": "Fax_Queue_Reports"
11108   },
11109   {
11110     "type": "delete",
11111     "url": "/api/fax/reports/queue/{id}",
11112     "title": "Deletes a Fax Queue Report",
11113     "examples": [
11114       {
11115         "title": "Example usage:",
11116         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11117         "type": "json"
11118       }
11119     ],
11120     "name": "DeleteFax_Queue_Reports",
11121     "group": "Fax_Queue_Reports",
11122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11123     "version": "0.0.0",
11124     "filename": "server/api/faxQueueReport/index.js",
11125     "groupTitle": "Fax_Queue_Reports"
11126   },
11127   {
11128     "type": "get",
11129     "url": "/api/fax/reports/queue/describe",
11130     "title": "Gets table info about Fax Queue Reports",
11131     "examples": [
11132       {
11133         "title": "Example usage:",
11134         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11135         "type": "json"
11136       }
11137     ],
11138     "name": "DescribeFax_Queue_Reports",
11139     "group": "Fax_Queue_Reports",
11140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11141     "version": "0.0.0",
11142     "filename": "server/api/faxQueueReport/index.js",
11143     "groupTitle": "Fax_Queue_Reports"
11144   },
11145   {
11146     "type": "get",
11147     "url": "/api/fax/reports/queue",
11148     "title": "Gets a list of Fax Queue Reports",
11149     "examples": [
11150       {
11151         "title": "Example usage:",
11152         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11153         "type": "json"
11154       }
11155     ],
11156     "name": "GetFax_Queue_Reports",
11157     "group": "Fax_Queue_Reports",
11158     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11159     "version": "0.0.0",
11160     "filename": "server/api/faxQueueReport/index.js",
11161     "groupTitle": "Fax_Queue_Reports"
11162   },
11163   {
11164     "type": "get",
11165     "url": "/api/fax/reports/queue/{id}",
11166     "title": "Gets a single Fax Queue Report",
11167     "examples": [
11168       {
11169         "title": "Example usage:",
11170         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11171         "type": "json"
11172       }
11173     ],
11174     "name": "ShowFax_Queue_Reports",
11175     "group": "Fax_Queue_Reports",
11176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11177     "version": "0.0.0",
11178     "filename": "server/api/faxQueueReport/index.js",
11179     "groupTitle": "Fax_Queue_Reports"
11180   },
11181   {
11182     "type": "put",
11183     "url": "/api/fax/reports/queue/{id}",
11184     "title": "Update an existing Fax Queue Report",
11185     "examples": [
11186       {
11187         "title": "Example usage:",
11188         "content": "curl https://{domain}/api/fax/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11189         "type": "json"
11190       }
11191     ],
11192     "name": "updateFax_Queue_Reports",
11193     "group": "Fax_Queue_Reports",
11194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11195     "version": "0.0.0",
11196     "filename": "server/api/faxQueueReport/index.js",
11197     "groupTitle": "Fax_Queue_Reports"
11198   },
11199   {
11200     "type": "post",
11201     "url": "/api/fax/queues/{id}/users",
11202     "title": "Add agents to a queue",
11203     "examples": [
11204       {
11205         "title": "Example usage:",
11206         "content": "curl https://{domain}/api/fax/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11207         "type": "json"
11208       }
11209     ],
11210     "name": "AddAgents",
11211     "group": "Fax_Queues",
11212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11213     "version": "0.0.0",
11214     "filename": "server/api/faxQueue/index.js",
11215     "groupTitle": "Fax_Queues"
11216   },
11217   {
11218     "type": "post",
11219     "url": "/api/fax/queues/{id}/teams",
11220     "title": "Add teams to a queue",
11221     "examples": [
11222       {
11223         "title": "Example usage:",
11224         "content": "curl https://{domain}/api/fax/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11225         "type": "json"
11226       }
11227     ],
11228     "name": "AddTeams",
11229     "group": "Fax_Queues",
11230     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11231     "version": "0.0.0",
11232     "filename": "server/api/faxQueue/index.js",
11233     "groupTitle": "Fax_Queues"
11234   },
11235   {
11236     "type": "post",
11237     "url": "/api/fax/queues",
11238     "title": "Creates a new Queue",
11239     "examples": [
11240       {
11241         "title": "Example usage:",
11242         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11243         "type": "json"
11244       }
11245     ],
11246     "name": "CreateQueues",
11247     "group": "Fax_Queues",
11248     "parameter": {
11249       "fields": {
11250         "Body": [
11251           {
11252             "group": "Body",
11253             "type": "String",
11254             "optional": false,
11255             "field": "name",
11256             "description": ""
11257           },
11258           {
11259             "group": "Body",
11260             "type": "String",
11261             "optional": true,
11262             "field": "description",
11263             "description": ""
11264           },
11265           {
11266             "group": "Body",
11267             "type": "Integer",
11268             "optional": false,
11269             "field": "timeout",
11270             "description": ""
11271           },
11272           {
11273             "group": "Body",
11274             "type": "String",
11275             "allowedValues": [
11276               "\"rrmemory\"",
11277               "\"beepall\"",
11278               "\"roundrobin\""
11279             ],
11280             "optional": false,
11281             "field": "strategy",
11282             "description": ""
11283           },
11284           {
11285             "group": "Body",
11286             "type": "Integer",
11287             "optional": true,
11288             "field": "lastAgent",
11289             "description": ""
11290           }
11291         ]
11292       }
11293     },
11294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11295     "version": "0.0.0",
11296     "filename": "server/api/faxQueue/index.js",
11297     "groupTitle": "Fax_Queues"
11298   },
11299   {
11300     "type": "delete",
11301     "url": "/api/fax/queues/{id}",
11302     "title": "Deletes a Queue",
11303     "examples": [
11304       {
11305         "title": "Example usage:",
11306         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11307         "type": "json"
11308       }
11309     ],
11310     "name": "DeleteQueues",
11311     "group": "Fax_Queues",
11312     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11313     "version": "0.0.0",
11314     "filename": "server/api/faxQueue/index.js",
11315     "groupTitle": "Fax_Queues"
11316   },
11317   {
11318     "type": "get",
11319     "url": "/api/fax/queues/describe",
11320     "title": "Gets table info about Queues",
11321     "examples": [
11322       {
11323         "title": "Example usage:",
11324         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11325         "type": "json"
11326       }
11327     ],
11328     "name": "DescribeQueues",
11329     "group": "Fax_Queues",
11330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11331     "version": "0.0.0",
11332     "filename": "server/api/faxQueue/index.js",
11333     "groupTitle": "Fax_Queues"
11334   },
11335   {
11336     "type": "get",
11337     "url": "/api/fax/queues/{id}/users",
11338     "title": "Gets queue agents",
11339     "examples": [
11340       {
11341         "title": "Example usage:",
11342         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11343         "type": "json"
11344       }
11345     ],
11346     "name": "GetAgents",
11347     "group": "Fax_Queues",
11348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11349     "version": "0.0.0",
11350     "filename": "server/api/faxQueue/index.js",
11351     "groupTitle": "Fax_Queues"
11352   },
11353   {
11354     "type": "get",
11355     "url": "/api/fax/queues/{id}/members",
11356     "title": "GetMembers",
11357     "examples": [
11358       {
11359         "title": "Example usage:",
11360         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11361         "type": "json"
11362       }
11363     ],
11364     "name": "GetMembers",
11365     "group": "Fax_Queues",
11366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11367     "version": "0.0.0",
11368     "filename": "server/api/faxQueue/index.js",
11369     "groupTitle": "Fax_Queues"
11370   },
11371   {
11372     "type": "get",
11373     "url": "/api/fax/queues",
11374     "title": "Gets a list of Queues",
11375     "examples": [
11376       {
11377         "title": "Example usage:",
11378         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11379         "type": "json"
11380       }
11381     ],
11382     "name": "GetQueues",
11383     "group": "Fax_Queues",
11384     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11385     "version": "0.0.0",
11386     "filename": "server/api/faxQueue/index.js",
11387     "groupTitle": "Fax_Queues"
11388   },
11389   {
11390     "type": "get",
11391     "url": "/api/fax/queues/{id}/teams",
11392     "title": "Gets queues list",
11393     "examples": [
11394       {
11395         "title": "Example usage:",
11396         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11397         "type": "json"
11398       }
11399     ],
11400     "name": "GetTeams",
11401     "group": "Fax_Queues",
11402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11403     "version": "0.0.0",
11404     "filename": "server/api/faxQueue/index.js",
11405     "groupTitle": "Fax_Queues"
11406   },
11407   {
11408     "type": "delete",
11409     "url": "/api/fax/queues/{id}/users",
11410     "title": "Removes agents from a queue",
11411     "examples": [
11412       {
11413         "title": "Example usage:",
11414         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11415         "type": "json"
11416       }
11417     ],
11418     "name": "RemoveAgents",
11419     "group": "Fax_Queues",
11420     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11421     "version": "0.0.0",
11422     "filename": "server/api/faxQueue/index.js",
11423     "groupTitle": "Fax_Queues"
11424   },
11425   {
11426     "type": "get",
11427     "url": "/api/fax/queues/{id}",
11428     "title": "Gets a single Queue",
11429     "examples": [
11430       {
11431         "title": "Example usage:",
11432         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11433         "type": "json"
11434       }
11435     ],
11436     "name": "ShowQueues",
11437     "group": "Fax_Queues",
11438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11439     "version": "0.0.0",
11440     "filename": "server/api/faxQueue/index.js",
11441     "groupTitle": "Fax_Queues"
11442   },
11443   {
11444     "type": "put",
11445     "url": "/api/fax/queues/{id}",
11446     "title": "Update an existing Queue",
11447     "examples": [
11448       {
11449         "title": "Example usage:",
11450         "content": "curl https://{domain}/api/fax/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11451         "type": "json"
11452       }
11453     ],
11454     "name": "updateQueues",
11455     "group": "Fax_Queues",
11456     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11457     "version": "0.0.0",
11458     "filename": "server/api/faxQueue/index.js",
11459     "groupTitle": "Fax_Queues"
11460   },
11461   {
11462     "type": "post",
11463     "url": "/api/fax/reports/transfer",
11464     "title": "Creates a new Fax Transfer Report",
11465     "examples": [
11466       {
11467         "title": "Example usage:",
11468         "content": "curl https://{domain}/api/fax/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11469         "type": "json"
11470       }
11471     ],
11472     "name": "CreateFax_Transfer_Reports",
11473     "group": "Fax_Transfer_Reports",
11474     "parameter": {
11475       "fields": {
11476         "Body": [
11477           {
11478             "group": "Body",
11479             "type": "String",
11480             "optional": false,
11481             "field": "uniqueid",
11482             "description": ""
11483           },
11484           {
11485             "group": "Body",
11486             "type": "String",
11487             "allowedValues": [
11488               "\"account\"",
11489               "\"agent\"",
11490               "\"queue\""
11491             ],
11492             "optional": false,
11493             "field": "type",
11494             "description": ""
11495           },
11496           {
11497             "group": "Body",
11498             "type": "String",
11499             "optional": false,
11500             "field": "transferredAt",
11501             "description": ""
11502           }
11503         ]
11504       }
11505     },
11506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11507     "version": "0.0.0",
11508     "filename": "server/api/faxTransferReport/index.js",
11509     "groupTitle": "Fax_Transfer_Reports"
11510   },
11511   {
11512     "type": "delete",
11513     "url": "/api/fax/reports/transfer/{id}",
11514     "title": "Deletes a Fax Transfer Report",
11515     "examples": [
11516       {
11517         "title": "Example usage:",
11518         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11519         "type": "json"
11520       }
11521     ],
11522     "name": "DeleteFax_Transfer_Reports",
11523     "group": "Fax_Transfer_Reports",
11524     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11525     "version": "0.0.0",
11526     "filename": "server/api/faxTransferReport/index.js",
11527     "groupTitle": "Fax_Transfer_Reports"
11528   },
11529   {
11530     "type": "get",
11531     "url": "/api/fax/reports/transfer/describe",
11532     "title": "Gets table info about Fax Transfer Reports",
11533     "examples": [
11534       {
11535         "title": "Example usage:",
11536         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11537         "type": "json"
11538       }
11539     ],
11540     "name": "DescribeFax_Transfer_Reports",
11541     "group": "Fax_Transfer_Reports",
11542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11543     "version": "0.0.0",
11544     "filename": "server/api/faxTransferReport/index.js",
11545     "groupTitle": "Fax_Transfer_Reports"
11546   },
11547   {
11548     "type": "get",
11549     "url": "/api/fax/reports/transfer",
11550     "title": "Gets a list of Fax Transfer Reports",
11551     "examples": [
11552       {
11553         "title": "Example usage:",
11554         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11555         "type": "json"
11556       }
11557     ],
11558     "name": "GetFax_Transfer_Reports",
11559     "group": "Fax_Transfer_Reports",
11560     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11561     "version": "0.0.0",
11562     "filename": "server/api/faxTransferReport/index.js",
11563     "groupTitle": "Fax_Transfer_Reports"
11564   },
11565   {
11566     "type": "get",
11567     "url": "/api/fax/reports/transfer/{id}",
11568     "title": "Gets a single Fax Transfer Report",
11569     "examples": [
11570       {
11571         "title": "Example usage:",
11572         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11573         "type": "json"
11574       }
11575     ],
11576     "name": "ShowFax_Transfer_Reports",
11577     "group": "Fax_Transfer_Reports",
11578     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11579     "version": "0.0.0",
11580     "filename": "server/api/faxTransferReport/index.js",
11581     "groupTitle": "Fax_Transfer_Reports"
11582   },
11583   {
11584     "type": "put",
11585     "url": "/api/fax/reports/transfer/{id}",
11586     "title": "Update an existing Fax Transfer Report",
11587     "examples": [
11588       {
11589         "title": "Example usage:",
11590         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11591         "type": "json"
11592       }
11593     ],
11594     "name": "updateFax_Transfer_Reports",
11595     "group": "Fax_Transfer_Reports",
11596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11597     "version": "0.0.0",
11598     "filename": "server/api/faxTransferReport/index.js",
11599     "groupTitle": "Fax_Transfer_Reports"
11600   },
11601   {
11602     "type": "post",
11603     "url": "/api/integrations/freshdesk/accounts",
11604     "title": "Creates a new Freshdesk Account",
11605     "examples": [
11606       {
11607         "title": "Example usage:",
11608         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11609         "type": "json"
11610       }
11611     ],
11612     "name": "CreateFreshdesk_Accounts",
11613     "group": "Freshdesk_Accounts",
11614     "parameter": {
11615       "fields": {
11616         "Body": [
11617           {
11618             "group": "Body",
11619             "type": "String",
11620             "optional": true,
11621             "field": "name",
11622             "description": ""
11623           },
11624           {
11625             "group": "Body",
11626             "type": "String",
11627             "optional": true,
11628             "field": "description",
11629             "description": ""
11630           },
11631           {
11632             "group": "Body",
11633             "type": "String",
11634             "optional": true,
11635             "field": "username",
11636             "description": ""
11637           },
11638           {
11639             "group": "Body",
11640             "type": "String",
11641             "optional": true,
11642             "field": "apiKey",
11643             "description": ""
11644           },
11645           {
11646             "group": "Body",
11647             "type": "String",
11648             "optional": true,
11649             "field": "remoteUri",
11650             "description": ""
11651           },
11652           {
11653             "group": "Body",
11654             "type": "String",
11655             "optional": false,
11656             "field": "serverUrl",
11657             "description": ""
11658           }
11659         ]
11660       }
11661     },
11662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11663     "version": "0.0.0",
11664     "filename": "server/api/intFreshdeskAccount/index.js",
11665     "groupTitle": "Freshdesk_Accounts"
11666   },
11667   {
11668     "type": "delete",
11669     "url": "/api/integrations/freshdesk/accounts/{id}",
11670     "title": "Deletes a Freshdesk Account",
11671     "examples": [
11672       {
11673         "title": "Example usage:",
11674         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11675         "type": "json"
11676       }
11677     ],
11678     "name": "DeleteFreshdesk_Accounts",
11679     "group": "Freshdesk_Accounts",
11680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11681     "version": "0.0.0",
11682     "filename": "server/api/intFreshdeskAccount/index.js",
11683     "groupTitle": "Freshdesk_Accounts"
11684   },
11685   {
11686     "type": "get",
11687     "url": "/api/integrations/freshdesk/accounts",
11688     "title": "Gets a list of Freshdesk Accounts",
11689     "examples": [
11690       {
11691         "title": "Example usage:",
11692         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11693         "type": "json"
11694       }
11695     ],
11696     "name": "GetFreshdesk_Accounts",
11697     "group": "Freshdesk_Accounts",
11698     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11699     "version": "0.0.0",
11700     "filename": "server/api/intFreshdeskAccount/index.js",
11701     "groupTitle": "Freshdesk_Accounts"
11702   },
11703   {
11704     "type": "get",
11705     "url": "/api/integrations/freshdesk/accounts/{id}",
11706     "title": "Gets a single Freshdesk Account",
11707     "examples": [
11708       {
11709         "title": "Example usage:",
11710         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11711         "type": "json"
11712       }
11713     ],
11714     "name": "ShowFreshdesk_Accounts",
11715     "group": "Freshdesk_Accounts",
11716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11717     "version": "0.0.0",
11718     "filename": "server/api/intFreshdeskAccount/index.js",
11719     "groupTitle": "Freshdesk_Accounts"
11720   },
11721   {
11722     "type": "post",
11723     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11724     "title": "Creates new configuration",
11725     "examples": [
11726       {
11727         "title": "Example usage:",
11728         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11729         "type": "json"
11730       }
11731     ],
11732     "name": "addConfiguration",
11733     "group": "Freshdesk_Accounts",
11734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11735     "version": "0.0.0",
11736     "filename": "server/api/intFreshdeskAccount/index.js",
11737     "groupTitle": "Freshdesk_Accounts"
11738   },
11739   {
11740     "type": "get",
11741     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11742     "title": "Gets account configurations",
11743     "examples": [
11744       {
11745         "title": "Example usage:",
11746         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11747         "type": "json"
11748       }
11749     ],
11750     "name": "getConfigurations",
11751     "group": "Freshdesk_Accounts",
11752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11753     "version": "0.0.0",
11754     "filename": "server/api/intFreshdeskAccount/index.js",
11755     "groupTitle": "Freshdesk_Accounts"
11756   },
11757   {
11758     "type": "get",
11759     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11760     "title": "Gets account fields",
11761     "examples": [
11762       {
11763         "title": "Example usage:",
11764         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11765         "type": "json"
11766       }
11767     ],
11768     "name": "getFields",
11769     "group": "Freshdesk_Accounts",
11770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11771     "version": "0.0.0",
11772     "filename": "server/api/intFreshdeskAccount/index.js",
11773     "groupTitle": "Freshdesk_Accounts"
11774   },
11775   {
11776     "type": "put",
11777     "url": "/api/integrations/freshdesk/accounts/{id}",
11778     "title": "Update an existing Freshdesk Account",
11779     "examples": [
11780       {
11781         "title": "Example usage:",
11782         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11783         "type": "json"
11784       }
11785     ],
11786     "name": "updateFreshdesk_Accounts",
11787     "group": "Freshdesk_Accounts",
11788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11789     "version": "0.0.0",
11790     "filename": "server/api/intFreshdeskAccount/index.js",
11791     "groupTitle": "Freshdesk_Accounts"
11792   },
11793   {
11794     "type": "post",
11795     "url": "/api/integrations/freshdesk/configurations",
11796     "title": "Creates a new Freshdesk Configuration",
11797     "examples": [
11798       {
11799         "title": "Example usage:",
11800         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11801         "type": "json"
11802       }
11803     ],
11804     "name": "CreateFreshdesk_Configurations",
11805     "group": "Freshdesk_Configurations",
11806     "parameter": {
11807       "fields": {
11808         "Body": [
11809           {
11810             "group": "Body",
11811             "type": "String",
11812             "optional": true,
11813             "field": "name",
11814             "description": ""
11815           },
11816           {
11817             "group": "Body",
11818             "type": "String",
11819             "optional": true,
11820             "field": "description",
11821             "description": ""
11822           }
11823         ]
11824       }
11825     },
11826     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11827     "version": "0.0.0",
11828     "filename": "server/api/intFreshdeskConfiguration/index.js",
11829     "groupTitle": "Freshdesk_Configurations"
11830   },
11831   {
11832     "type": "delete",
11833     "url": "/api/integrations/freshdesk/configurations/{id}",
11834     "title": "Deletes a Freshdesk Configuration",
11835     "examples": [
11836       {
11837         "title": "Example usage:",
11838         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11839         "type": "json"
11840       }
11841     ],
11842     "name": "DeleteFreshdesk_Configurations",
11843     "group": "Freshdesk_Configurations",
11844     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11845     "version": "0.0.0",
11846     "filename": "server/api/intFreshdeskConfiguration/index.js",
11847     "groupTitle": "Freshdesk_Configurations"
11848   },
11849   {
11850     "type": "get",
11851     "url": "/api/integrations/freshdesk/configurations",
11852     "title": "Gets a list of Freshdesk Configurations",
11853     "examples": [
11854       {
11855         "title": "Example usage:",
11856         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11857         "type": "json"
11858       }
11859     ],
11860     "name": "GetFreshdesk_Configurations",
11861     "group": "Freshdesk_Configurations",
11862     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11863     "version": "0.0.0",
11864     "filename": "server/api/intFreshdeskConfiguration/index.js",
11865     "groupTitle": "Freshdesk_Configurations"
11866   },
11867   {
11868     "type": "get",
11869     "url": "/api/integrations/freshdesk/configurations/{id}",
11870     "title": "Gets a single Freshdesk Configuration",
11871     "examples": [
11872       {
11873         "title": "Example usage:",
11874         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11875         "type": "json"
11876       }
11877     ],
11878     "name": "ShowFreshdesk_Configurations",
11879     "group": "Freshdesk_Configurations",
11880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11881     "version": "0.0.0",
11882     "filename": "server/api/intFreshdeskConfiguration/index.js",
11883     "groupTitle": "Freshdesk_Configurations"
11884   },
11885   {
11886     "type": "get",
11887     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11888     "title": "Gets configurations descriptions",
11889     "examples": [
11890       {
11891         "title": "Example usage:",
11892         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11893         "type": "json"
11894       }
11895     ],
11896     "name": "getDescriptions",
11897     "group": "Freshdesk_Configurations",
11898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11899     "version": "0.0.0",
11900     "filename": "server/api/intFreshdeskConfiguration/index.js",
11901     "groupTitle": "Freshdesk_Configurations"
11902   },
11903   {
11904     "type": "get",
11905     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11906     "title": "Gets configurations fields",
11907     "examples": [
11908       {
11909         "title": "Example usage:",
11910         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11911         "type": "json"
11912       }
11913     ],
11914     "name": "getFields",
11915     "group": "Freshdesk_Configurations",
11916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11917     "version": "0.0.0",
11918     "filename": "server/api/intFreshdeskConfiguration/index.js",
11919     "groupTitle": "Freshdesk_Configurations"
11920   },
11921   {
11922     "type": "get",
11923     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11924     "title": "Gets configurations subjects",
11925     "examples": [
11926       {
11927         "title": "Example usage:",
11928         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11929         "type": "json"
11930       }
11931     ],
11932     "name": "getSubjects",
11933     "group": "Freshdesk_Configurations",
11934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11935     "version": "0.0.0",
11936     "filename": "server/api/intFreshdeskConfiguration/index.js",
11937     "groupTitle": "Freshdesk_Configurations"
11938   },
11939   {
11940     "type": "get",
11941     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11942     "title": "Gets configurations tags",
11943     "examples": [
11944       {
11945         "title": "Example usage:",
11946         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11947         "type": "json"
11948       }
11949     ],
11950     "name": "getTags",
11951     "group": "Freshdesk_Configurations",
11952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11953     "version": "0.0.0",
11954     "filename": "server/api/intFreshdeskConfiguration/index.js",
11955     "groupTitle": "Freshdesk_Configurations"
11956   },
11957   {
11958     "type": "post",
11959     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11960     "title": "Sets new tags",
11961     "examples": [
11962       {
11963         "title": "Example usage:",
11964         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11965         "type": "json"
11966       }
11967     ],
11968     "name": "setTags",
11969     "group": "Freshdesk_Configurations",
11970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11971     "version": "0.0.0",
11972     "filename": "server/api/intFreshdeskConfiguration/index.js",
11973     "groupTitle": "Freshdesk_Configurations"
11974   },
11975   {
11976     "type": "put",
11977     "url": "/api/integrations/freshdesk/configurations/{id}",
11978     "title": "Update an existing Freshdesk Configuration",
11979     "examples": [
11980       {
11981         "title": "Example usage:",
11982         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11983         "type": "json"
11984       }
11985     ],
11986     "name": "updateFreshdesk_Configurations",
11987     "group": "Freshdesk_Configurations",
11988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11989     "version": "0.0.0",
11990     "filename": "server/api/intFreshdeskConfiguration/index.js",
11991     "groupTitle": "Freshdesk_Configurations"
11992   },
11993   {
11994     "type": "post",
11995     "url": "/api/integrations/freshdesk/fields",
11996     "title": "Creates a new Freshdesk Field",
11997     "examples": [
11998       {
11999         "title": "Example usage:",
12000         "content": "curl https://{domain}/api/integrations/freshdesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12001         "type": "json"
12002       }
12003     ],
12004     "name": "CreateFreshdesk_Fields",
12005     "group": "Freshdesk_Fields",
12006     "parameter": {
12007       "fields": {
12008         "Body": [
12009           {
12010             "group": "Body",
12011             "type": "String",
12012             "allowedValues": [
12013               "\"string\"",
12014               "\"variable\"",
12015               "\"customVariable\"",
12016               "\"keyValue\"",
12017               "\"picklist\""
12018             ],
12019             "optional": true,
12020             "field": "type",
12021             "description": ""
12022           },
12023           {
12024             "group": "Body",
12025             "type": "String",
12026             "optional": true,
12027             "field": "content",
12028             "description": ""
12029           },
12030           {
12031             "group": "Body",
12032             "type": "String",
12033             "optional": true,
12034             "field": "key",
12035             "description": ""
12036           },
12037           {
12038             "group": "Body",
12039             "type": "String",
12040             "allowedValues": [
12041               "\"string\"",
12042               "\"variable\"",
12043               "\"customVariable\""
12044             ],
12045             "optional": true,
12046             "field": "keyType",
12047             "description": ""
12048           },
12049           {
12050             "group": "Body",
12051             "type": "String",
12052             "optional": true,
12053             "field": "keyContent",
12054             "description": ""
12055           },
12056           {
12057             "group": "Body",
12058             "type": "String",
12059             "optional": true,
12060             "field": "idField",
12061             "description": ""
12062           },
12063           {
12064             "group": "Body",
12065             "type": "String",
12066             "optional": true,
12067             "field": "nameField",
12068             "description": ""
12069           },
12070           {
12071             "group": "Body",
12072             "type": "Boolean",
12073             "optional": true,
12074             "field": "customField",
12075             "description": ""
12076           },
12077           {
12078             "group": "Body",
12079             "type": "String",
12080             "optional": true,
12081             "field": "variableName",
12082             "description": ""
12083           }
12084         ]
12085       }
12086     },
12087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12088     "version": "0.0.0",
12089     "filename": "server/api/intFreshdeskField/index.js",
12090     "groupTitle": "Freshdesk_Fields"
12091   },
12092   {
12093     "type": "delete",
12094     "url": "/api/integrations/freshdesk/fields/{id}",
12095     "title": "Deletes a Freshdesk Field",
12096     "examples": [
12097       {
12098         "title": "Example usage:",
12099         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12100         "type": "json"
12101       }
12102     ],
12103     "name": "DeleteFreshdesk_Fields",
12104     "group": "Freshdesk_Fields",
12105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12106     "version": "0.0.0",
12107     "filename": "server/api/intFreshdeskField/index.js",
12108     "groupTitle": "Freshdesk_Fields"
12109   },
12110   {
12111     "type": "get",
12112     "url": "/api/integrations/freshdesk/fields",
12113     "title": "Gets a list of Freshdesk Fields",
12114     "examples": [
12115       {
12116         "title": "Example usage:",
12117         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12118         "type": "json"
12119       }
12120     ],
12121     "name": "GetFreshdesk_Fields",
12122     "group": "Freshdesk_Fields",
12123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12124     "version": "0.0.0",
12125     "filename": "server/api/intFreshdeskField/index.js",
12126     "groupTitle": "Freshdesk_Fields"
12127   },
12128   {
12129     "type": "get",
12130     "url": "/api/integrations/freshdesk/fields/{id}",
12131     "title": "Gets a single Freshdesk Field",
12132     "examples": [
12133       {
12134         "title": "Example usage:",
12135         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12136         "type": "json"
12137       }
12138     ],
12139     "name": "ShowFreshdesk_Fields",
12140     "group": "Freshdesk_Fields",
12141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12142     "version": "0.0.0",
12143     "filename": "server/api/intFreshdeskField/index.js",
12144     "groupTitle": "Freshdesk_Fields"
12145   },
12146   {
12147     "type": "put",
12148     "url": "/api/integrations/freshdesk/fields/{id}",
12149     "title": "Update an existing Freshdesk Field",
12150     "examples": [
12151       {
12152         "title": "Example usage:",
12153         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12154         "type": "json"
12155       }
12156     ],
12157     "name": "updateFreshdesk_Fields",
12158     "group": "Freshdesk_Fields",
12159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12160     "version": "0.0.0",
12161     "filename": "server/api/intFreshdeskField/index.js",
12162     "groupTitle": "Freshdesk_Fields"
12163   },
12164   {
12165     "type": "post",
12166     "url": "/api/integrations/freshsales/accounts",
12167     "title": "Creates a new Freshsales Account",
12168     "examples": [
12169       {
12170         "title": "Example usage:",
12171         "content": "curl https://{domain}/api/integrations/freshsales/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12172         "type": "json"
12173       }
12174     ],
12175     "name": "CreateFreshsales_Accounts",
12176     "group": "Freshsales_Accounts",
12177     "parameter": {
12178       "fields": {
12179         "Body": [
12180           {
12181             "group": "Body",
12182             "type": "String",
12183             "optional": true,
12184             "field": "name",
12185             "description": ""
12186           },
12187           {
12188             "group": "Body",
12189             "type": "String",
12190             "optional": true,
12191             "field": "description",
12192             "description": ""
12193           },
12194           {
12195             "group": "Body",
12196             "type": "String",
12197             "optional": true,
12198             "field": "username",
12199             "description": ""
12200           },
12201           {
12202             "group": "Body",
12203             "type": "String",
12204             "optional": true,
12205             "field": "apiKey",
12206             "description": ""
12207           },
12208           {
12209             "group": "Body",
12210             "type": "String",
12211             "optional": true,
12212             "field": "remoteUri",
12213             "description": ""
12214           },
12215           {
12216             "group": "Body",
12217             "type": "String",
12218             "optional": false,
12219             "field": "serverUrl",
12220             "description": ""
12221           }
12222         ]
12223       }
12224     },
12225     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12226     "version": "0.0.0",
12227     "filename": "server/api/intFreshsalesAccount/index.js",
12228     "groupTitle": "Freshsales_Accounts"
12229   },
12230   {
12231     "type": "delete",
12232     "url": "/api/integrations/freshsales/accounts/{id}",
12233     "title": "Deletes a Freshsales Account",
12234     "examples": [
12235       {
12236         "title": "Example usage:",
12237         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12238         "type": "json"
12239       }
12240     ],
12241     "name": "DeleteFreshsales_Accounts",
12242     "group": "Freshsales_Accounts",
12243     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12244     "version": "0.0.0",
12245     "filename": "server/api/intFreshsalesAccount/index.js",
12246     "groupTitle": "Freshsales_Accounts"
12247   },
12248   {
12249     "type": "get",
12250     "url": "/api/integrations/freshsales/accounts",
12251     "title": "Gets a list of Freshsales Accounts",
12252     "examples": [
12253       {
12254         "title": "Example usage:",
12255         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12256         "type": "json"
12257       }
12258     ],
12259     "name": "GetFreshsales_Accounts",
12260     "group": "Freshsales_Accounts",
12261     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12262     "version": "0.0.0",
12263     "filename": "server/api/intFreshsalesAccount/index.js",
12264     "groupTitle": "Freshsales_Accounts"
12265   },
12266   {
12267     "type": "get",
12268     "url": "/api/integrations/freshsales/accounts/{id}",
12269     "title": "Gets a single Freshsales Account",
12270     "examples": [
12271       {
12272         "title": "Example usage:",
12273         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12274         "type": "json"
12275       }
12276     ],
12277     "name": "ShowFreshsales_Accounts",
12278     "group": "Freshsales_Accounts",
12279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12280     "version": "0.0.0",
12281     "filename": "server/api/intFreshsalesAccount/index.js",
12282     "groupTitle": "Freshsales_Accounts"
12283   },
12284   {
12285     "type": "post",
12286     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12287     "title": "Creates new configuration",
12288     "examples": [
12289       {
12290         "title": "Example usage:",
12291         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12292         "type": "json"
12293       }
12294     ],
12295     "name": "addConfiguration",
12296     "group": "Freshsales_Accounts",
12297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12298     "version": "0.0.0",
12299     "filename": "server/api/intFreshsalesAccount/index.js",
12300     "groupTitle": "Freshsales_Accounts"
12301   },
12302   {
12303     "type": "get",
12304     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12305     "title": "Gets account configurations",
12306     "examples": [
12307       {
12308         "title": "Example usage:",
12309         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12310         "type": "json"
12311       }
12312     ],
12313     "name": "getConfigurations",
12314     "group": "Freshsales_Accounts",
12315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12316     "version": "0.0.0",
12317     "filename": "server/api/intFreshsalesAccount/index.js",
12318     "groupTitle": "Freshsales_Accounts"
12319   },
12320   {
12321     "type": "get",
12322     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12323     "title": "Gets account fields",
12324     "examples": [
12325       {
12326         "title": "Example usage:",
12327         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12328         "type": "json"
12329       }
12330     ],
12331     "name": "getFields",
12332     "group": "Freshsales_Accounts",
12333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12334     "version": "0.0.0",
12335     "filename": "server/api/intFreshsalesAccount/index.js",
12336     "groupTitle": "Freshsales_Accounts"
12337   },
12338   {
12339     "type": "put",
12340     "url": "/api/integrations/freshsales/accounts/{id}",
12341     "title": "Update an existing Freshsales Account",
12342     "examples": [
12343       {
12344         "title": "Example usage:",
12345         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12346         "type": "json"
12347       }
12348     ],
12349     "name": "updateFreshsales_Accounts",
12350     "group": "Freshsales_Accounts",
12351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12352     "version": "0.0.0",
12353     "filename": "server/api/intFreshsalesAccount/index.js",
12354     "groupTitle": "Freshsales_Accounts"
12355   },
12356   {
12357     "type": "post",
12358     "url": "/api/integrations/freshsales/configurations",
12359     "title": "Creates a new Freshsales Configuration",
12360     "examples": [
12361       {
12362         "title": "Example usage:",
12363         "content": "curl https://{domain}/api/integrations/freshsales/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12364         "type": "json"
12365       }
12366     ],
12367     "name": "CreateFreshsales_Configurations",
12368     "group": "Freshsales_Configurations",
12369     "parameter": {
12370       "fields": {
12371         "Body": [
12372           {
12373             "group": "Body",
12374             "type": "String",
12375             "optional": true,
12376             "field": "name",
12377             "description": ""
12378           },
12379           {
12380             "group": "Body",
12381             "type": "String",
12382             "optional": true,
12383             "field": "description",
12384             "description": ""
12385           }
12386         ]
12387       }
12388     },
12389     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12390     "version": "0.0.0",
12391     "filename": "server/api/intFreshsalesConfiguration/index.js",
12392     "groupTitle": "Freshsales_Configurations"
12393   },
12394   {
12395     "type": "delete",
12396     "url": "/api/integrations/freshsales/configurations/{id}",
12397     "title": "Deletes a Freshsales Configuration",
12398     "examples": [
12399       {
12400         "title": "Example usage:",
12401         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12402         "type": "json"
12403       }
12404     ],
12405     "name": "DeleteFreshsales_Configurations",
12406     "group": "Freshsales_Configurations",
12407     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12408     "version": "0.0.0",
12409     "filename": "server/api/intFreshsalesConfiguration/index.js",
12410     "groupTitle": "Freshsales_Configurations"
12411   },
12412   {
12413     "type": "get",
12414     "url": "/api/integrations/freshsales/configurations",
12415     "title": "Gets a list of Freshsales Configurations",
12416     "examples": [
12417       {
12418         "title": "Example usage:",
12419         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12420         "type": "json"
12421       }
12422     ],
12423     "name": "GetFreshsales_Configurations",
12424     "group": "Freshsales_Configurations",
12425     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12426     "version": "0.0.0",
12427     "filename": "server/api/intFreshsalesConfiguration/index.js",
12428     "groupTitle": "Freshsales_Configurations"
12429   },
12430   {
12431     "type": "get",
12432     "url": "/api/integrations/freshsales/configurations/{id}",
12433     "title": "Gets a single Freshsales Configuration",
12434     "examples": [
12435       {
12436         "title": "Example usage:",
12437         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12438         "type": "json"
12439       }
12440     ],
12441     "name": "ShowFreshsales_Configurations",
12442     "group": "Freshsales_Configurations",
12443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12444     "version": "0.0.0",
12445     "filename": "server/api/intFreshsalesConfiguration/index.js",
12446     "groupTitle": "Freshsales_Configurations"
12447   },
12448   {
12449     "type": "get",
12450     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12451     "title": "Gets configurations descriptions",
12452     "examples": [
12453       {
12454         "title": "Example usage:",
12455         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12456         "type": "json"
12457       }
12458     ],
12459     "name": "getDescriptions",
12460     "group": "Freshsales_Configurations",
12461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12462     "version": "0.0.0",
12463     "filename": "server/api/intFreshsalesConfiguration/index.js",
12464     "groupTitle": "Freshsales_Configurations"
12465   },
12466   {
12467     "type": "get",
12468     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12469     "title": "Gets configurations fields",
12470     "examples": [
12471       {
12472         "title": "Example usage:",
12473         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12474         "type": "json"
12475       }
12476     ],
12477     "name": "getFields",
12478     "group": "Freshsales_Configurations",
12479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12480     "version": "0.0.0",
12481     "filename": "server/api/intFreshsalesConfiguration/index.js",
12482     "groupTitle": "Freshsales_Configurations"
12483   },
12484   {
12485     "type": "get",
12486     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12487     "title": "Gets configurations subjects",
12488     "examples": [
12489       {
12490         "title": "Example usage:",
12491         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12492         "type": "json"
12493       }
12494     ],
12495     "name": "getSubjects",
12496     "group": "Freshsales_Configurations",
12497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12498     "version": "0.0.0",
12499     "filename": "server/api/intFreshsalesConfiguration/index.js",
12500     "groupTitle": "Freshsales_Configurations"
12501   },
12502   {
12503     "type": "put",
12504     "url": "/api/integrations/freshsales/configurations/{id}",
12505     "title": "Update an existing Freshsales Configuration",
12506     "examples": [
12507       {
12508         "title": "Example usage:",
12509         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12510         "type": "json"
12511       }
12512     ],
12513     "name": "updateFreshsales_Configurations",
12514     "group": "Freshsales_Configurations",
12515     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12516     "version": "0.0.0",
12517     "filename": "server/api/intFreshsalesConfiguration/index.js",
12518     "groupTitle": "Freshsales_Configurations"
12519   },
12520   {
12521     "type": "post",
12522     "url": "/api/integrations/freshsales/fields",
12523     "title": "Creates a new Freshsales Field",
12524     "examples": [
12525       {
12526         "title": "Example usage:",
12527         "content": "curl https://{domain}/api/integrations/freshsales/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12528         "type": "json"
12529       }
12530     ],
12531     "name": "CreateFreshsales_Fields",
12532     "group": "Freshsales_Fields",
12533     "parameter": {
12534       "fields": {
12535         "Body": [
12536           {
12537             "group": "Body",
12538             "type": "String",
12539             "allowedValues": [
12540               "\"string\"",
12541               "\"variable\"",
12542               "\"customVariable\"",
12543               "\"keyValue\"",
12544               "\"picklist\""
12545             ],
12546             "optional": true,
12547             "field": "type",
12548             "description": ""
12549           },
12550           {
12551             "group": "Body",
12552             "type": "String",
12553             "optional": true,
12554             "field": "content",
12555             "description": ""
12556           },
12557           {
12558             "group": "Body",
12559             "type": "String",
12560             "optional": true,
12561             "field": "key",
12562             "description": ""
12563           },
12564           {
12565             "group": "Body",
12566             "type": "String",
12567             "allowedValues": [
12568               "\"string\"",
12569               "\"variable\"",
12570               "\"customVariable\""
12571             ],
12572             "optional": true,
12573             "field": "keyType",
12574             "description": ""
12575           },
12576           {
12577             "group": "Body",
12578             "type": "String",
12579             "optional": true,
12580             "field": "keyContent",
12581             "description": ""
12582           },
12583           {
12584             "group": "Body",
12585             "type": "String",
12586             "optional": true,
12587             "field": "idField",
12588             "description": ""
12589           },
12590           {
12591             "group": "Body",
12592             "type": "String",
12593             "optional": true,
12594             "field": "nameField",
12595             "description": ""
12596           },
12597           {
12598             "group": "Body",
12599             "type": "Boolean",
12600             "optional": true,
12601             "field": "customField",
12602             "description": ""
12603           },
12604           {
12605             "group": "Body",
12606             "type": "String",
12607             "optional": true,
12608             "field": "variableName",
12609             "description": ""
12610           }
12611         ]
12612       }
12613     },
12614     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12615     "version": "0.0.0",
12616     "filename": "server/api/intFreshsalesField/index.js",
12617     "groupTitle": "Freshsales_Fields"
12618   },
12619   {
12620     "type": "delete",
12621     "url": "/api/integrations/freshsales/fields/{id}",
12622     "title": "Deletes a Freshsales Field",
12623     "examples": [
12624       {
12625         "title": "Example usage:",
12626         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12627         "type": "json"
12628       }
12629     ],
12630     "name": "DeleteFreshsales_Fields",
12631     "group": "Freshsales_Fields",
12632     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12633     "version": "0.0.0",
12634     "filename": "server/api/intFreshsalesField/index.js",
12635     "groupTitle": "Freshsales_Fields"
12636   },
12637   {
12638     "type": "get",
12639     "url": "/api/integrations/freshsales/fields",
12640     "title": "Gets a list of Freshsales Fields",
12641     "examples": [
12642       {
12643         "title": "Example usage:",
12644         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12645         "type": "json"
12646       }
12647     ],
12648     "name": "GetFreshsales_Fields",
12649     "group": "Freshsales_Fields",
12650     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12651     "version": "0.0.0",
12652     "filename": "server/api/intFreshsalesField/index.js",
12653     "groupTitle": "Freshsales_Fields"
12654   },
12655   {
12656     "type": "get",
12657     "url": "/api/integrations/freshsales/fields/{id}",
12658     "title": "Gets a single Freshsales Field",
12659     "examples": [
12660       {
12661         "title": "Example usage:",
12662         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12663         "type": "json"
12664       }
12665     ],
12666     "name": "ShowFreshsales_Fields",
12667     "group": "Freshsales_Fields",
12668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12669     "version": "0.0.0",
12670     "filename": "server/api/intFreshsalesField/index.js",
12671     "groupTitle": "Freshsales_Fields"
12672   },
12673   {
12674     "type": "put",
12675     "url": "/api/integrations/freshsales/fields/{id}",
12676     "title": "Update an existing Freshsales Field",
12677     "examples": [
12678       {
12679         "title": "Example usage:",
12680         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12681         "type": "json"
12682       }
12683     ],
12684     "name": "updateFreshsales_Fields",
12685     "group": "Freshsales_Fields",
12686     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12687     "version": "0.0.0",
12688     "filename": "server/api/intFreshsalesField/index.js",
12689     "groupTitle": "Freshsales_Fields"
12690   },
12691   {
12692     "type": "post",
12693     "url": "/api/campaigns/{id}/blacklists",
12694     "title": "Add blacklists to an IVR campaign",
12695     "examples": [
12696       {
12697         "title": "Example usage:",
12698         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12699         "type": "json"
12700       }
12701     ],
12702     "name": "AddBlackLists",
12703     "group": "IVR_Campaigns",
12704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12705     "version": "0.0.0",
12706     "filename": "server/api/campaign/index.js",
12707     "groupTitle": "IVR_Campaigns"
12708   },
12709   {
12710     "type": "post",
12711     "url": "/api/campaigns/{id}/lists",
12712     "title": "Add lists to an IVR campaign",
12713     "examples": [
12714       {
12715         "title": "Example usage:",
12716         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12717         "type": "json"
12718       }
12719     ],
12720     "name": "AddLists",
12721     "group": "IVR_Campaigns",
12722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12723     "version": "0.0.0",
12724     "filename": "server/api/campaign/index.js",
12725     "groupTitle": "IVR_Campaigns"
12726   },
12727   {
12728     "type": "post",
12729     "url": "/api/campaigns/clone",
12730     "title": "Clone an existing IVR Campaign",
12731     "examples": [
12732       {
12733         "title": "Example usage:",
12734         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12735         "type": "json"
12736       }
12737     ],
12738     "name": "CloneIVR_Campaigns",
12739     "group": "IVR_Campaigns",
12740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12741     "version": "0.0.0",
12742     "filename": "server/api/campaign/index.js",
12743     "groupTitle": "IVR_Campaigns"
12744   },
12745   {
12746     "type": "post",
12747     "url": "/api/campaigns",
12748     "title": "Creates a new IVR Campaign",
12749     "examples": [
12750       {
12751         "title": "Example usage:",
12752         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12753         "type": "json"
12754       }
12755     ],
12756     "name": "CreateIVR_Campaigns",
12757     "group": "IVR_Campaigns",
12758     "parameter": {
12759       "fields": {
12760         "Body": [
12761           {
12762             "group": "Body",
12763             "type": "String",
12764             "optional": false,
12765             "field": "name",
12766             "description": ""
12767           },
12768           {
12769             "group": "Body",
12770             "type": "String",
12771             "allowedValues": [
12772               "\"ivr\""
12773             ],
12774             "optional": false,
12775             "field": "type",
12776             "description": ""
12777           },
12778           {
12779             "group": "Body",
12780             "type": "String",
12781             "optional": true,
12782             "field": "description",
12783             "description": ""
12784           },
12785           {
12786             "group": "Body",
12787             "type": "Boolean",
12788             "optional": true,
12789             "field": "active",
12790             "description": "<p>Active/Disactive Campaign</p>"
12791           },
12792           {
12793             "group": "Body",
12794             "type": "Integer",
12795             "optional": true,
12796             "field": "limitCalls",
12797             "description": "<p>Max 200 calls.</p>"
12798           },
12799           {
12800             "group": "Body",
12801             "type": "String",
12802             "optional": true,
12803             "field": "dialOriginateCallerIdName",
12804             "description": ""
12805           },
12806           {
12807             "group": "Body",
12808             "type": "String",
12809             "optional": true,
12810             "field": "dialOriginateCallerIdNumber",
12811             "description": ""
12812           },
12813           {
12814             "group": "Body",
12815             "type": "Integer",
12816             "optional": true,
12817             "field": "dialOriginateTimeout",
12818             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12819           },
12820           {
12821             "group": "Body",
12822             "type": "Integer",
12823             "optional": true,
12824             "field": "dialCongestionMaxRetry",
12825             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12826           },
12827           {
12828             "group": "Body",
12829             "type": "Integer",
12830             "optional": true,
12831             "field": "dialCongestionRetryFrequency",
12832             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12833           },
12834           {
12835             "group": "Body",
12836             "type": "Integer",
12837             "optional": true,
12838             "field": "dialBusyMaxRetry",
12839             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12840           },
12841           {
12842             "group": "Body",
12843             "type": "Integer",
12844             "optional": true,
12845             "field": "dialBusyRetryFrequency",
12846             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12847           },
12848           {
12849             "group": "Body",
12850             "type": "Integer",
12851             "optional": true,
12852             "field": "dialNoAnswerMaxRetry",
12853             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12854           },
12855           {
12856             "group": "Body",
12857             "type": "Integer",
12858             "optional": true,
12859             "field": "dialNoAnswerRetryFrequency",
12860             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12861           },
12862           {
12863             "group": "Body",
12864             "type": "Integer",
12865             "optional": true,
12866             "field": "dialGlobalMaxRetry",
12867             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12868           },
12869           {
12870             "group": "Body",
12871             "type": "String",
12872             "optional": true,
12873             "field": "dialTimezone",
12874             "description": ""
12875           },
12876           {
12877             "group": "Body",
12878             "type": "String",
12879             "optional": true,
12880             "field": "dialGlobalInterval",
12881             "description": ""
12882           },
12883           {
12884             "group": "Body",
12885             "type": "String",
12886             "allowedValues": [
12887               "\"always\"",
12888               "\"never\"",
12889               "\"onlyIfOpen\""
12890             ],
12891             "optional": true,
12892             "field": "dialCheckDuplicateType",
12893             "description": ""
12894           },
12895           {
12896             "group": "Body",
12897             "type": "Boolean",
12898             "optional": true,
12899             "field": "dialAMDActive",
12900             "description": "<p>Active/Disactive AMD</p>"
12901           },
12902           {
12903             "group": "Body",
12904             "type": "Integer",
12905             "optional": true,
12906             "field": "dialAMDInitialSilence",
12907             "description": "<p>#AMD Initial Silence</p>"
12908           },
12909           {
12910             "group": "Body",
12911             "type": "Integer",
12912             "optional": true,
12913             "field": "dialAMDGreeting",
12914             "description": "<p>#AMD Greeting</p>"
12915           },
12916           {
12917             "group": "Body",
12918             "type": "Integer",
12919             "optional": true,
12920             "field": "dialAMDAfterGreetingSilence",
12921             "description": "<p>#AMD After Greeting Silence</p>"
12922           },
12923           {
12924             "group": "Body",
12925             "type": "Integer",
12926             "optional": true,
12927             "field": "dialAMDTotalAnalysisTime",
12928             "description": "<p>#AMD Total Analysis Time</p>"
12929           },
12930           {
12931             "group": "Body",
12932             "type": "Integer",
12933             "optional": true,
12934             "field": "dialAMDMinWordLength",
12935             "description": "<p>#AMD Min Word Length</p>"
12936           },
12937           {
12938             "group": "Body",
12939             "type": "Integer",
12940             "optional": true,
12941             "field": "dialAMDBetweenWordsSilence",
12942             "description": "<p>#AMD Between Words Silence</p>"
12943           },
12944           {
12945             "group": "Body",
12946             "type": "Integer",
12947             "optional": true,
12948             "field": "dialAMDMaximumNumberOfWords",
12949             "description": "<p>#AMD Maximum Number Of Words</p>"
12950           },
12951           {
12952             "group": "Body",
12953             "type": "Integer",
12954             "optional": true,
12955             "field": "dialAMDSilenceThreshold",
12956             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12957           },
12958           {
12959             "group": "Body",
12960             "type": "Integer",
12961             "optional": true,
12962             "field": "dialAMDMaximumWordLength",
12963             "description": "<p>#AMD Maximum Word Length</p>"
12964           },
12965           {
12966             "group": "Body",
12967             "type": "String",
12968             "allowedValues": [
12969               "\"DESC\"",
12970               "\"ASC\""
12971             ],
12972             "optional": true,
12973             "field": "dialOrderByScheduledAt",
12974             "description": ""
12975           },
12976           {
12977             "group": "Body",
12978             "type": "String",
12979             "optional": true,
12980             "field": "dialPrefix",
12981             "description": ""
12982           },
12983           {
12984             "group": "Body",
12985             "type": "Integer",
12986             "optional": true,
12987             "field": "dialRandomLastDigitCallerIdNumber",
12988             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12989           },
12990           {
12991             "group": "Body",
12992             "type": "Integer",
12993             "optional": true,
12994             "field": "dialCutDigit",
12995             "description": "<p>Cut Digit (min:1, max:15)</p>"
12996           },
12997           {
12998             "group": "Body",
12999             "type": "Integer",
13000             "optional": true,
13001             "field": "dialNoSuchNumberMaxRetry",
13002             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13003           },
13004           {
13005             "group": "Body",
13006             "type": "Integer",
13007             "optional": true,
13008             "field": "dialNoSuchNumberRetryFrequency",
13009             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13010           },
13011           {
13012             "group": "Body",
13013             "type": "Integer",
13014             "optional": true,
13015             "field": "dialDropMaxRetry",
13016             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13017           },
13018           {
13019             "group": "Body",
13020             "type": "Integer",
13021             "optional": true,
13022             "field": "dialDropRetryFrequency",
13023             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13024           },
13025           {
13026             "group": "Body",
13027             "type": "Integer",
13028             "optional": true,
13029             "field": "dialAbandonedMaxRetry",
13030             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13031           },
13032           {
13033             "group": "Body",
13034             "type": "Integer",
13035             "optional": true,
13036             "field": "dialAbandonedRetryFrequency",
13037             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13038           },
13039           {
13040             "group": "Body",
13041             "type": "Integer",
13042             "optional": true,
13043             "field": "dialMachineMaxRetry",
13044             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13045           },
13046           {
13047             "group": "Body",
13048             "type": "Integer",
13049             "optional": true,
13050             "field": "dialMachineRetryFrequency",
13051             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13052           },
13053           {
13054             "group": "Body",
13055             "type": "Integer",
13056             "optional": true,
13057             "field": "dialAgentRejectMaxRetry",
13058             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13059           },
13060           {
13061             "group": "Body",
13062             "type": "Integer",
13063             "optional": true,
13064             "field": "dialAgentRejectRetryFrequency",
13065             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13066           }
13067         ]
13068       }
13069     },
13070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13071     "version": "0.0.0",
13072     "filename": "server/api/campaign/index.js",
13073     "groupTitle": "IVR_Campaigns"
13074   },
13075   {
13076     "type": "delete",
13077     "url": "/api/campaigns/{id}",
13078     "title": "Deletes a IVR Campaign",
13079     "examples": [
13080       {
13081         "title": "Example usage:",
13082         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13083         "type": "json"
13084       }
13085     ],
13086     "name": "DeleteIVR_Campaigns",
13087     "group": "IVR_Campaigns",
13088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13089     "version": "0.0.0",
13090     "filename": "server/api/campaign/index.js",
13091     "groupTitle": "IVR_Campaigns"
13092   },
13093   {
13094     "type": "get",
13095     "url": "/api/campaigns/{id}/blacklists",
13096     "title": "Get IVR campaign blacklists",
13097     "examples": [
13098       {
13099         "title": "Example usage:",
13100         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13101         "type": "json"
13102       }
13103     ],
13104     "name": "GetBlackLists",
13105     "group": "IVR_Campaigns",
13106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13107     "version": "0.0.0",
13108     "filename": "server/api/campaign/index.js",
13109     "groupTitle": "IVR_Campaigns"
13110   },
13111   {
13112     "type": "get",
13113     "url": "/api/campaigns/{id}/finals",
13114     "title": "Gets IVR campaign hopper finals",
13115     "examples": [
13116       {
13117         "title": "Example usage:",
13118         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13119         "type": "json"
13120       }
13121     ],
13122     "name": "GetHopperFinals",
13123     "group": "IVR_Campaigns",
13124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13125     "version": "0.0.0",
13126     "filename": "server/api/campaign/index.js",
13127     "groupTitle": "IVR_Campaigns"
13128   },
13129   {
13130     "type": "get",
13131     "url": "/api/campaigns/{id}/hopper_histories",
13132     "title": "Gets IVR campaign hopper histories",
13133     "examples": [
13134       {
13135         "title": "Example usage:",
13136         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13137         "type": "json"
13138       }
13139     ],
13140     "name": "GetHopperHistories",
13141     "group": "IVR_Campaigns",
13142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13143     "version": "0.0.0",
13144     "filename": "server/api/campaign/index.js",
13145     "groupTitle": "IVR_Campaigns"
13146   },
13147   {
13148     "type": "get",
13149     "url": "/api/campaigns/{id}/hoppers",
13150     "title": "Gets IVR campaign hoppers",
13151     "examples": [
13152       {
13153         "title": "Example usage:",
13154         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13155         "type": "json"
13156       }
13157     ],
13158     "name": "GetHoppers",
13159     "group": "IVR_Campaigns",
13160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13161     "version": "0.0.0",
13162     "filename": "server/api/campaign/index.js",
13163     "groupTitle": "IVR_Campaigns"
13164   },
13165   {
13166     "type": "get",
13167     "url": "/api/campaigns",
13168     "title": "Gets a list of IVR Campaigns",
13169     "examples": [
13170       {
13171         "title": "Example usage:",
13172         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13173         "type": "json"
13174       }
13175     ],
13176     "name": "GetIVR_Campaigns",
13177     "group": "IVR_Campaigns",
13178     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/campaigns?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/campaigns?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/campaigns?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/campaigns?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/campaigns?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13179     "version": "0.0.0",
13180     "filename": "server/api/campaign/index.js",
13181     "groupTitle": "IVR_Campaigns"
13182   },
13183   {
13184     "type": "get",
13185     "url": "/api/campaigns/{id}/lists",
13186     "title": "Get IVR campaign lists",
13187     "examples": [
13188       {
13189         "title": "Example usage:",
13190         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13191         "type": "json"
13192       }
13193     ],
13194     "name": "GetLists",
13195     "group": "IVR_Campaigns",
13196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13197     "version": "0.0.0",
13198     "filename": "server/api/campaign/index.js",
13199     "groupTitle": "IVR_Campaigns"
13200   },
13201   {
13202     "type": "delete",
13203     "url": "/api/campaigns/{id}/blacklists",
13204     "title": "Remove blacklists from an IVR Campaign",
13205     "examples": [
13206       {
13207         "title": "Example usage:",
13208         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13209         "type": "json"
13210       }
13211     ],
13212     "name": "RemoveBlackLists",
13213     "group": "IVR_Campaigns",
13214     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13215     "version": "0.0.0",
13216     "filename": "server/api/campaign/index.js",
13217     "groupTitle": "IVR_Campaigns"
13218   },
13219   {
13220     "type": "delete",
13221     "url": "/api/campaigns/{id}/lists",
13222     "title": "Remove lists from an IVR Campaign",
13223     "examples": [
13224       {
13225         "title": "Example usage:",
13226         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13227         "type": "json"
13228       }
13229     ],
13230     "name": "RemoveLists",
13231     "group": "IVR_Campaigns",
13232     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13233     "version": "0.0.0",
13234     "filename": "server/api/campaign/index.js",
13235     "groupTitle": "IVR_Campaigns"
13236   },
13237   {
13238     "type": "get",
13239     "url": "/api/campaigns/{id}",
13240     "title": "Gets a single IVR Campaign",
13241     "examples": [
13242       {
13243         "title": "Example usage:",
13244         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13245         "type": "json"
13246       }
13247     ],
13248     "name": "ShowIVR_Campaigns",
13249     "group": "IVR_Campaigns",
13250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13251     "version": "0.0.0",
13252     "filename": "server/api/campaign/index.js",
13253     "groupTitle": "IVR_Campaigns"
13254   },
13255   {
13256     "type": "get",
13257     "url": "/api/campaigns/{id}/blacks",
13258     "title": "Gets IVR campaign hopper blacks",
13259     "examples": [
13260       {
13261         "title": "Example usage:",
13262         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13263         "type": "json"
13264       }
13265     ],
13266     "name": "getHopperBlacks",
13267     "group": "IVR_Campaigns",
13268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13269     "version": "0.0.0",
13270     "filename": "server/api/campaign/index.js",
13271     "groupTitle": "IVR_Campaigns"
13272   },
13273   {
13274     "type": "put",
13275     "url": "/api/campaigns/{id}",
13276     "title": "Update an existing IVR Campaign",
13277     "examples": [
13278       {
13279         "title": "Example usage:",
13280         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13281         "type": "json"
13282       }
13283     ],
13284     "name": "updateIVR_Campaigns",
13285     "group": "IVR_Campaigns",
13286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13287     "version": "0.0.0",
13288     "filename": "server/api/campaign/index.js",
13289     "groupTitle": "IVR_Campaigns"
13290   },
13291   {
13292     "type": "post",
13293     "url": "/api/integrations/reports",
13294     "title": "Creates a new Integration Report",
13295     "examples": [
13296       {
13297         "title": "Example usage:",
13298         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13299         "type": "json"
13300       }
13301     ],
13302     "name": "CreateIntegration_Reports",
13303     "group": "Integration_Reports",
13304     "parameter": {
13305       "fields": {
13306         "Body": [
13307           {
13308             "group": "Body",
13309             "type": "String",
13310             "optional": true,
13311             "field": "integration",
13312             "description": ""
13313           },
13314           {
13315             "group": "Body",
13316             "type": "String",
13317             "optional": true,
13318             "field": "eventChannel",
13319             "description": ""
13320           },
13321           {
13322             "group": "Body",
13323             "type": "String",
13324             "optional": true,
13325             "field": "exitStatus",
13326             "description": ""
13327           },
13328           {
13329             "group": "Body",
13330             "type": "String",
13331             "optional": true,
13332             "field": "ticketId",
13333             "description": ""
13334           },
13335           {
13336             "group": "Body",
13337             "type": "Integer",
13338             "optional": true,
13339             "field": "integrationId",
13340             "description": ""
13341           },
13342           {
13343             "group": "Body",
13344             "type": "String",
13345             "optional": true,
13346             "field": "contacts",
13347             "description": ""
13348           },
13349           {
13350             "group": "Body",
13351             "type": "String",
13352             "optional": true,
13353             "field": "uniqueid",
13354             "description": ""
13355           },
13356           {
13357             "group": "Body",
13358             "type": "String",
13359             "optional": true,
13360             "field": "calleridnum",
13361             "description": ""
13362           },
13363           {
13364             "group": "Body",
13365             "type": "String",
13366             "optional": true,
13367             "field": "calleridname",
13368             "description": ""
13369           },
13370           {
13371             "group": "Body",
13372             "type": "String",
13373             "optional": true,
13374             "field": "queue",
13375             "description": ""
13376           },
13377           {
13378             "group": "Body",
13379             "type": "String",
13380             "optional": true,
13381             "field": "interface",
13382             "description": ""
13383           },
13384           {
13385             "group": "Body",
13386             "type": "String",
13387             "optional": true,
13388             "field": "membername",
13389             "description": ""
13390           },
13391           {
13392             "group": "Body",
13393             "type": "String",
13394             "optional": true,
13395             "field": "agentcalledAt",
13396             "description": ""
13397           },
13398           {
13399             "group": "Body",
13400             "type": "String",
13401             "optional": true,
13402             "field": "agentconnectAt",
13403             "description": ""
13404           },
13405           {
13406             "group": "Body",
13407             "type": "Integer",
13408             "optional": true,
13409             "field": "holdtime",
13410             "description": ""
13411           },
13412           {
13413             "group": "Body",
13414             "type": "Boolean",
13415             "optional": true,
13416             "field": "agentcomplete",
13417             "description": ""
13418           },
13419           {
13420             "group": "Body",
13421             "type": "String",
13422             "optional": true,
13423             "field": "agentcompleteAt",
13424             "description": ""
13425           },
13426           {
13427             "group": "Body",
13428             "type": "Integer",
13429             "optional": true,
13430             "field": "talktime",
13431             "description": ""
13432           },
13433           {
13434             "group": "Body",
13435             "type": "Boolean",
13436             "optional": true,
13437             "field": "agentacw",
13438             "description": ""
13439           },
13440           {
13441             "group": "Body",
13442             "type": "Integer",
13443             "optional": true,
13444             "field": "acwtime",
13445             "description": ""
13446           },
13447           {
13448             "group": "Body",
13449             "type": "String",
13450             "optional": true,
13451             "field": "reason",
13452             "description": ""
13453           },
13454           {
13455             "group": "Body",
13456             "type": "Boolean",
13457             "optional": true,
13458             "field": "agentringnoanswer",
13459             "description": ""
13460           },
13461           {
13462             "group": "Body",
13463             "type": "String",
13464             "optional": true,
13465             "field": "agentringnoanswerAt",
13466             "description": ""
13467           },
13468           {
13469             "group": "Body",
13470             "type": "Boolean",
13471             "optional": true,
13472             "field": "agentdump",
13473             "description": ""
13474           },
13475           {
13476             "group": "Body",
13477             "type": "String",
13478             "optional": true,
13479             "field": "agentdumpAt",
13480             "description": ""
13481           },
13482           {
13483             "group": "Body",
13484             "type": "String",
13485             "optional": true,
13486             "field": "lastevent",
13487             "description": ""
13488           },
13489           {
13490             "group": "Body",
13491             "type": "String",
13492             "optional": true,
13493             "field": "channel",
13494             "description": ""
13495           },
13496           {
13497             "group": "Body",
13498             "type": "Integer",
13499             "optional": true,
13500             "field": "channelstate",
13501             "description": ""
13502           },
13503           {
13504             "group": "Body",
13505             "type": "String",
13506             "optional": true,
13507             "field": "channelstatedesc",
13508             "description": ""
13509           },
13510           {
13511             "group": "Body",
13512             "type": "String",
13513             "optional": true,
13514             "field": "connectedlinenum",
13515             "description": ""
13516           },
13517           {
13518             "group": "Body",
13519             "type": "String",
13520             "optional": true,
13521             "field": "connectedlinename",
13522             "description": ""
13523           },
13524           {
13525             "group": "Body",
13526             "type": "String",
13527             "optional": true,
13528             "field": "language",
13529             "description": ""
13530           },
13531           {
13532             "group": "Body",
13533             "type": "String",
13534             "optional": true,
13535             "field": "accountcode",
13536             "description": ""
13537           },
13538           {
13539             "group": "Body",
13540             "type": "String",
13541             "optional": true,
13542             "field": "context",
13543             "description": ""
13544           },
13545           {
13546             "group": "Body",
13547             "type": "String",
13548             "optional": true,
13549             "field": "exten",
13550             "description": ""
13551           },
13552           {
13553             "group": "Body",
13554             "type": "String",
13555             "optional": true,
13556             "field": "priority",
13557             "description": ""
13558           },
13559           {
13560             "group": "Body",
13561             "type": "String",
13562             "optional": true,
13563             "field": "destchannel",
13564             "description": ""
13565           },
13566           {
13567             "group": "Body",
13568             "type": "Integer",
13569             "optional": true,
13570             "field": "destchannelstate",
13571             "description": ""
13572           },
13573           {
13574             "group": "Body",
13575             "type": "String",
13576             "optional": true,
13577             "field": "destchannelstatedesc",
13578             "description": ""
13579           },
13580           {
13581             "group": "Body",
13582             "type": "String",
13583             "optional": true,
13584             "field": "destcalleridnum",
13585             "description": ""
13586           },
13587           {
13588             "group": "Body",
13589             "type": "String",
13590             "optional": true,
13591             "field": "destcalleridname",
13592             "description": ""
13593           },
13594           {
13595             "group": "Body",
13596             "type": "String",
13597             "optional": true,
13598             "field": "destconnectedlinenum",
13599             "description": ""
13600           },
13601           {
13602             "group": "Body",
13603             "type": "String",
13604             "optional": true,
13605             "field": "destconnectedlinename",
13606             "description": ""
13607           },
13608           {
13609             "group": "Body",
13610             "type": "String",
13611             "optional": true,
13612             "field": "destlanguage",
13613             "description": ""
13614           },
13615           {
13616             "group": "Body",
13617             "type": "String",
13618             "optional": true,
13619             "field": "destaccountcode",
13620             "description": ""
13621           },
13622           {
13623             "group": "Body",
13624             "type": "String",
13625             "optional": true,
13626             "field": "destcontext",
13627             "description": ""
13628           },
13629           {
13630             "group": "Body",
13631             "type": "String",
13632             "optional": true,
13633             "field": "destexten",
13634             "description": ""
13635           },
13636           {
13637             "group": "Body",
13638             "type": "String",
13639             "optional": true,
13640             "field": "destpriority",
13641             "description": ""
13642           },
13643           {
13644             "group": "Body",
13645             "type": "String",
13646             "optional": true,
13647             "field": "destuniqueid",
13648             "description": ""
13649           },
13650           {
13651             "group": "Body",
13652             "type": "String",
13653             "optional": true,
13654             "field": "messageId",
13655             "description": ""
13656           },
13657           {
13658             "group": "Body",
13659             "type": "String",
13660             "optional": true,
13661             "field": "inReplyTo",
13662             "description": ""
13663           },
13664           {
13665             "group": "Body",
13666             "type": "String",
13667             "optional": true,
13668             "field": "subject",
13669             "description": ""
13670           },
13671           {
13672             "group": "Body",
13673             "type": "String",
13674             "optional": true,
13675             "field": "from",
13676             "description": ""
13677           },
13678           {
13679             "group": "Body",
13680             "type": "String",
13681             "optional": true,
13682             "field": "to",
13683             "description": ""
13684           },
13685           {
13686             "group": "Body",
13687             "type": "String",
13688             "optional": true,
13689             "field": "cc",
13690             "description": ""
13691           },
13692           {
13693             "group": "Body",
13694             "type": "Text",
13695             "optional": true,
13696             "field": "attachment",
13697             "description": ""
13698           },
13699           {
13700             "group": "Body",
13701             "type": "Text",
13702             "optional": true,
13703             "field": "html",
13704             "description": ""
13705           },
13706           {
13707             "group": "Body",
13708             "type": "Text",
13709             "optional": true,
13710             "field": "text",
13711             "description": ""
13712           },
13713           {
13714             "group": "Body",
13715             "type": "String",
13716             "allowedValues": [
13717               "\"SENT\"",
13718               "\"SENDING\"",
13719               "\"RECEIVED\"",
13720               "\"FAILED\""
13721             ],
13722             "optional": true,
13723             "field": "status",
13724             "description": ""
13725           },
13726           {
13727             "group": "Body",
13728             "type": "String",
13729             "optional": true,
13730             "field": "url",
13731             "description": ""
13732           },
13733           {
13734             "group": "Body",
13735             "type": "String",
13736             "optional": true,
13737             "field": "app",
13738             "description": ""
13739           },
13740           {
13741             "group": "Body",
13742             "type": "String",
13743             "optional": true,
13744             "field": "appdata",
13745             "description": ""
13746           },
13747           {
13748             "group": "Body",
13749             "type": "Integer",
13750             "optional": true,
13751             "field": "projectId",
13752             "description": ""
13753           }
13754         ]
13755       }
13756     },
13757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13758     "version": "0.0.0",
13759     "filename": "server/api/integrationReport/index.js",
13760     "groupTitle": "Integration_Reports"
13761   },
13762   {
13763     "type": "delete",
13764     "url": "/api/integrations/reports/{id}",
13765     "title": "Deletes a Integration Report",
13766     "examples": [
13767       {
13768         "title": "Example usage:",
13769         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13770         "type": "json"
13771       }
13772     ],
13773     "name": "DeleteIntegration_Reports",
13774     "group": "Integration_Reports",
13775     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13776     "version": "0.0.0",
13777     "filename": "server/api/integrationReport/index.js",
13778     "groupTitle": "Integration_Reports"
13779   },
13780   {
13781     "type": "get",
13782     "url": "/api/integrations/reports/describe",
13783     "title": "Gets table info about Integration Reports",
13784     "examples": [
13785       {
13786         "title": "Example usage:",
13787         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13788         "type": "json"
13789       }
13790     ],
13791     "name": "DescribeIntegration_Reports",
13792     "group": "Integration_Reports",
13793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13794     "version": "0.0.0",
13795     "filename": "server/api/integrationReport/index.js",
13796     "groupTitle": "Integration_Reports"
13797   },
13798   {
13799     "type": "get",
13800     "url": "/api/integrations/reports",
13801     "title": "Gets a list of Integration Reports",
13802     "examples": [
13803       {
13804         "title": "Example usage:",
13805         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13806         "type": "json"
13807       }
13808     ],
13809     "name": "GetIntegration_Reports",
13810     "group": "Integration_Reports",
13811     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13812     "version": "0.0.0",
13813     "filename": "server/api/integrationReport/index.js",
13814     "groupTitle": "Integration_Reports"
13815   },
13816   {
13817     "type": "get",
13818     "url": "/api/integrations/reports/{id}",
13819     "title": "Gets a single Integration Report",
13820     "examples": [
13821       {
13822         "title": "Example usage:",
13823         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13824         "type": "json"
13825       }
13826     ],
13827     "name": "ShowIntegration_Reports",
13828     "group": "Integration_Reports",
13829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13830     "version": "0.0.0",
13831     "filename": "server/api/integrationReport/index.js",
13832     "groupTitle": "Integration_Reports"
13833   },
13834   {
13835     "type": "put",
13836     "url": "/api/integrations/reports/{id}",
13837     "title": "Update an existing Integration Report",
13838     "examples": [
13839       {
13840         "title": "Example usage:",
13841         "content": "curl https://{domain}/api/integrations/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13842         "type": "json"
13843       }
13844     ],
13845     "name": "updateIntegration_Reports",
13846     "group": "Integration_Reports",
13847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13848     "version": "0.0.0",
13849     "filename": "server/api/integrationReport/index.js",
13850     "groupTitle": "Integration_Reports"
13851   },
13852   {
13853     "type": "post",
13854     "url": "/api/intervals",
13855     "title": "Creates a new Interval",
13856     "examples": [
13857       {
13858         "title": "Example usage:",
13859         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13860         "type": "json"
13861       }
13862     ],
13863     "name": "CreateIntervals",
13864     "group": "Intervals",
13865     "parameter": {
13866       "fields": {
13867         "Body": [
13868           {
13869             "group": "Body",
13870             "type": "String",
13871             "optional": true,
13872             "field": "name",
13873             "description": ""
13874           },
13875           {
13876             "group": "Body",
13877             "type": "String",
13878             "optional": true,
13879             "field": "description",
13880             "description": ""
13881           },
13882           {
13883             "group": "Body",
13884             "type": "String",
13885             "optional": true,
13886             "field": "interval",
13887             "description": ""
13888           }
13889         ]
13890       }
13891     },
13892     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13893     "version": "0.0.0",
13894     "filename": "server/api/interval/index.js",
13895     "groupTitle": "Intervals"
13896   },
13897   {
13898     "type": "delete",
13899     "url": "/api/intervals/{id}",
13900     "title": "Deletes a Interval",
13901     "examples": [
13902       {
13903         "title": "Example usage:",
13904         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13905         "type": "json"
13906       }
13907     ],
13908     "name": "DeleteIntervals",
13909     "group": "Intervals",
13910     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13911     "version": "0.0.0",
13912     "filename": "server/api/interval/index.js",
13913     "groupTitle": "Intervals"
13914   },
13915   {
13916     "type": "get",
13917     "url": "/api/intervals",
13918     "title": "Gets a list of Intervals",
13919     "examples": [
13920       {
13921         "title": "Example usage:",
13922         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13923         "type": "json"
13924       }
13925     ],
13926     "name": "GetIntervals",
13927     "group": "Intervals",
13928     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/intervals?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/intervals?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/intervals?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/intervals?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/intervals?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13929     "version": "0.0.0",
13930     "filename": "server/api/interval/index.js",
13931     "groupTitle": "Intervals"
13932   },
13933   {
13934     "type": "get",
13935     "url": "/api/intervals/{id}",
13936     "title": "Gets a single Interval",
13937     "examples": [
13938       {
13939         "title": "Example usage:",
13940         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13941         "type": "json"
13942       }
13943     ],
13944     "name": "ShowIntervals",
13945     "group": "Intervals",
13946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13947     "version": "0.0.0",
13948     "filename": "server/api/interval/index.js",
13949     "groupTitle": "Intervals"
13950   },
13951   {
13952     "type": "post",
13953     "url": "/api/intervals/{id}/sub_intervals",
13954     "title": "Creates a new sub interval",
13955     "examples": [
13956       {
13957         "title": "Example usage:",
13958         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -d '{\"interval\": \"00:00-08:30,mon-fri,*,*\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13959         "type": "json"
13960       }
13961     ],
13962     "name": "addInterval",
13963     "group": "Intervals",
13964     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13965     "version": "0.0.0",
13966     "filename": "server/api/interval/index.js",
13967     "groupTitle": "Intervals"
13968   },
13969   {
13970     "type": "post",
13971     "url": "/api/intervals/{id}/sub_intervals/create_many",
13972     "title": "Create new sub intervals set",
13973     "examples": [
13974       {
13975         "title": "Example usage:",
13976         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13977         "type": "json"
13978       }
13979     ],
13980     "name": "addIntervals",
13981     "group": "Intervals",
13982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13983     "version": "0.0.0",
13984     "filename": "server/api/interval/index.js",
13985     "groupTitle": "Intervals"
13986   },
13987   {
13988     "type": "get",
13989     "url": "/api/intervals/{id}/sub_intervals",
13990     "title": "Get sub intervals set",
13991     "examples": [
13992       {
13993         "title": "Example usage:",
13994         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13995         "type": "json"
13996       }
13997     ],
13998     "name": "getIntervals",
13999     "group": "Intervals",
14000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14001     "version": "0.0.0",
14002     "filename": "server/api/interval/index.js",
14003     "groupTitle": "Intervals"
14004   },
14005   {
14006     "type": "put",
14007     "url": "/api/intervals/{id}",
14008     "title": "Update an existing Interval",
14009     "examples": [
14010       {
14011         "title": "Example usage:",
14012         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14013         "type": "json"
14014       }
14015     ],
14016     "name": "updateIntervals",
14017     "group": "Intervals",
14018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14019     "version": "0.0.0",
14020     "filename": "server/api/interval/index.js",
14021     "groupTitle": "Intervals"
14022   },
14023   {
14024     "type": "post",
14025     "url": "/api/jira",
14026     "title": "Creates a new issue",
14027     "examples": [
14028       {
14029         "title": "Example usage:",
14030         "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST -v -u {name}:{password}",
14031         "type": "json"
14032       }
14033     ],
14034     "name": "Creates_Issue",
14035     "group": "Issue",
14036     "parameter": {
14037       "fields": {
14038         "Body": [
14039           {
14040             "group": "Body",
14041             "type": "String",
14042             "allowedValues": [
14043               "\"Bug\""
14044             ],
14045             "optional": true,
14046             "field": "issuetype",
14047             "description": ""
14048           },
14049           {
14050             "group": "Body",
14051             "type": "String",
14052             "optional": false,
14053             "field": "summary",
14054             "description": ""
14055           },
14056           {
14057             "group": "Body",
14058             "type": "String",
14059             "optional": false,
14060             "field": "description",
14061             "description": ""
14062           }
14063         ]
14064       }
14065     },
14066     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14067     "version": "0.0.0",
14068     "filename": "server/api/jira/index.js",
14069     "groupTitle": "Issue"
14070   },
14071   {
14072     "type": "post",
14073     "url": "/api/jscripty/answers/reports",
14074     "title": "Creates a new Report",
14075     "examples": [
14076       {
14077         "title": "Example usage:",
14078         "content": "curl https://{domain}/api/jscripty/answers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14079         "type": "json"
14080       }
14081     ],
14082     "name": "CreateReports",
14083     "group": "JscriptyAnswerReport",
14084     "parameter": {
14085       "fields": {
14086         "Body": [
14087           {
14088             "group": "Body",
14089             "type": "Text",
14090             "optional": true,
14091             "field": "question",
14092             "description": ""
14093           },
14094           {
14095             "group": "Body",
14096             "type": "Text",
14097             "optional": true,
14098             "field": "answer",
14099             "description": ""
14100           },
14101           {
14102             "group": "Body",
14103             "type": "String",
14104             "optional": true,
14105             "field": "membername",
14106             "description": ""
14107           },
14108           {
14109             "group": "Body",
14110             "type": "String",
14111             "optional": true,
14112             "field": "projectname",
14113             "description": ""
14114           },
14115           {
14116             "group": "Body",
14117             "type": "String",
14118             "optional": true,
14119             "field": "queue",
14120             "description": ""
14121           },
14122           {
14123             "group": "Body",
14124             "type": "String",
14125             "optional": true,
14126             "field": "uniqueid",
14127             "description": ""
14128           },
14129           {
14130             "group": "Body",
14131             "type": "String",
14132             "optional": true,
14133             "field": "calleridname",
14134             "description": ""
14135           },
14136           {
14137             "group": "Body",
14138             "type": "String",
14139             "optional": true,
14140             "field": "calleridnum",
14141             "description": ""
14142           },
14143           {
14144             "group": "Body",
14145             "type": "String",
14146             "optional": true,
14147             "field": "questionId",
14148             "description": ""
14149           }
14150         ]
14151       }
14152     },
14153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14154     "version": "0.0.0",
14155     "filename": "server/api/jscriptyAnswerReport/index.js",
14156     "groupTitle": "JscriptyAnswerReport"
14157   },
14158   {
14159     "type": "delete",
14160     "url": "/api/jscripty/answers/reports/{id}",
14161     "title": "Deletes a Report",
14162     "examples": [
14163       {
14164         "title": "Example usage:",
14165         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14166         "type": "json"
14167       }
14168     ],
14169     "name": "DeleteReports",
14170     "group": "JscriptyAnswerReport",
14171     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14172     "version": "0.0.0",
14173     "filename": "server/api/jscriptyAnswerReport/index.js",
14174     "groupTitle": "JscriptyAnswerReport"
14175   },
14176   {
14177     "type": "get",
14178     "url": "/api/jscripty/answers/reports/describe",
14179     "title": "Gets table info about Reports",
14180     "examples": [
14181       {
14182         "title": "Example usage:",
14183         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14184         "type": "json"
14185       }
14186     ],
14187     "name": "DescribeReports",
14188     "group": "JscriptyAnswerReport",
14189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14190     "version": "0.0.0",
14191     "filename": "server/api/jscriptyAnswerReport/index.js",
14192     "groupTitle": "JscriptyAnswerReport"
14193   },
14194   {
14195     "type": "get",
14196     "url": "/api/jscripty/answers/reports",
14197     "title": "Gets a list of Reports",
14198     "examples": [
14199       {
14200         "title": "Example usage:",
14201         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14202         "type": "json"
14203       }
14204     ],
14205     "name": "GetReports",
14206     "group": "JscriptyAnswerReport",
14207     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/answers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/answers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/answers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/answers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/answers/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14208     "version": "0.0.0",
14209     "filename": "server/api/jscriptyAnswerReport/index.js",
14210     "groupTitle": "JscriptyAnswerReport"
14211   },
14212   {
14213     "type": "get",
14214     "url": "/api/jscripty/answers/reports/{id}",
14215     "title": "Gets a single Report",
14216     "examples": [
14217       {
14218         "title": "Example usage:",
14219         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14220         "type": "json"
14221       }
14222     ],
14223     "name": "ShowReports",
14224     "group": "JscriptyAnswerReport",
14225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14226     "version": "0.0.0",
14227     "filename": "server/api/jscriptyAnswerReport/index.js",
14228     "groupTitle": "JscriptyAnswerReport"
14229   },
14230   {
14231     "type": "put",
14232     "url": "/api/jscripty/answers/reports/{id}",
14233     "title": "Update an existing Report",
14234     "examples": [
14235       {
14236         "title": "Example usage:",
14237         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14238         "type": "json"
14239       }
14240     ],
14241     "name": "updateReports",
14242     "group": "JscriptyAnswerReport",
14243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14244     "version": "0.0.0",
14245     "filename": "server/api/jscriptyAnswerReport/index.js",
14246     "groupTitle": "JscriptyAnswerReport"
14247   },
14248   {
14249     "type": "post",
14250     "url": "/api/jscripty/questions/reports",
14251     "title": "Creates a new Report",
14252     "examples": [
14253       {
14254         "title": "Example usage:",
14255         "content": "curl https://{domain}/api/jscripty/questions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14256         "type": "json"
14257       }
14258     ],
14259     "name": "CreateReports",
14260     "group": "JscriptyQuestionReport",
14261     "parameter": {
14262       "fields": {
14263         "Body": [
14264           {
14265             "group": "Body",
14266             "type": "Text",
14267             "optional": true,
14268             "field": "question",
14269             "description": ""
14270           },
14271           {
14272             "group": "Body",
14273             "type": "Text",
14274             "optional": true,
14275             "field": "answer",
14276             "description": ""
14277           },
14278           {
14279             "group": "Body",
14280             "type": "String",
14281             "optional": true,
14282             "field": "membername",
14283             "description": ""
14284           },
14285           {
14286             "group": "Body",
14287             "type": "String",
14288             "optional": true,
14289             "field": "projectname",
14290             "description": ""
14291           },
14292           {
14293             "group": "Body",
14294             "type": "String",
14295             "optional": true,
14296             "field": "queue",
14297             "description": ""
14298           },
14299           {
14300             "group": "Body",
14301             "type": "String",
14302             "optional": true,
14303             "field": "uniqueid",
14304             "description": ""
14305           },
14306           {
14307             "group": "Body",
14308             "type": "String",
14309             "optional": true,
14310             "field": "calleridname",
14311             "description": ""
14312           },
14313           {
14314             "group": "Body",
14315             "type": "String",
14316             "optional": true,
14317             "field": "calleridnum",
14318             "description": ""
14319           },
14320           {
14321             "group": "Body",
14322             "type": "String",
14323             "optional": true,
14324             "field": "questionId",
14325             "description": ""
14326           }
14327         ]
14328       }
14329     },
14330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14331     "version": "0.0.0",
14332     "filename": "server/api/jscriptyQuestionReport/index.js",
14333     "groupTitle": "JscriptyQuestionReport"
14334   },
14335   {
14336     "type": "delete",
14337     "url": "/api/jscripty/questions/reports/{id}",
14338     "title": "Deletes a Report",
14339     "examples": [
14340       {
14341         "title": "Example usage:",
14342         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14343         "type": "json"
14344       }
14345     ],
14346     "name": "DeleteReports",
14347     "group": "JscriptyQuestionReport",
14348     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14349     "version": "0.0.0",
14350     "filename": "server/api/jscriptyQuestionReport/index.js",
14351     "groupTitle": "JscriptyQuestionReport"
14352   },
14353   {
14354     "type": "get",
14355     "url": "/api/jscripty/questions/reports/describe",
14356     "title": "Gets table info about Reports",
14357     "examples": [
14358       {
14359         "title": "Example usage:",
14360         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14361         "type": "json"
14362       }
14363     ],
14364     "name": "DescribeReports",
14365     "group": "JscriptyQuestionReport",
14366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14367     "version": "0.0.0",
14368     "filename": "server/api/jscriptyQuestionReport/index.js",
14369     "groupTitle": "JscriptyQuestionReport"
14370   },
14371   {
14372     "type": "get",
14373     "url": "/api/jscripty/questions/reports",
14374     "title": "Gets a list of Reports",
14375     "examples": [
14376       {
14377         "title": "Example usage:",
14378         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14379         "type": "json"
14380       }
14381     ],
14382     "name": "GetReports",
14383     "group": "JscriptyQuestionReport",
14384     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/questions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/questions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/questions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/questions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/questions/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14385     "version": "0.0.0",
14386     "filename": "server/api/jscriptyQuestionReport/index.js",
14387     "groupTitle": "JscriptyQuestionReport"
14388   },
14389   {
14390     "type": "get",
14391     "url": "/api/jscripty/questions/reports/{id}",
14392     "title": "Gets a single Report",
14393     "examples": [
14394       {
14395         "title": "Example usage:",
14396         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14397         "type": "json"
14398       }
14399     ],
14400     "name": "ShowReports",
14401     "group": "JscriptyQuestionReport",
14402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14403     "version": "0.0.0",
14404     "filename": "server/api/jscriptyQuestionReport/index.js",
14405     "groupTitle": "JscriptyQuestionReport"
14406   },
14407   {
14408     "type": "put",
14409     "url": "/api/jscripty/questions/reports/{id}",
14410     "title": "Update an existing Report",
14411     "examples": [
14412       {
14413         "title": "Example usage:",
14414         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14415         "type": "json"
14416       }
14417     ],
14418     "name": "updateReports",
14419     "group": "JscriptyQuestionReport",
14420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14421     "version": "0.0.0",
14422     "filename": "server/api/jscriptyQuestionReport/index.js",
14423     "groupTitle": "JscriptyQuestionReport"
14424   },
14425   {
14426     "type": "post",
14427     "url": "/api/jscripty/sessions/reports",
14428     "title": "Creates a new Report",
14429     "examples": [
14430       {
14431         "title": "Example usage:",
14432         "content": "curl https://{domain}/api/jscripty/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14433         "type": "json"
14434       }
14435     ],
14436     "name": "CreateReports",
14437     "group": "JscriptySessionReport",
14438     "parameter": {
14439       "fields": {
14440         "Body": [
14441           {
14442             "group": "Body",
14443             "type": "String",
14444             "optional": true,
14445             "field": "starttime",
14446             "description": ""
14447           },
14448           {
14449             "group": "Body",
14450             "type": "String",
14451             "optional": true,
14452             "field": "endtime",
14453             "description": ""
14454           },
14455           {
14456             "group": "Body",
14457             "type": "String",
14458             "optional": true,
14459             "field": "membername",
14460             "description": ""
14461           },
14462           {
14463             "group": "Body",
14464             "type": "String",
14465             "optional": true,
14466             "field": "projectname",
14467             "description": ""
14468           },
14469           {
14470             "group": "Body",
14471             "type": "String",
14472             "optional": true,
14473             "field": "queue",
14474             "description": ""
14475           },
14476           {
14477             "group": "Body",
14478             "type": "String",
14479             "optional": true,
14480             "field": "uniqueid",
14481             "description": ""
14482           },
14483           {
14484             "group": "Body",
14485             "type": "String",
14486             "optional": true,
14487             "field": "calleridname",
14488             "description": ""
14489           },
14490           {
14491             "group": "Body",
14492             "type": "String",
14493             "optional": true,
14494             "field": "calleridnum",
14495             "description": ""
14496           },
14497           {
14498             "group": "Body",
14499             "type": "Boolean",
14500             "optional": true,
14501             "field": "completed",
14502             "description": ""
14503           }
14504         ]
14505       }
14506     },
14507     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14508     "version": "0.0.0",
14509     "filename": "server/api/jscriptySessionReport/index.js",
14510     "groupTitle": "JscriptySessionReport"
14511   },
14512   {
14513     "type": "delete",
14514     "url": "/api/jscripty/sessions/reports/{id}",
14515     "title": "Deletes a Report",
14516     "examples": [
14517       {
14518         "title": "Example usage:",
14519         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14520         "type": "json"
14521       }
14522     ],
14523     "name": "DeleteReports",
14524     "group": "JscriptySessionReport",
14525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14526     "version": "0.0.0",
14527     "filename": "server/api/jscriptySessionReport/index.js",
14528     "groupTitle": "JscriptySessionReport"
14529   },
14530   {
14531     "type": "get",
14532     "url": "/api/jscripty/sessions/reports/describe",
14533     "title": "Gets table info about Reports",
14534     "examples": [
14535       {
14536         "title": "Example usage:",
14537         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14538         "type": "json"
14539       }
14540     ],
14541     "name": "DescribeReports",
14542     "group": "JscriptySessionReport",
14543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14544     "version": "0.0.0",
14545     "filename": "server/api/jscriptySessionReport/index.js",
14546     "groupTitle": "JscriptySessionReport"
14547   },
14548   {
14549     "type": "get",
14550     "url": "/api/jscripty/sessions/reports",
14551     "title": "Gets a list of Reports",
14552     "examples": [
14553       {
14554         "title": "Example usage:",
14555         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14556         "type": "json"
14557       }
14558     ],
14559     "name": "GetReports",
14560     "group": "JscriptySessionReport",
14561     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/sessions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/sessions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14562     "version": "0.0.0",
14563     "filename": "server/api/jscriptySessionReport/index.js",
14564     "groupTitle": "JscriptySessionReport"
14565   },
14566   {
14567     "type": "get",
14568     "url": "/api/jscripty/sessions/reports/{id}",
14569     "title": "Gets a single Report",
14570     "examples": [
14571       {
14572         "title": "Example usage:",
14573         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14574         "type": "json"
14575       }
14576     ],
14577     "name": "ShowReports",
14578     "group": "JscriptySessionReport",
14579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14580     "version": "0.0.0",
14581     "filename": "server/api/jscriptySessionReport/index.js",
14582     "groupTitle": "JscriptySessionReport"
14583   },
14584   {
14585     "type": "get",
14586     "url": "/api/jscripty/sessions/reports/{id}/questions",
14587     "title": "Gets Jscripty Session questions",
14588     "examples": [
14589       {
14590         "title": "Example usage:",
14591         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14592         "type": "json"
14593       }
14594     ],
14595     "name": "getQuestions",
14596     "group": "JscriptySessionReport",
14597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14598     "version": "0.0.0",
14599     "filename": "server/api/jscriptySessionReport/index.js",
14600     "groupTitle": "JscriptySessionReport"
14601   },
14602   {
14603     "type": "put",
14604     "url": "/api/jscripty/sessions/reports/{id}",
14605     "title": "Update an existing Report",
14606     "examples": [
14607       {
14608         "title": "Example usage:",
14609         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14610         "type": "json"
14611       }
14612     ],
14613     "name": "updateReports",
14614     "group": "JscriptySessionReport",
14615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14616     "version": "0.0.0",
14617     "filename": "server/api/jscriptySessionReport/index.js",
14618     "groupTitle": "JscriptySessionReport"
14619   },
14620   {
14621     "type": "post",
14622     "url": "/api/jscripty/projects/clone",
14623     "title": "Clone an existing Project",
14624     "examples": [
14625       {
14626         "title": "Example usage:",
14627         "content": "curl https://{domain}/api/jscripty/projects/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14628         "type": "json"
14629       }
14630     ],
14631     "name": "CloneProjects",
14632     "group": "Jscripty_Projects",
14633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14634     "version": "0.0.0",
14635     "filename": "server/api/jscriptyProject/index.js",
14636     "groupTitle": "Jscripty_Projects"
14637   },
14638   {
14639     "type": "post",
14640     "url": "/api/jscripty/projects",
14641     "title": "Creates a new Project",
14642     "examples": [
14643       {
14644         "title": "Example usage:",
14645         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14646         "type": "json"
14647       }
14648     ],
14649     "name": "CreateProjects",
14650     "group": "Jscripty_Projects",
14651     "parameter": {
14652       "fields": {
14653         "Body": [
14654           {
14655             "group": "Body",
14656             "type": "String",
14657             "optional": true,
14658             "field": "name",
14659             "description": ""
14660           },
14661           {
14662             "group": "Body",
14663             "type": "String",
14664             "optional": true,
14665             "field": "description",
14666             "description": ""
14667           },
14668           {
14669             "group": "Body",
14670             "type": "Text",
14671             "optional": true,
14672             "field": "formData",
14673             "description": ""
14674           },
14675           {
14676             "group": "Body",
14677             "type": "Boolean",
14678             "optional": true,
14679             "field": "enableUncompleteSave",
14680             "description": ""
14681           },
14682           {
14683             "group": "Body",
14684             "type": "Boolean",
14685             "optional": true,
14686             "field": "sendUnpauseOnSubmit",
14687             "description": ""
14688           }
14689         ]
14690       }
14691     },
14692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14693     "version": "0.0.0",
14694     "filename": "server/api/jscriptyProject/index.js",
14695     "groupTitle": "Jscripty_Projects"
14696   },
14697   {
14698     "type": "delete",
14699     "url": "/api/jscripty/projects/{id}",
14700     "title": "Deletes a Project",
14701     "examples": [
14702       {
14703         "title": "Example usage:",
14704         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14705         "type": "json"
14706       }
14707     ],
14708     "name": "DeleteProjects",
14709     "group": "Jscripty_Projects",
14710     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14711     "version": "0.0.0",
14712     "filename": "server/api/jscriptyProject/index.js",
14713     "groupTitle": "Jscripty_Projects"
14714   },
14715   {
14716     "type": "get",
14717     "url": "/api/jscripty/projects",
14718     "title": "Gets a list of Projects",
14719     "examples": [
14720       {
14721         "title": "Example usage:",
14722         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14723         "type": "json"
14724       }
14725     ],
14726     "name": "GetProjects",
14727     "group": "Jscripty_Projects",
14728     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/projects?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14729     "version": "0.0.0",
14730     "filename": "server/api/jscriptyProject/index.js",
14731     "groupTitle": "Jscripty_Projects"
14732   },
14733   {
14734     "type": "get",
14735     "url": "/api/jscripty/projects/{id}",
14736     "title": "Gets a single Project",
14737     "examples": [
14738       {
14739         "title": "Example usage:",
14740         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14741         "type": "json"
14742       }
14743     ],
14744     "name": "ShowProjects",
14745     "group": "Jscripty_Projects",
14746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14747     "version": "0.0.0",
14748     "filename": "server/api/jscriptyProject/index.js",
14749     "groupTitle": "Jscripty_Projects"
14750   },
14751   {
14752     "type": "get",
14753     "url": "/api/jscripty/projects/{id}/answers",
14754     "title": "Gets jscripty project answers",
14755     "examples": [
14756       {
14757         "title": "Example usage:",
14758         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14759         "type": "json"
14760       }
14761     ],
14762     "name": "getAnswers",
14763     "group": "Jscripty_Projects",
14764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14765     "version": "0.0.0",
14766     "filename": "server/api/jscriptyProject/index.js",
14767     "groupTitle": "Jscripty_Projects"
14768   },
14769   {
14770     "type": "get",
14771     "url": "/api/jscripty/projects/{id}/sessions",
14772     "title": "Gets jscripty project sessions",
14773     "examples": [
14774       {
14775         "title": "Example usage:",
14776         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14777         "type": "json"
14778       }
14779     ],
14780     "name": "getSessions",
14781     "group": "Jscripty_Projects",
14782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14783     "version": "0.0.0",
14784     "filename": "server/api/jscriptyProject/index.js",
14785     "groupTitle": "Jscripty_Projects"
14786   },
14787   {
14788     "type": "get",
14789     "url": "/api/jscripty/projects/{id}/summary",
14790     "title": "Gets jscripty project summary",
14791     "examples": [
14792       {
14793         "title": "Example usage:",
14794         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14795         "type": "json"
14796       }
14797     ],
14798     "name": "getSummary",
14799     "group": "Jscripty_Projects",
14800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14801     "version": "0.0.0",
14802     "filename": "server/api/jscriptyProject/index.js",
14803     "groupTitle": "Jscripty_Projects"
14804   },
14805   {
14806     "type": "put",
14807     "url": "/api/jscripty/projects/{id}",
14808     "title": "Update an existing Project",
14809     "examples": [
14810       {
14811         "title": "Example usage:",
14812         "content": "curl https://{domain}/api/jscripty/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14813         "type": "json"
14814       }
14815     ],
14816     "name": "updateProjects",
14817     "group": "Jscripty_Projects",
14818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14819     "version": "0.0.0",
14820     "filename": "server/api/jscriptyProject/index.js",
14821     "groupTitle": "Jscripty_Projects"
14822   },
14823   {
14824     "type": "get",
14825     "url": "/api/license",
14826     "title": "Gets License Info",
14827     "examples": [
14828       {
14829         "title": "Example usage:",
14830         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14831         "type": "json"
14832       }
14833     ],
14834     "name": "index",
14835     "group": "License",
14836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14837     "version": "0.0.0",
14838     "filename": "server/api/license/index.js",
14839     "groupTitle": "License"
14840   },
14841   {
14842     "type": "put",
14843     "url": "/api/license/{id}",
14844     "title": "Update License Info",
14845     "examples": [
14846       {
14847         "title": "Example usage:",
14848         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14849         "type": "json"
14850       }
14851     ],
14852     "name": "update",
14853     "group": "License",
14854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14855     "version": "0.0.0",
14856     "filename": "server/api/license/index.js",
14857     "groupTitle": "License"
14858   },
14859   {
14860     "type": "post",
14861     "url": "/api/mail/accounts/{id}/users",
14862     "title": "Add agents to a mail account",
14863     "examples": [
14864       {
14865         "title": "Example usage:",
14866         "content": "curl https://{domain}/api/mail/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14867         "type": "json"
14868       }
14869     ],
14870     "name": "AddAgents",
14871     "group": "Mail_Accounts",
14872     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14873     "version": "0.0.0",
14874     "filename": "server/api/mailAccount/index.js",
14875     "groupTitle": "Mail_Accounts"
14876   },
14877   {
14878     "type": "post",
14879     "url": "/api/mail/accounts/{id}/in_servers",
14880     "title": "Creates a new IMAP server",
14881     "examples": [
14882       {
14883         "title": "Example usage:",
14884         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14885         "type": "json"
14886       }
14887     ],
14888     "name": "AddImap",
14889     "group": "Mail_Accounts",
14890     "parameter": {
14891       "fields": {
14892         "Body": [
14893           {
14894             "group": "Body",
14895             "type": "String",
14896             "optional": true,
14897             "field": "description",
14898             "description": ""
14899           },
14900           {
14901             "group": "Body",
14902             "type": "String",
14903             "optional": true,
14904             "field": "host",
14905             "description": ""
14906           },
14907           {
14908             "group": "Body",
14909             "type": "Boolean",
14910             "optional": true,
14911             "field": "authentication",
14912             "description": ""
14913           },
14914           {
14915             "group": "Body",
14916             "type": "String",
14917             "optional": true,
14918             "field": "user",
14919             "description": ""
14920           },
14921           {
14922             "group": "Body",
14923             "type": "String",
14924             "optional": true,
14925             "field": "password",
14926             "description": ""
14927           },
14928           {
14929             "group": "Body",
14930             "type": "Integer",
14931             "optional": true,
14932             "field": "port",
14933             "description": ""
14934           },
14935           {
14936             "group": "Body",
14937             "type": "Boolean",
14938             "optional": true,
14939             "field": "tls",
14940             "description": ""
14941           },
14942           {
14943             "group": "Body",
14944             "type": "String",
14945             "optional": true,
14946             "field": "mailbox",
14947             "description": ""
14948           },
14949           {
14950             "group": "Body",
14951             "type": "Integer",
14952             "optional": true,
14953             "field": "connTimeout",
14954             "description": ""
14955           },
14956           {
14957             "group": "Body",
14958             "type": "Integer",
14959             "optional": true,
14960             "field": "authTimeout",
14961             "description": ""
14962           },
14963           {
14964             "group": "Body",
14965             "type": "String",
14966             "optional": true,
14967             "field": "service",
14968             "description": ""
14969           }
14970         ]
14971       }
14972     },
14973     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14974     "version": "0.0.0",
14975     "filename": "server/api/mailAccount/index.js",
14976     "groupTitle": "Mail_Accounts"
14977   },
14978   {
14979     "type": "post",
14980     "url": "/api/mail/accounts/{id}/out_servers",
14981     "title": "Creates a new SMTP server",
14982     "examples": [
14983       {
14984         "title": "Example usage:",
14985         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14986         "type": "json"
14987       }
14988     ],
14989     "name": "AddSmtp",
14990     "group": "Mail_Accounts",
14991     "parameter": {
14992       "fields": {
14993         "Body": [
14994           {
14995             "group": "Body",
14996             "type": "String",
14997             "optional": true,
14998             "field": "description",
14999             "description": ""
15000           },
15001           {
15002             "group": "Body",
15003             "type": "String",
15004             "optional": true,
15005             "field": "host",
15006             "description": ""
15007           },
15008           {
15009             "group": "Body",
15010             "type": "String",
15011             "optional": true,
15012             "field": "user",
15013             "description": ""
15014           },
15015           {
15016             "group": "Body",
15017             "type": "String",
15018             "optional": true,
15019             "field": "pass",
15020             "description": ""
15021           },
15022           {
15023             "group": "Body",
15024             "type": "Integer",
15025             "optional": true,
15026             "field": "port",
15027             "description": ""
15028           },
15029           {
15030             "group": "Body",
15031             "type": "Boolean",
15032             "optional": true,
15033             "field": "secure",
15034             "description": ""
15035           },
15036           {
15037             "group": "Body",
15038             "type": "String",
15039             "optional": true,
15040             "field": "service",
15041             "description": ""
15042           },
15043           {
15044             "group": "Body",
15045             "type": "Boolean",
15046             "optional": true,
15047             "field": "authentication",
15048             "description": ""
15049           }
15050         ]
15051       }
15052     },
15053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15054     "version": "0.0.0",
15055     "filename": "server/api/mailAccount/index.js",
15056     "groupTitle": "Mail_Accounts"
15057   },
15058   {
15059     "type": "delete",
15060     "url": "/api/mail/accounts/{id}",
15061     "title": "Deletes a mail account",
15062     "examples": [
15063       {
15064         "title": "Example usage:",
15065         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15066         "type": "json"
15067       }
15068     ],
15069     "name": "DeleteMailAccounts",
15070     "group": "Mail_Accounts",
15071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15072     "version": "0.0.0",
15073     "filename": "server/api/mailAccount/index.js",
15074     "groupTitle": "Mail_Accounts"
15075   },
15076   {
15077     "type": "get",
15078     "url": "/api/mail/accounts/describe",
15079     "title": "Gets table info about Accounts",
15080     "examples": [
15081       {
15082         "title": "Example usage:",
15083         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15084         "type": "json"
15085       }
15086     ],
15087     "name": "DescribeAccounts",
15088     "group": "Mail_Accounts",
15089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15090     "version": "0.0.0",
15091     "filename": "server/api/mailAccount/index.js",
15092     "groupTitle": "Mail_Accounts"
15093   },
15094   {
15095     "type": "get",
15096     "url": "/api/mail/accounts",
15097     "title": "Gets a list of Accounts",
15098     "examples": [
15099       {
15100         "title": "Example usage:",
15101         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15102         "type": "json"
15103       }
15104     ],
15105     "name": "GetAccounts",
15106     "group": "Mail_Accounts",
15107     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15108     "version": "0.0.0",
15109     "filename": "server/api/mailAccount/index.js",
15110     "groupTitle": "Mail_Accounts"
15111   },
15112   {
15113     "type": "get",
15114     "url": "/api/mail/accounts/{id}/users",
15115     "title": "Gets agents from mail account",
15116     "examples": [
15117       {
15118         "title": "Example usage:",
15119         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15120         "type": "json"
15121       }
15122     ],
15123     "name": "GetAgents",
15124     "group": "Mail_Accounts",
15125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15126     "version": "0.0.0",
15127     "filename": "server/api/mailAccount/index.js",
15128     "groupTitle": "Mail_Accounts"
15129   },
15130   {
15131     "type": "get",
15132     "url": "/api/mail/accounts/{id}/in_servers",
15133     "title": "Gets account IMAP server",
15134     "examples": [
15135       {
15136         "title": "Example usage:",
15137         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15138         "type": "json"
15139       }
15140     ],
15141     "name": "GetImap",
15142     "group": "Mail_Accounts",
15143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15144     "version": "0.0.0",
15145     "filename": "server/api/mailAccount/index.js",
15146     "groupTitle": "Mail_Accounts"
15147   },
15148   {
15149     "type": "get",
15150     "url": "/api/mail/accounts/{id}/out_servers",
15151     "title": "Gets account SMTP server",
15152     "examples": [
15153       {
15154         "title": "Example usage:",
15155         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15156         "type": "json"
15157       }
15158     ],
15159     "name": "GetSmtp",
15160     "group": "Mail_Accounts",
15161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15162     "version": "0.0.0",
15163     "filename": "server/api/mailAccount/index.js",
15164     "groupTitle": "Mail_Accounts"
15165   },
15166   {
15167     "type": "delete",
15168     "url": "/api/mail/accounts/{id}/users",
15169     "title": "Removes agents from a mail account",
15170     "examples": [
15171       {
15172         "title": "Example usage:",
15173         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15174         "type": "json"
15175       }
15176     ],
15177     "name": "RemoveAgents",
15178     "group": "Mail_Accounts",
15179     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15180     "version": "0.0.0",
15181     "filename": "server/api/mailAccount/index.js",
15182     "groupTitle": "Mail_Accounts"
15183   },
15184   {
15185     "type": "delete",
15186     "url": "/api/mail/accounts/{id}/canned_answers",
15187     "title": "Removes canned answers from account",
15188     "examples": [
15189       {
15190         "title": "Example usage:",
15191         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15192         "type": "json"
15193       }
15194     ],
15195     "name": "RemoveAnswers",
15196     "group": "Mail_Accounts",
15197     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15198     "version": "0.0.0",
15199     "filename": "server/api/mailAccount/index.js",
15200     "groupTitle": "Mail_Accounts"
15201   },
15202   {
15203     "type": "delete",
15204     "url": "/api/mail/accounts/{id}/dispositions",
15205     "title": "Removes dispositions from account",
15206     "examples": [
15207       {
15208         "title": "Example usage:",
15209         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15210         "type": "json"
15211       }
15212     ],
15213     "name": "RemoveDispositions",
15214     "group": "Mail_Accounts",
15215     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15216     "version": "0.0.0",
15217     "filename": "server/api/mailAccount/index.js",
15218     "groupTitle": "Mail_Accounts"
15219   },
15220   {
15221     "type": "delete",
15222     "url": "/api/mail/accounts/{id}/in_servers",
15223     "title": "Removes IMAP server from an account",
15224     "examples": [
15225       {
15226         "title": "Example usage:",
15227         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15228         "type": "json"
15229       }
15230     ],
15231     "name": "RemoveImmap",
15232     "group": "Mail_Accounts",
15233     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15234     "version": "0.0.0",
15235     "filename": "server/api/mailAccount/index.js",
15236     "groupTitle": "Mail_Accounts"
15237   },
15238   {
15239     "type": "delete",
15240     "url": "/api/mail/accounts/{id}/out_servers",
15241     "title": "Removes SMTP server from an account",
15242     "examples": [
15243       {
15244         "title": "Example usage:",
15245         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15246         "type": "json"
15247       }
15248     ],
15249     "name": "RemoveSmtp",
15250     "group": "Mail_Accounts",
15251     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15252     "version": "0.0.0",
15253     "filename": "server/api/mailAccount/index.js",
15254     "groupTitle": "Mail_Accounts"
15255   },
15256   {
15257     "type": "get",
15258     "url": "/api/mail/accounts/{id}",
15259     "title": "Gets a single Account",
15260     "examples": [
15261       {
15262         "title": "Example usage:",
15263         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15264         "type": "json"
15265       }
15266     ],
15267     "name": "ShowAccounts",
15268     "group": "Mail_Accounts",
15269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15270     "version": "0.0.0",
15271     "filename": "server/api/mailAccount/index.js",
15272     "groupTitle": "Mail_Accounts"
15273   },
15274   {
15275     "type": "post",
15276     "url": "/api/mail/accounts/{id}/canned_answers",
15277     "title": "Creates new canned answer",
15278     "examples": [
15279       {
15280         "title": "Example usage:",
15281         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15282         "type": "json"
15283       }
15284     ],
15285     "name": "addAnswer",
15286     "group": "Mail_Accounts",
15287     "parameter": {
15288       "fields": {
15289         "Body": [
15290           {
15291             "group": "Body",
15292             "type": "String",
15293             "optional": false,
15294             "field": "key",
15295             "description": ""
15296           },
15297           {
15298             "group": "Body",
15299             "type": "Text",
15300             "optional": false,
15301             "field": "value",
15302             "description": ""
15303           },
15304           {
15305             "group": "Body",
15306             "type": "String",
15307             "optional": true,
15308             "field": "description",
15309             "description": ""
15310           },
15311           {
15312             "group": "Body",
15313             "type": "Virtual",
15314             "optional": true,
15315             "field": "name",
15316             "description": ""
15317           }
15318         ]
15319       }
15320     },
15321     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15322     "version": "0.0.0",
15323     "filename": "server/api/mailAccount/index.js",
15324     "groupTitle": "Mail_Accounts"
15325   },
15326   {
15327     "type": "post",
15328     "url": "/api/mail/accounts/{id}/applications",
15329     "title": "Creates new applications",
15330     "examples": [
15331       {
15332         "title": "Example usage:",
15333         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15334         "type": "json"
15335       }
15336     ],
15337     "name": "addApplications",
15338     "group": "Mail_Accounts",
15339     "parameter": {
15340       "fields": {
15341         "Body": [
15342           {
15343             "group": "Body",
15344             "type": "Integer",
15345             "optional": false,
15346             "field": "priority",
15347             "description": ""
15348           },
15349           {
15350             "group": "Body",
15351             "type": "String",
15352             "optional": false,
15353             "field": "app",
15354             "description": ""
15355           },
15356           {
15357             "group": "Body",
15358             "type": "Text",
15359             "optional": true,
15360             "field": "appdata",
15361             "description": ""
15362           },
15363           {
15364             "group": "Body",
15365             "type": "String",
15366             "optional": true,
15367             "field": "description",
15368             "description": ""
15369           },
15370           {
15371             "group": "Body",
15372             "type": "String",
15373             "optional": true,
15374             "field": "interval",
15375             "description": ""
15376           }
15377         ]
15378       }
15379     },
15380     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15381     "version": "0.0.0",
15382     "filename": "server/api/mailAccount/index.js",
15383     "groupTitle": "Mail_Accounts"
15384   },
15385   {
15386     "type": "post",
15387     "url": "/api/mail/accounts/{id}/dispositions",
15388     "title": "Creates new disposition",
15389     "examples": [
15390       {
15391         "title": "Example usage:",
15392         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15393         "type": "json"
15394       }
15395     ],
15396     "name": "addDisposition",
15397     "group": "Mail_Accounts",
15398     "parameter": {
15399       "fields": {
15400         "Body": [
15401           {
15402             "group": "Body",
15403             "type": "String",
15404             "optional": false,
15405             "field": "name",
15406             "description": ""
15407           },
15408           {
15409             "group": "Body",
15410             "type": "String",
15411             "allowedValues": [
15412               "\"first\"",
15413               "\"second\"",
15414               "\"third\""
15415             ],
15416             "optional": false,
15417             "field": "level",
15418             "description": ""
15419           },
15420           {
15421             "group": "Body",
15422             "type": "String",
15423             "optional": true,
15424             "field": "description",
15425             "description": ""
15426           }
15427         ]
15428       }
15429     },
15430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15431     "version": "0.0.0",
15432     "filename": "server/api/mailAccount/index.js",
15433     "groupTitle": "Mail_Accounts"
15434   },
15435   {
15436     "type": "post",
15437     "url": "/api/mail/accounts/{id}/interactions",
15438     "title": "Creates new interactions",
15439     "examples": [
15440       {
15441         "title": "Example usage:",
15442         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -d '[{\"subject\": \"My printer is on fire!\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15443         "type": "json"
15444       }
15445     ],
15446     "name": "addInteraction",
15447     "group": "Mail_Accounts",
15448     "parameter": {
15449       "fields": {
15450         "Body": [
15451           {
15452             "group": "Body",
15453             "type": "Boolean",
15454             "optional": true,
15455             "field": "closed",
15456             "description": ""
15457           },
15458           {
15459             "group": "Body",
15460             "type": "String",
15461             "optional": true,
15462             "field": "closedAt",
15463             "description": ""
15464           },
15465           {
15466             "group": "Body",
15467             "type": "String",
15468             "optional": true,
15469             "field": "disposition",
15470             "description": ""
15471           },
15472           {
15473             "group": "Body",
15474             "type": "String",
15475             "optional": true,
15476             "field": "secondDisposition",
15477             "description": ""
15478           },
15479           {
15480             "group": "Body",
15481             "type": "String",
15482             "optional": true,
15483             "field": "thirdDisposition",
15484             "description": ""
15485           },
15486           {
15487             "group": "Body",
15488             "type": "String",
15489             "optional": true,
15490             "field": "note",
15491             "description": ""
15492           },
15493           {
15494             "group": "Body",
15495             "type": "String",
15496             "optional": true,
15497             "field": "inReplyTo",
15498             "description": ""
15499           },
15500           {
15501             "group": "Body",
15502             "type": "String",
15503             "optional": true,
15504             "field": "to",
15505             "description": ""
15506           },
15507           {
15508             "group": "Body",
15509             "type": "Text",
15510             "optional": true,
15511             "field": "cc",
15512             "description": ""
15513           },
15514           {
15515             "group": "Body",
15516             "type": "Text",
15517             "optional": true,
15518             "field": "subject",
15519             "description": ""
15520           },
15521           {
15522             "group": "Body",
15523             "type": "Boolean",
15524             "optional": true,
15525             "field": "attach",
15526             "description": ""
15527           },
15528           {
15529             "group": "Body",
15530             "type": "String",
15531             "optional": true,
15532             "field": "read1stAt",
15533             "description": ""
15534           },
15535           {
15536             "group": "Body",
15537             "type": "String",
15538             "optional": true,
15539             "field": "substatus",
15540             "description": ""
15541           },
15542           {
15543             "group": "Body",
15544             "type": "String",
15545             "optional": true,
15546             "field": "substatusAt",
15547             "description": ""
15548           },
15549           {
15550             "group": "Body",
15551             "type": "String",
15552             "allowedValues": [
15553               "\"in\"",
15554               "\"out\""
15555             ],
15556             "optional": false,
15557             "field": "firstMsgDirection",
15558             "description": ""
15559           },
15560           {
15561             "group": "Body",
15562             "type": "String",
15563             "optional": true,
15564             "field": "lastMsgAt",
15565             "description": ""
15566           },
15567           {
15568             "group": "Body",
15569             "type": "String",
15570             "allowedValues": [
15571               "\"in\"",
15572               "\"out\""
15573             ],
15574             "optional": false,
15575             "field": "lastMsgDirection",
15576             "description": ""
15577           },
15578           {
15579             "group": "Body",
15580             "type": "Boolean",
15581             "optional": true,
15582             "field": "autoreplyExecuted",
15583             "description": ""
15584           }
15585         ]
15586       }
15587     },
15588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15589     "version": "0.0.0",
15590     "filename": "server/api/mailAccount/index.js",
15591     "groupTitle": "Mail_Accounts"
15592   },
15593   {
15594     "type": "post",
15595     "url": "/api/mail/accounts",
15596     "title": "Create a mail account",
15597     "examples": [
15598       {
15599         "title": "Example usage:",
15600         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15601         "type": "json"
15602       }
15603     ],
15604     "name": "create",
15605     "group": "Mail_Accounts",
15606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15607     "version": "0.0.0",
15608     "filename": "server/api/mailAccount/index.js",
15609     "groupTitle": "Mail_Accounts"
15610   },
15611   {
15612     "type": "get",
15613     "url": "/api/mail/accounts/{id}/canned_answers",
15614     "title": "Gets account canned answers",
15615     "examples": [
15616       {
15617         "title": "Example usage:",
15618         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15619         "type": "json"
15620       }
15621     ],
15622     "name": "getAnswers",
15623     "group": "Mail_Accounts",
15624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15625     "version": "0.0.0",
15626     "filename": "server/api/mailAccount/index.js",
15627     "groupTitle": "Mail_Accounts"
15628   },
15629   {
15630     "type": "get",
15631     "url": "/api/mail/accounts/{id}/applications",
15632     "title": "Gets account applications",
15633     "examples": [
15634       {
15635         "title": "Example usage:",
15636         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15637         "type": "json"
15638       }
15639     ],
15640     "name": "getApplications",
15641     "group": "Mail_Accounts",
15642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15643     "version": "0.0.0",
15644     "filename": "server/api/mailAccount/index.js",
15645     "groupTitle": "Mail_Accounts"
15646   },
15647   {
15648     "type": "get",
15649     "url": "/api/mail/accounts/{id}/dispositions",
15650     "title": "Gets account dispositions",
15651     "examples": [
15652       {
15653         "title": "Example usage:",
15654         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15655         "type": "json"
15656       }
15657     ],
15658     "name": "getDispositions",
15659     "group": "Mail_Accounts",
15660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15661     "version": "0.0.0",
15662     "filename": "server/api/mailAccount/index.js",
15663     "groupTitle": "Mail_Accounts"
15664   },
15665   {
15666     "type": "get",
15667     "url": "/api/mail/accounts/{id}/interactions",
15668     "title": "Gets account interactions",
15669     "examples": [
15670       {
15671         "title": "Example usage:",
15672         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15673         "type": "json"
15674       }
15675     ],
15676     "name": "getInteraction",
15677     "group": "Mail_Accounts",
15678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15679     "version": "0.0.0",
15680     "filename": "server/api/mailAccount/index.js",
15681     "groupTitle": "Mail_Accounts"
15682   },
15683   {
15684     "type": "get",
15685     "url": "/api/mail/accounts/{id}/messages",
15686     "title": "Gets account messages",
15687     "examples": [
15688       {
15689         "title": "Example usage:",
15690         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15691         "type": "json"
15692       }
15693     ],
15694     "name": "getMessages",
15695     "group": "Mail_Accounts",
15696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697     "version": "0.0.0",
15698     "filename": "server/api/mailAccount/index.js",
15699     "groupTitle": "Mail_Accounts"
15700   },
15701   {
15702     "type": "post",
15703     "url": "/api/mail/accounts/{id}/send",
15704     "title": "Send new mail",
15705     "examples": [
15706       {
15707         "title": "Example usage:",
15708         "content": "curl https://{domain}/api/mail/accounts/{id}/send -d '{from: '\"John Doe\" <john.doe@xcally.com>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15709         "type": "json"
15710       }
15711     ],
15712     "name": "sendMail",
15713     "group": "Mail_Accounts",
15714     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715     "version": "0.0.0",
15716     "filename": "server/api/mailAccount/index.js",
15717     "groupTitle": "Mail_Accounts"
15718   },
15719   {
15720     "type": "put",
15721     "url": "/api/mail/accounts/{id}",
15722     "title": "Update an existing Account",
15723     "examples": [
15724       {
15725         "title": "Example usage:",
15726         "content": "curl https://{domain}/api/mail/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15727         "type": "json"
15728       }
15729     ],
15730     "name": "updateAccounts",
15731     "group": "Mail_Accounts",
15732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15733     "version": "0.0.0",
15734     "filename": "server/api/mailAccount/index.js",
15735     "groupTitle": "Mail_Accounts"
15736   },
15737   {
15738     "type": "get",
15739     "url": "/api/mail/accounts/{id}/verify",
15740     "title": "Verify mail account",
15741     "examples": [
15742       {
15743         "title": "Example usage:",
15744         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15745         "type": "json"
15746       }
15747     ],
15748     "name": "verifySmtp",
15749     "group": "Mail_Accounts",
15750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15751     "version": "0.0.0",
15752     "filename": "server/api/mailAccount/index.js",
15753     "groupTitle": "Mail_Accounts"
15754   },
15755   {
15756     "type": "delete",
15757     "url": "/api/mail/applications/{id}",
15758     "title": "Deletes a Application",
15759     "examples": [
15760       {
15761         "title": "Example usage:",
15762         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15763         "type": "json"
15764       }
15765     ],
15766     "name": "DeleteApplications",
15767     "group": "Mail_Applications",
15768     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15769     "version": "0.0.0",
15770     "filename": "server/api/mailApplication/index.js",
15771     "groupTitle": "Mail_Applications"
15772   },
15773   {
15774     "type": "get",
15775     "url": "/api/mail/applications/{id}",
15776     "title": "Gets a single Application",
15777     "examples": [
15778       {
15779         "title": "Example usage:",
15780         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15781         "type": "json"
15782       }
15783     ],
15784     "name": "ShowApplications",
15785     "group": "Mail_Applications",
15786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15787     "version": "0.0.0",
15788     "filename": "server/api/mailApplication/index.js",
15789     "groupTitle": "Mail_Applications"
15790   },
15791   {
15792     "type": "put",
15793     "url": "/api/mail/applications/{id}",
15794     "title": "Update an existing Application",
15795     "examples": [
15796       {
15797         "title": "Example usage:",
15798         "content": "curl https://{domain}/api/mail/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15799         "type": "json"
15800       }
15801     ],
15802     "name": "updateApplications",
15803     "group": "Mail_Applications",
15804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15805     "version": "0.0.0",
15806     "filename": "server/api/mailApplication/index.js",
15807     "groupTitle": "Mail_Applications"
15808   },
15809   {
15810     "type": "post",
15811     "url": "/api/mail/interactions/{id}/tags",
15812     "title": "Add tags to the interaction",
15813     "examples": [
15814       {
15815         "title": "Example usage:",
15816         "content": "curl https://{domain}/api/mail/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15817         "type": "json"
15818       }
15819     ],
15820     "name": "AddTags",
15821     "group": "Mail_Interactions",
15822     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15823     "version": "0.0.0",
15824     "filename": "server/api/mailInteraction/index.js",
15825     "groupTitle": "Mail_Interactions"
15826   },
15827   {
15828     "type": "post",
15829     "url": "/api/mail/interactions",
15830     "title": "Creates a new Interaction",
15831     "examples": [
15832       {
15833         "title": "Example usage:",
15834         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15835         "type": "json"
15836       }
15837     ],
15838     "name": "CreateInteractions",
15839     "group": "Mail_Interactions",
15840     "parameter": {
15841       "fields": {
15842         "Body": [
15843           {
15844             "group": "Body",
15845             "type": "Boolean",
15846             "optional": true,
15847             "field": "closed",
15848             "description": ""
15849           },
15850           {
15851             "group": "Body",
15852             "type": "String",
15853             "optional": true,
15854             "field": "closedAt",
15855             "description": ""
15856           },
15857           {
15858             "group": "Body",
15859             "type": "String",
15860             "optional": true,
15861             "field": "disposition",
15862             "description": ""
15863           },
15864           {
15865             "group": "Body",
15866             "type": "String",
15867             "optional": true,
15868             "field": "secondDisposition",
15869             "description": ""
15870           },
15871           {
15872             "group": "Body",
15873             "type": "String",
15874             "optional": true,
15875             "field": "thirdDisposition",
15876             "description": ""
15877           },
15878           {
15879             "group": "Body",
15880             "type": "String",
15881             "optional": true,
15882             "field": "note",
15883             "description": ""
15884           },
15885           {
15886             "group": "Body",
15887             "type": "String",
15888             "optional": true,
15889             "field": "inReplyTo",
15890             "description": ""
15891           },
15892           {
15893             "group": "Body",
15894             "type": "String",
15895             "optional": true,
15896             "field": "to",
15897             "description": ""
15898           },
15899           {
15900             "group": "Body",
15901             "type": "Text",
15902             "optional": true,
15903             "field": "cc",
15904             "description": ""
15905           },
15906           {
15907             "group": "Body",
15908             "type": "Text",
15909             "optional": true,
15910             "field": "subject",
15911             "description": ""
15912           },
15913           {
15914             "group": "Body",
15915             "type": "Boolean",
15916             "optional": true,
15917             "field": "attach",
15918             "description": ""
15919           },
15920           {
15921             "group": "Body",
15922             "type": "String",
15923             "optional": true,
15924             "field": "read1stAt",
15925             "description": ""
15926           },
15927           {
15928             "group": "Body",
15929             "type": "String",
15930             "optional": true,
15931             "field": "substatus",
15932             "description": ""
15933           },
15934           {
15935             "group": "Body",
15936             "type": "String",
15937             "optional": true,
15938             "field": "substatusAt",
15939             "description": ""
15940           },
15941           {
15942             "group": "Body",
15943             "type": "String",
15944             "allowedValues": [
15945               "\"in\"",
15946               "\"out\""
15947             ],
15948             "optional": false,
15949             "field": "firstMsgDirection",
15950             "description": ""
15951           },
15952           {
15953             "group": "Body",
15954             "type": "String",
15955             "optional": true,
15956             "field": "lastMsgAt",
15957             "description": ""
15958           },
15959           {
15960             "group": "Body",
15961             "type": "String",
15962             "allowedValues": [
15963               "\"in\"",
15964               "\"out\""
15965             ],
15966             "optional": false,
15967             "field": "lastMsgDirection",
15968             "description": ""
15969           },
15970           {
15971             "group": "Body",
15972             "type": "Boolean",
15973             "optional": true,
15974             "field": "autoreplyExecuted",
15975             "description": ""
15976           }
15977         ]
15978       }
15979     },
15980     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15981     "version": "0.0.0",
15982     "filename": "server/api/mailInteraction/index.js",
15983     "groupTitle": "Mail_Interactions"
15984   },
15985   {
15986     "type": "delete",
15987     "url": "/api/mail/interactions/{id}",
15988     "title": "Deletes a Interaction",
15989     "examples": [
15990       {
15991         "title": "Example usage:",
15992         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15993         "type": "json"
15994       }
15995     ],
15996     "name": "DeleteInteractions",
15997     "group": "Mail_Interactions",
15998     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15999     "version": "0.0.0",
16000     "filename": "server/api/mailInteraction/index.js",
16001     "groupTitle": "Mail_Interactions"
16002   },
16003   {
16004     "type": "get",
16005     "url": "/api/mail/interactions/describe",
16006     "title": "Gets table info about Interactions",
16007     "examples": [
16008       {
16009         "title": "Example usage:",
16010         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16011         "type": "json"
16012       }
16013     ],
16014     "name": "DescribeInteractions",
16015     "group": "Mail_Interactions",
16016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16017     "version": "0.0.0",
16018     "filename": "server/api/mailInteraction/index.js",
16019     "groupTitle": "Mail_Interactions"
16020   },
16021   {
16022     "type": "get",
16023     "url": "/api/mail/interactions",
16024     "title": "Gets a list of Interactions",
16025     "examples": [
16026       {
16027         "title": "Example usage:",
16028         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16029         "type": "json"
16030       }
16031     ],
16032     "name": "GetInteractions",
16033     "group": "Mail_Interactions",
16034     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16035     "version": "0.0.0",
16036     "filename": "server/api/mailInteraction/index.js",
16037     "groupTitle": "Mail_Interactions"
16038   },
16039   {
16040     "type": "delete",
16041     "url": "/api/mail/interactions/{id}/tags",
16042     "title": "Removes tags from interaction",
16043     "examples": [
16044       {
16045         "title": "Example usage:",
16046         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16047         "type": "json"
16048       }
16049     ],
16050     "name": "RemoveTags",
16051     "group": "Mail_Interactions",
16052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16053     "version": "0.0.0",
16054     "filename": "server/api/mailInteraction/index.js",
16055     "groupTitle": "Mail_Interactions"
16056   },
16057   {
16058     "type": "get",
16059     "url": "/api/mail/interactions/{id}",
16060     "title": "Gets a single Interaction",
16061     "examples": [
16062       {
16063         "title": "Example usage:",
16064         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16065         "type": "json"
16066       }
16067     ],
16068     "name": "ShowInteractions",
16069     "group": "Mail_Interactions",
16070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16071     "version": "0.0.0",
16072     "filename": "server/api/mailInteraction/index.js",
16073     "groupTitle": "Mail_Interactions"
16074   },
16075   {
16076     "type": "post",
16077     "url": "/api/mail/interactions/{id}/messages",
16078     "title": "Creates new message",
16079     "examples": [
16080       {
16081         "title": "Example usage:",
16082         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -d '[{\"to\": \"sales@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16083         "type": "json"
16084       }
16085     ],
16086     "name": "addMessage",
16087     "group": "Mail_Interactions",
16088     "parameter": {
16089       "fields": {
16090         "Body": [
16091           {
16092             "group": "Body",
16093             "type": "Text",
16094             "optional": false,
16095             "field": "body",
16096             "description": ""
16097           },
16098           {
16099             "group": "Body",
16100             "type": "Text",
16101             "optional": true,
16102             "field": "plainBody",
16103             "description": ""
16104           },
16105           {
16106             "group": "Body",
16107             "type": "Boolean",
16108             "optional": true,
16109             "field": "read",
16110             "description": ""
16111           },
16112           {
16113             "group": "Body",
16114             "type": "String",
16115             "allowedValues": [
16116               "\"in\"",
16117               "\"out\""
16118             ],
16119             "optional": false,
16120             "field": "direction",
16121             "description": ""
16122           },
16123           {
16124             "group": "Body",
16125             "type": "String",
16126             "optional": true,
16127             "field": "messageId",
16128             "description": ""
16129           },
16130           {
16131             "group": "Body",
16132             "type": "String",
16133             "optional": true,
16134             "field": "from",
16135             "description": ""
16136           },
16137           {
16138             "group": "Body",
16139             "type": "Text",
16140             "optional": true,
16141             "field": "to",
16142             "description": ""
16143           },
16144           {
16145             "group": "Body",
16146             "type": "Text",
16147             "optional": true,
16148             "field": "cc",
16149             "description": ""
16150           },
16151           {
16152             "group": "Body",
16153             "type": "Text",
16154             "optional": true,
16155             "field": "bcc",
16156             "description": ""
16157           },
16158           {
16159             "group": "Body",
16160             "type": "Text",
16161             "optional": true,
16162             "field": "subject",
16163             "description": ""
16164           },
16165           {
16166             "group": "Body",
16167             "type": "String",
16168             "optional": true,
16169             "field": "sentAt",
16170             "description": ""
16171           },
16172           {
16173             "group": "Body",
16174             "type": "Integer",
16175             "optional": true,
16176             "field": "attach",
16177             "description": ""
16178           },
16179           {
16180             "group": "Body",
16181             "type": "Boolean",
16182             "optional": true,
16183             "field": "secret",
16184             "description": ""
16185           },
16186           {
16187             "group": "Body",
16188             "type": "String",
16189             "optional": true,
16190             "field": "readAt",
16191             "description": ""
16192           },
16193           {
16194             "group": "Body",
16195             "type": "Text",
16196             "optional": true,
16197             "field": "originTo",
16198             "description": ""
16199           },
16200           {
16201             "group": "Body",
16202             "type": "Text",
16203             "optional": true,
16204             "field": "originCc",
16205             "description": ""
16206           },
16207           {
16208             "group": "Body",
16209             "type": "String",
16210             "allowedValues": [
16211               "\"Email\"",
16212               "\"Chat\""
16213             ],
16214             "optional": false,
16215             "field": "originChannel",
16216             "description": ""
16217           }
16218         ]
16219       }
16220     },
16221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16222     "version": "0.0.0",
16223     "filename": "server/api/mailInteraction/index.js",
16224     "groupTitle": "Mail_Interactions"
16225   },
16226   {
16227     "type": "get",
16228     "url": "/api/mail/interactions/{id}/download",
16229     "title": "Gets interaction",
16230     "examples": [
16231       {
16232         "title": "Example usage:",
16233         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16234         "type": "json"
16235       }
16236     ],
16237     "name": "download",
16238     "group": "Mail_Interactions",
16239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16240     "version": "0.0.0",
16241     "filename": "server/api/mailInteraction/index.js",
16242     "groupTitle": "Mail_Interactions"
16243   },
16244   {
16245     "type": "get",
16246     "url": "/api/mail/interactions/{id}/messages",
16247     "title": "Gets interaction messages",
16248     "examples": [
16249       {
16250         "title": "Example usage:",
16251         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16252         "type": "json"
16253       }
16254     ],
16255     "name": "getMessages",
16256     "group": "Mail_Interactions",
16257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16258     "version": "0.0.0",
16259     "filename": "server/api/mailInteraction/index.js",
16260     "groupTitle": "Mail_Interactions"
16261   },
16262   {
16263     "type": "put",
16264     "url": "/api/mail/interactions/{id}",
16265     "title": "Update an existing Interaction",
16266     "examples": [
16267       {
16268         "title": "Example usage:",
16269         "content": "curl https://{domain}/api/mail/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16270         "type": "json"
16271       }
16272     ],
16273     "name": "updateInteractions",
16274     "group": "Mail_Interactions",
16275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16276     "version": "0.0.0",
16277     "filename": "server/api/mailInteraction/index.js",
16278     "groupTitle": "Mail_Interactions"
16279   },
16280   {
16281     "type": "delete",
16282     "url": "/api/mail/messages/{id}",
16283     "title": "Deletes a Message",
16284     "examples": [
16285       {
16286         "title": "Example usage:",
16287         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16288         "type": "json"
16289       }
16290     ],
16291     "name": "DeleteMessages",
16292     "group": "Mail_Messages",
16293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16294     "version": "0.0.0",
16295     "filename": "server/api/mailMessage/index.js",
16296     "groupTitle": "Mail_Messages"
16297   },
16298   {
16299     "type": "get",
16300     "url": "/api/mail/messages/describe",
16301     "title": "Gets table info about Messages",
16302     "examples": [
16303       {
16304         "title": "Example usage:",
16305         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16306         "type": "json"
16307       }
16308     ],
16309     "name": "DescribeMessages",
16310     "group": "Mail_Messages",
16311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16312     "version": "0.0.0",
16313     "filename": "server/api/mailMessage/index.js",
16314     "groupTitle": "Mail_Messages"
16315   },
16316   {
16317     "type": "get",
16318     "url": "/api/mail/messages",
16319     "title": "Gets a list of Messages",
16320     "examples": [
16321       {
16322         "title": "Example usage:",
16323         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16324         "type": "json"
16325       }
16326     ],
16327     "name": "GetMessages",
16328     "group": "Mail_Messages",
16329     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16330     "version": "0.0.0",
16331     "filename": "server/api/mailMessage/index.js",
16332     "groupTitle": "Mail_Messages"
16333   },
16334   {
16335     "type": "get",
16336     "url": "/api/mail/messages/{id}",
16337     "title": "Gets a single Message",
16338     "examples": [
16339       {
16340         "title": "Example usage:",
16341         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16342         "type": "json"
16343       }
16344     ],
16345     "name": "ShowMessages",
16346     "group": "Mail_Messages",
16347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16348     "version": "0.0.0",
16349     "filename": "server/api/mailMessage/index.js",
16350     "groupTitle": "Mail_Messages"
16351   },
16352   {
16353     "type": "put",
16354     "url": "/api/mail/messages/{id}/accept",
16355     "title": "Accepts message",
16356     "examples": [
16357       {
16358         "title": "Example usage:",
16359         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16360         "type": "json"
16361       }
16362     ],
16363     "name": "acceptMessage",
16364     "group": "Mail_Messages",
16365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16366     "version": "0.0.0",
16367     "filename": "server/api/mailMessage/index.js",
16368     "groupTitle": "Mail_Messages"
16369   },
16370   {
16371     "type": "post",
16372     "url": "/api/mail/messages",
16373     "title": "Create a message",
16374     "examples": [
16375       {
16376         "title": "Example usage:",
16377         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16378         "type": "json"
16379       }
16380     ],
16381     "name": "createMessage",
16382     "group": "Mail_Messages",
16383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16384     "version": "0.0.0",
16385     "filename": "server/api/mailMessage/index.js",
16386     "groupTitle": "Mail_Messages"
16387   },
16388   {
16389     "type": "get",
16390     "url": "/api/mail/messages/{id}/download",
16391     "title": "Gets message",
16392     "examples": [
16393       {
16394         "title": "Example usage:",
16395         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16396         "type": "json"
16397       }
16398     ],
16399     "name": "download",
16400     "group": "Mail_Messages",
16401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16402     "version": "0.0.0",
16403     "filename": "server/api/mailMessage/index.js",
16404     "groupTitle": "Mail_Messages"
16405   },
16406   {
16407     "type": "put",
16408     "url": "/api/mail/messages/{id}/reject",
16409     "title": "Rejects message",
16410     "examples": [
16411       {
16412         "title": "Example usage:",
16413         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16414         "type": "json"
16415       }
16416     ],
16417     "name": "rejectMessage",
16418     "group": "Mail_Messages",
16419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16420     "version": "0.0.0",
16421     "filename": "server/api/mailMessage/index.js",
16422     "groupTitle": "Mail_Messages"
16423   },
16424   {
16425     "type": "put",
16426     "url": "/api/mail/messages/{id}",
16427     "title": "Update an existing Message",
16428     "examples": [
16429       {
16430         "title": "Example usage:",
16431         "content": "curl https://{domain}/api/mail/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16432         "type": "json"
16433       }
16434     ],
16435     "name": "updateMessages",
16436     "group": "Mail_Messages",
16437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16438     "version": "0.0.0",
16439     "filename": "server/api/mailMessage/index.js",
16440     "groupTitle": "Mail_Messages"
16441   },
16442   {
16443     "type": "post",
16444     "url": "/api/mail/reports/queue",
16445     "title": "Creates a new Mail Queue Report",
16446     "examples": [
16447       {
16448         "title": "Example usage:",
16449         "content": "curl https://{domain}/api/mail/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16450         "type": "json"
16451       }
16452     ],
16453     "name": "CreateMail_Queue_Reports",
16454     "group": "Mail_Queue_Reports",
16455     "parameter": {
16456       "fields": {
16457         "Body": [
16458           {
16459             "group": "Body",
16460             "type": "String",
16461             "optional": false,
16462             "field": "uniqueid",
16463             "description": ""
16464           },
16465           {
16466             "group": "Body",
16467             "type": "String",
16468             "optional": true,
16469             "field": "from",
16470             "description": ""
16471           },
16472           {
16473             "group": "Body",
16474             "type": "String",
16475             "optional": true,
16476             "field": "joinAt",
16477             "description": ""
16478           },
16479           {
16480             "group": "Body",
16481             "type": "String",
16482             "optional": true,
16483             "field": "leaveAt",
16484             "description": ""
16485           },
16486           {
16487             "group": "Body",
16488             "type": "String",
16489             "optional": true,
16490             "field": "acceptAt",
16491             "description": ""
16492           },
16493           {
16494             "group": "Body",
16495             "type": "String",
16496             "optional": true,
16497             "field": "exitAt",
16498             "description": ""
16499           },
16500           {
16501             "group": "Body",
16502             "type": "String",
16503             "optional": true,
16504             "field": "reason",
16505             "description": ""
16506           }
16507         ]
16508       }
16509     },
16510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16511     "version": "0.0.0",
16512     "filename": "server/api/mailQueueReport/index.js",
16513     "groupTitle": "Mail_Queue_Reports"
16514   },
16515   {
16516     "type": "delete",
16517     "url": "/api/mail/reports/queue/{id}",
16518     "title": "Deletes a Mail Queue Report",
16519     "examples": [
16520       {
16521         "title": "Example usage:",
16522         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16523         "type": "json"
16524       }
16525     ],
16526     "name": "DeleteMail_Queue_Reports",
16527     "group": "Mail_Queue_Reports",
16528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16529     "version": "0.0.0",
16530     "filename": "server/api/mailQueueReport/index.js",
16531     "groupTitle": "Mail_Queue_Reports"
16532   },
16533   {
16534     "type": "get",
16535     "url": "/api/mail/reports/queue/describe",
16536     "title": "Gets table info about Mail Queue Reports",
16537     "examples": [
16538       {
16539         "title": "Example usage:",
16540         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16541         "type": "json"
16542       }
16543     ],
16544     "name": "DescribeMail_Queue_Reports",
16545     "group": "Mail_Queue_Reports",
16546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16547     "version": "0.0.0",
16548     "filename": "server/api/mailQueueReport/index.js",
16549     "groupTitle": "Mail_Queue_Reports"
16550   },
16551   {
16552     "type": "get",
16553     "url": "/api/mail/reports/queue",
16554     "title": "Gets a list of Mail Queue Reports",
16555     "examples": [
16556       {
16557         "title": "Example usage:",
16558         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16559         "type": "json"
16560       }
16561     ],
16562     "name": "GetMail_Queue_Reports",
16563     "group": "Mail_Queue_Reports",
16564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16565     "version": "0.0.0",
16566     "filename": "server/api/mailQueueReport/index.js",
16567     "groupTitle": "Mail_Queue_Reports"
16568   },
16569   {
16570     "type": "get",
16571     "url": "/api/mail/reports/queue/{id}",
16572     "title": "Gets a single Mail Queue Report",
16573     "examples": [
16574       {
16575         "title": "Example usage:",
16576         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16577         "type": "json"
16578       }
16579     ],
16580     "name": "ShowMail_Queue_Reports",
16581     "group": "Mail_Queue_Reports",
16582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16583     "version": "0.0.0",
16584     "filename": "server/api/mailQueueReport/index.js",
16585     "groupTitle": "Mail_Queue_Reports"
16586   },
16587   {
16588     "type": "put",
16589     "url": "/api/mail/reports/queue/{id}",
16590     "title": "Update an existing Mail Queue Report",
16591     "examples": [
16592       {
16593         "title": "Example usage:",
16594         "content": "curl https://{domain}/api/mail/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16595         "type": "json"
16596       }
16597     ],
16598     "name": "updateMail_Queue_Reports",
16599     "group": "Mail_Queue_Reports",
16600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16601     "version": "0.0.0",
16602     "filename": "server/api/mailQueueReport/index.js",
16603     "groupTitle": "Mail_Queue_Reports"
16604   },
16605   {
16606     "type": "post",
16607     "url": "/api/mail/queues/{id}/users",
16608     "title": "Add agents to a queue",
16609     "examples": [
16610       {
16611         "title": "Example usage:",
16612         "content": "curl https://{domain}/api/mail/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16613         "type": "json"
16614       }
16615     ],
16616     "name": "AddAgents",
16617     "group": "Mail_Queues",
16618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16619     "version": "0.0.0",
16620     "filename": "server/api/mailQueue/index.js",
16621     "groupTitle": "Mail_Queues"
16622   },
16623   {
16624     "type": "post",
16625     "url": "/api/mail/queues/{id}/teams",
16626     "title": "Add teams to a queue",
16627     "examples": [
16628       {
16629         "title": "Example usage:",
16630         "content": "curl https://{domain}/api/mail/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16631         "type": "json"
16632       }
16633     ],
16634     "name": "AddTeams",
16635     "group": "Mail_Queues",
16636     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16637     "version": "0.0.0",
16638     "filename": "server/api/mailQueue/index.js",
16639     "groupTitle": "Mail_Queues"
16640   },
16641   {
16642     "type": "post",
16643     "url": "/api/mail/queues",
16644     "title": "Creates a new Queue",
16645     "examples": [
16646       {
16647         "title": "Example usage:",
16648         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16649         "type": "json"
16650       }
16651     ],
16652     "name": "CreateQueues",
16653     "group": "Mail_Queues",
16654     "parameter": {
16655       "fields": {
16656         "Body": [
16657           {
16658             "group": "Body",
16659             "type": "String",
16660             "optional": true,
16661             "field": "name",
16662             "description": ""
16663           },
16664           {
16665             "group": "Body",
16666             "type": "String",
16667             "optional": true,
16668             "field": "description",
16669             "description": ""
16670           },
16671           {
16672             "group": "Body",
16673             "type": "Integer",
16674             "optional": true,
16675             "field": "timeout",
16676             "description": ""
16677           },
16678           {
16679             "group": "Body",
16680             "type": "String",
16681             "allowedValues": [
16682               "\"rrmemory\"",
16683               "\"beepall\"",
16684               "\"roundrobin\""
16685             ],
16686             "optional": true,
16687             "field": "strategy",
16688             "description": ""
16689           }
16690         ]
16691       }
16692     },
16693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16694     "version": "0.0.0",
16695     "filename": "server/api/mailQueue/index.js",
16696     "groupTitle": "Mail_Queues"
16697   },
16698   {
16699     "type": "delete",
16700     "url": "/api/mail/queues/{id}",
16701     "title": "Deletes a Queue",
16702     "examples": [
16703       {
16704         "title": "Example usage:",
16705         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16706         "type": "json"
16707       }
16708     ],
16709     "name": "DeleteQueues",
16710     "group": "Mail_Queues",
16711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16712     "version": "0.0.0",
16713     "filename": "server/api/mailQueue/index.js",
16714     "groupTitle": "Mail_Queues"
16715   },
16716   {
16717     "type": "get",
16718     "url": "/api/mail/queues/describe",
16719     "title": "Gets table info about Queues",
16720     "examples": [
16721       {
16722         "title": "Example usage:",
16723         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16724         "type": "json"
16725       }
16726     ],
16727     "name": "DescribeQueues",
16728     "group": "Mail_Queues",
16729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16730     "version": "0.0.0",
16731     "filename": "server/api/mailQueue/index.js",
16732     "groupTitle": "Mail_Queues"
16733   },
16734   {
16735     "type": "get",
16736     "url": "/api/mail/queues/{id}/users",
16737     "title": "Gets queue agents",
16738     "examples": [
16739       {
16740         "title": "Example usage:",
16741         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16742         "type": "json"
16743       }
16744     ],
16745     "name": "GetAgents",
16746     "group": "Mail_Queues",
16747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16748     "version": "0.0.0",
16749     "filename": "server/api/mailQueue/index.js",
16750     "groupTitle": "Mail_Queues"
16751   },
16752   {
16753     "type": "get",
16754     "url": "/api/mail/queues/{id}/members",
16755     "title": "GetMembers",
16756     "examples": [
16757       {
16758         "title": "Example usage:",
16759         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16760         "type": "json"
16761       }
16762     ],
16763     "name": "GetMembers",
16764     "group": "Mail_Queues",
16765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16766     "version": "0.0.0",
16767     "filename": "server/api/mailQueue/index.js",
16768     "groupTitle": "Mail_Queues"
16769   },
16770   {
16771     "type": "get",
16772     "url": "/api/mail/queues",
16773     "title": "Gets a list of Queues",
16774     "examples": [
16775       {
16776         "title": "Example usage:",
16777         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16778         "type": "json"
16779       }
16780     ],
16781     "name": "GetQueues",
16782     "group": "Mail_Queues",
16783     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16784     "version": "0.0.0",
16785     "filename": "server/api/mailQueue/index.js",
16786     "groupTitle": "Mail_Queues"
16787   },
16788   {
16789     "type": "get",
16790     "url": "/api/mail/queues/{id}/teams",
16791     "title": "Gets queues list",
16792     "examples": [
16793       {
16794         "title": "Example usage:",
16795         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16796         "type": "json"
16797       }
16798     ],
16799     "name": "GetTeams",
16800     "group": "Mail_Queues",
16801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16802     "version": "0.0.0",
16803     "filename": "server/api/mailQueue/index.js",
16804     "groupTitle": "Mail_Queues"
16805   },
16806   {
16807     "type": "delete",
16808     "url": "/api/mail/queues/{id}/users",
16809     "title": "Removes agents from a queue",
16810     "examples": [
16811       {
16812         "title": "Example usage:",
16813         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16814         "type": "json"
16815       }
16816     ],
16817     "name": "RemoveAgents",
16818     "group": "Mail_Queues",
16819     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16820     "version": "0.0.0",
16821     "filename": "server/api/mailQueue/index.js",
16822     "groupTitle": "Mail_Queues"
16823   },
16824   {
16825     "type": "get",
16826     "url": "/api/mail/queues/{id}",
16827     "title": "Gets a single Queue",
16828     "examples": [
16829       {
16830         "title": "Example usage:",
16831         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16832         "type": "json"
16833       }
16834     ],
16835     "name": "ShowQueues",
16836     "group": "Mail_Queues",
16837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16838     "version": "0.0.0",
16839     "filename": "server/api/mailQueue/index.js",
16840     "groupTitle": "Mail_Queues"
16841   },
16842   {
16843     "type": "put",
16844     "url": "/api/mail/queues/{id}",
16845     "title": "Update an existing Queue",
16846     "examples": [
16847       {
16848         "title": "Example usage:",
16849         "content": "curl https://{domain}/api/mail/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16850         "type": "json"
16851       }
16852     ],
16853     "name": "updateQueues",
16854     "group": "Mail_Queues",
16855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16856     "version": "0.0.0",
16857     "filename": "server/api/mailQueue/index.js",
16858     "groupTitle": "Mail_Queues"
16859   },
16860   {
16861     "type": "post",
16862     "url": "/api/mail/out_servers",
16863     "title": "Creates a new SMTP",
16864     "examples": [
16865       {
16866         "title": "Example usage:",
16867         "content": "curl https://{domain}/api/mail/out_servers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16868         "type": "json"
16869       }
16870     ],
16871     "name": "CreateSMTPs",
16872     "group": "Mail_SMTP",
16873     "parameter": {
16874       "fields": {
16875         "Body": [
16876           {
16877             "group": "Body",
16878             "type": "String",
16879             "optional": true,
16880             "field": "description",
16881             "description": ""
16882           },
16883           {
16884             "group": "Body",
16885             "type": "String",
16886             "optional": true,
16887             "field": "host",
16888             "description": ""
16889           },
16890           {
16891             "group": "Body",
16892             "type": "String",
16893             "optional": true,
16894             "field": "user",
16895             "description": ""
16896           },
16897           {
16898             "group": "Body",
16899             "type": "String",
16900             "optional": true,
16901             "field": "pass",
16902             "description": ""
16903           },
16904           {
16905             "group": "Body",
16906             "type": "Integer",
16907             "optional": true,
16908             "field": "port",
16909             "description": ""
16910           },
16911           {
16912             "group": "Body",
16913             "type": "Boolean",
16914             "optional": true,
16915             "field": "secure",
16916             "description": ""
16917           },
16918           {
16919             "group": "Body",
16920             "type": "String",
16921             "optional": true,
16922             "field": "service",
16923             "description": ""
16924           },
16925           {
16926             "group": "Body",
16927             "type": "Boolean",
16928             "optional": true,
16929             "field": "authentication",
16930             "description": ""
16931           }
16932         ]
16933       }
16934     },
16935     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16936     "version": "0.0.0",
16937     "filename": "server/api/mailServerOut/index.js",
16938     "groupTitle": "Mail_SMTP"
16939   },
16940   {
16941     "type": "delete",
16942     "url": "/api/mail/out_servers/{id}",
16943     "title": "Deletes a SMTP",
16944     "examples": [
16945       {
16946         "title": "Example usage:",
16947         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16948         "type": "json"
16949       }
16950     ],
16951     "name": "DeleteSMTPs",
16952     "group": "Mail_SMTP",
16953     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16954     "version": "0.0.0",
16955     "filename": "server/api/mailServerOut/index.js",
16956     "groupTitle": "Mail_SMTP"
16957   },
16958   {
16959     "type": "get",
16960     "url": "/api/mail/out_servers",
16961     "title": "Gets a list of SMTPs",
16962     "examples": [
16963       {
16964         "title": "Example usage:",
16965         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16966         "type": "json"
16967       }
16968     ],
16969     "name": "GetSMTPs",
16970     "group": "Mail_SMTP",
16971     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/out_servers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/out_servers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/out_servers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/out_servers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/out_servers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16972     "version": "0.0.0",
16973     "filename": "server/api/mailServerOut/index.js",
16974     "groupTitle": "Mail_SMTP"
16975   },
16976   {
16977     "type": "get",
16978     "url": "/api/mail/out_servers/{id}",
16979     "title": "Gets a single SMTP",
16980     "examples": [
16981       {
16982         "title": "Example usage:",
16983         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16984         "type": "json"
16985       }
16986     ],
16987     "name": "ShowSMTPs",
16988     "group": "Mail_SMTP",
16989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16990     "version": "0.0.0",
16991     "filename": "server/api/mailServerOut/index.js",
16992     "groupTitle": "Mail_SMTP"
16993   },
16994   {
16995     "type": "put",
16996     "url": "/api/mail/out_servers/{id}",
16997     "title": "Update an existing SMTP",
16998     "examples": [
16999       {
17000         "title": "Example usage:",
17001         "content": "curl https://{domain}/api/mail/out_servers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17002         "type": "json"
17003       }
17004     ],
17005     "name": "updateSMTPs",
17006     "group": "Mail_SMTP",
17007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17008     "version": "0.0.0",
17009     "filename": "server/api/mailServerOut/index.js",
17010     "groupTitle": "Mail_SMTP"
17011   },
17012   {
17013     "type": "post",
17014     "url": "/api/mail/substatuses",
17015     "title": "Creates a new Queue",
17016     "examples": [
17017       {
17018         "title": "Example usage:",
17019         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17020         "type": "json"
17021       }
17022     ],
17023     "name": "CreateSubstatuses",
17024     "group": "Mail_Substatuses",
17025     "parameter": {
17026       "fields": {
17027         "Body": [
17028           {
17029             "group": "Body",
17030             "type": "String",
17031             "optional": false,
17032             "field": "name",
17033             "description": ""
17034           },
17035           {
17036             "group": "Body",
17037             "type": "String",
17038             "optional": true,
17039             "field": "description",
17040             "description": ""
17041           }
17042         ]
17043       }
17044     },
17045     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17046     "version": "0.0.0",
17047     "filename": "server/api/mailSubstatus/index.js",
17048     "groupTitle": "Mail_Substatuses"
17049   },
17050   {
17051     "type": "delete",
17052     "url": "/api/mail/substatuses/{id}",
17053     "title": "Deletes a Queue",
17054     "examples": [
17055       {
17056         "title": "Example usage:",
17057         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17058         "type": "json"
17059       }
17060     ],
17061     "name": "DeleteSubstatuses",
17062     "group": "Mail_Substatuses",
17063     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17064     "version": "0.0.0",
17065     "filename": "server/api/mailSubstatus/index.js",
17066     "groupTitle": "Mail_Substatuses"
17067   },
17068   {
17069     "type": "get",
17070     "url": "/api/mail/substatuses/describe",
17071     "title": "Gets table info about Substatuses",
17072     "examples": [
17073       {
17074         "title": "Example usage:",
17075         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17076         "type": "json"
17077       }
17078     ],
17079     "name": "DescribeSubstatuses",
17080     "group": "Mail_Substatuses",
17081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17082     "version": "0.0.0",
17083     "filename": "server/api/mailSubstatus/index.js",
17084     "groupTitle": "Mail_Substatuses"
17085   },
17086   {
17087     "type": "get",
17088     "url": "/api/mail/substatuses",
17089     "title": "Gets a list of Substatuses",
17090     "examples": [
17091       {
17092         "title": "Example usage:",
17093         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17094         "type": "json"
17095       }
17096     ],
17097     "name": "GetSubstatuses",
17098     "group": "Mail_Substatuses",
17099     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/substatuses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/substatuses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/substatuses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/substatuses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/substatuses?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17100     "version": "0.0.0",
17101     "filename": "server/api/mailSubstatus/index.js",
17102     "groupTitle": "Mail_Substatuses"
17103   },
17104   {
17105     "type": "get",
17106     "url": "/api/mail/substatuses/{id}",
17107     "title": "Gets a single Queue",
17108     "examples": [
17109       {
17110         "title": "Example usage:",
17111         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17112         "type": "json"
17113       }
17114     ],
17115     "name": "ShowSubstatuses",
17116     "group": "Mail_Substatuses",
17117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17118     "version": "0.0.0",
17119     "filename": "server/api/mailSubstatus/index.js",
17120     "groupTitle": "Mail_Substatuses"
17121   },
17122   {
17123     "type": "put",
17124     "url": "/api/mail/substatuses/{id}",
17125     "title": "Update an existing Queue",
17126     "examples": [
17127       {
17128         "title": "Example usage:",
17129         "content": "curl https://{domain}/api/mail/substatuses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17130         "type": "json"
17131       }
17132     ],
17133     "name": "updateSubstatuses",
17134     "group": "Mail_Substatuses",
17135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17136     "version": "0.0.0",
17137     "filename": "server/api/mailSubstatus/index.js",
17138     "groupTitle": "Mail_Substatuses"
17139   },
17140   {
17141     "type": "post",
17142     "url": "/api/mail/reports/transfer",
17143     "title": "Creates a new Mail Transfer Report",
17144     "examples": [
17145       {
17146         "title": "Example usage:",
17147         "content": "curl https://{domain}/api/mail/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17148         "type": "json"
17149       }
17150     ],
17151     "name": "CreateMail_Transfer_Reports",
17152     "group": "Mail_Transfer_Reports",
17153     "parameter": {
17154       "fields": {
17155         "Body": [
17156           {
17157             "group": "Body",
17158             "type": "String",
17159             "optional": false,
17160             "field": "uniqueid",
17161             "description": ""
17162           },
17163           {
17164             "group": "Body",
17165             "type": "String",
17166             "allowedValues": [
17167               "\"account\"",
17168               "\"agent\"",
17169               "\"queue\""
17170             ],
17171             "optional": false,
17172             "field": "type",
17173             "description": ""
17174           },
17175           {
17176             "group": "Body",
17177             "type": "String",
17178             "optional": false,
17179             "field": "transferredAt",
17180             "description": ""
17181           }
17182         ]
17183       }
17184     },
17185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17186     "version": "0.0.0",
17187     "filename": "server/api/mailTransferReport/index.js",
17188     "groupTitle": "Mail_Transfer_Reports"
17189   },
17190   {
17191     "type": "delete",
17192     "url": "/api/mail/reports/transfer/{id}",
17193     "title": "Deletes a Mail Transfer Report",
17194     "examples": [
17195       {
17196         "title": "Example usage:",
17197         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17198         "type": "json"
17199       }
17200     ],
17201     "name": "DeleteMail_Transfer_Reports",
17202     "group": "Mail_Transfer_Reports",
17203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17204     "version": "0.0.0",
17205     "filename": "server/api/mailTransferReport/index.js",
17206     "groupTitle": "Mail_Transfer_Reports"
17207   },
17208   {
17209     "type": "get",
17210     "url": "/api/mail/reports/transfer/describe",
17211     "title": "Gets table info about Mail Transfer Reports",
17212     "examples": [
17213       {
17214         "title": "Example usage:",
17215         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17216         "type": "json"
17217       }
17218     ],
17219     "name": "DescribeMail_Transfer_Reports",
17220     "group": "Mail_Transfer_Reports",
17221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17222     "version": "0.0.0",
17223     "filename": "server/api/mailTransferReport/index.js",
17224     "groupTitle": "Mail_Transfer_Reports"
17225   },
17226   {
17227     "type": "get",
17228     "url": "/api/mail/reports/transfer",
17229     "title": "Gets a list of Mail Transfer Reports",
17230     "examples": [
17231       {
17232         "title": "Example usage:",
17233         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17234         "type": "json"
17235       }
17236     ],
17237     "name": "GetMail_Transfer_Reports",
17238     "group": "Mail_Transfer_Reports",
17239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17240     "version": "0.0.0",
17241     "filename": "server/api/mailTransferReport/index.js",
17242     "groupTitle": "Mail_Transfer_Reports"
17243   },
17244   {
17245     "type": "get",
17246     "url": "/api/mail/reports/transfer/{id}",
17247     "title": "Gets a single Mail Transfer Report",
17248     "examples": [
17249       {
17250         "title": "Example usage:",
17251         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17252         "type": "json"
17253       }
17254     ],
17255     "name": "ShowMail_Transfer_Reports",
17256     "group": "Mail_Transfer_Reports",
17257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17258     "version": "0.0.0",
17259     "filename": "server/api/mailTransferReport/index.js",
17260     "groupTitle": "Mail_Transfer_Reports"
17261   },
17262   {
17263     "type": "put",
17264     "url": "/api/mail/reports/transfer/{id}",
17265     "title": "Update an existing Mail Transfer Report",
17266     "examples": [
17267       {
17268         "title": "Example usage:",
17269         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17270         "type": "json"
17271       }
17272     ],
17273     "name": "updateMail_Transfer_Reports",
17274     "group": "Mail_Transfer_Reports",
17275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17276     "version": "0.0.0",
17277     "filename": "server/api/mailTransferReport/index.js",
17278     "groupTitle": "Mail_Transfer_Reports"
17279   },
17280   {
17281     "type": "get",
17282     "url": "/api/members/reports/describe",
17283     "title": "Gets table info about Member Reports",
17284     "examples": [
17285       {
17286         "title": "Example usage:",
17287         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17288         "type": "json"
17289       }
17290     ],
17291     "name": "DescribeMember_Reports",
17292     "group": "Member_Reports",
17293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17294     "version": "0.0.0",
17295     "filename": "server/api/memberReport/index.js",
17296     "groupTitle": "Member_Reports"
17297   },
17298   {
17299     "type": "get",
17300     "url": "/api/members/reports",
17301     "title": "Gets a list of Member Reports",
17302     "examples": [
17303       {
17304         "title": "Example usage:",
17305         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17306         "type": "json"
17307       }
17308     ],
17309     "name": "GetMember_Reports",
17310     "group": "Member_Reports",
17311     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/members/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/members/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/members/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/members/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/members/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17312     "version": "0.0.0",
17313     "filename": "server/api/memberReport/index.js",
17314     "groupTitle": "Member_Reports"
17315   },
17316   {
17317     "type": "get",
17318     "url": "/api/members/reports/{id}",
17319     "title": "Gets a single Member Report",
17320     "examples": [
17321       {
17322         "title": "Example usage:",
17323         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17324         "type": "json"
17325       }
17326     ],
17327     "name": "ShowMember_Reports",
17328     "group": "Member_Reports",
17329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17330     "version": "0.0.0",
17331     "filename": "server/api/memberReport/index.js",
17332     "groupTitle": "Member_Reports"
17333   },
17334   {
17335     "type": "get",
17336     "url": "/api/migrations",
17337     "title": "Gets a list of Migrations",
17338     "examples": [
17339       {
17340         "title": "Example usage:",
17341         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17342         "type": "json"
17343       }
17344     ],
17345     "name": "GetMigrations",
17346     "group": "Migrations",
17347     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/migrations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/migrations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/migrations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/migrations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/migrations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17348     "version": "0.0.0",
17349     "filename": "server/api/migration/index.js",
17350     "groupTitle": "Migrations"
17351   },
17352   {
17353     "type": "post",
17354     "url": "/api/voice/networks",
17355     "title": "Create a new network",
17356     "examples": [
17357       {
17358         "title": "Example usage:",
17359         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17360         "type": "json"
17361       }
17362     ],
17363     "name": "Create",
17364     "group": "Networks",
17365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17366     "version": "0.0.0",
17367     "filename": "server/api/network/index.js",
17368     "groupTitle": "Networks"
17369   },
17370   {
17371     "type": "delete",
17372     "url": "/api/voice/networks/{id}",
17373     "title": "Deletes a network",
17374     "examples": [
17375       {
17376         "title": "Example usage:",
17377         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17378         "type": "json"
17379       }
17380     ],
17381     "name": "Delete",
17382     "group": "Networks",
17383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17384     "version": "0.0.0",
17385     "filename": "server/api/network/index.js",
17386     "groupTitle": "Networks"
17387   },
17388   {
17389     "type": "get",
17390     "url": "/api/networks",
17391     "title": "Gets a list of Networks",
17392     "examples": [
17393       {
17394         "title": "Example usage:",
17395         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17396         "type": "json"
17397       }
17398     ],
17399     "name": "GetNetworks",
17400     "group": "Networks",
17401     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/networks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/networks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/networks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/networks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/networks?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17402     "version": "0.0.0",
17403     "filename": "server/api/network/index.js",
17404     "groupTitle": "Networks"
17405   },
17406   {
17407     "type": "get",
17408     "url": "/api/networks/{id}",
17409     "title": "Gets a single Network",
17410     "examples": [
17411       {
17412         "title": "Example usage:",
17413         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17414         "type": "json"
17415       }
17416     ],
17417     "name": "ShowNetworks",
17418     "group": "Networks",
17419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17420     "version": "0.0.0",
17421     "filename": "server/api/network/index.js",
17422     "groupTitle": "Networks"
17423   },
17424   {
17425     "type": "put",
17426     "url": "/api/voice/networks/{id}",
17427     "title": "Update an existing network",
17428     "examples": [
17429       {
17430         "title": "Example usage:",
17431         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17432         "type": "json"
17433       }
17434     ],
17435     "name": "Update",
17436     "group": "Networks",
17437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17438     "version": "0.0.0",
17439     "filename": "server/api/network/index.js",
17440     "groupTitle": "Networks"
17441   },
17442   {
17443     "type": "post",
17444     "url": "/api/openchannel/accounts/{id}/users",
17445     "title": "Add agents to a openchannel account",
17446     "examples": [
17447       {
17448         "title": "Example usage:",
17449         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17450         "type": "json"
17451       }
17452     ],
17453     "name": "AddAgents",
17454     "group": "Openchannel_Accounts",
17455     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17456     "version": "0.0.0",
17457     "filename": "server/api/openchannelAccount/index.js",
17458     "groupTitle": "Openchannel_Accounts"
17459   },
17460   {
17461     "type": "post",
17462     "url": "/api/openchannel/accounts",
17463     "title": "Creates a new Account",
17464     "examples": [
17465       {
17466         "title": "Example usage:",
17467         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17468         "type": "json"
17469       }
17470     ],
17471     "name": "CreateAccounts",
17472     "group": "Openchannel_Accounts",
17473     "parameter": {
17474       "fields": {
17475         "Body": [
17476           {
17477             "group": "Body",
17478             "type": "String",
17479             "optional": false,
17480             "field": "name",
17481             "description": ""
17482           },
17483           {
17484             "group": "Body",
17485             "type": "String",
17486             "optional": true,
17487             "field": "description",
17488             "description": ""
17489           },
17490           {
17491             "group": "Body",
17492             "type": "String",
17493             "optional": true,
17494             "field": "token",
17495             "description": ""
17496           },
17497           {
17498             "group": "Body",
17499             "type": "String",
17500             "optional": true,
17501             "field": "replyUri",
17502             "description": ""
17503           },
17504           {
17505             "group": "Body",
17506             "type": "String",
17507             "optional": false,
17508             "field": "key",
17509             "description": ""
17510           },
17511           {
17512             "group": "Body",
17513             "type": "Text",
17514             "optional": true,
17515             "field": "notificationTemplate",
17516             "description": ""
17517           },
17518           {
17519             "group": "Body",
17520             "type": "Boolean",
17521             "optional": true,
17522             "field": "notificationSound",
17523             "description": ""
17524           },
17525           {
17526             "group": "Body",
17527             "type": "Boolean",
17528             "optional": true,
17529             "field": "notificationShake",
17530             "description": ""
17531           },
17532           {
17533             "group": "Body",
17534             "type": "Integer",
17535             "optional": true,
17536             "field": "waitForTheAssignedAgent",
17537             "description": ""
17538           },
17539           {
17540             "group": "Body",
17541             "type": "String",
17542             "optional": true,
17543             "field": "mapKey",
17544             "description": ""
17545           },
17546           {
17547             "group": "Body",
17548             "type": "Boolean",
17549             "optional": true,
17550             "field": "queueTransfer",
17551             "description": ""
17552           },
17553           {
17554             "group": "Body",
17555             "type": "Integer",
17556             "optional": true,
17557             "field": "queueTransferTimeout",
17558             "description": ""
17559           },
17560           {
17561             "group": "Body",
17562             "type": "Boolean",
17563             "optional": true,
17564             "field": "agentTransfer",
17565             "description": ""
17566           },
17567           {
17568             "group": "Body",
17569             "type": "Integer",
17570             "optional": true,
17571             "field": "agentTransferTimeout",
17572             "description": ""
17573           },
17574           {
17575             "group": "Body",
17576             "type": "Integer",
17577             "optional": true,
17578             "field": "mandatoryDispositionPauseId",
17579             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17580           },
17581           {
17582             "group": "Body",
17583             "type": "Boolean",
17584             "optional": true,
17585             "field": "mandatoryDisposition",
17586             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17587           }
17588         ]
17589       }
17590     },
17591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17592     "version": "0.0.0",
17593     "filename": "server/api/openchannelAccount/index.js",
17594     "groupTitle": "Openchannel_Accounts"
17595   },
17596   {
17597     "type": "delete",
17598     "url": "/api/openchannel/accounts/{id}",
17599     "title": "Deletes a Account",
17600     "examples": [
17601       {
17602         "title": "Example usage:",
17603         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17604         "type": "json"
17605       }
17606     ],
17607     "name": "DeleteAccounts",
17608     "group": "Openchannel_Accounts",
17609     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17610     "version": "0.0.0",
17611     "filename": "server/api/openchannelAccount/index.js",
17612     "groupTitle": "Openchannel_Accounts"
17613   },
17614   {
17615     "type": "get",
17616     "url": "/api/openchannel/accounts/describe",
17617     "title": "Gets table info about Accounts",
17618     "examples": [
17619       {
17620         "title": "Example usage:",
17621         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17622         "type": "json"
17623       }
17624     ],
17625     "name": "DescribeAccounts",
17626     "group": "Openchannel_Accounts",
17627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17628     "version": "0.0.0",
17629     "filename": "server/api/openchannelAccount/index.js",
17630     "groupTitle": "Openchannel_Accounts"
17631   },
17632   {
17633     "type": "get",
17634     "url": "/api/openchannel/accounts",
17635     "title": "Gets a list of Accounts",
17636     "examples": [
17637       {
17638         "title": "Example usage:",
17639         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17640         "type": "json"
17641       }
17642     ],
17643     "name": "GetAccounts",
17644     "group": "Openchannel_Accounts",
17645     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17646     "version": "0.0.0",
17647     "filename": "server/api/openchannelAccount/index.js",
17648     "groupTitle": "Openchannel_Accounts"
17649   },
17650   {
17651     "type": "get",
17652     "url": "/api/openchannel/accounts/{id}/users",
17653     "title": "Gets agents from openchannel account",
17654     "examples": [
17655       {
17656         "title": "Example usage:",
17657         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17658         "type": "json"
17659       }
17660     ],
17661     "name": "GetAgents",
17662     "group": "Openchannel_Accounts",
17663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664     "version": "0.0.0",
17665     "filename": "server/api/openchannelAccount/index.js",
17666     "groupTitle": "Openchannel_Accounts"
17667   },
17668   {
17669     "type": "delete",
17670     "url": "/api/openchannel/accounts/{id}/users",
17671     "title": "Removes agents from a openchannel account",
17672     "examples": [
17673       {
17674         "title": "Example usage:",
17675         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17676         "type": "json"
17677       }
17678     ],
17679     "name": "RemoveAgents",
17680     "group": "Openchannel_Accounts",
17681     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17682     "version": "0.0.0",
17683     "filename": "server/api/openchannelAccount/index.js",
17684     "groupTitle": "Openchannel_Accounts"
17685   },
17686   {
17687     "type": "delete",
17688     "url": "/api/openchannel/accounts/{id}/canned_answers",
17689     "title": "Removes canned answers from account",
17690     "examples": [
17691       {
17692         "title": "Example usage:",
17693         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17694         "type": "json"
17695       }
17696     ],
17697     "name": "RemoveAnswers",
17698     "group": "Openchannel_Accounts",
17699     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17700     "version": "0.0.0",
17701     "filename": "server/api/openchannelAccount/index.js",
17702     "groupTitle": "Openchannel_Accounts"
17703   },
17704   {
17705     "type": "delete",
17706     "url": "/api/openchannel/accounts/{id}/dispositions",
17707     "title": "Removes dispositions from account",
17708     "examples": [
17709       {
17710         "title": "Example usage:",
17711         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17712         "type": "json"
17713       }
17714     ],
17715     "name": "RemoveDispositions",
17716     "group": "Openchannel_Accounts",
17717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17718     "version": "0.0.0",
17719     "filename": "server/api/openchannelAccount/index.js",
17720     "groupTitle": "Openchannel_Accounts"
17721   },
17722   {
17723     "type": "get",
17724     "url": "/api/openchannel/accounts/{id}",
17725     "title": "Gets a single Account",
17726     "examples": [
17727       {
17728         "title": "Example usage:",
17729         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17730         "type": "json"
17731       }
17732     ],
17733     "name": "ShowAccounts",
17734     "group": "Openchannel_Accounts",
17735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17736     "version": "0.0.0",
17737     "filename": "server/api/openchannelAccount/index.js",
17738     "groupTitle": "Openchannel_Accounts"
17739   },
17740   {
17741     "type": "post",
17742     "url": "/api/openchannel/accounts/{id}/canned_answers",
17743     "title": "Creates new canned answer",
17744     "examples": [
17745       {
17746         "title": "Example usage:",
17747         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17748         "type": "json"
17749       }
17750     ],
17751     "name": "addAnswer",
17752     "group": "Openchannel_Accounts",
17753     "parameter": {
17754       "fields": {
17755         "Body": [
17756           {
17757             "group": "Body",
17758             "type": "String",
17759             "optional": false,
17760             "field": "key",
17761             "description": ""
17762           },
17763           {
17764             "group": "Body",
17765             "type": "Text",
17766             "optional": false,
17767             "field": "value",
17768             "description": ""
17769           },
17770           {
17771             "group": "Body",
17772             "type": "String",
17773             "optional": true,
17774             "field": "description",
17775             "description": ""
17776           },
17777           {
17778             "group": "Body",
17779             "type": "Virtual",
17780             "optional": true,
17781             "field": "name",
17782             "description": ""
17783           }
17784         ]
17785       }
17786     },
17787     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17788     "version": "0.0.0",
17789     "filename": "server/api/openchannelAccount/index.js",
17790     "groupTitle": "Openchannel_Accounts"
17791   },
17792   {
17793     "type": "post",
17794     "url": "/api/openchannel/accounts/{id}/applications",
17795     "title": "Creates new applications",
17796     "examples": [
17797       {
17798         "title": "Example usage:",
17799         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17800         "type": "json"
17801       }
17802     ],
17803     "name": "addApplications",
17804     "group": "Openchannel_Accounts",
17805     "parameter": {
17806       "fields": {
17807         "Body": [
17808           {
17809             "group": "Body",
17810             "type": "Integer",
17811             "optional": false,
17812             "field": "priority",
17813             "description": ""
17814           },
17815           {
17816             "group": "Body",
17817             "type": "String",
17818             "optional": false,
17819             "field": "app",
17820             "description": ""
17821           },
17822           {
17823             "group": "Body",
17824             "type": "Text",
17825             "optional": true,
17826             "field": "appdata",
17827             "description": ""
17828           },
17829           {
17830             "group": "Body",
17831             "type": "String",
17832             "optional": true,
17833             "field": "description",
17834             "description": ""
17835           },
17836           {
17837             "group": "Body",
17838             "type": "String",
17839             "optional": true,
17840             "field": "interval",
17841             "description": ""
17842           }
17843         ]
17844       }
17845     },
17846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17847     "version": "0.0.0",
17848     "filename": "server/api/openchannelAccount/index.js",
17849     "groupTitle": "Openchannel_Accounts"
17850   },
17851   {
17852     "type": "post",
17853     "url": "/api/openchannel/accounts/{id}/dispositions",
17854     "title": "Creates new disposition",
17855     "examples": [
17856       {
17857         "title": "Example usage:",
17858         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17859         "type": "json"
17860       }
17861     ],
17862     "name": "addDisposition",
17863     "group": "Openchannel_Accounts",
17864     "parameter": {
17865       "fields": {
17866         "Body": [
17867           {
17868             "group": "Body",
17869             "type": "String",
17870             "optional": false,
17871             "field": "name",
17872             "description": ""
17873           },
17874           {
17875             "group": "Body",
17876             "type": "String",
17877             "allowedValues": [
17878               "\"first\"",
17879               "\"second\"",
17880               "\"third\""
17881             ],
17882             "optional": false,
17883             "field": "level",
17884             "description": ""
17885           },
17886           {
17887             "group": "Body",
17888             "type": "String",
17889             "optional": true,
17890             "field": "description",
17891             "description": ""
17892           }
17893         ]
17894       }
17895     },
17896     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17897     "version": "0.0.0",
17898     "filename": "server/api/openchannelAccount/index.js",
17899     "groupTitle": "Openchannel_Accounts"
17900   },
17901   {
17902     "type": "get",
17903     "url": "/api/openchannel/accounts/{id}/canned_answers",
17904     "title": "Gets account canned answers",
17905     "examples": [
17906       {
17907         "title": "Example usage:",
17908         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17909         "type": "json"
17910       }
17911     ],
17912     "name": "getAnswers",
17913     "group": "Openchannel_Accounts",
17914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17915     "version": "0.0.0",
17916     "filename": "server/api/openchannelAccount/index.js",
17917     "groupTitle": "Openchannel_Accounts"
17918   },
17919   {
17920     "type": "get",
17921     "url": "/api/openchannel/accounts/{id}/applications",
17922     "title": "Gets account applications",
17923     "examples": [
17924       {
17925         "title": "Example usage:",
17926         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17927         "type": "json"
17928       }
17929     ],
17930     "name": "getApplications",
17931     "group": "Openchannel_Accounts",
17932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17933     "version": "0.0.0",
17934     "filename": "server/api/openchannelAccount/index.js",
17935     "groupTitle": "Openchannel_Accounts"
17936   },
17937   {
17938     "type": "get",
17939     "url": "/api/openchannel/accounts/{id}/dispositions",
17940     "title": "Gets account dispositions",
17941     "examples": [
17942       {
17943         "title": "Example usage:",
17944         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17945         "type": "json"
17946       }
17947     ],
17948     "name": "getDispositions",
17949     "group": "Openchannel_Accounts",
17950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17951     "version": "0.0.0",
17952     "filename": "server/api/openchannelAccount/index.js",
17953     "groupTitle": "Openchannel_Accounts"
17954   },
17955   {
17956     "type": "get",
17957     "url": "/api/openchannel/accounts/{id}/interactions",
17958     "title": "Gets Openchannel Account Interactions",
17959     "examples": [
17960       {
17961         "title": "Example usage:",
17962         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17963         "type": "json"
17964       }
17965     ],
17966     "name": "getInteractions",
17967     "group": "Openchannel_Accounts",
17968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17969     "version": "0.0.0",
17970     "filename": "server/api/openchannelAccount/index.js",
17971     "groupTitle": "Openchannel_Accounts"
17972   },
17973   {
17974     "type": "post",
17975     "url": "/api/openchannel/accounts/{id}/notify",
17976     "title": "Notify new message",
17977     "examples": [
17978       {
17979         "title": "Example usage:",
17980         "content": "curl https://{domain}/api/openchannel/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17981         "type": "json"
17982       }
17983     ],
17984     "name": "notify",
17985     "group": "Openchannel_Accounts",
17986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
17987     "version": "0.0.0",
17988     "filename": "server/api/openchannelAccount/index.js",
17989     "groupTitle": "Openchannel_Accounts"
17990   },
17991   {
17992     "type": "post",
17993     "url": "/api/openchannel/accounts/{id}/send",
17994     "title": "Send new openchannel message",
17995     "examples": [
17996       {
17997         "title": "Example usage:",
17998         "content": "curl https://{domain}/api/openchannel/accounts/{id}/send -d '{from: 'John Doe', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17999         "type": "json"
18000       }
18001     ],
18002     "name": "sendOpenchannel",
18003     "group": "Openchannel_Accounts",
18004     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18005     "version": "0.0.0",
18006     "filename": "server/api/openchannelAccount/index.js",
18007     "groupTitle": "Openchannel_Accounts"
18008   },
18009   {
18010     "type": "put",
18011     "url": "/api/openchannel/accounts/{id}",
18012     "title": "Update an existing Account",
18013     "examples": [
18014       {
18015         "title": "Example usage:",
18016         "content": "curl https://{domain}/api/openchannel/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18017         "type": "json"
18018       }
18019     ],
18020     "name": "updateAccounts",
18021     "group": "Openchannel_Accounts",
18022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18023     "version": "0.0.0",
18024     "filename": "server/api/openchannelAccount/index.js",
18025     "groupTitle": "Openchannel_Accounts"
18026   },
18027   {
18028     "type": "post",
18029     "url": "/api/openchannel/applications",
18030     "title": "Creates a new Application",
18031     "examples": [
18032       {
18033         "title": "Example usage:",
18034         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18035         "type": "json"
18036       }
18037     ],
18038     "name": "CreateApplications",
18039     "group": "Openchannel_Applications",
18040     "parameter": {
18041       "fields": {
18042         "Body": [
18043           {
18044             "group": "Body",
18045             "type": "Integer",
18046             "optional": false,
18047             "field": "priority",
18048             "description": ""
18049           },
18050           {
18051             "group": "Body",
18052             "type": "String",
18053             "optional": false,
18054             "field": "app",
18055             "description": ""
18056           },
18057           {
18058             "group": "Body",
18059             "type": "Text",
18060             "optional": true,
18061             "field": "appdata",
18062             "description": ""
18063           },
18064           {
18065             "group": "Body",
18066             "type": "String",
18067             "optional": true,
18068             "field": "description",
18069             "description": ""
18070           },
18071           {
18072             "group": "Body",
18073             "type": "String",
18074             "optional": true,
18075             "field": "interval",
18076             "description": ""
18077           }
18078         ]
18079       }
18080     },
18081     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18082     "version": "0.0.0",
18083     "filename": "server/api/openchannelApplication/index.js",
18084     "groupTitle": "Openchannel_Applications"
18085   },
18086   {
18087     "type": "delete",
18088     "url": "/api/openchannel/applications/{id}",
18089     "title": "Deletes a Application",
18090     "examples": [
18091       {
18092         "title": "Example usage:",
18093         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18094         "type": "json"
18095       }
18096     ],
18097     "name": "DeleteApplications",
18098     "group": "Openchannel_Applications",
18099     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18100     "version": "0.0.0",
18101     "filename": "server/api/openchannelApplication/index.js",
18102     "groupTitle": "Openchannel_Applications"
18103   },
18104   {
18105     "type": "get",
18106     "url": "/api/openchannel/applications",
18107     "title": "Gets a list of Applications",
18108     "examples": [
18109       {
18110         "title": "Example usage:",
18111         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18112         "type": "json"
18113       }
18114     ],
18115     "name": "GetApplications",
18116     "group": "Openchannel_Applications",
18117     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18118     "version": "0.0.0",
18119     "filename": "server/api/openchannelApplication/index.js",
18120     "groupTitle": "Openchannel_Applications"
18121   },
18122   {
18123     "type": "get",
18124     "url": "/api/openchannel/applications/{id}",
18125     "title": "Gets a single Application",
18126     "examples": [
18127       {
18128         "title": "Example usage:",
18129         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18130         "type": "json"
18131       }
18132     ],
18133     "name": "ShowApplications",
18134     "group": "Openchannel_Applications",
18135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18136     "version": "0.0.0",
18137     "filename": "server/api/openchannelApplication/index.js",
18138     "groupTitle": "Openchannel_Applications"
18139   },
18140   {
18141     "type": "put",
18142     "url": "/api/openchannel/applications/{id}",
18143     "title": "Update an existing Application",
18144     "examples": [
18145       {
18146         "title": "Example usage:",
18147         "content": "curl https://{domain}/api/openchannel/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18148         "type": "json"
18149       }
18150     ],
18151     "name": "updateApplications",
18152     "group": "Openchannel_Applications",
18153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18154     "version": "0.0.0",
18155     "filename": "server/api/openchannelApplication/index.js",
18156     "groupTitle": "Openchannel_Applications"
18157   },
18158   {
18159     "type": "post",
18160     "url": "/api/openchannel/interactions/{id}/tags",
18161     "title": "Add tags to the interaction",
18162     "examples": [
18163       {
18164         "title": "Example usage:",
18165         "content": "curl https://{domain}/api/openchannel/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18166         "type": "json"
18167       }
18168     ],
18169     "name": "AddTags",
18170     "group": "Openchannel_Interactions",
18171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172     "version": "0.0.0",
18173     "filename": "server/api/openchannelInteraction/index.js",
18174     "groupTitle": "Openchannel_Interactions"
18175   },
18176   {
18177     "type": "post",
18178     "url": "/api/openchannel/interactions",
18179     "title": "Creates a new Interaction",
18180     "examples": [
18181       {
18182         "title": "Example usage:",
18183         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18184         "type": "json"
18185       }
18186     ],
18187     "name": "CreateInteractions",
18188     "group": "Openchannel_Interactions",
18189     "parameter": {
18190       "fields": {
18191         "Body": [
18192           {
18193             "group": "Body",
18194             "type": "Boolean",
18195             "optional": true,
18196             "field": "closed",
18197             "description": ""
18198           },
18199           {
18200             "group": "Body",
18201             "type": "String",
18202             "optional": true,
18203             "field": "closedAt",
18204             "description": ""
18205           },
18206           {
18207             "group": "Body",
18208             "type": "String",
18209             "optional": true,
18210             "field": "disposition",
18211             "description": ""
18212           },
18213           {
18214             "group": "Body",
18215             "type": "String",
18216             "optional": true,
18217             "field": "secondDisposition",
18218             "description": ""
18219           },
18220           {
18221             "group": "Body",
18222             "type": "String",
18223             "optional": true,
18224             "field": "thirdDisposition",
18225             "description": ""
18226           },
18227           {
18228             "group": "Body",
18229             "type": "String",
18230             "optional": true,
18231             "field": "note",
18232             "description": ""
18233           },
18234           {
18235             "group": "Body",
18236             "type": "String",
18237             "optional": true,
18238             "field": "read1stAt",
18239             "description": ""
18240           },
18241           {
18242             "group": "Body",
18243             "type": "String",
18244             "optional": true,
18245             "field": "threadId",
18246             "description": ""
18247           },
18248           {
18249             "group": "Body",
18250             "type": "String",
18251             "optional": true,
18252             "field": "externalUrl",
18253             "description": ""
18254           },
18255           {
18256             "group": "Body",
18257             "type": "String",
18258             "optional": true,
18259             "field": "lastMsgAt",
18260             "description": ""
18261           },
18262           {
18263             "group": "Body",
18264             "type": "String",
18265             "allowedValues": [
18266               "\"in\"",
18267               "\"out\""
18268             ],
18269             "optional": false,
18270             "field": "lastMsgDirection",
18271             "description": ""
18272           },
18273           {
18274             "group": "Body",
18275             "type": "String",
18276             "optional": true,
18277             "field": "from",
18278             "description": ""
18279           },
18280           {
18281             "group": "Body",
18282             "type": "Boolean",
18283             "optional": true,
18284             "field": "autoreplyExecuted",
18285             "description": ""
18286           }
18287         ]
18288       }
18289     },
18290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18291     "version": "0.0.0",
18292     "filename": "server/api/openchannelInteraction/index.js",
18293     "groupTitle": "Openchannel_Interactions"
18294   },
18295   {
18296     "type": "delete",
18297     "url": "/api/openchannel/interactions/{id}",
18298     "title": "Deletes a Interaction",
18299     "examples": [
18300       {
18301         "title": "Example usage:",
18302         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18303         "type": "json"
18304       }
18305     ],
18306     "name": "DeleteInteractions",
18307     "group": "Openchannel_Interactions",
18308     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18309     "version": "0.0.0",
18310     "filename": "server/api/openchannelInteraction/index.js",
18311     "groupTitle": "Openchannel_Interactions"
18312   },
18313   {
18314     "type": "get",
18315     "url": "/api/openchannel/interactions/describe",
18316     "title": "Gets table info about Interactions",
18317     "examples": [
18318       {
18319         "title": "Example usage:",
18320         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18321         "type": "json"
18322       }
18323     ],
18324     "name": "DescribeInteractions",
18325     "group": "Openchannel_Interactions",
18326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18327     "version": "0.0.0",
18328     "filename": "server/api/openchannelInteraction/index.js",
18329     "groupTitle": "Openchannel_Interactions"
18330   },
18331   {
18332     "type": "get",
18333     "url": "/api/openchannel/interactions",
18334     "title": "Gets a list of Interactions",
18335     "examples": [
18336       {
18337         "title": "Example usage:",
18338         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18339         "type": "json"
18340       }
18341     ],
18342     "name": "GetInteractions",
18343     "group": "Openchannel_Interactions",
18344     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18345     "version": "0.0.0",
18346     "filename": "server/api/openchannelInteraction/index.js",
18347     "groupTitle": "Openchannel_Interactions"
18348   },
18349   {
18350     "type": "delete",
18351     "url": "/api/openchannel/interactions/{id}/tags",
18352     "title": "Removes tags from interaction",
18353     "examples": [
18354       {
18355         "title": "Example usage:",
18356         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18357         "type": "json"
18358       }
18359     ],
18360     "name": "RemoveTags",
18361     "group": "Openchannel_Interactions",
18362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18363     "version": "0.0.0",
18364     "filename": "server/api/openchannelInteraction/index.js",
18365     "groupTitle": "Openchannel_Interactions"
18366   },
18367   {
18368     "type": "get",
18369     "url": "/api/openchannel/interactions/{id}",
18370     "title": "Gets a single Interaction",
18371     "examples": [
18372       {
18373         "title": "Example usage:",
18374         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18375         "type": "json"
18376       }
18377     ],
18378     "name": "ShowInteractions",
18379     "group": "Openchannel_Interactions",
18380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18381     "version": "0.0.0",
18382     "filename": "server/api/openchannelInteraction/index.js",
18383     "groupTitle": "Openchannel_Interactions"
18384   },
18385   {
18386     "type": "post",
18387     "url": "/api/openchannel/interactions/{id}/messages",
18388     "title": "Creates new messages",
18389     "examples": [
18390       {
18391         "title": "Example usage:",
18392         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18393         "type": "json"
18394       }
18395     ],
18396     "name": "addMessage",
18397     "group": "Openchannel_Interactions",
18398     "parameter": {
18399       "fields": {
18400         "Body": [
18401           {
18402             "group": "Body",
18403             "type": "Text",
18404             "optional": false,
18405             "field": "body",
18406             "description": ""
18407           },
18408           {
18409             "group": "Body",
18410             "type": "Boolean",
18411             "optional": true,
18412             "field": "read",
18413             "description": ""
18414           },
18415           {
18416             "group": "Body",
18417             "type": "Boolean",
18418             "optional": true,
18419             "field": "secret",
18420             "description": ""
18421           },
18422           {
18423             "group": "Body",
18424             "type": "String",
18425             "allowedValues": [
18426               "\"in\"",
18427               "\"out\""
18428             ],
18429             "optional": false,
18430             "field": "direction",
18431             "description": ""
18432           },
18433           {
18434             "group": "Body",
18435             "type": "String",
18436             "optional": true,
18437             "field": "readAt",
18438             "description": ""
18439           },
18440           {
18441             "group": "Body",
18442             "type": "String",
18443             "optional": true,
18444             "field": "providerName",
18445             "description": ""
18446           },
18447           {
18448             "group": "Body",
18449             "type": "Text",
18450             "optional": true,
18451             "field": "providerResponse",
18452             "description": ""
18453           }
18454         ]
18455       }
18456     },
18457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18458     "version": "0.0.0",
18459     "filename": "server/api/openchannelInteraction/index.js",
18460     "groupTitle": "Openchannel_Interactions"
18461   },
18462   {
18463     "type": "get",
18464     "url": "/api/openchannel/interactions/{id}/download",
18465     "title": "Gets interaction",
18466     "examples": [
18467       {
18468         "title": "Example usage:",
18469         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18470         "type": "json"
18471       }
18472     ],
18473     "name": "download",
18474     "group": "Openchannel_Interactions",
18475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18476     "version": "0.0.0",
18477     "filename": "server/api/openchannelInteraction/index.js",
18478     "groupTitle": "Openchannel_Interactions"
18479   },
18480   {
18481     "type": "get",
18482     "url": "/api/openchannel/interactions/{id}/messages",
18483     "title": "Gets interaction messages",
18484     "examples": [
18485       {
18486         "title": "Example usage:",
18487         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18488         "type": "json"
18489       }
18490     ],
18491     "name": "getMessages",
18492     "group": "Openchannel_Interactions",
18493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18494     "version": "0.0.0",
18495     "filename": "server/api/openchannelInteraction/index.js",
18496     "groupTitle": "Openchannel_Interactions"
18497   },
18498   {
18499     "type": "put",
18500     "url": "/api/openchannel/interactions/{id}",
18501     "title": "Update an existing Interaction",
18502     "examples": [
18503       {
18504         "title": "Example usage:",
18505         "content": "curl https://{domain}/api/openchannel/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18506         "type": "json"
18507       }
18508     ],
18509     "name": "updateInteractions",
18510     "group": "Openchannel_Interactions",
18511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18512     "version": "0.0.0",
18513     "filename": "server/api/openchannelInteraction/index.js",
18514     "groupTitle": "Openchannel_Interactions"
18515   },
18516   {
18517     "type": "post",
18518     "url": "/api/openchannel/messages",
18519     "title": "Creates a new Message",
18520     "examples": [
18521       {
18522         "title": "Example usage:",
18523         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18524         "type": "json"
18525       }
18526     ],
18527     "name": "CreateMessages",
18528     "group": "Openchannel_Messages",
18529     "parameter": {
18530       "fields": {
18531         "Body": [
18532           {
18533             "group": "Body",
18534             "type": "Text",
18535             "optional": false,
18536             "field": "body",
18537             "description": ""
18538           },
18539           {
18540             "group": "Body",
18541             "type": "Boolean",
18542             "optional": true,
18543             "field": "read",
18544             "description": ""
18545           },
18546           {
18547             "group": "Body",
18548             "type": "Boolean",
18549             "optional": true,
18550             "field": "secret",
18551             "description": ""
18552           },
18553           {
18554             "group": "Body",
18555             "type": "String",
18556             "allowedValues": [
18557               "\"in\"",
18558               "\"out\""
18559             ],
18560             "optional": false,
18561             "field": "direction",
18562             "description": ""
18563           },
18564           {
18565             "group": "Body",
18566             "type": "String",
18567             "optional": true,
18568             "field": "readAt",
18569             "description": ""
18570           },
18571           {
18572             "group": "Body",
18573             "type": "String",
18574             "optional": true,
18575             "field": "providerName",
18576             "description": ""
18577           },
18578           {
18579             "group": "Body",
18580             "type": "Text",
18581             "optional": true,
18582             "field": "providerResponse",
18583             "description": ""
18584           }
18585         ]
18586       }
18587     },
18588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18589     "version": "0.0.0",
18590     "filename": "server/api/openchannelMessage/index.js",
18591     "groupTitle": "Openchannel_Messages"
18592   },
18593   {
18594     "type": "delete",
18595     "url": "/api/openchannel/messages/{id}",
18596     "title": "Deletes a Message",
18597     "examples": [
18598       {
18599         "title": "Example usage:",
18600         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18601         "type": "json"
18602       }
18603     ],
18604     "name": "DeleteMessages",
18605     "group": "Openchannel_Messages",
18606     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18607     "version": "0.0.0",
18608     "filename": "server/api/openchannelMessage/index.js",
18609     "groupTitle": "Openchannel_Messages"
18610   },
18611   {
18612     "type": "get",
18613     "url": "/api/openchannel/messages/describe",
18614     "title": "Gets table info about Messages",
18615     "examples": [
18616       {
18617         "title": "Example usage:",
18618         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18619         "type": "json"
18620       }
18621     ],
18622     "name": "DescribeMessages",
18623     "group": "Openchannel_Messages",
18624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18625     "version": "0.0.0",
18626     "filename": "server/api/openchannelMessage/index.js",
18627     "groupTitle": "Openchannel_Messages"
18628   },
18629   {
18630     "type": "get",
18631     "url": "/api/openchannel/messages",
18632     "title": "Gets a list of Messages",
18633     "examples": [
18634       {
18635         "title": "Example usage:",
18636         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18637         "type": "json"
18638       }
18639     ],
18640     "name": "GetMessages",
18641     "group": "Openchannel_Messages",
18642     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18643     "version": "0.0.0",
18644     "filename": "server/api/openchannelMessage/index.js",
18645     "groupTitle": "Openchannel_Messages"
18646   },
18647   {
18648     "type": "get",
18649     "url": "/api/openchannel/messages/{id}",
18650     "title": "Gets a single Message",
18651     "examples": [
18652       {
18653         "title": "Example usage:",
18654         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18655         "type": "json"
18656       }
18657     ],
18658     "name": "ShowMessages",
18659     "group": "Openchannel_Messages",
18660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18661     "version": "0.0.0",
18662     "filename": "server/api/openchannelMessage/index.js",
18663     "groupTitle": "Openchannel_Messages"
18664   },
18665   {
18666     "type": "put",
18667     "url": "/api/openchannel/messages/{id}/accept",
18668     "title": "Accepts message",
18669     "examples": [
18670       {
18671         "title": "Example usage:",
18672         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18673         "type": "json"
18674       }
18675     ],
18676     "name": "acceptMessage",
18677     "group": "Openchannel_Messages",
18678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18679     "version": "0.0.0",
18680     "filename": "server/api/openchannelMessage/index.js",
18681     "groupTitle": "Openchannel_Messages"
18682   },
18683   {
18684     "type": "put",
18685     "url": "/api/openchannel/messages/{id}/reject",
18686     "title": "Rejects message",
18687     "examples": [
18688       {
18689         "title": "Example usage:",
18690         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18691         "type": "json"
18692       }
18693     ],
18694     "name": "rejectMessage",
18695     "group": "Openchannel_Messages",
18696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18697     "version": "0.0.0",
18698     "filename": "server/api/openchannelMessage/index.js",
18699     "groupTitle": "Openchannel_Messages"
18700   },
18701   {
18702     "type": "put",
18703     "url": "/api/openchannel/messages/{id}",
18704     "title": "Update an existing Message",
18705     "examples": [
18706       {
18707         "title": "Example usage:",
18708         "content": "curl https://{domain}/api/openchannel/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18709         "type": "json"
18710       }
18711     ],
18712     "name": "updateMessages",
18713     "group": "Openchannel_Messages",
18714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18715     "version": "0.0.0",
18716     "filename": "server/api/openchannelMessage/index.js",
18717     "groupTitle": "Openchannel_Messages"
18718   },
18719   {
18720     "type": "post",
18721     "url": "/api/openchannel/reports/queue",
18722     "title": "Creates a new Openchannel Queue Report",
18723     "examples": [
18724       {
18725         "title": "Example usage:",
18726         "content": "curl https://{domain}/api/openchannel/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18727         "type": "json"
18728       }
18729     ],
18730     "name": "CreateOpenchannel_Queue_Reports",
18731     "group": "Openchannel_Queue_Reports",
18732     "parameter": {
18733       "fields": {
18734         "Body": [
18735           {
18736             "group": "Body",
18737             "type": "String",
18738             "optional": false,
18739             "field": "uniqueid",
18740             "description": ""
18741           },
18742           {
18743             "group": "Body",
18744             "type": "String",
18745             "optional": true,
18746             "field": "from",
18747             "description": ""
18748           },
18749           {
18750             "group": "Body",
18751             "type": "String",
18752             "optional": true,
18753             "field": "joinAt",
18754             "description": ""
18755           },
18756           {
18757             "group": "Body",
18758             "type": "String",
18759             "optional": true,
18760             "field": "leaveAt",
18761             "description": ""
18762           },
18763           {
18764             "group": "Body",
18765             "type": "String",
18766             "optional": true,
18767             "field": "acceptAt",
18768             "description": ""
18769           },
18770           {
18771             "group": "Body",
18772             "type": "String",
18773             "optional": true,
18774             "field": "exitAt",
18775             "description": ""
18776           },
18777           {
18778             "group": "Body",
18779             "type": "String",
18780             "optional": true,
18781             "field": "reason",
18782             "description": ""
18783           }
18784         ]
18785       }
18786     },
18787     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18788     "version": "0.0.0",
18789     "filename": "server/api/openchannelQueueReport/index.js",
18790     "groupTitle": "Openchannel_Queue_Reports"
18791   },
18792   {
18793     "type": "delete",
18794     "url": "/api/openchannel/reports/queue/{id}",
18795     "title": "Deletes a Openchannel Queue Report",
18796     "examples": [
18797       {
18798         "title": "Example usage:",
18799         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18800         "type": "json"
18801       }
18802     ],
18803     "name": "DeleteOpenchannel_Queue_Reports",
18804     "group": "Openchannel_Queue_Reports",
18805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18806     "version": "0.0.0",
18807     "filename": "server/api/openchannelQueueReport/index.js",
18808     "groupTitle": "Openchannel_Queue_Reports"
18809   },
18810   {
18811     "type": "get",
18812     "url": "/api/openchannel/reports/queue/describe",
18813     "title": "Gets table info about Openchannel Queue Reports",
18814     "examples": [
18815       {
18816         "title": "Example usage:",
18817         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18818         "type": "json"
18819       }
18820     ],
18821     "name": "DescribeOpenchannel_Queue_Reports",
18822     "group": "Openchannel_Queue_Reports",
18823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18824     "version": "0.0.0",
18825     "filename": "server/api/openchannelQueueReport/index.js",
18826     "groupTitle": "Openchannel_Queue_Reports"
18827   },
18828   {
18829     "type": "get",
18830     "url": "/api/openchannel/reports/queue",
18831     "title": "Gets a list of Openchannel Queue Reports",
18832     "examples": [
18833       {
18834         "title": "Example usage:",
18835         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18836         "type": "json"
18837       }
18838     ],
18839     "name": "GetOpenchannel_Queue_Reports",
18840     "group": "Openchannel_Queue_Reports",
18841     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18842     "version": "0.0.0",
18843     "filename": "server/api/openchannelQueueReport/index.js",
18844     "groupTitle": "Openchannel_Queue_Reports"
18845   },
18846   {
18847     "type": "get",
18848     "url": "/api/openchannel/reports/queue/{id}",
18849     "title": "Gets a single Openchannel Queue Report",
18850     "examples": [
18851       {
18852         "title": "Example usage:",
18853         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18854         "type": "json"
18855       }
18856     ],
18857     "name": "ShowOpenchannel_Queue_Reports",
18858     "group": "Openchannel_Queue_Reports",
18859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18860     "version": "0.0.0",
18861     "filename": "server/api/openchannelQueueReport/index.js",
18862     "groupTitle": "Openchannel_Queue_Reports"
18863   },
18864   {
18865     "type": "put",
18866     "url": "/api/openchannel/reports/queue/{id}",
18867     "title": "Update an existing Openchannel Queue Report",
18868     "examples": [
18869       {
18870         "title": "Example usage:",
18871         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18872         "type": "json"
18873       }
18874     ],
18875     "name": "updateOpenchannel_Queue_Reports",
18876     "group": "Openchannel_Queue_Reports",
18877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18878     "version": "0.0.0",
18879     "filename": "server/api/openchannelQueueReport/index.js",
18880     "groupTitle": "Openchannel_Queue_Reports"
18881   },
18882   {
18883     "type": "post",
18884     "url": "/api/openchannel/queues/{id}/users",
18885     "title": "Add agents to a queue",
18886     "examples": [
18887       {
18888         "title": "Example usage:",
18889         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18890         "type": "json"
18891       }
18892     ],
18893     "name": "AddAgents",
18894     "group": "Openchannel_Queues",
18895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18896     "version": "0.0.0",
18897     "filename": "server/api/openchannelQueue/index.js",
18898     "groupTitle": "Openchannel_Queues"
18899   },
18900   {
18901     "type": "post",
18902     "url": "/api/openchannel/queues/{id}/teams",
18903     "title": "Add teams to a queue",
18904     "examples": [
18905       {
18906         "title": "Example usage:",
18907         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18908         "type": "json"
18909       }
18910     ],
18911     "name": "AddTeams",
18912     "group": "Openchannel_Queues",
18913     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18914     "version": "0.0.0",
18915     "filename": "server/api/openchannelQueue/index.js",
18916     "groupTitle": "Openchannel_Queues"
18917   },
18918   {
18919     "type": "post",
18920     "url": "/api/openchannel/queues",
18921     "title": "Creates a new Queue",
18922     "examples": [
18923       {
18924         "title": "Example usage:",
18925         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18926         "type": "json"
18927       }
18928     ],
18929     "name": "CreateQueues",
18930     "group": "Openchannel_Queues",
18931     "parameter": {
18932       "fields": {
18933         "Body": [
18934           {
18935             "group": "Body",
18936             "type": "String",
18937             "optional": true,
18938             "field": "name",
18939             "description": ""
18940           },
18941           {
18942             "group": "Body",
18943             "type": "String",
18944             "optional": true,
18945             "field": "description",
18946             "description": ""
18947           },
18948           {
18949             "group": "Body",
18950             "type": "Integer",
18951             "optional": true,
18952             "field": "timeout",
18953             "description": ""
18954           },
18955           {
18956             "group": "Body",
18957             "type": "String",
18958             "allowedValues": [
18959               "\"rrmemory\"",
18960               "\"beepall\"",
18961               "\"roundrobin\""
18962             ],
18963             "optional": true,
18964             "field": "strategy",
18965             "description": ""
18966           }
18967         ]
18968       }
18969     },
18970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18971     "version": "0.0.0",
18972     "filename": "server/api/openchannelQueue/index.js",
18973     "groupTitle": "Openchannel_Queues"
18974   },
18975   {
18976     "type": "delete",
18977     "url": "/api/openchannel/queues/{id}",
18978     "title": "Deletes a Queue",
18979     "examples": [
18980       {
18981         "title": "Example usage:",
18982         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18983         "type": "json"
18984       }
18985     ],
18986     "name": "DeleteQueues",
18987     "group": "Openchannel_Queues",
18988     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18989     "version": "0.0.0",
18990     "filename": "server/api/openchannelQueue/index.js",
18991     "groupTitle": "Openchannel_Queues"
18992   },
18993   {
18994     "type": "get",
18995     "url": "/api/openchannel/queues/describe",
18996     "title": "Gets table info about Queues",
18997     "examples": [
18998       {
18999         "title": "Example usage:",
19000         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19001         "type": "json"
19002       }
19003     ],
19004     "name": "DescribeQueues",
19005     "group": "Openchannel_Queues",
19006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19007     "version": "0.0.0",
19008     "filename": "server/api/openchannelQueue/index.js",
19009     "groupTitle": "Openchannel_Queues"
19010   },
19011   {
19012     "type": "get",
19013     "url": "/api/openchannel/queues/{id}/users",
19014     "title": "Gets queue agents",
19015     "examples": [
19016       {
19017         "title": "Example usage:",
19018         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19019         "type": "json"
19020       }
19021     ],
19022     "name": "GetAgents",
19023     "group": "Openchannel_Queues",
19024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19025     "version": "0.0.0",
19026     "filename": "server/api/openchannelQueue/index.js",
19027     "groupTitle": "Openchannel_Queues"
19028   },
19029   {
19030     "type": "get",
19031     "url": "/api/openchannel/queues/{id}/members",
19032     "title": "GetMembers",
19033     "examples": [
19034       {
19035         "title": "Example usage:",
19036         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19037         "type": "json"
19038       }
19039     ],
19040     "name": "GetMembers",
19041     "group": "Openchannel_Queues",
19042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19043     "version": "0.0.0",
19044     "filename": "server/api/openchannelQueue/index.js",
19045     "groupTitle": "Openchannel_Queues"
19046   },
19047   {
19048     "type": "get",
19049     "url": "/api/openchannel/queues",
19050     "title": "Gets a list of Queues",
19051     "examples": [
19052       {
19053         "title": "Example usage:",
19054         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19055         "type": "json"
19056       }
19057     ],
19058     "name": "GetQueues",
19059     "group": "Openchannel_Queues",
19060     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19061     "version": "0.0.0",
19062     "filename": "server/api/openchannelQueue/index.js",
19063     "groupTitle": "Openchannel_Queues"
19064   },
19065   {
19066     "type": "get",
19067     "url": "/api/openchannel/queues/{id}/teams",
19068     "title": "Gets queues list",
19069     "examples": [
19070       {
19071         "title": "Example usage:",
19072         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19073         "type": "json"
19074       }
19075     ],
19076     "name": "GetTeams",
19077     "group": "Openchannel_Queues",
19078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19079     "version": "0.0.0",
19080     "filename": "server/api/openchannelQueue/index.js",
19081     "groupTitle": "Openchannel_Queues"
19082   },
19083   {
19084     "type": "delete",
19085     "url": "/api/openchannel/queues/{id}/users",
19086     "title": "Removes agents from a queue",
19087     "examples": [
19088       {
19089         "title": "Example usage:",
19090         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19091         "type": "json"
19092       }
19093     ],
19094     "name": "RemoveAgents",
19095     "group": "Openchannel_Queues",
19096     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19097     "version": "0.0.0",
19098     "filename": "server/api/openchannelQueue/index.js",
19099     "groupTitle": "Openchannel_Queues"
19100   },
19101   {
19102     "type": "get",
19103     "url": "/api/openchannel/queues/{id}",
19104     "title": "Gets a single Queue",
19105     "examples": [
19106       {
19107         "title": "Example usage:",
19108         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19109         "type": "json"
19110       }
19111     ],
19112     "name": "ShowQueues",
19113     "group": "Openchannel_Queues",
19114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19115     "version": "0.0.0",
19116     "filename": "server/api/openchannelQueue/index.js",
19117     "groupTitle": "Openchannel_Queues"
19118   },
19119   {
19120     "type": "put",
19121     "url": "/api/openchannel/queues/{id}",
19122     "title": "Update an existing Queue",
19123     "examples": [
19124       {
19125         "title": "Example usage:",
19126         "content": "curl https://{domain}/api/openchannel/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19127         "type": "json"
19128       }
19129     ],
19130     "name": "updateQueues",
19131     "group": "Openchannel_Queues",
19132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19133     "version": "0.0.0",
19134     "filename": "server/api/openchannelQueue/index.js",
19135     "groupTitle": "Openchannel_Queues"
19136   },
19137   {
19138     "type": "post",
19139     "url": "/api/openchannel/reports/transfer",
19140     "title": "Creates a new Openchannel Transfer Report",
19141     "examples": [
19142       {
19143         "title": "Example usage:",
19144         "content": "curl https://{domain}/api/openchannel/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19145         "type": "json"
19146       }
19147     ],
19148     "name": "CreateOpenchannel_Transfer_Reports",
19149     "group": "Openchannel_Transfer_Reports",
19150     "parameter": {
19151       "fields": {
19152         "Body": [
19153           {
19154             "group": "Body",
19155             "type": "String",
19156             "optional": false,
19157             "field": "uniqueid",
19158             "description": ""
19159           },
19160           {
19161             "group": "Body",
19162             "type": "String",
19163             "allowedValues": [
19164               "\"account\"",
19165               "\"agent\"",
19166               "\"queue\""
19167             ],
19168             "optional": false,
19169             "field": "type",
19170             "description": ""
19171           },
19172           {
19173             "group": "Body",
19174             "type": "String",
19175             "optional": false,
19176             "field": "transferredAt",
19177             "description": ""
19178           }
19179         ]
19180       }
19181     },
19182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19183     "version": "0.0.0",
19184     "filename": "server/api/openchannelTransferReport/index.js",
19185     "groupTitle": "Openchannel_Transfer_Reports"
19186   },
19187   {
19188     "type": "delete",
19189     "url": "/api/openchannel/reports/transfer/{id}",
19190     "title": "Deletes a Openchannel Transfer Report",
19191     "examples": [
19192       {
19193         "title": "Example usage:",
19194         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19195         "type": "json"
19196       }
19197     ],
19198     "name": "DeleteOpenchannel_Transfer_Reports",
19199     "group": "Openchannel_Transfer_Reports",
19200     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19201     "version": "0.0.0",
19202     "filename": "server/api/openchannelTransferReport/index.js",
19203     "groupTitle": "Openchannel_Transfer_Reports"
19204   },
19205   {
19206     "type": "get",
19207     "url": "/api/openchannel/reports/transfer/describe",
19208     "title": "Gets table info about Openchannel Transfer Reports",
19209     "examples": [
19210       {
19211         "title": "Example usage:",
19212         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19213         "type": "json"
19214       }
19215     ],
19216     "name": "DescribeOpenchannel_Transfer_Reports",
19217     "group": "Openchannel_Transfer_Reports",
19218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19219     "version": "0.0.0",
19220     "filename": "server/api/openchannelTransferReport/index.js",
19221     "groupTitle": "Openchannel_Transfer_Reports"
19222   },
19223   {
19224     "type": "get",
19225     "url": "/api/openchannel/reports/transfer",
19226     "title": "Gets a list of Openchannel Transfer Reports",
19227     "examples": [
19228       {
19229         "title": "Example usage:",
19230         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19231         "type": "json"
19232       }
19233     ],
19234     "name": "GetOpenchannel_Transfer_Reports",
19235     "group": "Openchannel_Transfer_Reports",
19236     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19237     "version": "0.0.0",
19238     "filename": "server/api/openchannelTransferReport/index.js",
19239     "groupTitle": "Openchannel_Transfer_Reports"
19240   },
19241   {
19242     "type": "get",
19243     "url": "/api/openchannel/reports/transfer/{id}",
19244     "title": "Gets a single Openchannel Transfer Report",
19245     "examples": [
19246       {
19247         "title": "Example usage:",
19248         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19249         "type": "json"
19250       }
19251     ],
19252     "name": "ShowOpenchannel_Transfer_Reports",
19253     "group": "Openchannel_Transfer_Reports",
19254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19255     "version": "0.0.0",
19256     "filename": "server/api/openchannelTransferReport/index.js",
19257     "groupTitle": "Openchannel_Transfer_Reports"
19258   },
19259   {
19260     "type": "put",
19261     "url": "/api/openchannel/reports/transfer/{id}",
19262     "title": "Update an existing Openchannel Transfer Report",
19263     "examples": [
19264       {
19265         "title": "Example usage:",
19266         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19267         "type": "json"
19268       }
19269     ],
19270     "name": "updateOpenchannel_Transfer_Reports",
19271     "group": "Openchannel_Transfer_Reports",
19272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19273     "version": "0.0.0",
19274     "filename": "server/api/openchannelTransferReport/index.js",
19275     "groupTitle": "Openchannel_Transfer_Reports"
19276   },
19277   {
19278     "type": "post",
19279     "url": "/api/pauses",
19280     "title": "Creates a new Pause",
19281     "examples": [
19282       {
19283         "title": "Example usage:",
19284         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19285         "type": "json"
19286       }
19287     ],
19288     "name": "CreatePauses",
19289     "group": "Pauses",
19290     "parameter": {
19291       "fields": {
19292         "Body": [
19293           {
19294             "group": "Body",
19295             "type": "String",
19296             "optional": false,
19297             "field": "name",
19298             "description": ""
19299           },
19300           {
19301             "group": "Body",
19302             "type": "String",
19303             "optional": true,
19304             "field": "description",
19305             "description": ""
19306           }
19307         ]
19308       }
19309     },
19310     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19311     "version": "0.0.0",
19312     "filename": "server/api/pause/index.js",
19313     "groupTitle": "Pauses"
19314   },
19315   {
19316     "type": "delete",
19317     "url": "/api/pauses/{id}",
19318     "title": "Deletes a Pause",
19319     "examples": [
19320       {
19321         "title": "Example usage:",
19322         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19323         "type": "json"
19324       }
19325     ],
19326     "name": "DeletePauses",
19327     "group": "Pauses",
19328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19329     "version": "0.0.0",
19330     "filename": "server/api/pause/index.js",
19331     "groupTitle": "Pauses"
19332   },
19333   {
19334     "type": "get",
19335     "url": "/api/pauses",
19336     "title": "Gets a list of Pauses",
19337     "examples": [
19338       {
19339         "title": "Example usage:",
19340         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19341         "type": "json"
19342       }
19343     ],
19344     "name": "GetPauses",
19345     "group": "Pauses",
19346     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/pauses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/pauses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/pauses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/pauses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/pauses?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19347     "version": "0.0.0",
19348     "filename": "server/api/pause/index.js",
19349     "groupTitle": "Pauses"
19350   },
19351   {
19352     "type": "get",
19353     "url": "/api/pauses/{id}",
19354     "title": "Gets a single Pause",
19355     "examples": [
19356       {
19357         "title": "Example usage:",
19358         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19359         "type": "json"
19360       }
19361     ],
19362     "name": "ShowPauses",
19363     "group": "Pauses",
19364     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19365     "version": "0.0.0",
19366     "filename": "server/api/pause/index.js",
19367     "groupTitle": "Pauses"
19368   },
19369   {
19370     "type": "put",
19371     "url": "/api/pauses/{id}",
19372     "title": "Update an existing Pause",
19373     "examples": [
19374       {
19375         "title": "Example usage:",
19376         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19377         "type": "json"
19378       }
19379     ],
19380     "name": "updatePauses",
19381     "group": "Pauses",
19382     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19383     "version": "0.0.0",
19384     "filename": "server/api/pause/index.js",
19385     "groupTitle": "Pauses"
19386   },
19387   {
19388     "type": "get",
19389     "url": "/api/plugins",
19390     "title": "Gets a list of Plugins",
19391     "examples": [
19392       {
19393         "title": "Example usage:",
19394         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19395         "type": "json"
19396       }
19397     ],
19398     "name": "GetPlugins",
19399     "group": "Plugins",
19400     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/plugins?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/plugins?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/plugins?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/plugins?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/plugins?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19401     "version": "0.0.0",
19402     "filename": "server/api/plugin/index.js",
19403     "groupTitle": "Plugins"
19404   },
19405   {
19406     "type": "get",
19407     "url": "/api/plugins/{id}",
19408     "title": "Gets a single Plugin",
19409     "examples": [
19410       {
19411         "title": "Example usage:",
19412         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19413         "type": "json"
19414       }
19415     ],
19416     "name": "ShowPlugins",
19417     "group": "Plugins",
19418     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19419     "version": "0.0.0",
19420     "filename": "server/api/plugin/index.js",
19421     "groupTitle": "Plugins"
19422   },
19423   {
19424     "type": "delete",
19425     "url": "/api/plugins/{id}",
19426     "title": "Delete a plugin",
19427     "examples": [
19428       {
19429         "title": "Example usage:",
19430         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19431         "type": "json"
19432       }
19433     ],
19434     "name": "destroyPlugin",
19435     "group": "Plugins",
19436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19437     "version": "0.0.0",
19438     "filename": "server/api/plugin/index.js",
19439     "groupTitle": "Plugins"
19440   },
19441   {
19442     "type": "get",
19443     "url": "/api/plugins/{id}/download",
19444     "title": "Download plugin source code",
19445     "examples": [
19446       {
19447         "title": "Example usage:",
19448         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19449         "type": "json"
19450       }
19451     ],
19452     "name": "download",
19453     "group": "Plugins",
19454     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19455     "version": "0.0.0",
19456     "filename": "server/api/plugin/index.js",
19457     "groupTitle": "Plugins"
19458   },
19459   {
19460     "type": "put",
19461     "url": "/api/plugins/{id}",
19462     "title": "Update an existing plugin",
19463     "examples": [
19464       {
19465         "title": "Example usage:",
19466         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19467         "type": "json"
19468       }
19469     ],
19470     "name": "updatePlugin",
19471     "group": "Plugins",
19472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19473     "version": "0.0.0",
19474     "filename": "server/api/plugin/index.js",
19475     "groupTitle": "Plugins"
19476   },
19477   {
19478     "type": "post",
19479     "url": "/api/plugins",
19480     "title": "Upload new plugin",
19481     "examples": [
19482       {
19483         "title": "Example usage:",
19484         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19485         "type": "json"
19486       }
19487     ],
19488     "name": "uploadPlugin",
19489     "group": "Plugins",
19490     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19491     "version": "0.0.0",
19492     "filename": "server/api/plugin/index.js",
19493     "groupTitle": "Plugins"
19494   },
19495   {
19496     "type": "post",
19497     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19498     "title": "Redirect a plugin request to the specified path",
19499     "examples": [
19500       {
19501         "title": "Example usage:",
19502         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19503         "type": "json"
19504       }
19505     ],
19506     "name": "webhookPlugin",
19507     "group": "Plugins",
19508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19509     "version": "0.0.0",
19510     "filename": "server/api/plugin/index.js",
19511     "groupTitle": "Plugins"
19512   },
19513   {
19514     "type": "get",
19515     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19516     "title": "Redirect a plugin request to the specified path",
19517     "examples": [
19518       {
19519         "title": "Example usage:",
19520         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19521         "type": "json"
19522       }
19523     ],
19524     "name": "webhookPlugin",
19525     "group": "Plugins",
19526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19527     "version": "0.0.0",
19528     "filename": "server/api/plugin/index.js",
19529     "groupTitle": "Plugins"
19530   },
19531   {
19532     "type": "delete",
19533     "url": "/api/pm2/{id}",
19534     "title": "Deletes an existing process",
19535     "examples": [
19536       {
19537         "title": "Example usage:",
19538         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19539         "type": "json"
19540       }
19541     ],
19542     "name": "DeletePm2Process",
19543     "group": "Pm2",
19544     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19545     "version": "0.0.0",
19546     "filename": "server/api/pm2/index.js",
19547     "groupTitle": "Pm2"
19548   },
19549   {
19550     "type": "get",
19551     "url": "/api/pm2/{id}",
19552     "title": "Gets a single pm2 process",
19553     "examples": [
19554       {
19555         "title": "Example usage:",
19556         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19557         "type": "json"
19558       }
19559     ],
19560     "name": "GetPm2Process",
19561     "group": "Pm2",
19562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19563     "version": "0.0.0",
19564     "filename": "server/api/pm2/index.js",
19565     "groupTitle": "Pm2"
19566   },
19567   {
19568     "type": "get",
19569     "url": "/api/pm2",
19570     "title": "Gets pm2 processes",
19571     "examples": [
19572       {
19573         "title": "Example usage:",
19574         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19575         "type": "json"
19576       }
19577     ],
19578     "name": "GetPm2Processes",
19579     "group": "Pm2",
19580     "description": "<p>Motion returns the pm2 processes list.</p>",
19581     "version": "0.0.0",
19582     "filename": "server/api/pm2/index.js",
19583     "groupTitle": "Pm2"
19584   },
19585   {
19586     "type": "post",
19587     "url": "/api/pm2",
19588     "title": "Start a single pm2 process",
19589     "examples": [
19590       {
19591         "title": "Example usage:",
19592         "content": "curl https://{domain}/api/pm2 -d '{\"name\": \"process_name\", \"script\": \"/index.js\"}'\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19593         "type": "json"
19594       }
19595     ],
19596     "name": "StartPm2Process",
19597     "group": "Pm2",
19598     "parameter": {
19599       "fields": {
19600         "Body": [
19601           {
19602             "group": "Body",
19603             "type": "String",
19604             "optional": false,
19605             "field": "name",
19606             "description": ""
19607           },
19608           {
19609             "group": "Body",
19610             "type": "String",
19611             "optional": false,
19612             "field": "script",
19613             "description": ""
19614           }
19615         ]
19616       }
19617     },
19618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19619     "version": "0.0.0",
19620     "filename": "server/api/pm2/index.js",
19621     "groupTitle": "Pm2"
19622   },
19623   {
19624     "type": "put",
19625     "url": "/api/pm2/{id}",
19626     "title": "Update an existing process",
19627     "examples": [
19628       {
19629         "title": "Example usage:",
19630         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19631         "type": "json"
19632       }
19633     ],
19634     "name": "UpdatePm2Process",
19635     "group": "Pm2",
19636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19637     "version": "0.0.0",
19638     "filename": "server/api/pm2/index.js",
19639     "groupTitle": "Pm2"
19640   },
19641   {
19642     "type": "get",
19643     "url": "/api/rpc/campaigns/",
19644     "title": "Gets a list of campaigns",
19645     "examples": [
19646       {
19647         "title": "Example usage:",
19648         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19649         "type": "json"
19650       }
19651     ],
19652     "name": "Campaigns",
19653     "group": "RPC_Realtime",
19654     "description": "<p>Motion will return a list of realtime campaigns parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19655     "version": "0.0.0",
19656     "filename": "server/api/rpc/index.js",
19657     "groupTitle": "RPC_Realtime"
19658   },
19659   {
19660     "type": "get",
19661     "url": "/api/rpc/fax/accounts",
19662     "title": "Gets a list of FaxAccounts",
19663     "examples": [
19664       {
19665         "title": "Example usage:",
19666         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19667         "type": "json"
19668       }
19669     ],
19670     "name": "FaxAccounts",
19671     "group": "RPC_Realtime",
19672     "description": "<p>Motion will return a list of realtime fax account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19673     "version": "0.0.0",
19674     "filename": "server/api/rpc/index.js",
19675     "groupTitle": "RPC_Realtime"
19676   },
19677   {
19678     "type": "put",
19679     "url": "/api/rpc/agents/:id/capacity",
19680     "title": "Sets agent capacity",
19681     "examples": [
19682       {
19683         "title": "Example usage:",
19684         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19685         "type": "json"
19686       }
19687     ],
19688     "name": "RTAgentCapacity",
19689     "group": "RPC_Realtime",
19690     "description": "<p>Motion will return the current agent capacity.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19691     "version": "0.0.0",
19692     "filename": "server/api/rpc/index.js",
19693     "groupTitle": "RPC_Realtime"
19694   },
19695   {
19696     "type": "get",
19697     "url": "/api/rpc/agents",
19698     "title": "Gets a list of RTAgents",
19699     "examples": [
19700       {
19701         "title": "Example usage:",
19702         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19703         "type": "json"
19704       }
19705     ],
19706     "name": "RTAgents",
19707     "group": "RPC_Realtime",
19708     "description": "<p>Motion will return a list of realtime agents parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19709     "version": "0.0.0",
19710     "filename": "server/api/rpc/index.js",
19711     "groupTitle": "RPC_Realtime"
19712   },
19713   {
19714     "type": "get",
19715     "url": "/api/rpc/chat/queues",
19716     "title": "Gets a list of RTChatQueues",
19717     "examples": [
19718       {
19719         "title": "Example usage:",
19720         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19721         "type": "json"
19722       }
19723     ],
19724     "name": "RTChatQueues",
19725     "group": "RPC_Realtime",
19726     "description": "<p>Motion will return a list of realtime chat queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19727     "version": "0.0.0",
19728     "filename": "server/api/rpc/index.js",
19729     "groupTitle": "RPC_Realtime"
19730   },
19731   {
19732     "type": "get",
19733     "url": "/api/rpc/fax/queues",
19734     "title": "Gets a list of RTFaxQueues",
19735     "examples": [
19736       {
19737         "title": "Example usage:",
19738         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19739         "type": "json"
19740       }
19741     ],
19742     "name": "RTFaxQueues",
19743     "group": "RPC_Realtime",
19744     "description": "<p>Motion will return a list of realtime fax queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19745     "version": "0.0.0",
19746     "filename": "server/api/rpc/index.js",
19747     "groupTitle": "RPC_Realtime"
19748   },
19749   {
19750     "type": "get",
19751     "url": "/api/rpc/mail/accounts",
19752     "title": "Gets a list of RTMailAccounts",
19753     "examples": [
19754       {
19755         "title": "Example usage:",
19756         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19757         "type": "json"
19758       }
19759     ],
19760     "name": "RTMailAccounts",
19761     "group": "RPC_Realtime",
19762     "description": "<p>Motion will return a list of realtime mail account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19763     "version": "0.0.0",
19764     "filename": "server/api/rpc/index.js",
19765     "groupTitle": "RPC_Realtime"
19766   },
19767   {
19768     "type": "get",
19769     "url": "/api/rpc/mail/queues",
19770     "title": "Gets a list of RTMailQueues",
19771     "examples": [
19772       {
19773         "title": "Example usage:",
19774         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19775         "type": "json"
19776       }
19777     ],
19778     "name": "RTMailQueues",
19779     "group": "RPC_Realtime",
19780     "description": "<p>Motion will return a list of realtime mail queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19781     "version": "0.0.0",
19782     "filename": "server/api/rpc/index.js",
19783     "groupTitle": "RPC_Realtime"
19784   },
19785   {
19786     "type": "get",
19787     "url": "/api/rpc/openchannel/queues",
19788     "title": "Gets a list of RTOpenchannelQueues",
19789     "examples": [
19790       {
19791         "title": "Example usage:",
19792         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19793         "type": "json"
19794       }
19795     ],
19796     "name": "RTOpenchannelQueues",
19797     "group": "RPC_Realtime",
19798     "description": "<p>Motion will return a list of realtime openchannel queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19799     "version": "0.0.0",
19800     "filename": "server/api/rpc/index.js",
19801     "groupTitle": "RPC_Realtime"
19802   },
19803   {
19804     "type": "get",
19805     "url": "/api/rpc/outbound/channels",
19806     "title": "Gets a list of RTOutboundChannels",
19807     "examples": [
19808       {
19809         "title": "Example usage:",
19810         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19811         "type": "json"
19812       }
19813     ],
19814     "name": "RTOutboundChannels",
19815     "group": "RPC_Realtime",
19816     "description": "<p>Motion will return a list of realtime outbound channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19817     "version": "0.0.0",
19818     "filename": "server/api/rpc/index.js",
19819     "groupTitle": "RPC_Realtime"
19820   },
19821   {
19822     "type": "get",
19823     "url": "/api/rpc/sms/queues",
19824     "title": "Gets a list of RTSmsQueues",
19825     "examples": [
19826       {
19827         "title": "Example usage:",
19828         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19829         "type": "json"
19830       }
19831     ],
19832     "name": "RTSmsQueues",
19833     "group": "RPC_Realtime",
19834     "description": "<p>Motion will return a list of realtime sms queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19835     "version": "0.0.0",
19836     "filename": "server/api/rpc/index.js",
19837     "groupTitle": "RPC_Realtime"
19838   },
19839   {
19840     "type": "get",
19841     "url": "/api/rpc/telephones",
19842     "title": "Gets a list of RTTelephones",
19843     "examples": [
19844       {
19845         "title": "Example usage:",
19846         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19847         "type": "json"
19848       }
19849     ],
19850     "name": "RTTelephones",
19851     "group": "RPC_Realtime",
19852     "description": "<p>Motion will return a list of telephones parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19853     "version": "0.0.0",
19854     "filename": "server/api/rpc/index.js",
19855     "groupTitle": "RPC_Realtime"
19856   },
19857   {
19858     "type": "get",
19859     "url": "/api/rpc/trunks",
19860     "title": "Gets a list of RTTrunks",
19861     "examples": [
19862       {
19863         "title": "Example usage:",
19864         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19865         "type": "json"
19866       }
19867     ],
19868     "name": "RTTrunks",
19869     "group": "RPC_Realtime",
19870     "description": "<p>Motion will return a list of realtime trunks parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19871     "version": "0.0.0",
19872     "filename": "server/api/rpc/index.js",
19873     "groupTitle": "RPC_Realtime"
19874   },
19875   {
19876     "type": "get",
19877     "url": "/api/rpc/voice/channels",
19878     "title": "Gets a list of RTVoiceChannelMixMonitor",
19879     "examples": [
19880       {
19881         "title": "Example usage:",
19882         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19883         "type": "json"
19884       }
19885     ],
19886     "name": "RTVoiceChannelMixMonitor",
19887     "group": "RPC_Realtime",
19888     "description": "<p>Motion will return a list of realtime voice channel mixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19889     "version": "0.0.0",
19890     "filename": "server/api/rpc/index.js",
19891     "groupTitle": "RPC_Realtime"
19892   },
19893   {
19894     "type": "get",
19895     "url": "/api/rpc/voice/channels",
19896     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19897     "examples": [
19898       {
19899         "title": "Example usage:",
19900         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19901         "type": "json"
19902       }
19903     ],
19904     "name": "RTVoiceChannelStopMixMonitor",
19905     "group": "RPC_Realtime",
19906     "description": "<p>Motion will return a list of realtime voice channel stopmixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19907     "version": "0.0.0",
19908     "filename": "server/api/rpc/index.js",
19909     "groupTitle": "RPC_Realtime"
19910   },
19911   {
19912     "type": "get",
19913     "url": "/api/rpc/voice/channels",
19914     "title": "Gets a list of RTVoiceChannels",
19915     "examples": [
19916       {
19917         "title": "Example usage:",
19918         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19919         "type": "json"
19920       }
19921     ],
19922     "name": "RTVoiceChannels",
19923     "group": "RPC_Realtime",
19924     "description": "<p>Motion will return a list of realtime voice channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19925     "version": "0.0.0",
19926     "filename": "server/api/rpc/index.js",
19927     "groupTitle": "RPC_Realtime"
19928   },
19929   {
19930     "type": "get",
19931     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19932     "title": "Gets a single RTVoiceQueueChannel",
19933     "examples": [
19934       {
19935         "title": "Example usage:",
19936         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19937         "type": "json"
19938       }
19939     ],
19940     "name": "RTVoiceQueueChannel",
19941     "group": "RPC_Realtime",
19942     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19943     "version": "0.0.0",
19944     "filename": "server/api/rpc/index.js",
19945     "groupTitle": "RPC_Realtime"
19946   },
19947   {
19948     "type": "get",
19949     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19950     "title": "Hangup a single RTVoiceQueueChannel",
19951     "examples": [
19952       {
19953         "title": "Example usage:",
19954         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19955         "type": "json"
19956       }
19957     ],
19958     "name": "RTVoiceQueueChannelHangup",
19959     "group": "RPC_Realtime",
19960     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19961     "version": "0.0.0",
19962     "filename": "server/api/rpc/index.js",
19963     "groupTitle": "RPC_Realtime"
19964   },
19965   {
19966     "type": "get",
19967     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19968     "title": "Hangup a single RTVoiceQueueChannel",
19969     "examples": [
19970       {
19971         "title": "Example usage:",
19972         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19973         "type": "json"
19974       }
19975     ],
19976     "name": "RTVoiceQueueChannelRedirect",
19977     "group": "RPC_Realtime",
19978     "description": "<p>Motion will redirect a specific realtime voice queue channel to a specific extension.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19979     "version": "0.0.0",
19980     "filename": "server/api/rpc/index.js",
19981     "groupTitle": "RPC_Realtime"
19982   },
19983   {
19984     "type": "get",
19985     "url": "/api/rpc/voice/queues/preview/{id}",
19986     "title": "Gets a single preview contact",
19987     "examples": [
19988       {
19989         "title": "Example usage:",
19990         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19991         "type": "json"
19992       }
19993     ],
19994     "name": "RTVoiceQueuePreview",
19995     "group": "RPC_Realtime",
19996     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19997     "version": "0.0.0",
19998     "filename": "server/api/rpc/index.js",
19999     "groupTitle": "RPC_Realtime"
20000   },
20001   {
20002     "type": "get",
20003     "url": "/api/rpc/outbound",
20004     "title": "Gets a list of RTOutbound",
20005     "examples": [
20006       {
20007         "title": "Example usage:",
20008         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20009         "type": "json"
20010       }
20011     ],
20012     "name": "RTVoiceQueues",
20013     "group": "RPC_Realtime",
20014     "description": "<p>Motion will return a list of realtime outbound parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20015     "version": "0.0.0",
20016     "filename": "server/api/rpc/index.js",
20017     "groupTitle": "RPC_Realtime"
20018   },
20019   {
20020     "type": "get",
20021     "url": "/api/rpc/voice/queues",
20022     "title": "Gets a list of RTVoiceQueues",
20023     "examples": [
20024       {
20025         "title": "Example usage:",
20026         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20027         "type": "json"
20028       }
20029     ],
20030     "name": "RTVoiceQueues",
20031     "group": "RPC_Realtime",
20032     "description": "<p>Motion will return a list of realtime voice queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20033     "version": "0.0.0",
20034     "filename": "server/api/rpc/index.js",
20035     "groupTitle": "RPC_Realtime"
20036   },
20037   {
20038     "type": "get",
20039     "url": "/api/rpc/voice/queues/channels",
20040     "title": "Gets a list of RTVoiceQueuesChannels",
20041     "examples": [
20042       {
20043         "title": "Example usage:",
20044         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20045         "type": "json"
20046       }
20047     ],
20048     "name": "RTVoiceQueuesChannels",
20049     "group": "RPC_Realtime",
20050     "description": "<p>Motion will return a list of realtime voice queues channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20051     "version": "0.0.0",
20052     "filename": "server/api/rpc/index.js",
20053     "groupTitle": "RPC_Realtime"
20054   },
20055   {
20056     "type": "get",
20057     "url": "/api/rpc/chat/queues/{id}",
20058     "title": "Gets a single RTChatQueue",
20059     "examples": [
20060       {
20061         "title": "Example usage:",
20062         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20063         "type": "json"
20064       }
20065     ],
20066     "name": "ShowRTChatQueues",
20067     "group": "RPC_Realtime",
20068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20069     "version": "0.0.0",
20070     "filename": "server/api/rpc/index.js",
20071     "groupTitle": "RPC_Realtime"
20072   },
20073   {
20074     "type": "get",
20075     "url": "/api/rpc/fax/queues/{id}",
20076     "title": "Gets a single RTFaxQueue",
20077     "examples": [
20078       {
20079         "title": "Example usage:",
20080         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20081         "type": "json"
20082       }
20083     ],
20084     "name": "ShowRTFaxQueues",
20085     "group": "RPC_Realtime",
20086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20087     "version": "0.0.0",
20088     "filename": "server/api/rpc/index.js",
20089     "groupTitle": "RPC_Realtime"
20090   },
20091   {
20092     "type": "get",
20093     "url": "/api/rpc/mail/queues/{id}",
20094     "title": "Gets a single RTMailQueue",
20095     "examples": [
20096       {
20097         "title": "Example usage:",
20098         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20099         "type": "json"
20100       }
20101     ],
20102     "name": "ShowRTMailQueues",
20103     "group": "RPC_Realtime",
20104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20105     "version": "0.0.0",
20106     "filename": "server/api/rpc/index.js",
20107     "groupTitle": "RPC_Realtime"
20108   },
20109   {
20110     "type": "get",
20111     "url": "/api/rpc/openchannel/queues/{id}",
20112     "title": "Gets a single RTOpenchannelQueue",
20113     "examples": [
20114       {
20115         "title": "Example usage:",
20116         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20117         "type": "json"
20118       }
20119     ],
20120     "name": "ShowRTOpenchannelQueues",
20121     "group": "RPC_Realtime",
20122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20123     "version": "0.0.0",
20124     "filename": "server/api/rpc/index.js",
20125     "groupTitle": "RPC_Realtime"
20126   },
20127   {
20128     "type": "get",
20129     "url": "/api/rpc/sms/queues/{id}",
20130     "title": "Gets a single RTSmsQueue",
20131     "examples": [
20132       {
20133         "title": "Example usage:",
20134         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20135         "type": "json"
20136       }
20137     ],
20138     "name": "ShowRTSmsQueues",
20139     "group": "RPC_Realtime",
20140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20141     "version": "0.0.0",
20142     "filename": "server/api/rpc/index.js",
20143     "groupTitle": "RPC_Realtime"
20144   },
20145   {
20146     "type": "get",
20147     "url": "/api/rpc/voice/queues/{id}",
20148     "title": "Gets a single RTVoiceQueue",
20149     "examples": [
20150       {
20151         "title": "Example usage:",
20152         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20153         "type": "json"
20154       }
20155     ],
20156     "name": "ShowRTVoiceQueues",
20157     "group": "RPC_Realtime",
20158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20159     "version": "0.0.0",
20160     "filename": "server/api/rpc/index.js",
20161     "groupTitle": "RPC_Realtime"
20162   },
20163   {
20164     "type": "put",
20165     "url": "/api/rpc/voice/{id}/queues",
20166     "title": "Updates a single VoiceQueue",
20167     "examples": [
20168       {
20169         "title": "Example usage:",
20170         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20171         "type": "json"
20172       }
20173     ],
20174     "name": "UpdateVoiceQueues",
20175     "group": "RPC_Realtime",
20176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20177     "version": "0.0.0",
20178     "filename": "server/api/rpc/index.js",
20179     "groupTitle": "RPC_Realtime"
20180   },
20181   {
20182     "type": "post",
20183     "url": "/api/rpc/agents/:id/notify",
20184     "title": "Notify message to a specific agent",
20185     "examples": [
20186       {
20187         "title": "Example usage:",
20188         "content": "curl https://{domain}/api/rpc/agents/:id/notify -d '{\"messageId\": \"5080\", \"channel\": \"mail\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20189         "type": "json"
20190       }
20191     ],
20192     "name": "agentNotify",
20193     "group": "RPC_Realtime",
20194     "description": "<p>Notify message to a specific agent.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20195     "version": "0.0.0",
20196     "filename": "server/api/rpc/index.js",
20197     "groupTitle": "RPC_Realtime"
20198   },
20199   {
20200     "type": "post",
20201     "url": "/api/rpc/chat/queues/:id/notify",
20202     "title": "Notify message to a specific queue",
20203     "examples": [
20204       {
20205         "title": "Example usage:",
20206         "content": "curl https://{domain}/api/rpc/chat/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20207         "type": "json"
20208       }
20209     ],
20210     "name": "chatQueueNotify",
20211     "group": "RPC_Realtime",
20212     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20213     "version": "0.0.0",
20214     "filename": "server/api/rpc/index.js",
20215     "groupTitle": "RPC_Realtime"
20216   },
20217   {
20218     "type": "get",
20219     "url": "/api/rpc/chat/queues/waitinginteractions",
20220     "title": "Gets a list of chatQueuesWaitingInteractions",
20221     "examples": [
20222       {
20223         "title": "Example usage:",
20224         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20225         "type": "json"
20226       }
20227     ],
20228     "name": "chatQueuesWaitingInteractions",
20229     "group": "RPC_Realtime",
20230     "description": "<p>Motion will return a list of realtime waiting chat queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20231     "version": "0.0.0",
20232     "filename": "server/api/rpc/index.js",
20233     "groupTitle": "RPC_Realtime"
20234   },
20235   {
20236     "type": "post",
20237     "url": "/api/rpc/fax/queues/:id/notify",
20238     "title": "Notify message to a specific queue",
20239     "examples": [
20240       {
20241         "title": "Example usage:",
20242         "content": "curl https://{domain}/api/rpc/fax/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20243         "type": "json"
20244       }
20245     ],
20246     "name": "faxQueueNotify",
20247     "group": "RPC_Realtime",
20248     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20249     "version": "0.0.0",
20250     "filename": "server/api/rpc/index.js",
20251     "groupTitle": "RPC_Realtime"
20252   },
20253   {
20254     "type": "get",
20255     "url": "/api/rpc/fax/queues/waitinginteractions",
20256     "title": "Gets a list of faxQueuesWaitingInteractions",
20257     "examples": [
20258       {
20259         "title": "Example usage:",
20260         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20261         "type": "json"
20262       }
20263     ],
20264     "name": "faxQueuesWaitingInteractions",
20265     "group": "RPC_Realtime",
20266     "description": "<p>Motion will return a list of realtime waiting fax queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20267     "version": "0.0.0",
20268     "filename": "server/api/rpc/index.js",
20269     "groupTitle": "RPC_Realtime"
20270   },
20271   {
20272     "type": "post",
20273     "url": "/api/rpc/mail/queues/:id/notify",
20274     "title": "Notify message to a specific queue",
20275     "examples": [
20276       {
20277         "title": "Example usage:",
20278         "content": "curl https://{domain}/api/rpc/mail/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20279         "type": "json"
20280       }
20281     ],
20282     "name": "mailQueueNotify",
20283     "group": "RPC_Realtime",
20284     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20285     "version": "0.0.0",
20286     "filename": "server/api/rpc/index.js",
20287     "groupTitle": "RPC_Realtime"
20288   },
20289   {
20290     "type": "get",
20291     "url": "/api/rpc/mail/queues/waitinginteractions",
20292     "title": "Gets a list of mailQueuesWaitingInteractions",
20293     "examples": [
20294       {
20295         "title": "Example usage:",
20296         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20297         "type": "json"
20298       }
20299     ],
20300     "name": "mailQueuesWaitingInteractions",
20301     "group": "RPC_Realtime",
20302     "description": "<p>Motion will return a list of realtime waiting mail queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20303     "version": "0.0.0",
20304     "filename": "server/api/rpc/index.js",
20305     "groupTitle": "RPC_Realtime"
20306   },
20307   {
20308     "type": "post",
20309     "url": "/api/rpc/openchannel/queues/:id/notify",
20310     "title": "Notify message to a specific queue",
20311     "examples": [
20312       {
20313         "title": "Example usage:",
20314         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20315         "type": "json"
20316       }
20317     ],
20318     "name": "openchannelQueueNotify",
20319     "group": "RPC_Realtime",
20320     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20321     "version": "0.0.0",
20322     "filename": "server/api/rpc/index.js",
20323     "groupTitle": "RPC_Realtime"
20324   },
20325   {
20326     "type": "get",
20327     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20328     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20329     "examples": [
20330       {
20331         "title": "Example usage:",
20332         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20333         "type": "json"
20334       }
20335     ],
20336     "name": "openchannelQueuesIdWaitingInteractions",
20337     "group": "RPC_Realtime",
20338     "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20339     "version": "0.0.0",
20340     "filename": "server/api/rpc/index.js",
20341     "groupTitle": "RPC_Realtime"
20342   },
20343   {
20344     "type": "get",
20345     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20346     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20347     "examples": [
20348       {
20349         "title": "Example usage:",
20350         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20351         "type": "json"
20352       }
20353     ],
20354     "name": "openchannelQueuesWaitingInteractions",
20355     "group": "RPC_Realtime",
20356     "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20357     "version": "0.0.0",
20358     "filename": "server/api/rpc/index.js",
20359     "groupTitle": "RPC_Realtime"
20360   },
20361   {
20362     "type": "post",
20363     "url": "/api/rpc/sms/queues/:id/notify",
20364     "title": "Notify message to a specific queue",
20365     "examples": [
20366       {
20367         "title": "Example usage:",
20368         "content": "curl https://{domain}/api/rpc/sms/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20369         "type": "json"
20370       }
20371     ],
20372     "name": "smsQueueNotify",
20373     "group": "RPC_Realtime",
20374     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20375     "version": "0.0.0",
20376     "filename": "server/api/rpc/index.js",
20377     "groupTitle": "RPC_Realtime"
20378   },
20379   {
20380     "type": "get",
20381     "url": "/api/rpc/sms/queues/waitinginteractions",
20382     "title": "Gets a list of smsQueuesWaitingInteractions",
20383     "examples": [
20384       {
20385         "title": "Example usage:",
20386         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20387         "type": "json"
20388       }
20389     ],
20390     "name": "smsQueuesWaitingInteractions",
20391     "group": "RPC_Realtime",
20392     "description": "<p>Motion will return a list of realtime waiting sms queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20393     "version": "0.0.0",
20394     "filename": "server/api/rpc/index.js",
20395     "groupTitle": "RPC_Realtime"
20396   },
20397   {
20398     "type": "get",
20399     "url": "/api/realtime/agents",
20400     "title": "Gets realtime agents info",
20401     "examples": [
20402       {
20403         "title": "Example usage:",
20404         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
20405         "type": "json"
20406       }
20407     ],
20408     "name": "getAgents",
20409     "group": "Realtime",
20410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20411     "version": "0.0.0",
20412     "filename": "server/api/realtime/index.js",
20413     "groupTitle": "Realtime"
20414   },
20415   {
20416     "type": "get",
20417     "url": "/api/realtime/queues",
20418     "title": "Gets realtime queues info",
20419     "examples": [
20420       {
20421         "title": "Example usage:",
20422         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
20423         "type": "json"
20424       }
20425     ],
20426     "name": "getQueues",
20427     "group": "Realtime",
20428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20429     "version": "0.0.0",
20430     "filename": "server/api/realtime/index.js",
20431     "groupTitle": "Realtime"
20432   },
20433   {
20434     "type": "post",
20435     "url": "/api/integrations/salesforce/accounts",
20436     "title": "Creates a new Salesforce Account",
20437     "examples": [
20438       {
20439         "title": "Example usage:",
20440         "content": "curl https://{domain}/api/integrations/salesforce/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20441         "type": "json"
20442       }
20443     ],
20444     "name": "CreateSalesforce_Accounts",
20445     "group": "Salesforce_Accounts",
20446     "parameter": {
20447       "fields": {
20448         "Body": [
20449           {
20450             "group": "Body",
20451             "type": "String",
20452             "optional": true,
20453             "field": "name",
20454             "description": ""
20455           },
20456           {
20457             "group": "Body",
20458             "type": "String",
20459             "optional": true,
20460             "field": "description",
20461             "description": ""
20462           },
20463           {
20464             "group": "Body",
20465             "type": "String",
20466             "optional": true,
20467             "field": "username",
20468             "description": ""
20469           },
20470           {
20471             "group": "Body",
20472             "type": "String",
20473             "optional": true,
20474             "field": "remoteUri",
20475             "description": ""
20476           },
20477           {
20478             "group": "Body",
20479             "type": "String",
20480             "optional": true,
20481             "field": "password",
20482             "description": ""
20483           },
20484           {
20485             "group": "Body",
20486             "type": "String",
20487             "optional": true,
20488             "field": "clientId",
20489             "description": ""
20490           },
20491           {
20492             "group": "Body",
20493             "type": "String",
20494             "optional": true,
20495             "field": "clientSecret",
20496             "description": ""
20497           },
20498           {
20499             "group": "Body",
20500             "type": "String",
20501             "optional": true,
20502             "field": "securityToken",
20503             "description": ""
20504           },
20505           {
20506             "group": "Body",
20507             "type": "String",
20508             "optional": false,
20509             "field": "serverUrl",
20510             "description": ""
20511           },
20512           {
20513             "group": "Body",
20514             "type": "String",
20515             "allowedValues": [
20516               "\"integrationTab\"",
20517               "\"newTab\""
20518             ],
20519             "optional": true,
20520             "field": "type",
20521             "description": ""
20522           }
20523         ]
20524       }
20525     },
20526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20527     "version": "0.0.0",
20528     "filename": "server/api/intSalesforceAccount/index.js",
20529     "groupTitle": "Salesforce_Accounts"
20530   },
20531   {
20532     "type": "delete",
20533     "url": "/api/integrations/salesforce/accounts/{id}",
20534     "title": "Deletes a Salesforce Account",
20535     "examples": [
20536       {
20537         "title": "Example usage:",
20538         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20539         "type": "json"
20540       }
20541     ],
20542     "name": "DeleteSalesforce_Accounts",
20543     "group": "Salesforce_Accounts",
20544     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20545     "version": "0.0.0",
20546     "filename": "server/api/intSalesforceAccount/index.js",
20547     "groupTitle": "Salesforce_Accounts"
20548   },
20549   {
20550     "type": "get",
20551     "url": "/api/integrations/salesforce/accounts",
20552     "title": "Gets a list of Salesforce Accounts",
20553     "examples": [
20554       {
20555         "title": "Example usage:",
20556         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20557         "type": "json"
20558       }
20559     ],
20560     "name": "GetSalesforce_Accounts",
20561     "group": "Salesforce_Accounts",
20562     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20563     "version": "0.0.0",
20564     "filename": "server/api/intSalesforceAccount/index.js",
20565     "groupTitle": "Salesforce_Accounts"
20566   },
20567   {
20568     "type": "get",
20569     "url": "/api/integrations/salesforce/accounts/{id}",
20570     "title": "Gets a single Salesforce Account",
20571     "examples": [
20572       {
20573         "title": "Example usage:",
20574         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20575         "type": "json"
20576       }
20577     ],
20578     "name": "ShowSalesforce_Accounts",
20579     "group": "Salesforce_Accounts",
20580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20581     "version": "0.0.0",
20582     "filename": "server/api/intSalesforceAccount/index.js",
20583     "groupTitle": "Salesforce_Accounts"
20584   },
20585   {
20586     "type": "post",
20587     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20588     "title": "Creates new configuration",
20589     "examples": [
20590       {
20591         "title": "Example usage:",
20592         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
20593         "type": "json"
20594       }
20595     ],
20596     "name": "addConfiguration",
20597     "group": "Salesforce_Accounts",
20598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20599     "version": "0.0.0",
20600     "filename": "server/api/intSalesforceAccount/index.js",
20601     "groupTitle": "Salesforce_Accounts"
20602   },
20603   {
20604     "type": "get",
20605     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20606     "title": "Gets account configurations",
20607     "examples": [
20608       {
20609         "title": "Example usage:",
20610         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20611         "type": "json"
20612       }
20613     ],
20614     "name": "getConfigurations",
20615     "group": "Salesforce_Accounts",
20616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20617     "version": "0.0.0",
20618     "filename": "server/api/intSalesforceAccount/index.js",
20619     "groupTitle": "Salesforce_Accounts"
20620   },
20621   {
20622     "type": "get",
20623     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20624     "title": "Gets account fields",
20625     "examples": [
20626       {
20627         "title": "Example usage:",
20628         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20629         "type": "json"
20630       }
20631     ],
20632     "name": "getFields",
20633     "group": "Salesforce_Accounts",
20634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20635     "version": "0.0.0",
20636     "filename": "server/api/intSalesforceAccount/index.js",
20637     "groupTitle": "Salesforce_Accounts"
20638   },
20639   {
20640     "type": "put",
20641     "url": "/api/integrations/salesforce/accounts/{id}",
20642     "title": "Update an existing Salesforce Account",
20643     "examples": [
20644       {
20645         "title": "Example usage:",
20646         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20647         "type": "json"
20648       }
20649     ],
20650     "name": "updateSalesforce_Accounts",
20651     "group": "Salesforce_Accounts",
20652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20653     "version": "0.0.0",
20654     "filename": "server/api/intSalesforceAccount/index.js",
20655     "groupTitle": "Salesforce_Accounts"
20656   },
20657   {
20658     "type": "post",
20659     "url": "/api/integrations/salesforce/configurations",
20660     "title": "Creates a new Salesforce Configuration",
20661     "examples": [
20662       {
20663         "title": "Example usage:",
20664         "content": "curl https://{domain}/api/integrations/salesforce/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20665         "type": "json"
20666       }
20667     ],
20668     "name": "CreateSalesforce_Configurations",
20669     "group": "Salesforce_Configurations",
20670     "parameter": {
20671       "fields": {
20672         "Body": [
20673           {
20674             "group": "Body",
20675             "type": "String",
20676             "optional": true,
20677             "field": "name",
20678             "description": ""
20679           },
20680           {
20681             "group": "Body",
20682             "type": "String",
20683             "optional": true,
20684             "field": "description",
20685             "description": ""
20686           },
20687           {
20688             "group": "Body",
20689             "type": "String",
20690             "allowedValues": [
20691               "\"Task\"",
20692               "\"Case\""
20693             ],
20694             "optional": true,
20695             "field": "ticketType",
20696             "description": ""
20697           },
20698           {
20699             "group": "Body",
20700             "type": "String",
20701             "allowedValues": [
20702               "\"contact_lead\"",
20703               "\"contact\"",
20704               "\"lead\"",
20705               "\"account_contact_lead\"",
20706               "\"account\""
20707             ],
20708             "optional": true,
20709             "field": "moduleSearch",
20710             "description": ""
20711           },
20712           {
20713             "group": "Body",
20714             "type": "String",
20715             "allowedValues": [
20716               "\"nothing\"",
20717               "\"contact\"",
20718               "\"lead\"",
20719               "\"account\""
20720             ],
20721             "optional": true,
20722             "field": "moduleCreate",
20723             "description": ""
20724           },
20725           {
20726             "group": "Body",
20727             "type": "String",
20728             "optional": true,
20729             "field": "leadId",
20730             "description": ""
20731           },
20732           {
20733             "group": "Body",
20734             "type": "String",
20735             "optional": true,
20736             "field": "additionalSearchAccount",
20737             "description": ""
20738           },
20739           {
20740             "group": "Body",
20741             "type": "String",
20742             "optional": true,
20743             "field": "additionalSearchContact",
20744             "description": ""
20745           },
20746           {
20747             "group": "Body",
20748             "type": "String",
20749             "optional": true,
20750             "field": "additionalSearchLead",
20751             "description": ""
20752           }
20753         ]
20754       }
20755     },
20756     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20757     "version": "0.0.0",
20758     "filename": "server/api/intSalesforceConfiguration/index.js",
20759     "groupTitle": "Salesforce_Configurations"
20760   },
20761   {
20762     "type": "delete",
20763     "url": "/api/integrations/salesforce/configurations/{id}",
20764     "title": "Deletes a Salesforce Configuration",
20765     "examples": [
20766       {
20767         "title": "Example usage:",
20768         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20769         "type": "json"
20770       }
20771     ],
20772     "name": "DeleteSalesforce_Configurations",
20773     "group": "Salesforce_Configurations",
20774     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20775     "version": "0.0.0",
20776     "filename": "server/api/intSalesforceConfiguration/index.js",
20777     "groupTitle": "Salesforce_Configurations"
20778   },
20779   {
20780     "type": "get",
20781     "url": "/api/integrations/salesforce/configurations",
20782     "title": "Gets a list of Salesforce Configurations",
20783     "examples": [
20784       {
20785         "title": "Example usage:",
20786         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20787         "type": "json"
20788       }
20789     ],
20790     "name": "GetSalesforce_Configurations",
20791     "group": "Salesforce_Configurations",
20792     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20793     "version": "0.0.0",
20794     "filename": "server/api/intSalesforceConfiguration/index.js",
20795     "groupTitle": "Salesforce_Configurations"
20796   },
20797   {
20798     "type": "get",
20799     "url": "/api/integrations/salesforce/configurations/{id}",
20800     "title": "Gets a single Salesforce Configuration",
20801     "examples": [
20802       {
20803         "title": "Example usage:",
20804         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20805         "type": "json"
20806       }
20807     ],
20808     "name": "ShowSalesforce_Configurations",
20809     "group": "Salesforce_Configurations",
20810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20811     "version": "0.0.0",
20812     "filename": "server/api/intSalesforceConfiguration/index.js",
20813     "groupTitle": "Salesforce_Configurations"
20814   },
20815   {
20816     "type": "get",
20817     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20818     "title": "Gets configurations descriptions",
20819     "examples": [
20820       {
20821         "title": "Example usage:",
20822         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20823         "type": "json"
20824       }
20825     ],
20826     "name": "getDescriptions",
20827     "group": "Salesforce_Configurations",
20828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20829     "version": "0.0.0",
20830     "filename": "server/api/intSalesforceConfiguration/index.js",
20831     "groupTitle": "Salesforce_Configurations"
20832   },
20833   {
20834     "type": "get",
20835     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20836     "title": "Gets configurations fields",
20837     "examples": [
20838       {
20839         "title": "Example usage:",
20840         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20841         "type": "json"
20842       }
20843     ],
20844     "name": "getFields",
20845     "group": "Salesforce_Configurations",
20846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20847     "version": "0.0.0",
20848     "filename": "server/api/intSalesforceConfiguration/index.js",
20849     "groupTitle": "Salesforce_Configurations"
20850   },
20851   {
20852     "type": "get",
20853     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20854     "title": "Gets configurations subjects",
20855     "examples": [
20856       {
20857         "title": "Example usage:",
20858         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20859         "type": "json"
20860       }
20861     ],
20862     "name": "getSubjects",
20863     "group": "Salesforce_Configurations",
20864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20865     "version": "0.0.0",
20866     "filename": "server/api/intSalesforceConfiguration/index.js",
20867     "groupTitle": "Salesforce_Configurations"
20868   },
20869   {
20870     "type": "put",
20871     "url": "/api/integrations/salesforce/configurations/{id}",
20872     "title": "Update an existing Salesforce Configuration",
20873     "examples": [
20874       {
20875         "title": "Example usage:",
20876         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20877         "type": "json"
20878       }
20879     ],
20880     "name": "updateSalesforce_Configurations",
20881     "group": "Salesforce_Configurations",
20882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20883     "version": "0.0.0",
20884     "filename": "server/api/intSalesforceConfiguration/index.js",
20885     "groupTitle": "Salesforce_Configurations"
20886   },
20887   {
20888     "type": "post",
20889     "url": "/api/integrations/salesforce/fields",
20890     "title": "Creates a new Salesforce Field",
20891     "examples": [
20892       {
20893         "title": "Example usage:",
20894         "content": "curl https://{domain}/api/integrations/salesforce/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20895         "type": "json"
20896       }
20897     ],
20898     "name": "CreateSalesforce_Fields",
20899     "group": "Salesforce_Fields",
20900     "parameter": {
20901       "fields": {
20902         "Body": [
20903           {
20904             "group": "Body",
20905             "type": "String",
20906             "allowedValues": [
20907               "\"string\"",
20908               "\"variable\"",
20909               "\"customVariable\"",
20910               "\"keyValue\"",
20911               "\"picklist\""
20912             ],
20913             "optional": true,
20914             "field": "type",
20915             "description": ""
20916           },
20917           {
20918             "group": "Body",
20919             "type": "String",
20920             "optional": true,
20921             "field": "content",
20922             "description": ""
20923           },
20924           {
20925             "group": "Body",
20926             "type": "String",
20927             "optional": true,
20928             "field": "key",
20929             "description": ""
20930           },
20931           {
20932             "group": "Body",
20933             "type": "String",
20934             "allowedValues": [
20935               "\"string\"",
20936               "\"variable\"",
20937               "\"customVariable\""
20938             ],
20939             "optional": true,
20940             "field": "keyType",
20941             "description": ""
20942           },
20943           {
20944             "group": "Body",
20945             "type": "String",
20946             "optional": true,
20947             "field": "keyContent",
20948             "description": ""
20949           },
20950           {
20951             "group": "Body",
20952             "type": "String",
20953             "optional": true,
20954             "field": "idField",
20955             "description": ""
20956           },
20957           {
20958             "group": "Body",
20959             "type": "String",
20960             "optional": true,
20961             "field": "variableName",
20962             "description": ""
20963           }
20964         ]
20965       }
20966     },
20967     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20968     "version": "0.0.0",
20969     "filename": "server/api/intSalesforceField/index.js",
20970     "groupTitle": "Salesforce_Fields"
20971   },
20972   {
20973     "type": "delete",
20974     "url": "/api/integrations/salesforce/fields/{id}",
20975     "title": "Deletes a Salesforce Field",
20976     "examples": [
20977       {
20978         "title": "Example usage:",
20979         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20980         "type": "json"
20981       }
20982     ],
20983     "name": "DeleteSalesforce_Fields",
20984     "group": "Salesforce_Fields",
20985     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20986     "version": "0.0.0",
20987     "filename": "server/api/intSalesforceField/index.js",
20988     "groupTitle": "Salesforce_Fields"
20989   },
20990   {
20991     "type": "get",
20992     "url": "/api/integrations/salesforce/fields",
20993     "title": "Gets a list of Salesforce Fields",
20994     "examples": [
20995       {
20996         "title": "Example usage:",
20997         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20998         "type": "json"
20999       }
21000     ],
21001     "name": "GetSalesforce_Fields",
21002     "group": "Salesforce_Fields",
21003     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21004     "version": "0.0.0",
21005     "filename": "server/api/intSalesforceField/index.js",
21006     "groupTitle": "Salesforce_Fields"
21007   },
21008   {
21009     "type": "get",
21010     "url": "/api/integrations/salesforce/fields/{id}",
21011     "title": "Gets a single Salesforce Field",
21012     "examples": [
21013       {
21014         "title": "Example usage:",
21015         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21016         "type": "json"
21017       }
21018     ],
21019     "name": "ShowSalesforce_Fields",
21020     "group": "Salesforce_Fields",
21021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21022     "version": "0.0.0",
21023     "filename": "server/api/intSalesforceField/index.js",
21024     "groupTitle": "Salesforce_Fields"
21025   },
21026   {
21027     "type": "put",
21028     "url": "/api/integrations/salesforce/fields/{id}",
21029     "title": "Update an existing Salesforce Field",
21030     "examples": [
21031       {
21032         "title": "Example usage:",
21033         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21034         "type": "json"
21035       }
21036     ],
21037     "name": "updateSalesforce_Fields",
21038     "group": "Salesforce_Fields",
21039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21040     "version": "0.0.0",
21041     "filename": "server/api/intSalesforceField/index.js",
21042     "groupTitle": "Salesforce_Fields"
21043   },
21044   {
21045     "type": "post",
21046     "url": "/api/schedules",
21047     "title": "Creates a new Schedule",
21048     "examples": [
21049       {
21050         "title": "Example usage:",
21051         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21052         "type": "json"
21053       }
21054     ],
21055     "name": "CreateSchedules",
21056     "group": "Schedules",
21057     "parameter": {
21058       "fields": {
21059         "Body": [
21060           {
21061             "group": "Body",
21062             "type": "String",
21063             "optional": false,
21064             "field": "name",
21065             "description": ""
21066           },
21067           {
21068             "group": "Body",
21069             "type": "String",
21070             "optional": true,
21071             "field": "description",
21072             "description": ""
21073           },
21074           {
21075             "group": "Body",
21076             "type": "Boolean",
21077             "optional": false,
21078             "field": "active",
21079             "description": ""
21080           },
21081           {
21082             "group": "Body",
21083             "type": "String",
21084             "optional": false,
21085             "field": "cron",
21086             "description": ""
21087           },
21088           {
21089             "group": "Body",
21090             "type": "String",
21091             "optional": false,
21092             "field": "startAt",
21093             "description": ""
21094           },
21095           {
21096             "group": "Body",
21097             "type": "String",
21098             "optional": false,
21099             "field": "endAt",
21100             "description": ""
21101           },
21102           {
21103             "group": "Body",
21104             "type": "Integer",
21105             "optional": false,
21106             "field": "subtractNumber",
21107             "description": ""
21108           },
21109           {
21110             "group": "Body",
21111             "type": "String",
21112             "allowedValues": [
21113               "\"years\"",
21114               "\"quarters\"",
21115               "\"months\"",
21116               "\"weeks\"",
21117               "\"days\"",
21118               "\"hours\"",
21119               "\"minutes\""
21120             ],
21121             "optional": false,
21122             "field": "subtractUnit",
21123             "description": ""
21124           },
21125           {
21126             "group": "Body",
21127             "type": "String",
21128             "allowedValues": [
21129               "\"csv\"",
21130               "\"pdf\"",
21131               "\"xlsx\""
21132             ],
21133             "optional": false,
21134             "field": "output",
21135             "description": ""
21136           },
21137           {
21138             "group": "Body",
21139             "type": "String",
21140             "allowedValues": [
21141               "\"custom\"",
21142               "\"default\""
21143             ],
21144             "optional": false,
21145             "field": "type",
21146             "description": ""
21147           },
21148           {
21149             "group": "Body",
21150             "type": "Boolean",
21151             "optional": true,
21152             "field": "sendMail",
21153             "description": ""
21154           },
21155           {
21156             "group": "Body",
21157             "type": "String",
21158             "optional": true,
21159             "field": "email",
21160             "description": ""
21161           },
21162           {
21163             "group": "Body",
21164             "type": "Text",
21165             "optional": true,
21166             "field": "cc",
21167             "description": ""
21168           },
21169           {
21170             "group": "Body",
21171             "type": "Text",
21172             "optional": true,
21173             "field": "bcc",
21174             "description": ""
21175           },
21176           {
21177             "group": "Body",
21178             "type": "Boolean",
21179             "optional": true,
21180             "field": "sendIfEmpty",
21181             "description": ""
21182           }
21183         ]
21184       }
21185     },
21186     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21187     "version": "0.0.0",
21188     "filename": "server/api/schedule/index.js",
21189     "groupTitle": "Schedules"
21190   },
21191   {
21192     "type": "delete",
21193     "url": "/api/schedules/{id}",
21194     "title": "Deletes a Schedule",
21195     "examples": [
21196       {
21197         "title": "Example usage:",
21198         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21199         "type": "json"
21200       }
21201     ],
21202     "name": "DeleteSchedules",
21203     "group": "Schedules",
21204     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21205     "version": "0.0.0",
21206     "filename": "server/api/schedule/index.js",
21207     "groupTitle": "Schedules"
21208   },
21209   {
21210     "type": "get",
21211     "url": "/api/schedules",
21212     "title": "Gets a list of Schedules",
21213     "examples": [
21214       {
21215         "title": "Example usage:",
21216         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21217         "type": "json"
21218       }
21219     ],
21220     "name": "GetSchedules",
21221     "group": "Schedules",
21222     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/schedules?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/schedules?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/schedules?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/schedules?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/schedules?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21223     "version": "0.0.0",
21224     "filename": "server/api/schedule/index.js",
21225     "groupTitle": "Schedules"
21226   },
21227   {
21228     "type": "get",
21229     "url": "/api/schedules/{id}",
21230     "title": "Gets a single Schedule",
21231     "examples": [
21232       {
21233         "title": "Example usage:",
21234         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21235         "type": "json"
21236       }
21237     ],
21238     "name": "ShowSchedules",
21239     "group": "Schedules",
21240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21241     "version": "0.0.0",
21242     "filename": "server/api/schedule/index.js",
21243     "groupTitle": "Schedules"
21244   },
21245   {
21246     "type": "get",
21247     "url": "/api/schedules/{id}/run",
21248     "title": "Run Scheduler",
21249     "examples": [
21250       {
21251         "title": "Example usage:",
21252         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21253         "type": "json"
21254       }
21255     ],
21256     "name": "run",
21257     "group": "Schedules",
21258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21259     "version": "0.0.0",
21260     "filename": "server/api/schedule/index.js",
21261     "groupTitle": "Schedules"
21262   },
21263   {
21264     "type": "put",
21265     "url": "/api/schedules/{id}",
21266     "title": "Update an existing Schedule",
21267     "examples": [
21268       {
21269         "title": "Example usage:",
21270         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21271         "type": "json"
21272       }
21273     ],
21274     "name": "updateSchedules",
21275     "group": "Schedules",
21276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21277     "version": "0.0.0",
21278     "filename": "server/api/schedule/index.js",
21279     "groupTitle": "Schedules"
21280   },
21281   {
21282     "type": "post",
21283     "url": "/api/screen/recordings",
21284     "title": "Creates a new Recording",
21285     "examples": [
21286       {
21287         "title": "Example usage:",
21288         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21289         "type": "json"
21290       }
21291     ],
21292     "name": "CreateRecordings",
21293     "group": "Screen_Recordings",
21294     "parameter": {
21295       "fields": {
21296         "Body": [
21297           {
21298             "group": "Body",
21299             "type": "Virtual",
21300             "optional": true,
21301             "field": "format",
21302             "description": ""
21303           },
21304           {
21305             "group": "Body",
21306             "type": "String",
21307             "optional": true,
21308             "field": "interactionid",
21309             "description": ""
21310           },
21311           {
21312             "group": "Body",
21313             "type": "String",
21314             "optional": true,
21315             "field": "channel",
21316             "description": ""
21317           },
21318           {
21319             "group": "Body",
21320             "type": "String",
21321             "optional": true,
21322             "field": "value",
21323             "description": ""
21324           },
21325           {
21326             "group": "Body",
21327             "type": "Integer",
21328             "optional": true,
21329             "field": "rating",
21330             "description": ""
21331           },
21332           {
21333             "group": "Body",
21334             "type": "Integer",
21335             "optional": true,
21336             "field": "duration",
21337             "description": ""
21338           },
21339           {
21340             "group": "Body",
21341             "type": "String",
21342             "optional": true,
21343             "field": "startedAt",
21344             "description": ""
21345           },
21346           {
21347             "group": "Body",
21348             "type": "String",
21349             "optional": true,
21350             "field": "closedAt",
21351             "description": ""
21352           },
21353           {
21354             "group": "Body",
21355             "type": "String",
21356             "optional": true,
21357             "field": "createdAt",
21358             "description": ""
21359           },
21360           {
21361             "group": "Body",
21362             "type": "String",
21363             "optional": true,
21364             "field": "updatedAt",
21365             "description": ""
21366           }
21367         ]
21368       }
21369     },
21370     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21371     "version": "0.0.0",
21372     "filename": "server/api/screenRecording/index.js",
21373     "groupTitle": "Screen_Recordings"
21374   },
21375   {
21376     "type": "get",
21377     "url": "/api/screen/recordings/describe",
21378     "title": "Gets table info about Recordings",
21379     "examples": [
21380       {
21381         "title": "Example usage:",
21382         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21383         "type": "json"
21384       }
21385     ],
21386     "name": "DescribeRecordings",
21387     "group": "Screen_Recordings",
21388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389     "version": "0.0.0",
21390     "filename": "server/api/screenRecording/index.js",
21391     "groupTitle": "Screen_Recordings"
21392   },
21393   {
21394     "type": "get",
21395     "url": "/api/screen/recordings",
21396     "title": "Gets a list of Recordings",
21397     "examples": [
21398       {
21399         "title": "Example usage:",
21400         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21401         "type": "json"
21402       }
21403     ],
21404     "name": "GetRecordings",
21405     "group": "Screen_Recordings",
21406     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/screen/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/screen/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/screen/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/screen/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/screen/recordings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21407     "version": "0.0.0",
21408     "filename": "server/api/screenRecording/index.js",
21409     "groupTitle": "Screen_Recordings"
21410   },
21411   {
21412     "type": "get",
21413     "url": "/api/screen/recordings/{id}",
21414     "title": "Gets a single Recording",
21415     "examples": [
21416       {
21417         "title": "Example usage:",
21418         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21419         "type": "json"
21420       }
21421     ],
21422     "name": "ShowRecordings",
21423     "group": "Screen_Recordings",
21424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425     "version": "0.0.0",
21426     "filename": "server/api/screenRecording/index.js",
21427     "groupTitle": "Screen_Recordings"
21428   },
21429   {
21430     "type": "delete",
21431     "url": "/api/screen/recordings/{id}",
21432     "title": "Delete screen recording",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "destroy",
21441     "group": "Screen_Recordings",
21442     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443     "version": "0.0.0",
21444     "filename": "server/api/screenRecording/index.js",
21445     "groupTitle": "Screen_Recordings"
21446   },
21447   {
21448     "type": "get",
21449     "url": "/api/screen/recordings/{id}/download",
21450     "title": "Download Recording",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "download",
21459     "group": "Screen_Recordings",
21460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461     "version": "0.0.0",
21462     "filename": "server/api/screenRecording/index.js",
21463     "groupTitle": "Screen_Recordings"
21464   },
21465   {
21466     "type": "put",
21467     "url": "/api/screen/recordings/{id}",
21468     "title": "Update an existing Recording",
21469     "examples": [
21470       {
21471         "title": "Example usage:",
21472         "content": "curl https://{domain}/api/screen/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21473         "type": "json"
21474       }
21475     ],
21476     "name": "updateRecordings",
21477     "group": "Screen_Recordings",
21478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479     "version": "0.0.0",
21480     "filename": "server/api/screenRecording/index.js",
21481     "groupTitle": "Screen_Recordings"
21482   },
21483   {
21484     "type": "post",
21485     "url": "/api/integrations/servicenow/accounts",
21486     "title": "Creates a new Servicenow Account",
21487     "examples": [
21488       {
21489         "title": "Example usage:",
21490         "content": "curl https://{domain}/api/integrations/servicenow/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21491         "type": "json"
21492       }
21493     ],
21494     "name": "CreateServicenow_Accounts",
21495     "group": "Servicenow_Accounts",
21496     "parameter": {
21497       "fields": {
21498         "Body": [
21499           {
21500             "group": "Body",
21501             "type": "String",
21502             "optional": true,
21503             "field": "name",
21504             "description": ""
21505           },
21506           {
21507             "group": "Body",
21508             "type": "String",
21509             "optional": true,
21510             "field": "description",
21511             "description": ""
21512           },
21513           {
21514             "group": "Body",
21515             "type": "String",
21516             "optional": true,
21517             "field": "username",
21518             "description": ""
21519           },
21520           {
21521             "group": "Body",
21522             "type": "String",
21523             "optional": true,
21524             "field": "password",
21525             "description": ""
21526           },
21527           {
21528             "group": "Body",
21529             "type": "String",
21530             "optional": true,
21531             "field": "email",
21532             "description": ""
21533           },
21534           {
21535             "group": "Body",
21536             "type": "String",
21537             "optional": true,
21538             "field": "remoteUri",
21539             "description": ""
21540           },
21541           {
21542             "group": "Body",
21543             "type": "String",
21544             "optional": false,
21545             "field": "serverUrl",
21546             "description": ""
21547           }
21548         ]
21549       }
21550     },
21551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21552     "version": "0.0.0",
21553     "filename": "server/api/intServicenowAccount/index.js",
21554     "groupTitle": "Servicenow_Accounts"
21555   },
21556   {
21557     "type": "delete",
21558     "url": "/api/integrations/servicenow/accounts/{id}",
21559     "title": "Deletes a Servicenow Account",
21560     "examples": [
21561       {
21562         "title": "Example usage:",
21563         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21564         "type": "json"
21565       }
21566     ],
21567     "name": "DeleteServicenow_Accounts",
21568     "group": "Servicenow_Accounts",
21569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21570     "version": "0.0.0",
21571     "filename": "server/api/intServicenowAccount/index.js",
21572     "groupTitle": "Servicenow_Accounts"
21573   },
21574   {
21575     "type": "get",
21576     "url": "/api/integrations/servicenow/accounts",
21577     "title": "Gets a list of Servicenow Accounts",
21578     "examples": [
21579       {
21580         "title": "Example usage:",
21581         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21582         "type": "json"
21583       }
21584     ],
21585     "name": "GetServicenow_Accounts",
21586     "group": "Servicenow_Accounts",
21587     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21588     "version": "0.0.0",
21589     "filename": "server/api/intServicenowAccount/index.js",
21590     "groupTitle": "Servicenow_Accounts"
21591   },
21592   {
21593     "type": "get",
21594     "url": "/api/integrations/servicenow/accounts/{id}",
21595     "title": "Gets a single Servicenow Account",
21596     "examples": [
21597       {
21598         "title": "Example usage:",
21599         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21600         "type": "json"
21601       }
21602     ],
21603     "name": "ShowServicenow_Accounts",
21604     "group": "Servicenow_Accounts",
21605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21606     "version": "0.0.0",
21607     "filename": "server/api/intServicenowAccount/index.js",
21608     "groupTitle": "Servicenow_Accounts"
21609   },
21610   {
21611     "type": "post",
21612     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21613     "title": "Creates new configuration",
21614     "examples": [
21615       {
21616         "title": "Example usage:",
21617         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
21618         "type": "json"
21619       }
21620     ],
21621     "name": "addConfiguration",
21622     "group": "Servicenow_Accounts",
21623     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21624     "version": "0.0.0",
21625     "filename": "server/api/intServicenowAccount/index.js",
21626     "groupTitle": "Servicenow_Accounts"
21627   },
21628   {
21629     "type": "get",
21630     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21631     "title": "Gets account configurations",
21632     "examples": [
21633       {
21634         "title": "Example usage:",
21635         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21636         "type": "json"
21637       }
21638     ],
21639     "name": "getConfigurations",
21640     "group": "Servicenow_Accounts",
21641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21642     "version": "0.0.0",
21643     "filename": "server/api/intServicenowAccount/index.js",
21644     "groupTitle": "Servicenow_Accounts"
21645   },
21646   {
21647     "type": "get",
21648     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21649     "title": "Gets account fields",
21650     "examples": [
21651       {
21652         "title": "Example usage:",
21653         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21654         "type": "json"
21655       }
21656     ],
21657     "name": "getFields",
21658     "group": "Servicenow_Accounts",
21659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21660     "version": "0.0.0",
21661     "filename": "server/api/intServicenowAccount/index.js",
21662     "groupTitle": "Servicenow_Accounts"
21663   },
21664   {
21665     "type": "put",
21666     "url": "/api/integrations/servicenow/accounts/{id}",
21667     "title": "Update an existing Servicenow Account",
21668     "examples": [
21669       {
21670         "title": "Example usage:",
21671         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21672         "type": "json"
21673       }
21674     ],
21675     "name": "updateServicenow_Accounts",
21676     "group": "Servicenow_Accounts",
21677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21678     "version": "0.0.0",
21679     "filename": "server/api/intServicenowAccount/index.js",
21680     "groupTitle": "Servicenow_Accounts"
21681   },
21682   {
21683     "type": "post",
21684     "url": "/api/integrations/servicenow/configurations",
21685     "title": "Creates a new Servicenow Configuration",
21686     "examples": [
21687       {
21688         "title": "Example usage:",
21689         "content": "curl https://{domain}/api/integrations/servicenow/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21690         "type": "json"
21691       }
21692     ],
21693     "name": "CreateServicenow_Configurations",
21694     "group": "Servicenow_Configurations",
21695     "parameter": {
21696       "fields": {
21697         "Body": [
21698           {
21699             "group": "Body",
21700             "type": "String",
21701             "optional": true,
21702             "field": "name",
21703             "description": ""
21704           },
21705           {
21706             "group": "Body",
21707             "type": "String",
21708             "optional": true,
21709             "field": "description",
21710             "description": ""
21711           }
21712         ]
21713       }
21714     },
21715     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21716     "version": "0.0.0",
21717     "filename": "server/api/intServicenowConfiguration/index.js",
21718     "groupTitle": "Servicenow_Configurations"
21719   },
21720   {
21721     "type": "delete",
21722     "url": "/api/integrations/servicenow/configurations/{id}",
21723     "title": "Deletes a Servicenow Configuration",
21724     "examples": [
21725       {
21726         "title": "Example usage:",
21727         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21728         "type": "json"
21729       }
21730     ],
21731     "name": "DeleteServicenow_Configurations",
21732     "group": "Servicenow_Configurations",
21733     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21734     "version": "0.0.0",
21735     "filename": "server/api/intServicenowConfiguration/index.js",
21736     "groupTitle": "Servicenow_Configurations"
21737   },
21738   {
21739     "type": "get",
21740     "url": "/api/integrations/servicenow/configurations",
21741     "title": "Gets a list of Servicenow Configurations",
21742     "examples": [
21743       {
21744         "title": "Example usage:",
21745         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21746         "type": "json"
21747       }
21748     ],
21749     "name": "GetServicenow_Configurations",
21750     "group": "Servicenow_Configurations",
21751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21752     "version": "0.0.0",
21753     "filename": "server/api/intServicenowConfiguration/index.js",
21754     "groupTitle": "Servicenow_Configurations"
21755   },
21756   {
21757     "type": "get",
21758     "url": "/api/integrations/servicenow/configurations/{id}",
21759     "title": "Gets a single Servicenow Configuration",
21760     "examples": [
21761       {
21762         "title": "Example usage:",
21763         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21764         "type": "json"
21765       }
21766     ],
21767     "name": "ShowServicenow_Configurations",
21768     "group": "Servicenow_Configurations",
21769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21770     "version": "0.0.0",
21771     "filename": "server/api/intServicenowConfiguration/index.js",
21772     "groupTitle": "Servicenow_Configurations"
21773   },
21774   {
21775     "type": "get",
21776     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21777     "title": "Gets configurations descriptions",
21778     "examples": [
21779       {
21780         "title": "Example usage:",
21781         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21782         "type": "json"
21783       }
21784     ],
21785     "name": "getDescriptions",
21786     "group": "Servicenow_Configurations",
21787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21788     "version": "0.0.0",
21789     "filename": "server/api/intServicenowConfiguration/index.js",
21790     "groupTitle": "Servicenow_Configurations"
21791   },
21792   {
21793     "type": "get",
21794     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21795     "title": "Gets configurations fields",
21796     "examples": [
21797       {
21798         "title": "Example usage:",
21799         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21800         "type": "json"
21801       }
21802     ],
21803     "name": "getFields",
21804     "group": "Servicenow_Configurations",
21805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21806     "version": "0.0.0",
21807     "filename": "server/api/intServicenowConfiguration/index.js",
21808     "groupTitle": "Servicenow_Configurations"
21809   },
21810   {
21811     "type": "get",
21812     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21813     "title": "Gets configurations subjects",
21814     "examples": [
21815       {
21816         "title": "Example usage:",
21817         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21818         "type": "json"
21819       }
21820     ],
21821     "name": "getSubjects",
21822     "group": "Servicenow_Configurations",
21823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21824     "version": "0.0.0",
21825     "filename": "server/api/intServicenowConfiguration/index.js",
21826     "groupTitle": "Servicenow_Configurations"
21827   },
21828   {
21829     "type": "put",
21830     "url": "/api/integrations/servicenow/configurations/{id}",
21831     "title": "Update an existing Servicenow Configuration",
21832     "examples": [
21833       {
21834         "title": "Example usage:",
21835         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21836         "type": "json"
21837       }
21838     ],
21839     "name": "updateServicenow_Configurations",
21840     "group": "Servicenow_Configurations",
21841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21842     "version": "0.0.0",
21843     "filename": "server/api/intServicenowConfiguration/index.js",
21844     "groupTitle": "Servicenow_Configurations"
21845   },
21846   {
21847     "type": "post",
21848     "url": "/api/integrations/servicenow/fields",
21849     "title": "Creates a new Servicenow Field",
21850     "examples": [
21851       {
21852         "title": "Example usage:",
21853         "content": "curl https://{domain}/api/integrations/servicenow/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21854         "type": "json"
21855       }
21856     ],
21857     "name": "CreateServicenow_Fields",
21858     "group": "Servicenow_Fields",
21859     "parameter": {
21860       "fields": {
21861         "Body": [
21862           {
21863             "group": "Body",
21864             "type": "String",
21865             "allowedValues": [
21866               "\"string\"",
21867               "\"variable\"",
21868               "\"customVariable\"",
21869               "\"keyValue\"",
21870               "\"picklist\""
21871             ],
21872             "optional": true,
21873             "field": "type",
21874             "description": ""
21875           },
21876           {
21877             "group": "Body",
21878             "type": "String",
21879             "optional": true,
21880             "field": "content",
21881             "description": ""
21882           },
21883           {
21884             "group": "Body",
21885             "type": "String",
21886             "optional": true,
21887             "field": "key",
21888             "description": ""
21889           },
21890           {
21891             "group": "Body",
21892             "type": "String",
21893             "allowedValues": [
21894               "\"string\"",
21895               "\"variable\"",
21896               "\"customVariable\""
21897             ],
21898             "optional": true,
21899             "field": "keyType",
21900             "description": ""
21901           },
21902           {
21903             "group": "Body",
21904             "type": "String",
21905             "optional": true,
21906             "field": "keyContent",
21907             "description": ""
21908           },
21909           {
21910             "group": "Body",
21911             "type": "String",
21912             "optional": true,
21913             "field": "idField",
21914             "description": ""
21915           },
21916           {
21917             "group": "Body",
21918             "type": "String",
21919             "optional": true,
21920             "field": "nameField",
21921             "description": ""
21922           },
21923           {
21924             "group": "Body",
21925             "type": "Boolean",
21926             "optional": true,
21927             "field": "customField",
21928             "description": ""
21929           },
21930           {
21931             "group": "Body",
21932             "type": "String",
21933             "optional": true,
21934             "field": "variableName",
21935             "description": ""
21936           }
21937         ]
21938       }
21939     },
21940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21941     "version": "0.0.0",
21942     "filename": "server/api/intServicenowField/index.js",
21943     "groupTitle": "Servicenow_Fields"
21944   },
21945   {
21946     "type": "delete",
21947     "url": "/api/integrations/servicenow/fields/{id}",
21948     "title": "Deletes a Servicenow Field",
21949     "examples": [
21950       {
21951         "title": "Example usage:",
21952         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21953         "type": "json"
21954       }
21955     ],
21956     "name": "DeleteServicenow_Fields",
21957     "group": "Servicenow_Fields",
21958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21959     "version": "0.0.0",
21960     "filename": "server/api/intServicenowField/index.js",
21961     "groupTitle": "Servicenow_Fields"
21962   },
21963   {
21964     "type": "get",
21965     "url": "/api/integrations/servicenow/fields",
21966     "title": "Gets a list of Servicenow Fields",
21967     "examples": [
21968       {
21969         "title": "Example usage:",
21970         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21971         "type": "json"
21972       }
21973     ],
21974     "name": "GetServicenow_Fields",
21975     "group": "Servicenow_Fields",
21976     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21977     "version": "0.0.0",
21978     "filename": "server/api/intServicenowField/index.js",
21979     "groupTitle": "Servicenow_Fields"
21980   },
21981   {
21982     "type": "get",
21983     "url": "/api/integrations/servicenow/fields/{id}",
21984     "title": "Gets a single Servicenow Field",
21985     "examples": [
21986       {
21987         "title": "Example usage:",
21988         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21989         "type": "json"
21990       }
21991     ],
21992     "name": "ShowServicenow_Fields",
21993     "group": "Servicenow_Fields",
21994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21995     "version": "0.0.0",
21996     "filename": "server/api/intServicenowField/index.js",
21997     "groupTitle": "Servicenow_Fields"
21998   },
21999   {
22000     "type": "put",
22001     "url": "/api/integrations/servicenow/fields/{id}",
22002     "title": "Update an existing Servicenow Field",
22003     "examples": [
22004       {
22005         "title": "Example usage:",
22006         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22007         "type": "json"
22008       }
22009     ],
22010     "name": "updateServicenow_Fields",
22011     "group": "Servicenow_Fields",
22012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22013     "version": "0.0.0",
22014     "filename": "server/api/intServicenowField/index.js",
22015     "groupTitle": "Servicenow_Fields"
22016   },
22017   {
22018     "type": "get",
22019     "url": "/api/settings",
22020     "title": "Gets a list of Settings",
22021     "examples": [
22022       {
22023         "title": "Example usage:",
22024         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22025         "type": "json"
22026       }
22027     ],
22028     "name": "GetSettings",
22029     "group": "Settings",
22030     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/settings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/settings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/settings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/settings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/settings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22031     "version": "0.0.0",
22032     "filename": "server/api/setting/index.js",
22033     "groupTitle": "Settings"
22034   },
22035   {
22036     "type": "get",
22037     "url": "/api/settings/{id}",
22038     "title": "Gets a single Setting",
22039     "examples": [
22040       {
22041         "title": "Example usage:",
22042         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22043         "type": "json"
22044       }
22045     ],
22046     "name": "ShowSettings",
22047     "group": "Settings",
22048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22049     "version": "0.0.0",
22050     "filename": "server/api/setting/index.js",
22051     "groupTitle": "Settings"
22052   },
22053   {
22054     "type": "post",
22055     "url": "/api/settings/{id}/favicon",
22056     "title": "Add Favicon",
22057     "examples": [
22058       {
22059         "title": "Example usage:",
22060         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22061         "type": "json"
22062       }
22063     ],
22064     "name": "addFavicon",
22065     "group": "Settings",
22066     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22067     "version": "0.0.0",
22068     "filename": "server/api/setting/index.js",
22069     "groupTitle": "Settings"
22070   },
22071   {
22072     "type": "post",
22073     "url": "/api/settings/{id}/logo",
22074     "title": "Add logo",
22075     "examples": [
22076       {
22077         "title": "Example usage:",
22078         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22079         "type": "json"
22080       }
22081     ],
22082     "name": "addLogo",
22083     "group": "Settings",
22084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22085     "version": "0.0.0",
22086     "filename": "server/api/setting/index.js",
22087     "groupTitle": "Settings"
22088   },
22089   {
22090     "type": "post",
22091     "url": "/api/settings/{id}/logo_login",
22092     "title": "Add logo login",
22093     "examples": [
22094       {
22095         "title": "Example usage:",
22096         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22097         "type": "json"
22098       }
22099     ],
22100     "name": "addLogoLogin",
22101     "group": "Settings",
22102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22103     "version": "0.0.0",
22104     "filename": "server/api/setting/index.js",
22105     "groupTitle": "Settings"
22106   },
22107   {
22108     "type": "post",
22109     "url": "/api/settings/{id}/preferred",
22110     "title": "Add Preferred",
22111     "examples": [
22112       {
22113         "title": "Example usage:",
22114         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22115         "type": "json"
22116       }
22117     ],
22118     "name": "addPreferred",
22119     "group": "Settings",
22120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22121     "version": "0.0.0",
22122     "filename": "server/api/setting/index.js",
22123     "groupTitle": "Settings"
22124   },
22125   {
22126     "type": "get",
22127     "url": "/api/settings/now",
22128     "title": "Get Server Current Date",
22129     "examples": [
22130       {
22131         "title": "Example usage:",
22132         "content": "curl https://{domain}/api/settings/now -v -X GET",
22133         "type": "json"
22134       }
22135     ],
22136     "name": "getDate",
22137     "group": "Settings",
22138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22139     "version": "0.0.0",
22140     "filename": "server/api/setting/index.js",
22141     "groupTitle": "Settings"
22142   },
22143   {
22144     "type": "get",
22145     "url": "/api/settings/{id}/favicon",
22146     "title": "Get Favicon",
22147     "examples": [
22148       {
22149         "title": "Example usage:",
22150         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22151         "type": "json"
22152       }
22153     ],
22154     "name": "getFavicon",
22155     "group": "Settings",
22156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22157     "version": "0.0.0",
22158     "filename": "server/api/setting/index.js",
22159     "groupTitle": "Settings"
22160   },
22161   {
22162     "type": "get",
22163     "url": "/api/settings/{id}/gdpr",
22164     "title": "Get gdpr settings",
22165     "examples": [
22166       {
22167         "title": "Example usage:",
22168         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22169         "type": "json"
22170       }
22171     ],
22172     "name": "getGdpr",
22173     "group": "Settings",
22174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22175     "version": "0.0.0",
22176     "filename": "server/api/setting/index.js",
22177     "groupTitle": "Settings"
22178   },
22179   {
22180     "type": "get",
22181     "url": "/api/settings/{id}/logo",
22182     "title": "Get logo",
22183     "examples": [
22184       {
22185         "title": "Example usage:",
22186         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22187         "type": "json"
22188       }
22189     ],
22190     "name": "getLogo",
22191     "group": "Settings",
22192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22193     "version": "0.0.0",
22194     "filename": "server/api/setting/index.js",
22195     "groupTitle": "Settings"
22196   },
22197   {
22198     "type": "get",
22199     "url": "/api/settings/{id}/logo_login",
22200     "title": "Get logo login",
22201     "examples": [
22202       {
22203         "title": "Example usage:",
22204         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22205         "type": "json"
22206       }
22207     ],
22208     "name": "getLogoLogin",
22209     "group": "Settings",
22210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22211     "version": "0.0.0",
22212     "filename": "server/api/setting/index.js",
22213     "groupTitle": "Settings"
22214   },
22215   {
22216     "type": "get",
22217     "url": "/api/settings/{id}/preferred",
22218     "title": "Get Preferred",
22219     "examples": [
22220       {
22221         "title": "Example usage:",
22222         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22223         "type": "json"
22224       }
22225     ],
22226     "name": "getPreferred",
22227     "group": "Settings",
22228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22229     "version": "0.0.0",
22230     "filename": "server/api/setting/index.js",
22231     "groupTitle": "Settings"
22232   },
22233   {
22234     "type": "put",
22235     "url": "/api/settings/{id}",
22236     "title": "Update an existing Setting",
22237     "examples": [
22238       {
22239         "title": "Example usage:",
22240         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22241         "type": "json"
22242       }
22243     ],
22244     "name": "updateSettings",
22245     "group": "Settings",
22246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22247     "version": "0.0.0",
22248     "filename": "server/api/setting/index.js",
22249     "groupTitle": "Settings"
22250   },
22251   {
22252     "type": "post",
22253     "url": "/api/sms/accounts/{id}/users",
22254     "title": "Add agents to a sms account",
22255     "examples": [
22256       {
22257         "title": "Example usage:",
22258         "content": "curl https://{domain}/api/sms/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22259         "type": "json"
22260       }
22261     ],
22262     "name": "AddAgents",
22263     "group": "Sms_Accounts",
22264     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22265     "version": "0.0.0",
22266     "filename": "server/api/smsAccount/index.js",
22267     "groupTitle": "Sms_Accounts"
22268   },
22269   {
22270     "type": "post",
22271     "url": "/api/sms/accounts",
22272     "title": "Creates a new Account",
22273     "examples": [
22274       {
22275         "title": "Example usage:",
22276         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22277         "type": "json"
22278       }
22279     ],
22280     "name": "CreateAccounts",
22281     "group": "Sms_Accounts",
22282     "parameter": {
22283       "fields": {
22284         "Body": [
22285           {
22286             "group": "Body",
22287             "type": "String",
22288             "optional": false,
22289             "field": "name",
22290             "description": ""
22291           },
22292           {
22293             "group": "Body",
22294             "type": "String",
22295             "optional": false,
22296             "field": "key",
22297             "description": ""
22298           },
22299           {
22300             "group": "Body",
22301             "type": "String",
22302             "optional": false,
22303             "field": "remote",
22304             "description": ""
22305           },
22306           {
22307             "group": "Body",
22308             "type": "String",
22309             "optional": true,
22310             "field": "token",
22311             "description": ""
22312           },
22313           {
22314             "group": "Body",
22315             "type": "String",
22316             "optional": true,
22317             "field": "phone",
22318             "description": ""
22319           },
22320           {
22321             "group": "Body",
22322             "type": "String",
22323             "allowedValues": [
22324               "\"twilio\"",
22325               "\"skebby\"",
22326               "\"connectel\"",
22327               "\"clicksend\"",
22328               "\"plivo\"",
22329               "\"clickatell\"",
22330               "\"bandwidth\"",
22331               "\"csc\"",
22332               "\"infobip\"",
22333               "\"intelepeer\""
22334             ],
22335             "optional": true,
22336             "field": "type",
22337             "description": ""
22338           },
22339           {
22340             "group": "Body",
22341             "type": "String",
22342             "optional": true,
22343             "field": "accountSid",
22344             "description": ""
22345           },
22346           {
22347             "group": "Body",
22348             "type": "String",
22349             "optional": true,
22350             "field": "authId",
22351             "description": ""
22352           },
22353           {
22354             "group": "Body",
22355             "type": "String",
22356             "optional": true,
22357             "field": "authToken",
22358             "description": ""
22359           },
22360           {
22361             "group": "Body",
22362             "type": "String",
22363             "allowedValues": [
22364               "\"SI\"",
22365               "\"TI\"",
22366               "\"GP\""
22367             ],
22368             "optional": true,
22369             "field": "smsMethod",
22370             "description": ""
22371           },
22372           {
22373             "group": "Body",
22374             "type": "String",
22375             "optional": true,
22376             "field": "username",
22377             "description": ""
22378           },
22379           {
22380             "group": "Body",
22381             "type": "String",
22382             "optional": true,
22383             "field": "password",
22384             "description": ""
22385           },
22386           {
22387             "group": "Body",
22388             "type": "String",
22389             "optional": true,
22390             "field": "apiKey",
22391             "description": ""
22392           },
22393           {
22394             "group": "Body",
22395             "type": "String",
22396             "optional": true,
22397             "field": "applicationId",
22398             "description": ""
22399           },
22400           {
22401             "group": "Body",
22402             "type": "String",
22403             "optional": true,
22404             "field": "accountId",
22405             "description": ""
22406           },
22407           {
22408             "group": "Body",
22409             "type": "String",
22410             "optional": true,
22411             "field": "senderString",
22412             "description": ""
22413           },
22414           {
22415             "group": "Body",
22416             "type": "Boolean",
22417             "optional": true,
22418             "field": "deliveryReport",
22419             "description": ""
22420           },
22421           {
22422             "group": "Body",
22423             "type": "String",
22424             "optional": true,
22425             "field": "description",
22426             "description": ""
22427           },
22428           {
22429             "group": "Body",
22430             "type": "Text",
22431             "optional": true,
22432             "field": "notificationTemplate",
22433             "description": ""
22434           },
22435           {
22436             "group": "Body",
22437             "type": "Boolean",
22438             "optional": true,
22439             "field": "notificationSound",
22440             "description": ""
22441           },
22442           {
22443             "group": "Body",
22444             "type": "Boolean",
22445             "optional": true,
22446             "field": "notificationShake",
22447             "description": ""
22448           },
22449           {
22450             "group": "Body",
22451             "type": "Integer",
22452             "optional": true,
22453             "field": "waitForTheAssignedAgent",
22454             "description": ""
22455           },
22456           {
22457             "group": "Body",
22458             "type": "Boolean",
22459             "optional": true,
22460             "field": "queueTransfer",
22461             "description": ""
22462           },
22463           {
22464             "group": "Body",
22465             "type": "Integer",
22466             "optional": true,
22467             "field": "queueTransferTimeout",
22468             "description": ""
22469           },
22470           {
22471             "group": "Body",
22472             "type": "Boolean",
22473             "optional": true,
22474             "field": "agentTransfer",
22475             "description": ""
22476           },
22477           {
22478             "group": "Body",
22479             "type": "Integer",
22480             "optional": true,
22481             "field": "agentTransferTimeout",
22482             "description": ""
22483           },
22484           {
22485             "group": "Body",
22486             "type": "String",
22487             "optional": true,
22488             "field": "baseUrl",
22489             "description": ""
22490           },
22491           {
22492             "group": "Body",
22493             "type": "Integer",
22494             "optional": true,
22495             "field": "mandatoryDispositionPauseId",
22496             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22497           },
22498           {
22499             "group": "Body",
22500             "type": "Boolean",
22501             "optional": true,
22502             "field": "mandatoryDisposition",
22503             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22504           }
22505         ]
22506       }
22507     },
22508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22509     "version": "0.0.0",
22510     "filename": "server/api/smsAccount/index.js",
22511     "groupTitle": "Sms_Accounts"
22512   },
22513   {
22514     "type": "delete",
22515     "url": "/api/sms/accounts/{id}",
22516     "title": "Deletes a Account",
22517     "examples": [
22518       {
22519         "title": "Example usage:",
22520         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22521         "type": "json"
22522       }
22523     ],
22524     "name": "DeleteAccounts",
22525     "group": "Sms_Accounts",
22526     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22527     "version": "0.0.0",
22528     "filename": "server/api/smsAccount/index.js",
22529     "groupTitle": "Sms_Accounts"
22530   },
22531   {
22532     "type": "get",
22533     "url": "/api/sms/accounts/describe",
22534     "title": "Gets table info about Accounts",
22535     "examples": [
22536       {
22537         "title": "Example usage:",
22538         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22539         "type": "json"
22540       }
22541     ],
22542     "name": "DescribeAccounts",
22543     "group": "Sms_Accounts",
22544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22545     "version": "0.0.0",
22546     "filename": "server/api/smsAccount/index.js",
22547     "groupTitle": "Sms_Accounts"
22548   },
22549   {
22550     "type": "get",
22551     "url": "/api/sms/accounts",
22552     "title": "Gets a list of Accounts",
22553     "examples": [
22554       {
22555         "title": "Example usage:",
22556         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22557         "type": "json"
22558       }
22559     ],
22560     "name": "GetAccounts",
22561     "group": "Sms_Accounts",
22562     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22563     "version": "0.0.0",
22564     "filename": "server/api/smsAccount/index.js",
22565     "groupTitle": "Sms_Accounts"
22566   },
22567   {
22568     "type": "get",
22569     "url": "/api/sms/accounts/{id}/users",
22570     "title": "Gets agents from sms account",
22571     "examples": [
22572       {
22573         "title": "Example usage:",
22574         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22575         "type": "json"
22576       }
22577     ],
22578     "name": "GetAgents",
22579     "group": "Sms_Accounts",
22580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22581     "version": "0.0.0",
22582     "filename": "server/api/smsAccount/index.js",
22583     "groupTitle": "Sms_Accounts"
22584   },
22585   {
22586     "type": "delete",
22587     "url": "/api/sms/accounts/{id}/users",
22588     "title": "Removes agents from a sms account",
22589     "examples": [
22590       {
22591         "title": "Example usage:",
22592         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22593         "type": "json"
22594       }
22595     ],
22596     "name": "RemoveAgents",
22597     "group": "Sms_Accounts",
22598     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22599     "version": "0.0.0",
22600     "filename": "server/api/smsAccount/index.js",
22601     "groupTitle": "Sms_Accounts"
22602   },
22603   {
22604     "type": "delete",
22605     "url": "/api/sms/accounts/{id}/canned_answers",
22606     "title": "Removes canned answers from account",
22607     "examples": [
22608       {
22609         "title": "Example usage:",
22610         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22611         "type": "json"
22612       }
22613     ],
22614     "name": "RemoveAnswers",
22615     "group": "Sms_Accounts",
22616     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22617     "version": "0.0.0",
22618     "filename": "server/api/smsAccount/index.js",
22619     "groupTitle": "Sms_Accounts"
22620   },
22621   {
22622     "type": "delete",
22623     "url": "/api/sms/accounts/{id}/dispositions",
22624     "title": "Removes dispositions from account",
22625     "examples": [
22626       {
22627         "title": "Example usage:",
22628         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22629         "type": "json"
22630       }
22631     ],
22632     "name": "RemoveDispositions",
22633     "group": "Sms_Accounts",
22634     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22635     "version": "0.0.0",
22636     "filename": "server/api/smsAccount/index.js",
22637     "groupTitle": "Sms_Accounts"
22638   },
22639   {
22640     "type": "get",
22641     "url": "/api/sms/accounts/{id}",
22642     "title": "Gets a single Account",
22643     "examples": [
22644       {
22645         "title": "Example usage:",
22646         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22647         "type": "json"
22648       }
22649     ],
22650     "name": "ShowAccounts",
22651     "group": "Sms_Accounts",
22652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22653     "version": "0.0.0",
22654     "filename": "server/api/smsAccount/index.js",
22655     "groupTitle": "Sms_Accounts"
22656   },
22657   {
22658     "type": "put",
22659     "url": "/api/sms/messages/{id}/accept",
22660     "title": "Accepts message",
22661     "examples": [
22662       {
22663         "title": "Example usage:",
22664         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22665         "type": "json"
22666       }
22667     ],
22668     "name": "acceptMessage",
22669     "group": "Sms_Accounts",
22670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22671     "version": "0.0.0",
22672     "filename": "server/api/smsMessage/index.js",
22673     "groupTitle": "Sms_Accounts"
22674   },
22675   {
22676     "type": "post",
22677     "url": "/api/sms/accounts/{id}/canned_answers",
22678     "title": "Creates new canned answer",
22679     "examples": [
22680       {
22681         "title": "Example usage:",
22682         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22683         "type": "json"
22684       }
22685     ],
22686     "name": "addAnswer",
22687     "group": "Sms_Accounts",
22688     "parameter": {
22689       "fields": {
22690         "Body": [
22691           {
22692             "group": "Body",
22693             "type": "String",
22694             "optional": false,
22695             "field": "key",
22696             "description": ""
22697           },
22698           {
22699             "group": "Body",
22700             "type": "Text",
22701             "optional": false,
22702             "field": "value",
22703             "description": ""
22704           },
22705           {
22706             "group": "Body",
22707             "type": "String",
22708             "optional": true,
22709             "field": "description",
22710             "description": ""
22711           },
22712           {
22713             "group": "Body",
22714             "type": "Virtual",
22715             "optional": true,
22716             "field": "name",
22717             "description": ""
22718           }
22719         ]
22720       }
22721     },
22722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22723     "version": "0.0.0",
22724     "filename": "server/api/smsAccount/index.js",
22725     "groupTitle": "Sms_Accounts"
22726   },
22727   {
22728     "type": "post",
22729     "url": "/api/sms/accounts/{id}/applications",
22730     "title": "Creates new applications",
22731     "examples": [
22732       {
22733         "title": "Example usage:",
22734         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22735         "type": "json"
22736       }
22737     ],
22738     "name": "addApplications",
22739     "group": "Sms_Accounts",
22740     "parameter": {
22741       "fields": {
22742         "Body": [
22743           {
22744             "group": "Body",
22745             "type": "Integer",
22746             "optional": false,
22747             "field": "priority",
22748             "description": ""
22749           },
22750           {
22751             "group": "Body",
22752             "type": "String",
22753             "optional": false,
22754             "field": "app",
22755             "description": ""
22756           },
22757           {
22758             "group": "Body",
22759             "type": "Text",
22760             "optional": true,
22761             "field": "appdata",
22762             "description": ""
22763           },
22764           {
22765             "group": "Body",
22766             "type": "String",
22767             "optional": true,
22768             "field": "description",
22769             "description": ""
22770           },
22771           {
22772             "group": "Body",
22773             "type": "String",
22774             "optional": true,
22775             "field": "interval",
22776             "description": ""
22777           }
22778         ]
22779       }
22780     },
22781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782     "version": "0.0.0",
22783     "filename": "server/api/smsAccount/index.js",
22784     "groupTitle": "Sms_Accounts"
22785   },
22786   {
22787     "type": "post",
22788     "url": "/api/sms/accounts/{id}/dispositions",
22789     "title": "Creates new disposition",
22790     "examples": [
22791       {
22792         "title": "Example usage:",
22793         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22794         "type": "json"
22795       }
22796     ],
22797     "name": "addDisposition",
22798     "group": "Sms_Accounts",
22799     "parameter": {
22800       "fields": {
22801         "Body": [
22802           {
22803             "group": "Body",
22804             "type": "String",
22805             "optional": false,
22806             "field": "name",
22807             "description": ""
22808           },
22809           {
22810             "group": "Body",
22811             "type": "String",
22812             "allowedValues": [
22813               "\"first\"",
22814               "\"second\"",
22815               "\"third\""
22816             ],
22817             "optional": false,
22818             "field": "level",
22819             "description": ""
22820           },
22821           {
22822             "group": "Body",
22823             "type": "String",
22824             "optional": true,
22825             "field": "description",
22826             "description": ""
22827           }
22828         ]
22829       }
22830     },
22831     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22832     "version": "0.0.0",
22833     "filename": "server/api/smsAccount/index.js",
22834     "groupTitle": "Sms_Accounts"
22835   },
22836   {
22837     "type": "get",
22838     "url": "/api/sms/accounts/{id}/canned_answers",
22839     "title": "Gets account canned answers",
22840     "examples": [
22841       {
22842         "title": "Example usage:",
22843         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22844         "type": "json"
22845       }
22846     ],
22847     "name": "getAnswers",
22848     "group": "Sms_Accounts",
22849     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22850     "version": "0.0.0",
22851     "filename": "server/api/smsAccount/index.js",
22852     "groupTitle": "Sms_Accounts"
22853   },
22854   {
22855     "type": "get",
22856     "url": "/api/sms/accounts/{id}/applications",
22857     "title": "Gets account applications",
22858     "examples": [
22859       {
22860         "title": "Example usage:",
22861         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22862         "type": "json"
22863       }
22864     ],
22865     "name": "getApplications",
22866     "group": "Sms_Accounts",
22867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22868     "version": "0.0.0",
22869     "filename": "server/api/smsAccount/index.js",
22870     "groupTitle": "Sms_Accounts"
22871   },
22872   {
22873     "type": "get",
22874     "url": "/api/sms/accounts/{id}/dispositions",
22875     "title": "Gets account dispositions",
22876     "examples": [
22877       {
22878         "title": "Example usage:",
22879         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22880         "type": "json"
22881       }
22882     ],
22883     "name": "getDispositions",
22884     "group": "Sms_Accounts",
22885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22886     "version": "0.0.0",
22887     "filename": "server/api/smsAccount/index.js",
22888     "groupTitle": "Sms_Accounts"
22889   },
22890   {
22891     "type": "get",
22892     "url": "/api/sms/accounts/{id}/interactions",
22893     "title": "Gets Sms Account interactions",
22894     "examples": [
22895       {
22896         "title": "Example usage:",
22897         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22898         "type": "json"
22899       }
22900     ],
22901     "name": "getInteractions",
22902     "group": "Sms_Accounts",
22903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22904     "version": "0.0.0",
22905     "filename": "server/api/smsAccount/index.js",
22906     "groupTitle": "Sms_Accounts"
22907   },
22908   {
22909     "type": "post",
22910     "url": "/api/sms/accounts/{id}/notify",
22911     "title": "Notify new message",
22912     "examples": [
22913       {
22914         "title": "Example usage:",
22915         "content": "curl https://{domain}/api/sms/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22916         "type": "json"
22917       }
22918     ],
22919     "name": "notify",
22920     "group": "Sms_Accounts",
22921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new sms message to be sent to the system.</p>",
22922     "version": "0.0.0",
22923     "filename": "server/api/smsAccount/index.js",
22924     "groupTitle": "Sms_Accounts"
22925   },
22926   {
22927     "type": "put",
22928     "url": "/api/sms/messages/{id}/reject",
22929     "title": "Rejects message",
22930     "examples": [
22931       {
22932         "title": "Example usage:",
22933         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22934         "type": "json"
22935       }
22936     ],
22937     "name": "rejectMessage",
22938     "group": "Sms_Accounts",
22939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22940     "version": "0.0.0",
22941     "filename": "server/api/smsMessage/index.js",
22942     "groupTitle": "Sms_Accounts"
22943   },
22944   {
22945     "type": "post",
22946     "url": "/api/sms/accounts/{id}/send",
22947     "title": "Send new sms message",
22948     "examples": [
22949       {
22950         "title": "Example usage:",
22951         "content": "curl https://{domain}/api/sms/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22952         "type": "json"
22953       }
22954     ],
22955     "name": "sendSms",
22956     "group": "Sms_Accounts",
22957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22958     "version": "0.0.0",
22959     "filename": "server/api/smsAccount/index.js",
22960     "groupTitle": "Sms_Accounts"
22961   },
22962   {
22963     "type": "get",
22964     "url": "/api/sms/accounts/{id}/status",
22965     "title": "Receive message status as get request",
22966     "examples": [
22967       {
22968         "title": "Example usage:",
22969         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22970         "type": "json"
22971       }
22972     ],
22973     "name": "statusMessage",
22974     "group": "Sms_Accounts",
22975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22976     "version": "0.0.0",
22977     "filename": "server/api/smsAccount/index.js",
22978     "groupTitle": "Sms_Accounts"
22979   },
22980   {
22981     "type": "post",
22982     "url": "/api/sms/messages/{id}/status",
22983     "title": "Receive message status",
22984     "examples": [
22985       {
22986         "title": "Example usage:",
22987         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22988         "type": "json"
22989       }
22990     ],
22991     "name": "statusMessage",
22992     "group": "Sms_Accounts",
22993     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22994     "version": "0.0.0",
22995     "filename": "server/api/smsMessage/index.js",
22996     "groupTitle": "Sms_Accounts"
22997   },
22998   {
22999     "type": "post",
23000     "url": "/api/sms/accounts/{id}/status",
23001     "title": "Receive message status",
23002     "examples": [
23003       {
23004         "title": "Example usage:",
23005         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23006         "type": "json"
23007       }
23008     ],
23009     "name": "statusMessage",
23010     "group": "Sms_Accounts",
23011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23012     "version": "0.0.0",
23013     "filename": "server/api/smsAccount/index.js",
23014     "groupTitle": "Sms_Accounts"
23015   },
23016   {
23017     "type": "put",
23018     "url": "/api/sms/accounts/{id}",
23019     "title": "Update an existing Account",
23020     "examples": [
23021       {
23022         "title": "Example usage:",
23023         "content": "curl https://{domain}/api/sms/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23024         "type": "json"
23025       }
23026     ],
23027     "name": "updateAccounts",
23028     "group": "Sms_Accounts",
23029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23030     "version": "0.0.0",
23031     "filename": "server/api/smsAccount/index.js",
23032     "groupTitle": "Sms_Accounts"
23033   },
23034   {
23035     "type": "post",
23036     "url": "/api/sms/applications",
23037     "title": "Creates a new Application",
23038     "examples": [
23039       {
23040         "title": "Example usage:",
23041         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23042         "type": "json"
23043       }
23044     ],
23045     "name": "CreateApplications",
23046     "group": "Sms_Applications",
23047     "parameter": {
23048       "fields": {
23049         "Body": [
23050           {
23051             "group": "Body",
23052             "type": "Integer",
23053             "optional": false,
23054             "field": "priority",
23055             "description": ""
23056           },
23057           {
23058             "group": "Body",
23059             "type": "String",
23060             "optional": false,
23061             "field": "app",
23062             "description": ""
23063           },
23064           {
23065             "group": "Body",
23066             "type": "Text",
23067             "optional": true,
23068             "field": "appdata",
23069             "description": ""
23070           },
23071           {
23072             "group": "Body",
23073             "type": "String",
23074             "optional": true,
23075             "field": "description",
23076             "description": ""
23077           },
23078           {
23079             "group": "Body",
23080             "type": "String",
23081             "optional": true,
23082             "field": "interval",
23083             "description": ""
23084           }
23085         ]
23086       }
23087     },
23088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23089     "version": "0.0.0",
23090     "filename": "server/api/smsApplication/index.js",
23091     "groupTitle": "Sms_Applications"
23092   },
23093   {
23094     "type": "delete",
23095     "url": "/api/sms/applications/{id}",
23096     "title": "Deletes a Application",
23097     "examples": [
23098       {
23099         "title": "Example usage:",
23100         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23101         "type": "json"
23102       }
23103     ],
23104     "name": "DeleteApplications",
23105     "group": "Sms_Applications",
23106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23107     "version": "0.0.0",
23108     "filename": "server/api/smsApplication/index.js",
23109     "groupTitle": "Sms_Applications"
23110   },
23111   {
23112     "type": "get",
23113     "url": "/api/sms/applications",
23114     "title": "Gets a list of Applications",
23115     "examples": [
23116       {
23117         "title": "Example usage:",
23118         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23119         "type": "json"
23120       }
23121     ],
23122     "name": "GetApplications",
23123     "group": "Sms_Applications",
23124     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23125     "version": "0.0.0",
23126     "filename": "server/api/smsApplication/index.js",
23127     "groupTitle": "Sms_Applications"
23128   },
23129   {
23130     "type": "get",
23131     "url": "/api/sms/applications/{id}",
23132     "title": "Gets a single Application",
23133     "examples": [
23134       {
23135         "title": "Example usage:",
23136         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23137         "type": "json"
23138       }
23139     ],
23140     "name": "ShowApplications",
23141     "group": "Sms_Applications",
23142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23143     "version": "0.0.0",
23144     "filename": "server/api/smsApplication/index.js",
23145     "groupTitle": "Sms_Applications"
23146   },
23147   {
23148     "type": "put",
23149     "url": "/api/sms/applications/{id}",
23150     "title": "Update an existing Application",
23151     "examples": [
23152       {
23153         "title": "Example usage:",
23154         "content": "curl https://{domain}/api/sms/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23155         "type": "json"
23156       }
23157     ],
23158     "name": "updateApplications",
23159     "group": "Sms_Applications",
23160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161     "version": "0.0.0",
23162     "filename": "server/api/smsApplication/index.js",
23163     "groupTitle": "Sms_Applications"
23164   },
23165   {
23166     "type": "post",
23167     "url": "/api/sms/interactions/{id}/tags",
23168     "title": "Add tags to the interaction",
23169     "examples": [
23170       {
23171         "title": "Example usage:",
23172         "content": "curl https://{domain}/api/sms/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23173         "type": "json"
23174       }
23175     ],
23176     "name": "AddTags",
23177     "group": "Sms_Interactions",
23178     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23179     "version": "0.0.0",
23180     "filename": "server/api/smsInteraction/index.js",
23181     "groupTitle": "Sms_Interactions"
23182   },
23183   {
23184     "type": "post",
23185     "url": "/api/sms/interactions",
23186     "title": "Creates a new Interaction",
23187     "examples": [
23188       {
23189         "title": "Example usage:",
23190         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23191         "type": "json"
23192       }
23193     ],
23194     "name": "CreateInteractions",
23195     "group": "Sms_Interactions",
23196     "parameter": {
23197       "fields": {
23198         "Body": [
23199           {
23200             "group": "Body",
23201             "type": "Boolean",
23202             "optional": true,
23203             "field": "closed",
23204             "description": ""
23205           },
23206           {
23207             "group": "Body",
23208             "type": "String",
23209             "optional": true,
23210             "field": "closedAt",
23211             "description": ""
23212           },
23213           {
23214             "group": "Body",
23215             "type": "String",
23216             "optional": true,
23217             "field": "disposition",
23218             "description": ""
23219           },
23220           {
23221             "group": "Body",
23222             "type": "String",
23223             "optional": true,
23224             "field": "secondDisposition",
23225             "description": ""
23226           },
23227           {
23228             "group": "Body",
23229             "type": "String",
23230             "optional": true,
23231             "field": "thirdDisposition",
23232             "description": ""
23233           },
23234           {
23235             "group": "Body",
23236             "type": "String",
23237             "optional": true,
23238             "field": "note",
23239             "description": ""
23240           },
23241           {
23242             "group": "Body",
23243             "type": "String",
23244             "optional": true,
23245             "field": "phone",
23246             "description": ""
23247           },
23248           {
23249             "group": "Body",
23250             "type": "String",
23251             "optional": true,
23252             "field": "read1stAt",
23253             "description": ""
23254           },
23255           {
23256             "group": "Body",
23257             "type": "String",
23258             "allowedValues": [
23259               "\"in\"",
23260               "\"out\""
23261             ],
23262             "optional": false,
23263             "field": "firstMsgDirection",
23264             "description": ""
23265           },
23266           {
23267             "group": "Body",
23268             "type": "String",
23269             "optional": true,
23270             "field": "lastMsgAt",
23271             "description": ""
23272           },
23273           {
23274             "group": "Body",
23275             "type": "String",
23276             "allowedValues": [
23277               "\"in\"",
23278               "\"out\""
23279             ],
23280             "optional": false,
23281             "field": "lastMsgDirection",
23282             "description": ""
23283           },
23284           {
23285             "group": "Body",
23286             "type": "Boolean",
23287             "optional": true,
23288             "field": "autoreplyExecuted",
23289             "description": ""
23290           }
23291         ]
23292       }
23293     },
23294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23295     "version": "0.0.0",
23296     "filename": "server/api/smsInteraction/index.js",
23297     "groupTitle": "Sms_Interactions"
23298   },
23299   {
23300     "type": "delete",
23301     "url": "/api/sms/interactions/{id}",
23302     "title": "Deletes a Interaction",
23303     "examples": [
23304       {
23305         "title": "Example usage:",
23306         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23307         "type": "json"
23308       }
23309     ],
23310     "name": "DeleteInteractions",
23311     "group": "Sms_Interactions",
23312     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23313     "version": "0.0.0",
23314     "filename": "server/api/smsInteraction/index.js",
23315     "groupTitle": "Sms_Interactions"
23316   },
23317   {
23318     "type": "get",
23319     "url": "/api/sms/interactions/describe",
23320     "title": "Gets table info about Interactions",
23321     "examples": [
23322       {
23323         "title": "Example usage:",
23324         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23325         "type": "json"
23326       }
23327     ],
23328     "name": "DescribeInteractions",
23329     "group": "Sms_Interactions",
23330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23331     "version": "0.0.0",
23332     "filename": "server/api/smsInteraction/index.js",
23333     "groupTitle": "Sms_Interactions"
23334   },
23335   {
23336     "type": "get",
23337     "url": "/api/sms/interactions",
23338     "title": "Gets a list of Interactions",
23339     "examples": [
23340       {
23341         "title": "Example usage:",
23342         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23343         "type": "json"
23344       }
23345     ],
23346     "name": "GetInteractions",
23347     "group": "Sms_Interactions",
23348     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23349     "version": "0.0.0",
23350     "filename": "server/api/smsInteraction/index.js",
23351     "groupTitle": "Sms_Interactions"
23352   },
23353   {
23354     "type": "delete",
23355     "url": "/api/sms/interactions/{id}/tags",
23356     "title": "Removes tags from interaction",
23357     "examples": [
23358       {
23359         "title": "Example usage:",
23360         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23361         "type": "json"
23362       }
23363     ],
23364     "name": "RemoveTags",
23365     "group": "Sms_Interactions",
23366     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23367     "version": "0.0.0",
23368     "filename": "server/api/smsInteraction/index.js",
23369     "groupTitle": "Sms_Interactions"
23370   },
23371   {
23372     "type": "get",
23373     "url": "/api/sms/interactions/{id}",
23374     "title": "Gets a single Interaction",
23375     "examples": [
23376       {
23377         "title": "Example usage:",
23378         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23379         "type": "json"
23380       }
23381     ],
23382     "name": "ShowInteractions",
23383     "group": "Sms_Interactions",
23384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23385     "version": "0.0.0",
23386     "filename": "server/api/smsInteraction/index.js",
23387     "groupTitle": "Sms_Interactions"
23388   },
23389   {
23390     "type": "post",
23391     "url": "/api/sms/interactions/{id}/messages",
23392     "title": "Creates new messages",
23393     "examples": [
23394       {
23395         "title": "Example usage:",
23396         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23397         "type": "json"
23398       }
23399     ],
23400     "name": "addMessage",
23401     "group": "Sms_Interactions",
23402     "parameter": {
23403       "fields": {
23404         "Body": [
23405           {
23406             "group": "Body",
23407             "type": "Text",
23408             "optional": false,
23409             "field": "body",
23410             "description": ""
23411           },
23412           {
23413             "group": "Body",
23414             "type": "Boolean",
23415             "optional": true,
23416             "field": "read",
23417             "description": ""
23418           },
23419           {
23420             "group": "Body",
23421             "type": "String",
23422             "allowedValues": [
23423               "\"in\"",
23424               "\"out\""
23425             ],
23426             "optional": false,
23427             "field": "direction",
23428             "description": ""
23429           },
23430           {
23431             "group": "Body",
23432             "type": "String",
23433             "optional": true,
23434             "field": "messageId",
23435             "description": ""
23436           },
23437           {
23438             "group": "Body",
23439             "type": "String",
23440             "optional": true,
23441             "field": "phone",
23442             "description": ""
23443           },
23444           {
23445             "group": "Body",
23446             "type": "String",
23447             "optional": true,
23448             "field": "readAt",
23449             "description": ""
23450           },
23451           {
23452             "group": "Body",
23453             "type": "Boolean",
23454             "optional": true,
23455             "field": "secret",
23456             "description": ""
23457           },
23458           {
23459             "group": "Body",
23460             "type": "String",
23461             "optional": true,
23462             "field": "providerName",
23463             "description": ""
23464           },
23465           {
23466             "group": "Body",
23467             "type": "Text",
23468             "optional": true,
23469             "field": "providerResponse",
23470             "description": ""
23471           }
23472         ]
23473       }
23474     },
23475     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23476     "version": "0.0.0",
23477     "filename": "server/api/smsInteraction/index.js",
23478     "groupTitle": "Sms_Interactions"
23479   },
23480   {
23481     "type": "get",
23482     "url": "/api/sms/interactions/{id}/download",
23483     "title": "Gets interaction",
23484     "examples": [
23485       {
23486         "title": "Example usage:",
23487         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23488         "type": "json"
23489       }
23490     ],
23491     "name": "download",
23492     "group": "Sms_Interactions",
23493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23494     "version": "0.0.0",
23495     "filename": "server/api/smsInteraction/index.js",
23496     "groupTitle": "Sms_Interactions"
23497   },
23498   {
23499     "type": "get",
23500     "url": "/api/sms/interactions/{id}/messages",
23501     "title": "Gets interaction messages",
23502     "examples": [
23503       {
23504         "title": "Example usage:",
23505         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23506         "type": "json"
23507       }
23508     ],
23509     "name": "getMessages",
23510     "group": "Sms_Interactions",
23511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23512     "version": "0.0.0",
23513     "filename": "server/api/smsInteraction/index.js",
23514     "groupTitle": "Sms_Interactions"
23515   },
23516   {
23517     "type": "put",
23518     "url": "/api/sms/interactions/{id}",
23519     "title": "Update an existing Interaction",
23520     "examples": [
23521       {
23522         "title": "Example usage:",
23523         "content": "curl https://{domain}/api/sms/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23524         "type": "json"
23525       }
23526     ],
23527     "name": "updateInteractions",
23528     "group": "Sms_Interactions",
23529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23530     "version": "0.0.0",
23531     "filename": "server/api/smsInteraction/index.js",
23532     "groupTitle": "Sms_Interactions"
23533   },
23534   {
23535     "type": "post",
23536     "url": "/api/sms/messages",
23537     "title": "Creates a new Message",
23538     "examples": [
23539       {
23540         "title": "Example usage:",
23541         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23542         "type": "json"
23543       }
23544     ],
23545     "name": "CreateMessages",
23546     "group": "Sms_Messages",
23547     "parameter": {
23548       "fields": {
23549         "Body": [
23550           {
23551             "group": "Body",
23552             "type": "Text",
23553             "optional": false,
23554             "field": "body",
23555             "description": ""
23556           },
23557           {
23558             "group": "Body",
23559             "type": "Boolean",
23560             "optional": true,
23561             "field": "read",
23562             "description": ""
23563           },
23564           {
23565             "group": "Body",
23566             "type": "String",
23567             "allowedValues": [
23568               "\"in\"",
23569               "\"out\""
23570             ],
23571             "optional": false,
23572             "field": "direction",
23573             "description": ""
23574           },
23575           {
23576             "group": "Body",
23577             "type": "String",
23578             "optional": true,
23579             "field": "messageId",
23580             "description": ""
23581           },
23582           {
23583             "group": "Body",
23584             "type": "String",
23585             "optional": true,
23586             "field": "phone",
23587             "description": ""
23588           },
23589           {
23590             "group": "Body",
23591             "type": "String",
23592             "optional": true,
23593             "field": "readAt",
23594             "description": ""
23595           },
23596           {
23597             "group": "Body",
23598             "type": "Boolean",
23599             "optional": true,
23600             "field": "secret",
23601             "description": ""
23602           },
23603           {
23604             "group": "Body",
23605             "type": "String",
23606             "optional": true,
23607             "field": "providerName",
23608             "description": ""
23609           },
23610           {
23611             "group": "Body",
23612             "type": "Text",
23613             "optional": true,
23614             "field": "providerResponse",
23615             "description": ""
23616           }
23617         ]
23618       }
23619     },
23620     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23621     "version": "0.0.0",
23622     "filename": "server/api/smsMessage/index.js",
23623     "groupTitle": "Sms_Messages"
23624   },
23625   {
23626     "type": "delete",
23627     "url": "/api/sms/messages/{id}",
23628     "title": "Deletes a Message",
23629     "examples": [
23630       {
23631         "title": "Example usage:",
23632         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23633         "type": "json"
23634       }
23635     ],
23636     "name": "DeleteMessages",
23637     "group": "Sms_Messages",
23638     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23639     "version": "0.0.0",
23640     "filename": "server/api/smsMessage/index.js",
23641     "groupTitle": "Sms_Messages"
23642   },
23643   {
23644     "type": "get",
23645     "url": "/api/sms/messages/describe",
23646     "title": "Gets table info about Messages",
23647     "examples": [
23648       {
23649         "title": "Example usage:",
23650         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23651         "type": "json"
23652       }
23653     ],
23654     "name": "DescribeMessages",
23655     "group": "Sms_Messages",
23656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23657     "version": "0.0.0",
23658     "filename": "server/api/smsMessage/index.js",
23659     "groupTitle": "Sms_Messages"
23660   },
23661   {
23662     "type": "get",
23663     "url": "/api/sms/messages",
23664     "title": "Gets a list of Messages",
23665     "examples": [
23666       {
23667         "title": "Example usage:",
23668         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23669         "type": "json"
23670       }
23671     ],
23672     "name": "GetMessages",
23673     "group": "Sms_Messages",
23674     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23675     "version": "0.0.0",
23676     "filename": "server/api/smsMessage/index.js",
23677     "groupTitle": "Sms_Messages"
23678   },
23679   {
23680     "type": "get",
23681     "url": "/api/sms/messages/{id}",
23682     "title": "Gets a single Message",
23683     "examples": [
23684       {
23685         "title": "Example usage:",
23686         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23687         "type": "json"
23688       }
23689     ],
23690     "name": "ShowMessages",
23691     "group": "Sms_Messages",
23692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23693     "version": "0.0.0",
23694     "filename": "server/api/smsMessage/index.js",
23695     "groupTitle": "Sms_Messages"
23696   },
23697   {
23698     "type": "put",
23699     "url": "/api/sms/messages/{id}",
23700     "title": "Update an existing Message",
23701     "examples": [
23702       {
23703         "title": "Example usage:",
23704         "content": "curl https://{domain}/api/sms/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23705         "type": "json"
23706       }
23707     ],
23708     "name": "updateMessages",
23709     "group": "Sms_Messages",
23710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23711     "version": "0.0.0",
23712     "filename": "server/api/smsMessage/index.js",
23713     "groupTitle": "Sms_Messages"
23714   },
23715   {
23716     "type": "post",
23717     "url": "/api/sms/reports/queue",
23718     "title": "Creates a new Sms Queue Report",
23719     "examples": [
23720       {
23721         "title": "Example usage:",
23722         "content": "curl https://{domain}/api/sms/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23723         "type": "json"
23724       }
23725     ],
23726     "name": "CreateSms_Queue_Reports",
23727     "group": "Sms_Queue_Reports",
23728     "parameter": {
23729       "fields": {
23730         "Body": [
23731           {
23732             "group": "Body",
23733             "type": "String",
23734             "optional": false,
23735             "field": "uniqueid",
23736             "description": ""
23737           },
23738           {
23739             "group": "Body",
23740             "type": "String",
23741             "optional": true,
23742             "field": "from",
23743             "description": ""
23744           },
23745           {
23746             "group": "Body",
23747             "type": "String",
23748             "optional": true,
23749             "field": "joinAt",
23750             "description": ""
23751           },
23752           {
23753             "group": "Body",
23754             "type": "String",
23755             "optional": true,
23756             "field": "leaveAt",
23757             "description": ""
23758           },
23759           {
23760             "group": "Body",
23761             "type": "String",
23762             "optional": true,
23763             "field": "acceptAt",
23764             "description": ""
23765           },
23766           {
23767             "group": "Body",
23768             "type": "String",
23769             "optional": true,
23770             "field": "exitAt",
23771             "description": ""
23772           },
23773           {
23774             "group": "Body",
23775             "type": "String",
23776             "optional": true,
23777             "field": "reason",
23778             "description": ""
23779           }
23780         ]
23781       }
23782     },
23783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23784     "version": "0.0.0",
23785     "filename": "server/api/smsQueueReport/index.js",
23786     "groupTitle": "Sms_Queue_Reports"
23787   },
23788   {
23789     "type": "delete",
23790     "url": "/api/sms/reports/queue/{id}",
23791     "title": "Deletes a Sms Queue Report",
23792     "examples": [
23793       {
23794         "title": "Example usage:",
23795         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23796         "type": "json"
23797       }
23798     ],
23799     "name": "DeleteSms_Queue_Reports",
23800     "group": "Sms_Queue_Reports",
23801     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23802     "version": "0.0.0",
23803     "filename": "server/api/smsQueueReport/index.js",
23804     "groupTitle": "Sms_Queue_Reports"
23805   },
23806   {
23807     "type": "get",
23808     "url": "/api/sms/reports/queue/describe",
23809     "title": "Gets table info about Sms Queue Reports",
23810     "examples": [
23811       {
23812         "title": "Example usage:",
23813         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23814         "type": "json"
23815       }
23816     ],
23817     "name": "DescribeSms_Queue_Reports",
23818     "group": "Sms_Queue_Reports",
23819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23820     "version": "0.0.0",
23821     "filename": "server/api/smsQueueReport/index.js",
23822     "groupTitle": "Sms_Queue_Reports"
23823   },
23824   {
23825     "type": "get",
23826     "url": "/api/sms/reports/queue",
23827     "title": "Gets a list of Sms Queue Reports",
23828     "examples": [
23829       {
23830         "title": "Example usage:",
23831         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23832         "type": "json"
23833       }
23834     ],
23835     "name": "GetSms_Queue_Reports",
23836     "group": "Sms_Queue_Reports",
23837     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23838     "version": "0.0.0",
23839     "filename": "server/api/smsQueueReport/index.js",
23840     "groupTitle": "Sms_Queue_Reports"
23841   },
23842   {
23843     "type": "get",
23844     "url": "/api/sms/reports/queue/{id}",
23845     "title": "Gets a single Sms Queue Report",
23846     "examples": [
23847       {
23848         "title": "Example usage:",
23849         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23850         "type": "json"
23851       }
23852     ],
23853     "name": "ShowSms_Queue_Reports",
23854     "group": "Sms_Queue_Reports",
23855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23856     "version": "0.0.0",
23857     "filename": "server/api/smsQueueReport/index.js",
23858     "groupTitle": "Sms_Queue_Reports"
23859   },
23860   {
23861     "type": "put",
23862     "url": "/api/sms/reports/queue/{id}",
23863     "title": "Update an existing Sms Queue Report",
23864     "examples": [
23865       {
23866         "title": "Example usage:",
23867         "content": "curl https://{domain}/api/sms/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23868         "type": "json"
23869       }
23870     ],
23871     "name": "updateSms_Queue_Reports",
23872     "group": "Sms_Queue_Reports",
23873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23874     "version": "0.0.0",
23875     "filename": "server/api/smsQueueReport/index.js",
23876     "groupTitle": "Sms_Queue_Reports"
23877   },
23878   {
23879     "type": "post",
23880     "url": "/api/sms/queues/{id}/users",
23881     "title": "Add agents to a queue",
23882     "examples": [
23883       {
23884         "title": "Example usage:",
23885         "content": "curl https://{domain}/api/sms/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23886         "type": "json"
23887       }
23888     ],
23889     "name": "AddAgents",
23890     "group": "Sms_Queues",
23891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23892     "version": "0.0.0",
23893     "filename": "server/api/smsQueue/index.js",
23894     "groupTitle": "Sms_Queues"
23895   },
23896   {
23897     "type": "post",
23898     "url": "/api/sms/queues/{id}/teams",
23899     "title": "Add teams to a queue",
23900     "examples": [
23901       {
23902         "title": "Example usage:",
23903         "content": "curl https://{domain}/api/sms/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23904         "type": "json"
23905       }
23906     ],
23907     "name": "AddTeams",
23908     "group": "Sms_Queues",
23909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23910     "version": "0.0.0",
23911     "filename": "server/api/smsQueue/index.js",
23912     "groupTitle": "Sms_Queues"
23913   },
23914   {
23915     "type": "post",
23916     "url": "/api/sms/queues",
23917     "title": "Creates a new Queue",
23918     "examples": [
23919       {
23920         "title": "Example usage:",
23921         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23922         "type": "json"
23923       }
23924     ],
23925     "name": "CreateQueues",
23926     "group": "Sms_Queues",
23927     "parameter": {
23928       "fields": {
23929         "Body": [
23930           {
23931             "group": "Body",
23932             "type": "String",
23933             "optional": true,
23934             "field": "name",
23935             "description": ""
23936           },
23937           {
23938             "group": "Body",
23939             "type": "String",
23940             "optional": true,
23941             "field": "description",
23942             "description": ""
23943           },
23944           {
23945             "group": "Body",
23946             "type": "Integer",
23947             "optional": true,
23948             "field": "timeout",
23949             "description": ""
23950           },
23951           {
23952             "group": "Body",
23953             "type": "String",
23954             "allowedValues": [
23955               "\"rrmemory\"",
23956               "\"beepall\"",
23957               "\"roundrobin\""
23958             ],
23959             "optional": true,
23960             "field": "strategy",
23961             "description": ""
23962           }
23963         ]
23964       }
23965     },
23966     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23967     "version": "0.0.0",
23968     "filename": "server/api/smsQueue/index.js",
23969     "groupTitle": "Sms_Queues"
23970   },
23971   {
23972     "type": "delete",
23973     "url": "/api/sms/queues/{id}",
23974     "title": "Deletes a Queue",
23975     "examples": [
23976       {
23977         "title": "Example usage:",
23978         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23979         "type": "json"
23980       }
23981     ],
23982     "name": "DeleteQueues",
23983     "group": "Sms_Queues",
23984     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23985     "version": "0.0.0",
23986     "filename": "server/api/smsQueue/index.js",
23987     "groupTitle": "Sms_Queues"
23988   },
23989   {
23990     "type": "get",
23991     "url": "/api/sms/queues/describe",
23992     "title": "Gets table info about Queues",
23993     "examples": [
23994       {
23995         "title": "Example usage:",
23996         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23997         "type": "json"
23998       }
23999     ],
24000     "name": "DescribeQueues",
24001     "group": "Sms_Queues",
24002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24003     "version": "0.0.0",
24004     "filename": "server/api/smsQueue/index.js",
24005     "groupTitle": "Sms_Queues"
24006   },
24007   {
24008     "type": "get",
24009     "url": "/api/sms/queues/{id}/users",
24010     "title": "Gets queue agents",
24011     "examples": [
24012       {
24013         "title": "Example usage:",
24014         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24015         "type": "json"
24016       }
24017     ],
24018     "name": "GetAgents",
24019     "group": "Sms_Queues",
24020     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24021     "version": "0.0.0",
24022     "filename": "server/api/smsQueue/index.js",
24023     "groupTitle": "Sms_Queues"
24024   },
24025   {
24026     "type": "get",
24027     "url": "/api/sms/queues/{id}/members",
24028     "title": "GetMembers",
24029     "examples": [
24030       {
24031         "title": "Example usage:",
24032         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24033         "type": "json"
24034       }
24035     ],
24036     "name": "GetMembers",
24037     "group": "Sms_Queues",
24038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24039     "version": "0.0.0",
24040     "filename": "server/api/smsQueue/index.js",
24041     "groupTitle": "Sms_Queues"
24042   },
24043   {
24044     "type": "get",
24045     "url": "/api/sms/queues",
24046     "title": "Gets a list of Queues",
24047     "examples": [
24048       {
24049         "title": "Example usage:",
24050         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24051         "type": "json"
24052       }
24053     ],
24054     "name": "GetQueues",
24055     "group": "Sms_Queues",
24056     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24057     "version": "0.0.0",
24058     "filename": "server/api/smsQueue/index.js",
24059     "groupTitle": "Sms_Queues"
24060   },
24061   {
24062     "type": "get",
24063     "url": "/api/sms/queues/{id}/teams",
24064     "title": "Gets queues list",
24065     "examples": [
24066       {
24067         "title": "Example usage:",
24068         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24069         "type": "json"
24070       }
24071     ],
24072     "name": "GetTeams",
24073     "group": "Sms_Queues",
24074     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24075     "version": "0.0.0",
24076     "filename": "server/api/smsQueue/index.js",
24077     "groupTitle": "Sms_Queues"
24078   },
24079   {
24080     "type": "delete",
24081     "url": "/api/sms/queues/{id}/users",
24082     "title": "Removes agents from a queue",
24083     "examples": [
24084       {
24085         "title": "Example usage:",
24086         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24087         "type": "json"
24088       }
24089     ],
24090     "name": "RemoveAgents",
24091     "group": "Sms_Queues",
24092     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24093     "version": "0.0.0",
24094     "filename": "server/api/smsQueue/index.js",
24095     "groupTitle": "Sms_Queues"
24096   },
24097   {
24098     "type": "get",
24099     "url": "/api/sms/queues/{id}",
24100     "title": "Gets a single Queue",
24101     "examples": [
24102       {
24103         "title": "Example usage:",
24104         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24105         "type": "json"
24106       }
24107     ],
24108     "name": "ShowQueues",
24109     "group": "Sms_Queues",
24110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24111     "version": "0.0.0",
24112     "filename": "server/api/smsQueue/index.js",
24113     "groupTitle": "Sms_Queues"
24114   },
24115   {
24116     "type": "put",
24117     "url": "/api/sms/queues/{id}",
24118     "title": "Update an existing Queue",
24119     "examples": [
24120       {
24121         "title": "Example usage:",
24122         "content": "curl https://{domain}/api/sms/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24123         "type": "json"
24124       }
24125     ],
24126     "name": "updateQueues",
24127     "group": "Sms_Queues",
24128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24129     "version": "0.0.0",
24130     "filename": "server/api/smsQueue/index.js",
24131     "groupTitle": "Sms_Queues"
24132   },
24133   {
24134     "type": "post",
24135     "url": "/api/sms/reports/transfer",
24136     "title": "Creates a new Sms Transfer Report",
24137     "examples": [
24138       {
24139         "title": "Example usage:",
24140         "content": "curl https://{domain}/api/sms/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24141         "type": "json"
24142       }
24143     ],
24144     "name": "CreateSms_Transfer_Reports",
24145     "group": "Sms_Transfer_Reports",
24146     "parameter": {
24147       "fields": {
24148         "Body": [
24149           {
24150             "group": "Body",
24151             "type": "String",
24152             "optional": false,
24153             "field": "uniqueid",
24154             "description": ""
24155           },
24156           {
24157             "group": "Body",
24158             "type": "String",
24159             "allowedValues": [
24160               "\"account\"",
24161               "\"agent\"",
24162               "\"queue\""
24163             ],
24164             "optional": false,
24165             "field": "type",
24166             "description": ""
24167           },
24168           {
24169             "group": "Body",
24170             "type": "String",
24171             "optional": false,
24172             "field": "transferredAt",
24173             "description": ""
24174           }
24175         ]
24176       }
24177     },
24178     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24179     "version": "0.0.0",
24180     "filename": "server/api/smsTransferReport/index.js",
24181     "groupTitle": "Sms_Transfer_Reports"
24182   },
24183   {
24184     "type": "delete",
24185     "url": "/api/sms/reports/transfer/{id}",
24186     "title": "Deletes a Sms Transfer Report",
24187     "examples": [
24188       {
24189         "title": "Example usage:",
24190         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24191         "type": "json"
24192       }
24193     ],
24194     "name": "DeleteSms_Transfer_Reports",
24195     "group": "Sms_Transfer_Reports",
24196     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24197     "version": "0.0.0",
24198     "filename": "server/api/smsTransferReport/index.js",
24199     "groupTitle": "Sms_Transfer_Reports"
24200   },
24201   {
24202     "type": "get",
24203     "url": "/api/sms/reports/transfer/describe",
24204     "title": "Gets table info about Sms Transfer Reports",
24205     "examples": [
24206       {
24207         "title": "Example usage:",
24208         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24209         "type": "json"
24210       }
24211     ],
24212     "name": "DescribeSms_Transfer_Reports",
24213     "group": "Sms_Transfer_Reports",
24214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24215     "version": "0.0.0",
24216     "filename": "server/api/smsTransferReport/index.js",
24217     "groupTitle": "Sms_Transfer_Reports"
24218   },
24219   {
24220     "type": "get",
24221     "url": "/api/sms/reports/transfer",
24222     "title": "Gets a list of Sms Transfer Reports",
24223     "examples": [
24224       {
24225         "title": "Example usage:",
24226         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24227         "type": "json"
24228       }
24229     ],
24230     "name": "GetSms_Transfer_Reports",
24231     "group": "Sms_Transfer_Reports",
24232     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24233     "version": "0.0.0",
24234     "filename": "server/api/smsTransferReport/index.js",
24235     "groupTitle": "Sms_Transfer_Reports"
24236   },
24237   {
24238     "type": "get",
24239     "url": "/api/sms/reports/transfer/{id}",
24240     "title": "Gets a single Sms Transfer Report",
24241     "examples": [
24242       {
24243         "title": "Example usage:",
24244         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24245         "type": "json"
24246       }
24247     ],
24248     "name": "ShowSms_Transfer_Reports",
24249     "group": "Sms_Transfer_Reports",
24250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24251     "version": "0.0.0",
24252     "filename": "server/api/smsTransferReport/index.js",
24253     "groupTitle": "Sms_Transfer_Reports"
24254   },
24255   {
24256     "type": "put",
24257     "url": "/api/sms/reports/transfer/{id}",
24258     "title": "Update an existing Sms Transfer Report",
24259     "examples": [
24260       {
24261         "title": "Example usage:",
24262         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24263         "type": "json"
24264       }
24265     ],
24266     "name": "updateSms_Transfer_Reports",
24267     "group": "Sms_Transfer_Reports",
24268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24269     "version": "0.0.0",
24270     "filename": "server/api/smsTransferReport/index.js",
24271     "groupTitle": "Sms_Transfer_Reports"
24272   },
24273   {
24274     "type": "get",
24275     "url": "/api/sounds",
24276     "title": "Gets a list of Sounds",
24277     "examples": [
24278       {
24279         "title": "Example usage:",
24280         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24281         "type": "json"
24282       }
24283     ],
24284     "name": "GetSounds",
24285     "group": "Sounds",
24286     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sounds?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sounds?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sounds?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sounds?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sounds?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24287     "version": "0.0.0",
24288     "filename": "server/api/sound/index.js",
24289     "groupTitle": "Sounds"
24290   },
24291   {
24292     "type": "get",
24293     "url": "/api/sounds/{id}",
24294     "title": "Gets a single Sound",
24295     "examples": [
24296       {
24297         "title": "Example usage:",
24298         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24299         "type": "json"
24300       }
24301     ],
24302     "name": "ShowSounds",
24303     "group": "Sounds",
24304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24305     "version": "0.0.0",
24306     "filename": "server/api/sound/index.js",
24307     "groupTitle": "Sounds"
24308   },
24309   {
24310     "type": "post",
24311     "url": "/api/sounds",
24312     "title": "Create a new sound",
24313     "examples": [
24314       {
24315         "title": "Example usage:",
24316         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24317         "type": "json"
24318       }
24319     ],
24320     "name": "addSound",
24321     "group": "Sounds",
24322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24323     "version": "0.0.0",
24324     "filename": "server/api/sound/index.js",
24325     "groupTitle": "Sounds"
24326   },
24327   {
24328     "type": "delete",
24329     "url": "/api/sounds/{id}",
24330     "title": "Deletes a sound",
24331     "examples": [
24332       {
24333         "title": "Example usage:",
24334         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24335         "type": "json"
24336       }
24337     ],
24338     "name": "destroySound",
24339     "group": "Sounds",
24340     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24341     "version": "0.0.0",
24342     "filename": "server/api/sound/index.js",
24343     "groupTitle": "Sounds"
24344   },
24345   {
24346     "type": "get",
24347     "url": "/api/sounds/{id}/download",
24348     "title": "Download Sound",
24349     "examples": [
24350       {
24351         "title": "Example usage:",
24352         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24353         "type": "json"
24354       }
24355     ],
24356     "name": "download",
24357     "group": "Sounds",
24358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24359     "version": "0.0.0",
24360     "filename": "server/api/sound/index.js",
24361     "groupTitle": "Sounds"
24362   },
24363   {
24364     "type": "put",
24365     "url": "/api/sounds",
24366     "title": "Update an existing new sound",
24367     "examples": [
24368       {
24369         "title": "Example usage:",
24370         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24371         "type": "json"
24372       }
24373     ],
24374     "name": "updateSound",
24375     "group": "Sounds",
24376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24377     "version": "0.0.0",
24378     "filename": "server/api/sound/index.js",
24379     "groupTitle": "Sounds"
24380   },
24381   {
24382     "type": "post",
24383     "url": "/api/square/details/reports",
24384     "title": "Creates a new Square Detail Report",
24385     "examples": [
24386       {
24387         "title": "Example usage:",
24388         "content": "curl https://{domain}/api/square/details/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24389         "type": "json"
24390       }
24391     ],
24392     "name": "CreateSquare_Detail_Reports",
24393     "group": "Square_Details_Reports",
24394     "parameter": {
24395       "fields": {
24396         "Body": [
24397           {
24398             "group": "Body",
24399             "type": "String",
24400             "optional": true,
24401             "field": "uniqueid",
24402             "description": ""
24403           },
24404           {
24405             "group": "Body",
24406             "type": "String",
24407             "optional": true,
24408             "field": "node",
24409             "description": ""
24410           },
24411           {
24412             "group": "Body",
24413             "type": "String",
24414             "optional": true,
24415             "field": "application",
24416             "description": ""
24417           },
24418           {
24419             "group": "Body",
24420             "type": "Text",
24421             "optional": true,
24422             "field": "data",
24423             "description": ""
24424           },
24425           {
24426             "group": "Body",
24427             "type": "String",
24428             "optional": true,
24429             "field": "project_name",
24430             "description": ""
24431           },
24432           {
24433             "group": "Body",
24434             "type": "String",
24435             "optional": true,
24436             "field": "callerid",
24437             "description": ""
24438           }
24439         ]
24440       }
24441     },
24442     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24443     "version": "0.0.0",
24444     "filename": "server/api/squareReportDetail/index.js",
24445     "groupTitle": "Square_Details_Reports"
24446   },
24447   {
24448     "type": "delete",
24449     "url": "/api/square/details/reports/{id}",
24450     "title": "Deletes a Square Detail Report",
24451     "examples": [
24452       {
24453         "title": "Example usage:",
24454         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24455         "type": "json"
24456       }
24457     ],
24458     "name": "DeleteSquare_Detail_Reports",
24459     "group": "Square_Details_Reports",
24460     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24461     "version": "0.0.0",
24462     "filename": "server/api/squareReportDetail/index.js",
24463     "groupTitle": "Square_Details_Reports"
24464   },
24465   {
24466     "type": "get",
24467     "url": "/api/square/details/reports/describe",
24468     "title": "Gets table info about Square Detail Reports",
24469     "examples": [
24470       {
24471         "title": "Example usage:",
24472         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24473         "type": "json"
24474       }
24475     ],
24476     "name": "DescribeSquare_Detail_Reports",
24477     "group": "Square_Details_Reports",
24478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24479     "version": "0.0.0",
24480     "filename": "server/api/squareReportDetail/index.js",
24481     "groupTitle": "Square_Details_Reports"
24482   },
24483   {
24484     "type": "get",
24485     "url": "/api/square/details/reports",
24486     "title": "Gets a list of Square Detail Reports",
24487     "examples": [
24488       {
24489         "title": "Example usage:",
24490         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24491         "type": "json"
24492       }
24493     ],
24494     "name": "GetSquare_Detail_Reports",
24495     "group": "Square_Details_Reports",
24496     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/details/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/details/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/details/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/details/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/details/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24497     "version": "0.0.0",
24498     "filename": "server/api/squareReportDetail/index.js",
24499     "groupTitle": "Square_Details_Reports"
24500   },
24501   {
24502     "type": "get",
24503     "url": "/api/square/details/reports/{id}",
24504     "title": "Gets a single Square Detail Report",
24505     "examples": [
24506       {
24507         "title": "Example usage:",
24508         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24509         "type": "json"
24510       }
24511     ],
24512     "name": "ShowSquare_Detail_Reports",
24513     "group": "Square_Details_Reports",
24514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24515     "version": "0.0.0",
24516     "filename": "server/api/squareReportDetail/index.js",
24517     "groupTitle": "Square_Details_Reports"
24518   },
24519   {
24520     "type": "put",
24521     "url": "/api/square/details/reports/{id}",
24522     "title": "Update an existing Square Detail Report",
24523     "examples": [
24524       {
24525         "title": "Example usage:",
24526         "content": "curl https://{domain}/api/square/details/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24527         "type": "json"
24528       }
24529     ],
24530     "name": "updateSquare_Detail_Reports",
24531     "group": "Square_Details_Reports",
24532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24533     "version": "0.0.0",
24534     "filename": "server/api/squareReportDetail/index.js",
24535     "groupTitle": "Square_Details_Reports"
24536   },
24537   {
24538     "type": "post",
24539     "url": "/api/square/messages",
24540     "title": "Creates a new Message",
24541     "examples": [
24542       {
24543         "title": "Example usage:",
24544         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24545         "type": "json"
24546       }
24547     ],
24548     "name": "CreateMessages",
24549     "group": "Square_Messages",
24550     "parameter": {
24551       "fields": {
24552         "Body": [
24553           {
24554             "group": "Body",
24555             "type": "String",
24556             "optional": true,
24557             "field": "uniqueid",
24558             "description": ""
24559           },
24560           {
24561             "group": "Body",
24562             "type": "Text",
24563             "optional": false,
24564             "field": "body",
24565             "description": ""
24566           },
24567           {
24568             "group": "Body",
24569             "type": "String",
24570             "allowedValues": [
24571               "\"in\"",
24572               "\"out\""
24573             ],
24574             "optional": false,
24575             "field": "direction",
24576             "description": ""
24577           },
24578           {
24579             "group": "Body",
24580             "type": "String",
24581             "optional": true,
24582             "field": "providerName",
24583             "description": ""
24584           },
24585           {
24586             "group": "Body",
24587             "type": "Text",
24588             "optional": true,
24589             "field": "providerResponse",
24590             "description": ""
24591           }
24592         ]
24593       }
24594     },
24595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24596     "version": "0.0.0",
24597     "filename": "server/api/squareMessage/index.js",
24598     "groupTitle": "Square_Messages"
24599   },
24600   {
24601     "type": "delete",
24602     "url": "/api/square/messages/{id}",
24603     "title": "Deletes a Message",
24604     "examples": [
24605       {
24606         "title": "Example usage:",
24607         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24608         "type": "json"
24609       }
24610     ],
24611     "name": "DeleteMessages",
24612     "group": "Square_Messages",
24613     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24614     "version": "0.0.0",
24615     "filename": "server/api/squareMessage/index.js",
24616     "groupTitle": "Square_Messages"
24617   },
24618   {
24619     "type": "get",
24620     "url": "/api/square/messages",
24621     "title": "Gets a list of Messages",
24622     "examples": [
24623       {
24624         "title": "Example usage:",
24625         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24626         "type": "json"
24627       }
24628     ],
24629     "name": "GetMessages",
24630     "group": "Square_Messages",
24631     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24632     "version": "0.0.0",
24633     "filename": "server/api/squareMessage/index.js",
24634     "groupTitle": "Square_Messages"
24635   },
24636   {
24637     "type": "get",
24638     "url": "/api/square/messages/{id}",
24639     "title": "Gets a single Message",
24640     "examples": [
24641       {
24642         "title": "Example usage:",
24643         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24644         "type": "json"
24645       }
24646     ],
24647     "name": "ShowMessages",
24648     "group": "Square_Messages",
24649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24650     "version": "0.0.0",
24651     "filename": "server/api/squareMessage/index.js",
24652     "groupTitle": "Square_Messages"
24653   },
24654   {
24655     "type": "put",
24656     "url": "/api/square/messages/{id}",
24657     "title": "Update an existing Message",
24658     "examples": [
24659       {
24660         "title": "Example usage:",
24661         "content": "curl https://{domain}/api/square/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24662         "type": "json"
24663       }
24664     ],
24665     "name": "updateMessages",
24666     "group": "Square_Messages",
24667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24668     "version": "0.0.0",
24669     "filename": "server/api/squareMessage/index.js",
24670     "groupTitle": "Square_Messages"
24671   },
24672   {
24673     "type": "post",
24674     "url": "/api/square/odbc",
24675     "title": "Creates a new ODBC",
24676     "examples": [
24677       {
24678         "title": "Example usage:",
24679         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24680         "type": "json"
24681       }
24682     ],
24683     "name": "CreateODBCs",
24684     "group": "Square_ODBC",
24685     "parameter": {
24686       "fields": {
24687         "Body": [
24688           {
24689             "group": "Body",
24690             "type": "String",
24691             "optional": false,
24692             "field": "name",
24693             "description": ""
24694           },
24695           {
24696             "group": "Body",
24697             "type": "String",
24698             "optional": true,
24699             "field": "dsn",
24700             "description": ""
24701           },
24702           {
24703             "group": "Body",
24704             "type": "String",
24705             "optional": true,
24706             "field": "description",
24707             "description": ""
24708           }
24709         ]
24710       }
24711     },
24712     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24713     "version": "0.0.0",
24714     "filename": "server/api/squareOdbc/index.js",
24715     "groupTitle": "Square_ODBC"
24716   },
24717   {
24718     "type": "delete",
24719     "url": "/api/square/odbc/{id}",
24720     "title": "Deletes a ODBC",
24721     "examples": [
24722       {
24723         "title": "Example usage:",
24724         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24725         "type": "json"
24726       }
24727     ],
24728     "name": "DeleteODBCs",
24729     "group": "Square_ODBC",
24730     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24731     "version": "0.0.0",
24732     "filename": "server/api/squareOdbc/index.js",
24733     "groupTitle": "Square_ODBC"
24734   },
24735   {
24736     "type": "get",
24737     "url": "/api/square/odbc",
24738     "title": "Gets a list of ODBCs",
24739     "examples": [
24740       {
24741         "title": "Example usage:",
24742         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24743         "type": "json"
24744       }
24745     ],
24746     "name": "GetODBCs",
24747     "group": "Square_ODBC",
24748     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/odbc?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/odbc?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/odbc?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/odbc?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/odbc?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24749     "version": "0.0.0",
24750     "filename": "server/api/squareOdbc/index.js",
24751     "groupTitle": "Square_ODBC"
24752   },
24753   {
24754     "type": "get",
24755     "url": "/api/square/odbc/{id}",
24756     "title": "Gets a single ODBC",
24757     "examples": [
24758       {
24759         "title": "Example usage:",
24760         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24761         "type": "json"
24762       }
24763     ],
24764     "name": "ShowODBCs",
24765     "group": "Square_ODBC",
24766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24767     "version": "0.0.0",
24768     "filename": "server/api/squareOdbc/index.js",
24769     "groupTitle": "Square_ODBC"
24770   },
24771   {
24772     "type": "get",
24773     "url": "/api/square/odbc/{id}/test",
24774     "title": "Test Odbc",
24775     "examples": [
24776       {
24777         "title": "Example usage:",
24778         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24779         "type": "json"
24780       }
24781     ],
24782     "name": "test",
24783     "group": "Square_ODBC",
24784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24785     "version": "0.0.0",
24786     "filename": "server/api/squareOdbc/index.js",
24787     "groupTitle": "Square_ODBC"
24788   },
24789   {
24790     "type": "put",
24791     "url": "/api/square/odbc/{id}",
24792     "title": "Update an existing ODBC",
24793     "examples": [
24794       {
24795         "title": "Example usage:",
24796         "content": "curl https://{domain}/api/square/odbc/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24797         "type": "json"
24798       }
24799     ],
24800     "name": "updateODBCs",
24801     "group": "Square_ODBC",
24802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24803     "version": "0.0.0",
24804     "filename": "server/api/squareOdbc/index.js",
24805     "groupTitle": "Square_ODBC"
24806   },
24807   {
24808     "type": "post",
24809     "url": "/api/square/projects",
24810     "title": "Creates a new Project",
24811     "examples": [
24812       {
24813         "title": "Example usage:",
24814         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24815         "type": "json"
24816       }
24817     ],
24818     "name": "CreateProjects",
24819     "group": "Square_Projects",
24820     "parameter": {
24821       "fields": {
24822         "Body": [
24823           {
24824             "group": "Body",
24825             "type": "String",
24826             "optional": false,
24827             "field": "name",
24828             "description": ""
24829           },
24830           {
24831             "group": "Body",
24832             "type": "String",
24833             "optional": true,
24834             "field": "description",
24835             "description": ""
24836           },
24837           {
24838             "group": "Body",
24839             "type": "Text",
24840             "optional": true,
24841             "field": "notes",
24842             "description": ""
24843           },
24844           {
24845             "group": "Body",
24846             "type": "Blob",
24847             "optional": true,
24848             "field": "preproduction",
24849             "description": ""
24850           },
24851           {
24852             "group": "Body",
24853             "type": "Blob",
24854             "optional": true,
24855             "field": "production",
24856             "description": ""
24857           },
24858           {
24859             "group": "Body",
24860             "type": "String",
24861             "optional": true,
24862             "field": "savedAt",
24863             "description": ""
24864           },
24865           {
24866             "group": "Body",
24867             "type": "String",
24868             "optional": true,
24869             "field": "publishedAt",
24870             "description": ""
24871           }
24872         ]
24873       }
24874     },
24875     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24876     "version": "0.0.0",
24877     "filename": "server/api/squareProject/index.js",
24878     "groupTitle": "Square_Projects"
24879   },
24880   {
24881     "type": "delete",
24882     "url": "/api/square/projects/{id}",
24883     "title": "Deletes a Project",
24884     "examples": [
24885       {
24886         "title": "Example usage:",
24887         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24888         "type": "json"
24889       }
24890     ],
24891     "name": "DeleteProjects",
24892     "group": "Square_Projects",
24893     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24894     "version": "0.0.0",
24895     "filename": "server/api/squareProject/index.js",
24896     "groupTitle": "Square_Projects"
24897   },
24898   {
24899     "type": "get",
24900     "url": "/api/square/projects",
24901     "title": "Gets a list of Projects",
24902     "examples": [
24903       {
24904         "title": "Example usage:",
24905         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24906         "type": "json"
24907       }
24908     ],
24909     "name": "GetProjects",
24910     "group": "Square_Projects",
24911     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/projects?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24912     "version": "0.0.0",
24913     "filename": "server/api/squareProject/index.js",
24914     "groupTitle": "Square_Projects"
24915   },
24916   {
24917     "type": "get",
24918     "url": "/api/square/projects/{id}",
24919     "title": "Gets a single Project",
24920     "examples": [
24921       {
24922         "title": "Example usage:",
24923         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24924         "type": "json"
24925       }
24926     ],
24927     "name": "ShowProjects",
24928     "group": "Square_Projects",
24929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24930     "version": "0.0.0",
24931     "filename": "server/api/squareProject/index.js",
24932     "groupTitle": "Square_Projects"
24933   },
24934   {
24935     "type": "post",
24936     "url": "/api/square/projects/{id}/users",
24937     "title": "Adds user permissions to a Project",
24938     "examples": [
24939       {
24940         "title": "Example usage:",
24941         "content": "curl https://{domain}/api/square/projects/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24942         "type": "json"
24943       }
24944     ],
24945     "name": "addUsers",
24946     "group": "Square_Projects",
24947     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24948     "version": "0.0.0",
24949     "filename": "server/api/squareProject/index.js",
24950     "groupTitle": "Square_Projects"
24951   },
24952   {
24953     "type": "get",
24954     "url": "/api/square/projects/{id}/users",
24955     "title": "Gets users permissions from Project",
24956     "examples": [
24957       {
24958         "title": "Example usage:",
24959         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24960         "type": "json"
24961       }
24962     ],
24963     "name": "getUsers",
24964     "group": "Square_Projects",
24965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24966     "version": "0.0.0",
24967     "filename": "server/api/squareProject/index.js",
24968     "groupTitle": "Square_Projects"
24969   },
24970   {
24971     "type": "delete",
24972     "url": "/api/square/projects/{id}/users",
24973     "title": "Removes user permissions from a Project",
24974     "examples": [
24975       {
24976         "title": "Example usage:",
24977         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24978         "type": "json"
24979       }
24980     ],
24981     "name": "removeUsers",
24982     "group": "Square_Projects",
24983     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24984     "version": "0.0.0",
24985     "filename": "server/api/squareProject/index.js",
24986     "groupTitle": "Square_Projects"
24987   },
24988   {
24989     "type": "put",
24990     "url": "/api/square/projects/{id}",
24991     "title": "Update an existing Project",
24992     "examples": [
24993       {
24994         "title": "Example usage:",
24995         "content": "curl https://{domain}/api/square/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24996         "type": "json"
24997       }
24998     ],
24999     "name": "updateProjects",
25000     "group": "Square_Projects",
25001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25002     "version": "0.0.0",
25003     "filename": "server/api/squareProject/index.js",
25004     "groupTitle": "Square_Projects"
25005   },
25006   {
25007     "type": "post",
25008     "url": "/api/square/recordings",
25009     "title": "Creates a new Recording",
25010     "examples": [
25011       {
25012         "title": "Example usage:",
25013         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25014         "type": "json"
25015       }
25016     ],
25017     "name": "CreateRecordings",
25018     "group": "Square_Recordings",
25019     "parameter": {
25020       "fields": {
25021         "Body": [
25022           {
25023             "group": "Body",
25024             "type": "String",
25025             "optional": true,
25026             "field": "uniqueid",
25027             "description": ""
25028           },
25029           {
25030             "group": "Body",
25031             "type": "String",
25032             "optional": true,
25033             "field": "callerid",
25034             "description": ""
25035           },
25036           {
25037             "group": "Body",
25038             "type": "String",
25039             "optional": true,
25040             "field": "calleridname",
25041             "description": ""
25042           },
25043           {
25044             "group": "Body",
25045             "type": "String",
25046             "optional": true,
25047             "field": "context",
25048             "description": ""
25049           },
25050           {
25051             "group": "Body",
25052             "type": "String",
25053             "optional": true,
25054             "field": "extension",
25055             "description": ""
25056           },
25057           {
25058             "group": "Body",
25059             "type": "String",
25060             "optional": true,
25061             "field": "priority",
25062             "description": ""
25063           },
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": true,
25068             "field": "accountcode",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "dnid",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "projectName",
25083             "description": ""
25084           },
25085           {
25086             "group": "Body",
25087             "type": "String",
25088             "optional": true,
25089             "field": "saveName",
25090             "description": ""
25091           },
25092           {
25093             "group": "Body",
25094             "type": "String",
25095             "optional": true,
25096             "field": "filename",
25097             "description": ""
25098           },
25099           {
25100             "group": "Body",
25101             "type": "String",
25102             "optional": true,
25103             "field": "savePath",
25104             "description": ""
25105           },
25106           {
25107             "group": "Body",
25108             "type": "Virtual",
25109             "optional": true,
25110             "field": "format",
25111             "description": ""
25112           }
25113         ]
25114       }
25115     },
25116     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25117     "version": "0.0.0",
25118     "filename": "server/api/squareRecording/index.js",
25119     "groupTitle": "Square_Recordings"
25120   },
25121   {
25122     "type": "get",
25123     "url": "/api/square/recordings",
25124     "title": "Gets a list of Recordings",
25125     "examples": [
25126       {
25127         "title": "Example usage:",
25128         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25129         "type": "json"
25130       }
25131     ],
25132     "name": "GetRecordings",
25133     "group": "Square_Recordings",
25134     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/recordings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25135     "version": "0.0.0",
25136     "filename": "server/api/squareRecording/index.js",
25137     "groupTitle": "Square_Recordings"
25138   },
25139   {
25140     "type": "get",
25141     "url": "/api/square/recordings/{id}",
25142     "title": "Gets a single Recording",
25143     "examples": [
25144       {
25145         "title": "Example usage:",
25146         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25147         "type": "json"
25148       }
25149     ],
25150     "name": "ShowRecordings",
25151     "group": "Square_Recordings",
25152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25153     "version": "0.0.0",
25154     "filename": "server/api/squareRecording/index.js",
25155     "groupTitle": "Square_Recordings"
25156   },
25157   {
25158     "type": "delete",
25159     "url": "/api/square/recordings/{id}",
25160     "title": "Delete recording",
25161     "examples": [
25162       {
25163         "title": "Example usage:",
25164         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25165         "type": "json"
25166       }
25167     ],
25168     "name": "destroy",
25169     "group": "Square_Recordings",
25170     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25171     "version": "0.0.0",
25172     "filename": "server/api/squareRecording/index.js",
25173     "groupTitle": "Square_Recordings"
25174   },
25175   {
25176     "type": "get",
25177     "url": "/api/square/recordings/{id}/download",
25178     "title": "Download Recording",
25179     "examples": [
25180       {
25181         "title": "Example usage:",
25182         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25183         "type": "json"
25184       }
25185     ],
25186     "name": "download",
25187     "group": "Square_Recordings",
25188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25189     "version": "0.0.0",
25190     "filename": "server/api/squareRecording/index.js",
25191     "groupTitle": "Square_Recordings"
25192   },
25193   {
25194     "type": "put",
25195     "url": "/api/square/recordings/{id}",
25196     "title": "Update an existing Recording",
25197     "examples": [
25198       {
25199         "title": "Example usage:",
25200         "content": "curl https://{domain}/api/square/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25201         "type": "json"
25202       }
25203     ],
25204     "name": "updateRecordings",
25205     "group": "Square_Recordings",
25206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25207     "version": "0.0.0",
25208     "filename": "server/api/squareRecording/index.js",
25209     "groupTitle": "Square_Recordings"
25210   },
25211   {
25212     "type": "post",
25213     "url": "/api/square/reports",
25214     "title": "Creates a new Square Report",
25215     "examples": [
25216       {
25217         "title": "Example usage:",
25218         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25219         "type": "json"
25220       }
25221     ],
25222     "name": "CreateSquare_Reports",
25223     "group": "Square_Reports",
25224     "parameter": {
25225       "fields": {
25226         "Body": [
25227           {
25228             "group": "Body",
25229             "type": "String",
25230             "optional": true,
25231             "field": "network",
25232             "description": ""
25233           },
25234           {
25235             "group": "Body",
25236             "type": "String",
25237             "optional": true,
25238             "field": "network_script",
25239             "description": ""
25240           },
25241           {
25242             "group": "Body",
25243             "type": "String",
25244             "optional": true,
25245             "field": "request",
25246             "description": ""
25247           },
25248           {
25249             "group": "Body",
25250             "type": "String",
25251             "optional": true,
25252             "field": "channel",
25253             "description": ""
25254           },
25255           {
25256             "group": "Body",
25257             "type": "String",
25258             "optional": true,
25259             "field": "language",
25260             "description": ""
25261           },
25262           {
25263             "group": "Body",
25264             "type": "String",
25265             "optional": true,
25266             "field": "type",
25267             "description": ""
25268           },
25269           {
25270             "group": "Body",
25271             "type": "String",
25272             "optional": true,
25273             "field": "uniqueid",
25274             "description": ""
25275           },
25276           {
25277             "group": "Body",
25278             "type": "String",
25279             "optional": true,
25280             "field": "version",
25281             "description": ""
25282           },
25283           {
25284             "group": "Body",
25285             "type": "String",
25286             "optional": true,
25287             "field": "callerid",
25288             "description": ""
25289           },
25290           {
25291             "group": "Body",
25292             "type": "String",
25293             "optional": true,
25294             "field": "calleridname",
25295             "description": ""
25296           },
25297           {
25298             "group": "Body",
25299             "type": "String",
25300             "optional": true,
25301             "field": "callingpres",
25302             "description": ""
25303           },
25304           {
25305             "group": "Body",
25306             "type": "String",
25307             "optional": true,
25308             "field": "callingani2",
25309             "description": ""
25310           },
25311           {
25312             "group": "Body",
25313             "type": "String",
25314             "optional": true,
25315             "field": "callington",
25316             "description": ""
25317           },
25318           {
25319             "group": "Body",
25320             "type": "String",
25321             "optional": true,
25322             "field": "callingtns",
25323             "description": ""
25324           },
25325           {
25326             "group": "Body",
25327             "type": "String",
25328             "optional": true,
25329             "field": "dnid",
25330             "description": ""
25331           },
25332           {
25333             "group": "Body",
25334             "type": "String",
25335             "optional": true,
25336             "field": "rdnis",
25337             "description": ""
25338           },
25339           {
25340             "group": "Body",
25341             "type": "String",
25342             "optional": true,
25343             "field": "context",
25344             "description": ""
25345           },
25346           {
25347             "group": "Body",
25348             "type": "String",
25349             "optional": true,
25350             "field": "extension",
25351             "description": ""
25352           },
25353           {
25354             "group": "Body",
25355             "type": "String",
25356             "optional": true,
25357             "field": "priority",
25358             "description": ""
25359           },
25360           {
25361             "group": "Body",
25362             "type": "String",
25363             "optional": true,
25364             "field": "enhanced",
25365             "description": ""
25366           },
25367           {
25368             "group": "Body",
25369             "type": "String",
25370             "optional": true,
25371             "field": "accountcode",
25372             "description": ""
25373           },
25374           {
25375             "group": "Body",
25376             "type": "String",
25377             "optional": true,
25378             "field": "threadid",
25379             "description": ""
25380           },
25381           {
25382             "group": "Body",
25383             "type": "String",
25384             "optional": true,
25385             "field": "project_name",
25386             "description": ""
25387           },
25388           {
25389             "group": "Body",
25390             "type": "String",
25391             "optional": true,
25392             "field": "joinAt",
25393             "description": ""
25394           },
25395           {
25396             "group": "Body",
25397             "type": "String",
25398             "optional": true,
25399             "field": "leaveAt",
25400             "description": ""
25401           },
25402           {
25403             "group": "Body",
25404             "type": "Boolean",
25405             "optional": true,
25406             "field": "bot",
25407             "description": ""
25408           }
25409         ]
25410       }
25411     },
25412     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25413     "version": "0.0.0",
25414     "filename": "server/api/squareReport/index.js",
25415     "groupTitle": "Square_Reports"
25416   },
25417   {
25418     "type": "delete",
25419     "url": "/api/square/reports/{id}",
25420     "title": "Deletes a Square Report",
25421     "examples": [
25422       {
25423         "title": "Example usage:",
25424         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25425         "type": "json"
25426       }
25427     ],
25428     "name": "DeleteSquare_Reports",
25429     "group": "Square_Reports",
25430     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25431     "version": "0.0.0",
25432     "filename": "server/api/squareReport/index.js",
25433     "groupTitle": "Square_Reports"
25434   },
25435   {
25436     "type": "get",
25437     "url": "/api/square/reports/describe",
25438     "title": "Gets table info about Square Reports",
25439     "examples": [
25440       {
25441         "title": "Example usage:",
25442         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25443         "type": "json"
25444       }
25445     ],
25446     "name": "DescribeSquare_Reports",
25447     "group": "Square_Reports",
25448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25449     "version": "0.0.0",
25450     "filename": "server/api/squareReport/index.js",
25451     "groupTitle": "Square_Reports"
25452   },
25453   {
25454     "type": "get",
25455     "url": "/api/square/reports",
25456     "title": "Gets a list of Square Reports",
25457     "examples": [
25458       {
25459         "title": "Example usage:",
25460         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25461         "type": "json"
25462       }
25463     ],
25464     "name": "GetSquare_Reports",
25465     "group": "Square_Reports",
25466     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25467     "version": "0.0.0",
25468     "filename": "server/api/squareReport/index.js",
25469     "groupTitle": "Square_Reports"
25470   },
25471   {
25472     "type": "get",
25473     "url": "/api/square/reports/{id}",
25474     "title": "Gets a single Square Report",
25475     "examples": [
25476       {
25477         "title": "Example usage:",
25478         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25479         "type": "json"
25480       }
25481     ],
25482     "name": "ShowSquare_Reports",
25483     "group": "Square_Reports",
25484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25485     "version": "0.0.0",
25486     "filename": "server/api/squareReport/index.js",
25487     "groupTitle": "Square_Reports"
25488   },
25489   {
25490     "type": "put",
25491     "url": "/api/square/reports/{id}",
25492     "title": "Update an existing Square Report",
25493     "examples": [
25494       {
25495         "title": "Example usage:",
25496         "content": "curl https://{domain}/api/square/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25497         "type": "json"
25498       }
25499     ],
25500     "name": "updateSquare_Reports",
25501     "group": "Square_Reports",
25502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25503     "version": "0.0.0",
25504     "filename": "server/api/squareReport/index.js",
25505     "groupTitle": "Square_Reports"
25506   },
25507   {
25508     "type": "post",
25509     "url": "/api/integrations/sugarcrm/configurations",
25510     "title": "Creates a new SugarCRM Configuration",
25511     "examples": [
25512       {
25513         "title": "Example usage:",
25514         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25515         "type": "json"
25516       }
25517     ],
25518     "name": "CreateSugarCRM_Configurations",
25519     "group": "SugarCRM_Configurations",
25520     "parameter": {
25521       "fields": {
25522         "Body": [
25523           {
25524             "group": "Body",
25525             "type": "String",
25526             "optional": true,
25527             "field": "name",
25528             "description": ""
25529           },
25530           {
25531             "group": "Body",
25532             "type": "String",
25533             "optional": true,
25534             "field": "description",
25535             "description": ""
25536           }
25537         ]
25538       }
25539     },
25540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25541     "version": "0.0.0",
25542     "filename": "server/api/intSugarcrmConfiguration/index.js",
25543     "groupTitle": "SugarCRM_Configurations"
25544   },
25545   {
25546     "type": "delete",
25547     "url": "/api/integrations/sugarcrm/configurations/{id}",
25548     "title": "Deletes a SugarCRM Configuration",
25549     "examples": [
25550       {
25551         "title": "Example usage:",
25552         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25553         "type": "json"
25554       }
25555     ],
25556     "name": "DeleteSugarCRM_Configurations",
25557     "group": "SugarCRM_Configurations",
25558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25559     "version": "0.0.0",
25560     "filename": "server/api/intSugarcrmConfiguration/index.js",
25561     "groupTitle": "SugarCRM_Configurations"
25562   },
25563   {
25564     "type": "get",
25565     "url": "/api/integrations/sugarcrm/configurations",
25566     "title": "Gets a list of SugarCRM Configurations",
25567     "examples": [
25568       {
25569         "title": "Example usage:",
25570         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25571         "type": "json"
25572       }
25573     ],
25574     "name": "GetSugarCRM_Configurations",
25575     "group": "SugarCRM_Configurations",
25576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25577     "version": "0.0.0",
25578     "filename": "server/api/intSugarcrmConfiguration/index.js",
25579     "groupTitle": "SugarCRM_Configurations"
25580   },
25581   {
25582     "type": "get",
25583     "url": "/api/integrations/sugarcrm/configurations/{id}",
25584     "title": "Gets a single SugarCRM Configuration",
25585     "examples": [
25586       {
25587         "title": "Example usage:",
25588         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25589         "type": "json"
25590       }
25591     ],
25592     "name": "ShowSugarCRM_Configurations",
25593     "group": "SugarCRM_Configurations",
25594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25595     "version": "0.0.0",
25596     "filename": "server/api/intSugarcrmConfiguration/index.js",
25597     "groupTitle": "SugarCRM_Configurations"
25598   },
25599   {
25600     "type": "put",
25601     "url": "/api/integrations/sugarcrm/configurations/{id}",
25602     "title": "Update an existing SugarCRM Configuration",
25603     "examples": [
25604       {
25605         "title": "Example usage:",
25606         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25607         "type": "json"
25608       }
25609     ],
25610     "name": "updateSugarCRM_Configurations",
25611     "group": "SugarCRM_Configurations",
25612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25613     "version": "0.0.0",
25614     "filename": "server/api/intSugarcrmConfiguration/index.js",
25615     "groupTitle": "SugarCRM_Configurations"
25616   },
25617   {
25618     "type": "post",
25619     "url": "/api/integrations/sugarcrm/accounts",
25620     "title": "Creates a new Sugarcrm Account",
25621     "examples": [
25622       {
25623         "title": "Example usage:",
25624         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25625         "type": "json"
25626       }
25627     ],
25628     "name": "CreateSugarcrm_Accounts",
25629     "group": "Sugarcrm_Accounts",
25630     "parameter": {
25631       "fields": {
25632         "Body": [
25633           {
25634             "group": "Body",
25635             "type": "String",
25636             "optional": true,
25637             "field": "name",
25638             "description": ""
25639           },
25640           {
25641             "group": "Body",
25642             "type": "String",
25643             "optional": true,
25644             "field": "description",
25645             "description": ""
25646           },
25647           {
25648             "group": "Body",
25649             "type": "String",
25650             "optional": true,
25651             "field": "username",
25652             "description": ""
25653           },
25654           {
25655             "group": "Body",
25656             "type": "String",
25657             "optional": true,
25658             "field": "password",
25659             "description": ""
25660           },
25661           {
25662             "group": "Body",
25663             "type": "String",
25664             "optional": true,
25665             "field": "remoteUri",
25666             "description": ""
25667           },
25668           {
25669             "group": "Body",
25670             "type": "String",
25671             "optional": false,
25672             "field": "serverUrl",
25673             "description": ""
25674           }
25675         ]
25676       }
25677     },
25678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25679     "version": "0.0.0",
25680     "filename": "server/api/intSugarcrmAccount/index.js",
25681     "groupTitle": "Sugarcrm_Accounts"
25682   },
25683   {
25684     "type": "delete",
25685     "url": "/api/integrations/sugarcrm/accounts/{id}",
25686     "title": "Deletes a Sugarcrm Account",
25687     "examples": [
25688       {
25689         "title": "Example usage:",
25690         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25691         "type": "json"
25692       }
25693     ],
25694     "name": "DeleteSugarcrm_Accounts",
25695     "group": "Sugarcrm_Accounts",
25696     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25697     "version": "0.0.0",
25698     "filename": "server/api/intSugarcrmAccount/index.js",
25699     "groupTitle": "Sugarcrm_Accounts"
25700   },
25701   {
25702     "type": "get",
25703     "url": "/api/integrations/sugarcrm/accounts",
25704     "title": "Gets a list of Sugarcrm Accounts",
25705     "examples": [
25706       {
25707         "title": "Example usage:",
25708         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25709         "type": "json"
25710       }
25711     ],
25712     "name": "GetSugarcrm_Accounts",
25713     "group": "Sugarcrm_Accounts",
25714     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25715     "version": "0.0.0",
25716     "filename": "server/api/intSugarcrmAccount/index.js",
25717     "groupTitle": "Sugarcrm_Accounts"
25718   },
25719   {
25720     "type": "get",
25721     "url": "/api/integrations/sugarcrm/accounts/{id}",
25722     "title": "Gets a single Sugarcrm Account",
25723     "examples": [
25724       {
25725         "title": "Example usage:",
25726         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25727         "type": "json"
25728       }
25729     ],
25730     "name": "ShowSugarcrm_Accounts",
25731     "group": "Sugarcrm_Accounts",
25732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25733     "version": "0.0.0",
25734     "filename": "server/api/intSugarcrmAccount/index.js",
25735     "groupTitle": "Sugarcrm_Accounts"
25736   },
25737   {
25738     "type": "post",
25739     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25740     "title": "Creates new configuration",
25741     "examples": [
25742       {
25743         "title": "Example usage:",
25744         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25745         "type": "json"
25746       }
25747     ],
25748     "name": "addConfiguration",
25749     "group": "Sugarcrm_Accounts",
25750     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25751     "version": "0.0.0",
25752     "filename": "server/api/intSugarcrmAccount/index.js",
25753     "groupTitle": "Sugarcrm_Accounts"
25754   },
25755   {
25756     "type": "get",
25757     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25758     "title": "Gets account configurations",
25759     "examples": [
25760       {
25761         "title": "Example usage:",
25762         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25763         "type": "json"
25764       }
25765     ],
25766     "name": "getConfigurations",
25767     "group": "Sugarcrm_Accounts",
25768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25769     "version": "0.0.0",
25770     "filename": "server/api/intSugarcrmAccount/index.js",
25771     "groupTitle": "Sugarcrm_Accounts"
25772   },
25773   {
25774     "type": "get",
25775     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25776     "title": "Gets account fields",
25777     "examples": [
25778       {
25779         "title": "Example usage:",
25780         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25781         "type": "json"
25782       }
25783     ],
25784     "name": "getFields",
25785     "group": "Sugarcrm_Accounts",
25786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25787     "version": "0.0.0",
25788     "filename": "server/api/intSugarcrmAccount/index.js",
25789     "groupTitle": "Sugarcrm_Accounts"
25790   },
25791   {
25792     "type": "put",
25793     "url": "/api/integrations/sugarcrm/accounts/{id}",
25794     "title": "Update an existing Sugarcrm Account",
25795     "examples": [
25796       {
25797         "title": "Example usage:",
25798         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25799         "type": "json"
25800       }
25801     ],
25802     "name": "updateSugarcrm_Accounts",
25803     "group": "Sugarcrm_Accounts",
25804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25805     "version": "0.0.0",
25806     "filename": "server/api/intSugarcrmAccount/index.js",
25807     "groupTitle": "Sugarcrm_Accounts"
25808   },
25809   {
25810     "type": "get",
25811     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25812     "title": "Gets configurations descriptions",
25813     "examples": [
25814       {
25815         "title": "Example usage:",
25816         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25817         "type": "json"
25818       }
25819     ],
25820     "name": "getDescriptions",
25821     "group": "Sugarcrm_Configurations",
25822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25823     "version": "0.0.0",
25824     "filename": "server/api/intSugarcrmConfiguration/index.js",
25825     "groupTitle": "Sugarcrm_Configurations"
25826   },
25827   {
25828     "type": "get",
25829     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25830     "title": "Gets configurations fields",
25831     "examples": [
25832       {
25833         "title": "Example usage:",
25834         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25835         "type": "json"
25836       }
25837     ],
25838     "name": "getFields",
25839     "group": "Sugarcrm_Configurations",
25840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25841     "version": "0.0.0",
25842     "filename": "server/api/intSugarcrmConfiguration/index.js",
25843     "groupTitle": "Sugarcrm_Configurations"
25844   },
25845   {
25846     "type": "get",
25847     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25848     "title": "Gets configurations subjects",
25849     "examples": [
25850       {
25851         "title": "Example usage:",
25852         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25853         "type": "json"
25854       }
25855     ],
25856     "name": "getSubjects",
25857     "group": "Sugarcrm_Configurations",
25858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25859     "version": "0.0.0",
25860     "filename": "server/api/intSugarcrmConfiguration/index.js",
25861     "groupTitle": "Sugarcrm_Configurations"
25862   },
25863   {
25864     "type": "post",
25865     "url": "/api/integrations/sugarcrm/fields",
25866     "title": "Creates a new Sugarcrm Field",
25867     "examples": [
25868       {
25869         "title": "Example usage:",
25870         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25871         "type": "json"
25872       }
25873     ],
25874     "name": "CreateSugarcrm_Fields",
25875     "group": "Sugarcrm_Fields",
25876     "parameter": {
25877       "fields": {
25878         "Body": [
25879           {
25880             "group": "Body",
25881             "type": "String",
25882             "allowedValues": [
25883               "\"string\"",
25884               "\"variable\"",
25885               "\"customVariable\"",
25886               "\"keyValue\"",
25887               "\"picklist\""
25888             ],
25889             "optional": true,
25890             "field": "type",
25891             "description": ""
25892           },
25893           {
25894             "group": "Body",
25895             "type": "String",
25896             "optional": true,
25897             "field": "content",
25898             "description": ""
25899           },
25900           {
25901             "group": "Body",
25902             "type": "String",
25903             "optional": true,
25904             "field": "key",
25905             "description": ""
25906           },
25907           {
25908             "group": "Body",
25909             "type": "String",
25910             "allowedValues": [
25911               "\"string\"",
25912               "\"variable\"",
25913               "\"customVariable\""
25914             ],
25915             "optional": true,
25916             "field": "keyType",
25917             "description": ""
25918           },
25919           {
25920             "group": "Body",
25921             "type": "String",
25922             "optional": true,
25923             "field": "keyContent",
25924             "description": ""
25925           },
25926           {
25927             "group": "Body",
25928             "type": "String",
25929             "optional": true,
25930             "field": "idField",
25931             "description": ""
25932           },
25933           {
25934             "group": "Body",
25935             "type": "String",
25936             "optional": true,
25937             "field": "nameField",
25938             "description": ""
25939           },
25940           {
25941             "group": "Body",
25942             "type": "Boolean",
25943             "optional": true,
25944             "field": "customField",
25945             "description": ""
25946           },
25947           {
25948             "group": "Body",
25949             "type": "String",
25950             "optional": true,
25951             "field": "variableName",
25952             "description": ""
25953           }
25954         ]
25955       }
25956     },
25957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25958     "version": "0.0.0",
25959     "filename": "server/api/intSugarcrmField/index.js",
25960     "groupTitle": "Sugarcrm_Fields"
25961   },
25962   {
25963     "type": "delete",
25964     "url": "/api/integrations/sugarcrm/fields/{id}",
25965     "title": "Deletes a Sugarcrm Field",
25966     "examples": [
25967       {
25968         "title": "Example usage:",
25969         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25970         "type": "json"
25971       }
25972     ],
25973     "name": "DeleteSugarcrm_Fields",
25974     "group": "Sugarcrm_Fields",
25975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25976     "version": "0.0.0",
25977     "filename": "server/api/intSugarcrmField/index.js",
25978     "groupTitle": "Sugarcrm_Fields"
25979   },
25980   {
25981     "type": "get",
25982     "url": "/api/integrations/sugarcrm/fields",
25983     "title": "Gets a list of Sugarcrm Fields",
25984     "examples": [
25985       {
25986         "title": "Example usage:",
25987         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25988         "type": "json"
25989       }
25990     ],
25991     "name": "GetSugarcrm_Fields",
25992     "group": "Sugarcrm_Fields",
25993     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25994     "version": "0.0.0",
25995     "filename": "server/api/intSugarcrmField/index.js",
25996     "groupTitle": "Sugarcrm_Fields"
25997   },
25998   {
25999     "type": "get",
26000     "url": "/api/integrations/sugarcrm/fields/{id}",
26001     "title": "Gets a single Sugarcrm Field",
26002     "examples": [
26003       {
26004         "title": "Example usage:",
26005         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26006         "type": "json"
26007       }
26008     ],
26009     "name": "ShowSugarcrm_Fields",
26010     "group": "Sugarcrm_Fields",
26011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26012     "version": "0.0.0",
26013     "filename": "server/api/intSugarcrmField/index.js",
26014     "groupTitle": "Sugarcrm_Fields"
26015   },
26016   {
26017     "type": "put",
26018     "url": "/api/integrations/sugarcrm/fields/{id}",
26019     "title": "Update an existing Sugarcrm Field",
26020     "examples": [
26021       {
26022         "title": "Example usage:",
26023         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26024         "type": "json"
26025       }
26026     ],
26027     "name": "updateSugarcrm_Fields",
26028     "group": "Sugarcrm_Fields",
26029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26030     "version": "0.0.0",
26031     "filename": "server/api/intSugarcrmField/index.js",
26032     "groupTitle": "Sugarcrm_Fields"
26033   },
26034   {
26035     "type": "get",
26036     "url": "/api/system",
26037     "title": "Gets system information",
26038     "examples": [
26039       {
26040         "title": "Example usage:",
26041         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26042         "type": "json"
26043       }
26044     ],
26045     "name": "GetSystemInformation",
26046     "group": "System_Information",
26047     "description": "<p>Motion returns the system information.</p>",
26048     "version": "0.0.0",
26049     "filename": "server/api/system/index.js",
26050     "groupTitle": "System_Information"
26051   },
26052   {
26053     "type": "get",
26054     "url": "/api/system/process",
26055     "title": "Gets system information",
26056     "examples": [
26057       {
26058         "title": "Example usage:",
26059         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26060         "type": "json"
26061       }
26062     ],
26063     "name": "GetSystemInformation",
26064     "group": "System_Information",
26065     "description": "<p>Motion returns the system information.</p>",
26066     "version": "0.0.0",
26067     "filename": "server/api/system/index.js",
26068     "groupTitle": "System_Information"
26069   },
26070   {
26071     "type": "post",
26072     "url": "/api/tags",
26073     "title": "Creates a new Tag",
26074     "examples": [
26075       {
26076         "title": "Example usage:",
26077         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26078         "type": "json"
26079       }
26080     ],
26081     "name": "CreateTags",
26082     "group": "Tags",
26083     "parameter": {
26084       "fields": {
26085         "Body": [
26086           {
26087             "group": "Body",
26088             "type": "String",
26089             "optional": false,
26090             "field": "name",
26091             "description": ""
26092           },
26093           {
26094             "group": "Body",
26095             "type": "String",
26096             "optional": true,
26097             "field": "color",
26098             "description": ""
26099           },
26100           {
26101             "group": "Body",
26102             "type": "String",
26103             "optional": true,
26104             "field": "description",
26105             "description": ""
26106           }
26107         ]
26108       }
26109     },
26110     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26111     "version": "0.0.0",
26112     "filename": "server/api/tag/index.js",
26113     "groupTitle": "Tags"
26114   },
26115   {
26116     "type": "delete",
26117     "url": "/api/tags/{id}",
26118     "title": "Deletes a Tag",
26119     "examples": [
26120       {
26121         "title": "Example usage:",
26122         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26123         "type": "json"
26124       }
26125     ],
26126     "name": "DeleteTags",
26127     "group": "Tags",
26128     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26129     "version": "0.0.0",
26130     "filename": "server/api/tag/index.js",
26131     "groupTitle": "Tags"
26132   },
26133   {
26134     "type": "get",
26135     "url": "/api/tags",
26136     "title": "Gets a list of Tags",
26137     "examples": [
26138       {
26139         "title": "Example usage:",
26140         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26141         "type": "json"
26142       }
26143     ],
26144     "name": "GetTags",
26145     "group": "Tags",
26146     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/tags?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/tags?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/tags?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/tags?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/tags?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26147     "version": "0.0.0",
26148     "filename": "server/api/tag/index.js",
26149     "groupTitle": "Tags"
26150   },
26151   {
26152     "type": "get",
26153     "url": "/api/tags/{id}",
26154     "title": "Gets a single Tag",
26155     "examples": [
26156       {
26157         "title": "Example usage:",
26158         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26159         "type": "json"
26160       }
26161     ],
26162     "name": "ShowTags",
26163     "group": "Tags",
26164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26165     "version": "0.0.0",
26166     "filename": "server/api/tag/index.js",
26167     "groupTitle": "Tags"
26168   },
26169   {
26170     "type": "put",
26171     "url": "/api/tags/{id}",
26172     "title": "Update an existing Tag",
26173     "examples": [
26174       {
26175         "title": "Example usage:",
26176         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26177         "type": "json"
26178       }
26179     ],
26180     "name": "updateTags",
26181     "group": "Tags",
26182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183     "version": "0.0.0",
26184     "filename": "server/api/tag/index.js",
26185     "groupTitle": "Tags"
26186   },
26187   {
26188     "type": "post",
26189     "url": "/api/teams/{id}/queues",
26190     "title": "Add queues to a team",
26191     "examples": [
26192       {
26193         "title": "Example usage:",
26194         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26195         "type": "json"
26196       }
26197     ],
26198     "name": "AddQueues",
26199     "group": "Teams",
26200     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26201     "version": "0.0.0",
26202     "filename": "server/api/team/index.js",
26203     "groupTitle": "Teams"
26204   },
26205   {
26206     "type": "post",
26207     "url": "/api/teams",
26208     "title": "Creates a new Team",
26209     "examples": [
26210       {
26211         "title": "Example usage:",
26212         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26213         "type": "json"
26214       }
26215     ],
26216     "name": "CreateTeams",
26217     "group": "Teams",
26218     "parameter": {
26219       "fields": {
26220         "Body": [
26221           {
26222             "group": "Body",
26223             "type": "String",
26224             "optional": false,
26225             "field": "name",
26226             "description": ""
26227           },
26228           {
26229             "group": "Body",
26230             "type": "String",
26231             "optional": true,
26232             "field": "description",
26233             "description": ""
26234           }
26235         ]
26236       }
26237     },
26238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26239     "version": "0.0.0",
26240     "filename": "server/api/team/index.js",
26241     "groupTitle": "Teams"
26242   },
26243   {
26244     "type": "delete",
26245     "url": "/api/teams/{id}",
26246     "title": "Deletes a Team",
26247     "examples": [
26248       {
26249         "title": "Example usage:",
26250         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26251         "type": "json"
26252       }
26253     ],
26254     "name": "DeleteTeams",
26255     "group": "Teams",
26256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26257     "version": "0.0.0",
26258     "filename": "server/api/team/index.js",
26259     "groupTitle": "Teams"
26260   },
26261   {
26262     "type": "get",
26263     "url": "/api/teams/{id}/users",
26264     "title": "Gets agents from team",
26265     "examples": [
26266       {
26267         "title": "Example usage:",
26268         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26269         "type": "json"
26270       }
26271     ],
26272     "name": "GetAgents",
26273     "group": "Teams",
26274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26275     "version": "0.0.0",
26276     "filename": "server/api/team/index.js",
26277     "groupTitle": "Teams"
26278   },
26279   {
26280     "type": "get",
26281     "url": "/api/teams/{id}/queues?channel={channel}",
26282     "title": "Gets Queues list",
26283     "examples": [
26284       {
26285         "title": "Example usage:",
26286         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26287         "type": "json"
26288       }
26289     ],
26290     "name": "GetQueues",
26291     "group": "Teams",
26292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26293     "version": "0.0.0",
26294     "filename": "server/api/team/index.js",
26295     "groupTitle": "Teams"
26296   },
26297   {
26298     "type": "get",
26299     "url": "/api/teams",
26300     "title": "Gets a list of Teams",
26301     "examples": [
26302       {
26303         "title": "Example usage:",
26304         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26305         "type": "json"
26306       }
26307     ],
26308     "name": "GetTeams",
26309     "group": "Teams",
26310     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/teams?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/teams?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/teams?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/teams?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/teams?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26311     "version": "0.0.0",
26312     "filename": "server/api/team/index.js",
26313     "groupTitle": "Teams"
26314   },
26315   {
26316     "type": "delete",
26317     "url": "/api/teams/{id}/users",
26318     "title": "Removes agents from a team",
26319     "examples": [
26320       {
26321         "title": "Example usage:",
26322         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26323         "type": "json"
26324       }
26325     ],
26326     "name": "RemoveAgents",
26327     "group": "Teams",
26328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26329     "version": "0.0.0",
26330     "filename": "server/api/team/index.js",
26331     "groupTitle": "Teams"
26332   },
26333   {
26334     "type": "delete",
26335     "url": "/api/teams/{id}/queues",
26336     "title": "Remove queues to a team",
26337     "examples": [
26338       {
26339         "title": "Example usage:",
26340         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26341         "type": "json"
26342       }
26343     ],
26344     "name": "RemoveQueues",
26345     "group": "Teams",
26346     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26347     "version": "0.0.0",
26348     "filename": "server/api/team/index.js",
26349     "groupTitle": "Teams"
26350   },
26351   {
26352     "type": "delete",
26353     "url": "/api/openchannel/queues/{id}/teams",
26354     "title": "Remove teams from a queue",
26355     "examples": [
26356       {
26357         "title": "Example usage:",
26358         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26359         "type": "json"
26360       }
26361     ],
26362     "name": "RemoveTeams",
26363     "group": "Teams",
26364     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26365     "version": "0.0.0",
26366     "filename": "server/api/openchannelQueue/index.js",
26367     "groupTitle": "Teams"
26368   },
26369   {
26370     "type": "delete",
26371     "url": "/api/voice/queues/{id}/teams",
26372     "title": "Remove teams from a queue",
26373     "examples": [
26374       {
26375         "title": "Example usage:",
26376         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26377         "type": "json"
26378       }
26379     ],
26380     "name": "RemoveTeams",
26381     "group": "Teams",
26382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26383     "version": "0.0.0",
26384     "filename": "server/api/voiceQueue/index.js",
26385     "groupTitle": "Teams"
26386   },
26387   {
26388     "type": "delete",
26389     "url": "/api/voice/Prefixes/{id}/teams",
26390     "title": "Remove teams from a voice prefix",
26391     "examples": [
26392       {
26393         "title": "Example usage:",
26394         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26395         "type": "json"
26396       }
26397     ],
26398     "name": "RemoveTeams",
26399     "group": "Teams",
26400     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26401     "version": "0.0.0",
26402     "filename": "server/api/voicePrefix/index.js",
26403     "groupTitle": "Teams"
26404   },
26405   {
26406     "type": "delete",
26407     "url": "/api/sms/queues/{id}/teams",
26408     "title": "Remove teams from a queue",
26409     "examples": [
26410       {
26411         "title": "Example usage:",
26412         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26413         "type": "json"
26414       }
26415     ],
26416     "name": "RemoveTeams",
26417     "group": "Teams",
26418     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26419     "version": "0.0.0",
26420     "filename": "server/api/smsQueue/index.js",
26421     "groupTitle": "Teams"
26422   },
26423   {
26424     "type": "delete",
26425     "url": "/api/whatsapp/queues/{id}/teams",
26426     "title": "Remove teams from a queue",
26427     "examples": [
26428       {
26429         "title": "Example usage:",
26430         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26431         "type": "json"
26432       }
26433     ],
26434     "name": "RemoveTeams",
26435     "group": "Teams",
26436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26437     "version": "0.0.0",
26438     "filename": "server/api/whatsappQueue/index.js",
26439     "groupTitle": "Teams"
26440   },
26441   {
26442     "type": "delete",
26443     "url": "/api/mail/queues/{id}/teams",
26444     "title": "Remove teams from a queue",
26445     "examples": [
26446       {
26447         "title": "Example usage:",
26448         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26449         "type": "json"
26450       }
26451     ],
26452     "name": "RemoveTeams",
26453     "group": "Teams",
26454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26455     "version": "0.0.0",
26456     "filename": "server/api/mailQueue/index.js",
26457     "groupTitle": "Teams"
26458   },
26459   {
26460     "type": "delete",
26461     "url": "/api/chat/queues/{id}/teams",
26462     "title": "Remove teams from a queue",
26463     "examples": [
26464       {
26465         "title": "Example usage:",
26466         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26467         "type": "json"
26468       }
26469     ],
26470     "name": "RemoveTeams",
26471     "group": "Teams",
26472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26473     "version": "0.0.0",
26474     "filename": "server/api/chatQueue/index.js",
26475     "groupTitle": "Teams"
26476   },
26477   {
26478     "type": "delete",
26479     "url": "/api/fax/queues/{id}/teams",
26480     "title": "Remove teams from a queue",
26481     "examples": [
26482       {
26483         "title": "Example usage:",
26484         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26485         "type": "json"
26486       }
26487     ],
26488     "name": "RemoveTeams",
26489     "group": "Teams",
26490     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26491     "version": "0.0.0",
26492     "filename": "server/api/faxQueue/index.js",
26493     "groupTitle": "Teams"
26494   },
26495   {
26496     "type": "get",
26497     "url": "/api/teams/{id}",
26498     "title": "Gets a single Team",
26499     "examples": [
26500       {
26501         "title": "Example usage:",
26502         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26503         "type": "json"
26504       }
26505     ],
26506     "name": "ShowTeams",
26507     "group": "Teams",
26508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26509     "version": "0.0.0",
26510     "filename": "server/api/team/index.js",
26511     "groupTitle": "Teams"
26512   },
26513   {
26514     "type": "post",
26515     "url": "/api/teams/{id}/users",
26516     "title": "Adds agents to a team",
26517     "examples": [
26518       {
26519         "title": "Example usage:",
26520         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26521         "type": "json"
26522       }
26523     ],
26524     "name": "addAgents",
26525     "group": "Teams",
26526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26527     "version": "0.0.0",
26528     "filename": "server/api/team/index.js",
26529     "groupTitle": "Teams"
26530   },
26531   {
26532     "type": "put",
26533     "url": "/api/teams/{id}",
26534     "title": "Update an existing Team",
26535     "examples": [
26536       {
26537         "title": "Example usage:",
26538         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26539         "type": "json"
26540       }
26541     ],
26542     "name": "updateTeams",
26543     "group": "Teams",
26544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26545     "version": "0.0.0",
26546     "filename": "server/api/team/index.js",
26547     "groupTitle": "Teams"
26548   },
26549   {
26550     "type": "post",
26551     "url": "/api/templates",
26552     "title": "Creates a new Template",
26553     "examples": [
26554       {
26555         "title": "Example usage:",
26556         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26557         "type": "json"
26558       }
26559     ],
26560     "name": "CreateTemplates",
26561     "group": "Templates",
26562     "parameter": {
26563       "fields": {
26564         "Body": [
26565           {
26566             "group": "Body",
26567             "type": "String",
26568             "optional": true,
26569             "field": "name",
26570             "description": ""
26571           },
26572           {
26573             "group": "Body",
26574             "type": "String",
26575             "optional": true,
26576             "field": "description",
26577             "description": ""
26578           },
26579           {
26580             "group": "Body",
26581             "type": "Text",
26582             "optional": true,
26583             "field": "html",
26584             "description": ""
26585           }
26586         ]
26587       }
26588     },
26589     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26590     "version": "0.0.0",
26591     "filename": "server/api/template/index.js",
26592     "groupTitle": "Templates"
26593   },
26594   {
26595     "type": "delete",
26596     "url": "/api/templates/{id}",
26597     "title": "Deletes a Template",
26598     "examples": [
26599       {
26600         "title": "Example usage:",
26601         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26602         "type": "json"
26603       }
26604     ],
26605     "name": "DeleteTemplates",
26606     "group": "Templates",
26607     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26608     "version": "0.0.0",
26609     "filename": "server/api/template/index.js",
26610     "groupTitle": "Templates"
26611   },
26612   {
26613     "type": "get",
26614     "url": "/api/templates",
26615     "title": "Gets a list of Templates",
26616     "examples": [
26617       {
26618         "title": "Example usage:",
26619         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26620         "type": "json"
26621       }
26622     ],
26623     "name": "GetTemplates",
26624     "group": "Templates",
26625     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/templates?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/templates?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/templates?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/templates?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/templates?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26626     "version": "0.0.0",
26627     "filename": "server/api/template/index.js",
26628     "groupTitle": "Templates"
26629   },
26630   {
26631     "type": "get",
26632     "url": "/api/templates/{id}",
26633     "title": "Gets a single Template",
26634     "examples": [
26635       {
26636         "title": "Example usage:",
26637         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26638         "type": "json"
26639       }
26640     ],
26641     "name": "ShowTemplates",
26642     "group": "Templates",
26643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26644     "version": "0.0.0",
26645     "filename": "server/api/template/index.js",
26646     "groupTitle": "Templates"
26647   },
26648   {
26649     "type": "put",
26650     "url": "/api/templates/{id}",
26651     "title": "Update an existing Template",
26652     "examples": [
26653       {
26654         "title": "Example usage:",
26655         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26656         "type": "json"
26657       }
26658     ],
26659     "name": "updateTemplates",
26660     "group": "Templates",
26661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26662     "version": "0.0.0",
26663     "filename": "server/api/template/index.js",
26664     "groupTitle": "Templates"
26665   },
26666   {
26667     "type": "post",
26668     "url": "/api/triggers",
26669     "title": "Creates a new Trigger",
26670     "examples": [
26671       {
26672         "title": "Example usage:",
26673         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26674         "type": "json"
26675       }
26676     ],
26677     "name": "CreateTriggers",
26678     "group": "Triggers",
26679     "parameter": {
26680       "fields": {
26681         "Body": [
26682           {
26683             "group": "Body",
26684             "type": "String",
26685             "optional": true,
26686             "field": "name",
26687             "description": ""
26688           },
26689           {
26690             "group": "Body",
26691             "type": "String",
26692             "optional": true,
26693             "field": "channel",
26694             "description": ""
26695           },
26696           {
26697             "group": "Body",
26698             "type": "String",
26699             "optional": true,
26700             "field": "description",
26701             "description": ""
26702           },
26703           {
26704             "group": "Body",
26705             "type": "Boolean",
26706             "optional": true,
26707             "field": "status",
26708             "description": ""
26709           }
26710         ]
26711       }
26712     },
26713     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26714     "version": "0.0.0",
26715     "filename": "server/api/trigger/index.js",
26716     "groupTitle": "Triggers"
26717   },
26718   {
26719     "type": "delete",
26720     "url": "/api/triggers/{id}",
26721     "title": "Deletes a Trigger",
26722     "examples": [
26723       {
26724         "title": "Example usage:",
26725         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26726         "type": "json"
26727       }
26728     ],
26729     "name": "DeleteTriggers",
26730     "group": "Triggers",
26731     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26732     "version": "0.0.0",
26733     "filename": "server/api/trigger/index.js",
26734     "groupTitle": "Triggers"
26735   },
26736   {
26737     "type": "get",
26738     "url": "/api/triggers",
26739     "title": "Gets a list of Triggers",
26740     "examples": [
26741       {
26742         "title": "Example usage:",
26743         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26744         "type": "json"
26745       }
26746     ],
26747     "name": "GetTriggers",
26748     "group": "Triggers",
26749     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/triggers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/triggers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/triggers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/triggers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/triggers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26750     "version": "0.0.0",
26751     "filename": "server/api/trigger/index.js",
26752     "groupTitle": "Triggers"
26753   },
26754   {
26755     "type": "get",
26756     "url": "/api/triggers/{id}",
26757     "title": "Gets a single Trigger",
26758     "examples": [
26759       {
26760         "title": "Example usage:",
26761         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26762         "type": "json"
26763       }
26764     ],
26765     "name": "ShowTriggers",
26766     "group": "Triggers",
26767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26768     "version": "0.0.0",
26769     "filename": "server/api/trigger/index.js",
26770     "groupTitle": "Triggers"
26771   },
26772   {
26773     "type": "post",
26774     "url": "/api/triggers/{id}/actions",
26775     "title": "Creates new actions",
26776     "examples": [
26777       {
26778         "title": "Example usage:",
26779         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26780         "type": "json"
26781       }
26782     ],
26783     "name": "addAction",
26784     "group": "Triggers",
26785     "parameter": {
26786       "fields": {
26787         "Body": [
26788           {
26789             "group": "Body",
26790             "type": "Virtual",
26791             "optional": true,
26792             "field": "name",
26793             "description": ""
26794           },
26795           {
26796             "group": "Body",
26797             "type": "String",
26798             "optional": false,
26799             "field": "action",
26800             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26801           },
26802           {
26803             "group": "Body",
26804             "type": "String",
26805             "optional": true,
26806             "field": "data1",
26807             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26808           },
26809           {
26810             "group": "Body",
26811             "type": "String",
26812             "optional": true,
26813             "field": "data2",
26814             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26815           },
26816           {
26817             "group": "Body",
26818             "type": "String",
26819             "optional": true,
26820             "field": "data3",
26821             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26822           },
26823           {
26824             "group": "Body",
26825             "type": "String",
26826             "optional": true,
26827             "field": "data4",
26828             "description": ""
26829           },
26830           {
26831             "group": "Body",
26832             "type": "String",
26833             "optional": true,
26834             "field": "data5",
26835             "description": ""
26836           },
26837           {
26838             "group": "Body",
26839             "type": "String",
26840             "optional": true,
26841             "field": "data6",
26842             "description": ""
26843           },
26844           {
26845             "group": "Body",
26846             "type": "Text",
26847             "optional": true,
26848             "field": "data7",
26849             "description": ""
26850           }
26851         ]
26852       }
26853     },
26854     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26855     "version": "0.0.0",
26856     "filename": "server/api/trigger/index.js",
26857     "groupTitle": "Triggers"
26858   },
26859   {
26860     "type": "post",
26861     "url": "/api/triggers/{id}/all_conditions",
26862     "title": "Creates a new \"AND\"condition",
26863     "examples": [
26864       {
26865         "title": "Example usage:",
26866         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26867         "type": "json"
26868       }
26869     ],
26870     "name": "addAllCondition",
26871     "group": "Triggers",
26872     "parameter": {
26873       "fields": {
26874         "Body": [
26875           {
26876             "group": "Body",
26877             "type": "Virtual",
26878             "optional": true,
26879             "field": "name",
26880             "description": ""
26881           },
26882           {
26883             "group": "Body",
26884             "type": "String",
26885             "optional": false,
26886             "field": "field",
26887             "description": ""
26888           },
26889           {
26890             "group": "Body",
26891             "type": "String",
26892             "optional": false,
26893             "field": "operator",
26894             "description": ""
26895           },
26896           {
26897             "group": "Body",
26898             "type": "String",
26899             "optional": false,
26900             "field": "value",
26901             "description": ""
26902           }
26903         ]
26904       }
26905     },
26906     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26907     "version": "0.0.0",
26908     "filename": "server/api/trigger/index.js",
26909     "groupTitle": "Triggers"
26910   },
26911   {
26912     "type": "post",
26913     "url": "/api/triggers/{id}/any_conditions",
26914     "title": "Creates a new \"OR\"condition",
26915     "examples": [
26916       {
26917         "title": "Example usage:",
26918         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26919         "type": "json"
26920       }
26921     ],
26922     "name": "addAnyCondition",
26923     "group": "Triggers",
26924     "parameter": {
26925       "fields": {
26926         "Body": [
26927           {
26928             "group": "Body",
26929             "type": "Virtual",
26930             "optional": true,
26931             "field": "name",
26932             "description": ""
26933           },
26934           {
26935             "group": "Body",
26936             "type": "String",
26937             "optional": false,
26938             "field": "field",
26939             "description": ""
26940           },
26941           {
26942             "group": "Body",
26943             "type": "String",
26944             "optional": false,
26945             "field": "operator",
26946             "description": ""
26947           },
26948           {
26949             "group": "Body",
26950             "type": "String",
26951             "optional": false,
26952             "field": "value",
26953             "description": ""
26954           }
26955         ]
26956       }
26957     },
26958     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26959     "version": "0.0.0",
26960     "filename": "server/api/trigger/index.js",
26961     "groupTitle": "Triggers"
26962   },
26963   {
26964     "type": "get",
26965     "url": "/api/triggers/{id}/actions",
26966     "title": "Gets Trigger Actions",
26967     "examples": [
26968       {
26969         "title": "Example usage:",
26970         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26971         "type": "json"
26972       }
26973     ],
26974     "name": "getActions",
26975     "group": "Triggers",
26976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26977     "version": "0.0.0",
26978     "filename": "server/api/trigger/index.js",
26979     "groupTitle": "Triggers"
26980   },
26981   {
26982     "type": "get",
26983     "url": "/api/triggers/{id}/all_conditions",
26984     "title": "Gets \"AND\" Trigger Conditions",
26985     "examples": [
26986       {
26987         "title": "Example usage:",
26988         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26989         "type": "json"
26990       }
26991     ],
26992     "name": "getAllConditions",
26993     "group": "Triggers",
26994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26995     "version": "0.0.0",
26996     "filename": "server/api/trigger/index.js",
26997     "groupTitle": "Triggers"
26998   },
26999   {
27000     "type": "get",
27001     "url": "/api/triggers/{id}/any_conditions",
27002     "title": "Gets \"OR\" Trigger Conditions",
27003     "examples": [
27004       {
27005         "title": "Example usage:",
27006         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27007         "type": "json"
27008       }
27009     ],
27010     "name": "getAnyConditions",
27011     "group": "Triggers",
27012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27013     "version": "0.0.0",
27014     "filename": "server/api/trigger/index.js",
27015     "groupTitle": "Triggers"
27016   },
27017   {
27018     "type": "put",
27019     "url": "/api/triggers/{id}",
27020     "title": "Update an existing Trigger",
27021     "examples": [
27022       {
27023         "title": "Example usage:",
27024         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27025         "type": "json"
27026       }
27027     ],
27028     "name": "updateTriggers",
27029     "group": "Triggers",
27030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27031     "version": "0.0.0",
27032     "filename": "server/api/trigger/index.js",
27033     "groupTitle": "Triggers"
27034   },
27035   {
27036     "type": "post",
27037     "url": "/api/trunks/clone",
27038     "title": "Clone an existing Trunk",
27039     "examples": [
27040       {
27041         "title": "Example usage:",
27042         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27043         "type": "json"
27044       }
27045     ],
27046     "name": "CloneTrunks",
27047     "group": "Trunks",
27048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27049     "version": "0.0.0",
27050     "filename": "server/api/trunk/index.js",
27051     "groupTitle": "Trunks"
27052   },
27053   {
27054     "type": "post",
27055     "url": "/api/trunks",
27056     "title": "Create a new trunk",
27057     "examples": [
27058       {
27059         "title": "Example usage:",
27060         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27061         "type": "json"
27062       }
27063     ],
27064     "name": "Create",
27065     "group": "Trunks",
27066     "parameter": {
27067       "fields": {
27068         "Body": [
27069           {
27070             "group": "Body",
27071             "type": "String",
27072             "optional": false,
27073             "field": "name",
27074             "description": ""
27075           },
27076           {
27077             "group": "Body",
27078             "type": "String",
27079             "allowedValues": [
27080               "\"friend\"",
27081               "\"user\"",
27082               "\"peer\""
27083             ],
27084             "optional": false,
27085             "field": "type",
27086             "description": ""
27087           },
27088           {
27089             "group": "Body",
27090             "type": "String",
27091             "optional": false,
27092             "field": "context",
27093             "description": ""
27094           },
27095           {
27096             "group": "Body",
27097             "type": "String",
27098             "allowedValues": [
27099               "\"ALLOWED_NOT_SCREENED\"",
27100               "\"ALLOWED_PASSED_SCREEN\"",
27101               "\"ALLOWED_FAILED_SCREEN\"",
27102               "\"ALLOWED\"",
27103               "\"PROHIB_NOT_SCREENED\"",
27104               "\"PROHIB_PASSED_SCREEN\"",
27105               "\"PROHIB_FAILED_SCREEN\"",
27106               "\"PROHIB\""
27107             ],
27108             "optional": true,
27109             "field": "callingpres",
27110             "description": ""
27111           },
27112           {
27113             "group": "Body",
27114             "type": "String",
27115             "optional": true,
27116             "field": "deny",
27117             "description": ""
27118           },
27119           {
27120             "group": "Body",
27121             "type": "String",
27122             "optional": true,
27123             "field": "permit",
27124             "description": ""
27125           },
27126           {
27127             "group": "Body",
27128             "type": "String",
27129             "optional": true,
27130             "field": "secret",
27131             "description": ""
27132           },
27133           {
27134             "group": "Body",
27135             "type": "String",
27136             "optional": true,
27137             "field": "md5secret",
27138             "description": ""
27139           },
27140           {
27141             "group": "Body",
27142             "type": "String",
27143             "optional": true,
27144             "field": "remotesecret",
27145             "description": ""
27146           },
27147           {
27148             "group": "Body",
27149             "type": "String",
27150             "optional": true,
27151             "field": "transport",
27152             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27153           },
27154           {
27155             "group": "Body",
27156             "type": "String",
27157             "allowedValues": [
27158               "\"rfc2833\"",
27159               "\"info\"",
27160               "\"shortinfo\"",
27161               "\"inband\"",
27162               "\"auto\""
27163             ],
27164             "optional": true,
27165             "field": "dtmfmode",
27166             "description": ""
27167           },
27168           {
27169             "group": "Body",
27170             "type": "String",
27171             "allowedValues": [
27172               "\"yes\"",
27173               "\"no\"",
27174               "\"nonat\"",
27175               "\"update\"",
27176               "\"outgoing\""
27177             ],
27178             "optional": true,
27179             "field": "directmedia",
27180             "description": ""
27181           },
27182           {
27183             "group": "Body",
27184             "type": "String",
27185             "allowedValues": [
27186               "\"yes\"",
27187               "\"no\""
27188             ],
27189             "optional": true,
27190             "field": "directrtpsetup",
27191             "description": ""
27192           },
27193           {
27194             "group": "Body",
27195             "type": "String",
27196             "optional": true,
27197             "field": "directmediapermit",
27198             "description": ""
27199           },
27200           {
27201             "group": "Body",
27202             "type": "String",
27203             "optional": true,
27204             "field": "directmediadeny",
27205             "description": ""
27206           },
27207           {
27208             "group": "Body",
27209             "type": "String",
27210             "optional": true,
27211             "field": "nat",
27212             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27213           },
27214           {
27215             "group": "Body",
27216             "type": "String",
27217             "optional": true,
27218             "field": "callgroup",
27219             "description": ""
27220           },
27221           {
27222             "group": "Body",
27223             "type": "String",
27224             "optional": true,
27225             "field": "namedcallgroup",
27226             "description": ""
27227           },
27228           {
27229             "group": "Body",
27230             "type": "String",
27231             "optional": true,
27232             "field": "pickupgroup",
27233             "description": ""
27234           },
27235           {
27236             "group": "Body",
27237             "type": "String",
27238             "optional": true,
27239             "field": "namedpickupgroup",
27240             "description": ""
27241           },
27242           {
27243             "group": "Body",
27244             "type": "String",
27245             "optional": true,
27246             "field": "language",
27247             "description": ""
27248           },
27249           {
27250             "group": "Body",
27251             "type": "String",
27252             "optional": true,
27253             "field": "tonezone",
27254             "description": ""
27255           },
27256           {
27257             "group": "Body",
27258             "type": "String",
27259             "optional": true,
27260             "field": "disallow",
27261             "description": ""
27262           },
27263           {
27264             "group": "Body",
27265             "type": "String",
27266             "optional": false,
27267             "field": "allow",
27268             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27269           },
27270           {
27271             "group": "Body",
27272             "type": "String",
27273             "allowedValues": [
27274               "\"yes\"",
27275               "\"no\""
27276             ],
27277             "optional": true,
27278             "field": "autoframing",
27279             "description": ""
27280           },
27281           {
27282             "group": "Body",
27283             "type": "String",
27284             "optional": true,
27285             "field": "insecure",
27286             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27287           },
27288           {
27289             "group": "Body",
27290             "type": "String",
27291             "allowedValues": [
27292               "\"yes\"",
27293               "\"no\""
27294             ],
27295             "optional": true,
27296             "field": "trustrpid",
27297             "description": ""
27298           },
27299           {
27300             "group": "Body",
27301             "type": "String",
27302             "allowedValues": [
27303               "\"yes\"",
27304               "\"no\""
27305             ],
27306             "optional": true,
27307             "field": "trust_id_outbound",
27308             "description": ""
27309           },
27310           {
27311             "group": "Body",
27312             "type": "String",
27313             "allowedValues": [
27314               "\"yes\"",
27315               "\"no\"",
27316               "\"never\""
27317             ],
27318             "optional": true,
27319             "field": "progressinband",
27320             "description": ""
27321           },
27322           {
27323             "group": "Body",
27324             "type": "String",
27325             "allowedValues": [
27326               "\"yes\"",
27327               "\"no\""
27328             ],
27329             "optional": true,
27330             "field": "promiscredir",
27331             "description": ""
27332           },
27333           {
27334             "group": "Body",
27335             "type": "String",
27336             "allowedValues": [
27337               "\"yes\"",
27338               "\"no\""
27339             ],
27340             "optional": true,
27341             "field": "useclientcode",
27342             "description": ""
27343           },
27344           {
27345             "group": "Body",
27346             "type": "Integer",
27347             "optional": true,
27348             "field": "accountcode",
27349             "description": ""
27350           },
27351           {
27352             "group": "Body",
27353             "type": "String",
27354             "optional": true,
27355             "field": "setvar",
27356             "description": ""
27357           },
27358           {
27359             "group": "Body",
27360             "type": "String",
27361             "optional": true,
27362             "field": "callerid",
27363             "description": ""
27364           },
27365           {
27366             "group": "Body",
27367             "type": "String",
27368             "optional": true,
27369             "field": "amaflags",
27370             "description": ""
27371           },
27372           {
27373             "group": "Body",
27374             "type": "String",
27375             "allowedValues": [
27376               "\"yes\"",
27377               "\"no\""
27378             ],
27379             "optional": true,
27380             "field": "callcounter",
27381             "description": ""
27382           },
27383           {
27384             "group": "Body",
27385             "type": "Integer",
27386             "optional": true,
27387             "field": "busylevel",
27388             "description": ""
27389           },
27390           {
27391             "group": "Body",
27392             "type": "String",
27393             "allowedValues": [
27394               "\"yes\"",
27395               "\"no\""
27396             ],
27397             "optional": true,
27398             "field": "allowoverlap",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "String",
27404             "allowedValues": [
27405               "\"yes\"",
27406               "\"no\""
27407             ],
27408             "optional": true,
27409             "field": "allowsubscribe",
27410             "description": ""
27411           },
27412           {
27413             "group": "Body",
27414             "type": "String",
27415             "allowedValues": [
27416               "\"yes\"",
27417               "\"no\""
27418             ],
27419             "optional": true,
27420             "field": "allowtransfer",
27421             "description": ""
27422           },
27423           {
27424             "group": "Body",
27425             "type": "String",
27426             "allowedValues": [
27427               "\"yes\"",
27428               "\"no\""
27429             ],
27430             "optional": true,
27431             "field": "ignoresdpversion",
27432             "description": ""
27433           },
27434           {
27435             "group": "Body",
27436             "type": "String",
27437             "optional": true,
27438             "field": "subscribecontext",
27439             "description": ""
27440           },
27441           {
27442             "group": "Body",
27443             "type": "String",
27444             "optional": true,
27445             "field": "template",
27446             "description": ""
27447           },
27448           {
27449             "group": "Body",
27450             "type": "String",
27451             "allowedValues": [
27452               "\"yes\"",
27453               "\"no\"",
27454               "\"always\""
27455             ],
27456             "optional": true,
27457             "field": "videosupport",
27458             "description": ""
27459           },
27460           {
27461             "group": "Body",
27462             "type": "Integer",
27463             "optional": true,
27464             "field": "maxcallbitrate",
27465             "description": ""
27466           },
27467           {
27468             "group": "Body",
27469             "type": "String",
27470             "allowedValues": [
27471               "\"yes\"",
27472               "\"no\""
27473             ],
27474             "optional": true,
27475             "field": "rfc2833compensate",
27476             "description": ""
27477           },
27478           {
27479             "group": "Body",
27480             "type": "String",
27481             "optional": true,
27482             "field": "mailbox",
27483             "description": ""
27484           },
27485           {
27486             "group": "Body",
27487             "type": "String",
27488             "allowedValues": [
27489               "\"accept\"",
27490               "\"refuse\"",
27491               "\"originate\""
27492             ],
27493             "optional": true,
27494             "field": "session_timers",
27495             "description": ""
27496           },
27497           {
27498             "group": "Body",
27499             "type": "Integer",
27500             "optional": true,
27501             "field": "session_expires",
27502             "description": ""
27503           },
27504           {
27505             "group": "Body",
27506             "type": "Integer",
27507             "optional": true,
27508             "field": "session_minse",
27509             "description": ""
27510           },
27511           {
27512             "group": "Body",
27513             "type": "String",
27514             "allowedValues": [
27515               "\"uac\"",
27516               "\"uas\""
27517             ],
27518             "optional": true,
27519             "field": "session_refresher",
27520             "description": ""
27521           },
27522           {
27523             "group": "Body",
27524             "type": "String",
27525             "optional": true,
27526             "field": "t38pt_usertpsource",
27527             "description": ""
27528           },
27529           {
27530             "group": "Body",
27531             "type": "String",
27532             "optional": true,
27533             "field": "regexten",
27534             "description": ""
27535           },
27536           {
27537             "group": "Body",
27538             "type": "String",
27539             "optional": true,
27540             "field": "fromdomain",
27541             "description": ""
27542           },
27543           {
27544             "group": "Body",
27545             "type": "String",
27546             "optional": true,
27547             "field": "fromuser",
27548             "description": ""
27549           },
27550           {
27551             "group": "Body",
27552             "type": "Integer",
27553             "optional": true,
27554             "field": "port",
27555             "description": ""
27556           },
27557           {
27558             "group": "Body",
27559             "type": "String",
27560             "allowedValues": [
27561               "\"yes\"",
27562               "\"no\""
27563             ],
27564             "optional": true,
27565             "field": "qualify",
27566             "description": ""
27567           },
27568           {
27569             "group": "Body",
27570             "type": "Integer",
27571             "optional": true,
27572             "field": "keepalive",
27573             "description": ""
27574           },
27575           {
27576             "group": "Body",
27577             "type": "String",
27578             "optional": true,
27579             "field": "defaultip",
27580             "description": ""
27581           },
27582           {
27583             "group": "Body",
27584             "type": "String",
27585             "optional": true,
27586             "field": "defaultuser",
27587             "description": ""
27588           },
27589           {
27590             "group": "Body",
27591             "type": "Integer",
27592             "optional": true,
27593             "field": "rtptimeout",
27594             "description": ""
27595           },
27596           {
27597             "group": "Body",
27598             "type": "Integer",
27599             "optional": true,
27600             "field": "rtpholdtimeout",
27601             "description": ""
27602           },
27603           {
27604             "group": "Body",
27605             "type": "Integer",
27606             "optional": true,
27607             "field": "rtpkeepalive",
27608             "description": ""
27609           },
27610           {
27611             "group": "Body",
27612             "type": "String",
27613             "allowedValues": [
27614               "\"yes\"",
27615               "\"no\"",
27616               "\"pai\""
27617             ],
27618             "optional": true,
27619             "field": "sendrpid",
27620             "description": ""
27621           },
27622           {
27623             "group": "Body",
27624             "type": "String",
27625             "optional": true,
27626             "field": "outboundproxy",
27627             "description": ""
27628           },
27629           {
27630             "group": "Body",
27631             "type": "String",
27632             "optional": true,
27633             "field": "callbackextension",
27634             "description": ""
27635           },
27636           {
27637             "group": "Body",
27638             "type": "Integer",
27639             "optional": true,
27640             "field": "timert1",
27641             "description": ""
27642           },
27643           {
27644             "group": "Body",
27645             "type": "Integer",
27646             "optional": true,
27647             "field": "timerb",
27648             "description": ""
27649           },
27650           {
27651             "group": "Body",
27652             "type": "Integer",
27653             "optional": true,
27654             "field": "qualifyfreq",
27655             "description": ""
27656           },
27657           {
27658             "group": "Body",
27659             "type": "String",
27660             "optional": true,
27661             "field": "contactpermit",
27662             "description": ""
27663           },
27664           {
27665             "group": "Body",
27666             "type": "String",
27667             "optional": true,
27668             "field": "contactdeny",
27669             "description": ""
27670           },
27671           {
27672             "group": "Body",
27673             "type": "String",
27674             "optional": true,
27675             "field": "contactacl",
27676             "description": ""
27677           },
27678           {
27679             "group": "Body",
27680             "type": "String",
27681             "optional": true,
27682             "field": "unsolicited_mailbox",
27683             "description": ""
27684           },
27685           {
27686             "group": "Body",
27687             "type": "String",
27688             "optional": true,
27689             "field": "use_q850_reason",
27690             "description": ""
27691           },
27692           {
27693             "group": "Body",
27694             "type": "Integer",
27695             "optional": true,
27696             "field": "maxforwards",
27697             "description": ""
27698           },
27699           {
27700             "group": "Body",
27701             "type": "String",
27702             "allowedValues": [
27703               "\"yes\"",
27704               "\"no\""
27705             ],
27706             "optional": true,
27707             "field": "encryption",
27708             "description": ""
27709           },
27710           {
27711             "group": "Body",
27712             "type": "String",
27713             "allowedValues": [
27714               "\"yes\"",
27715               "\"no\""
27716             ],
27717             "optional": true,
27718             "field": "avpf",
27719             "description": ""
27720           },
27721           {
27722             "group": "Body",
27723             "type": "String",
27724             "allowedValues": [
27725               "\"yes\"",
27726               "\"no\""
27727             ],
27728             "optional": true,
27729             "field": "force_avp",
27730             "description": ""
27731           },
27732           {
27733             "group": "Body",
27734             "type": "String",
27735             "allowedValues": [
27736               "\"yes\"",
27737               "\"no\""
27738             ],
27739             "optional": true,
27740             "field": "icesupport",
27741             "description": ""
27742           },
27743           {
27744             "group": "Body",
27745             "type": "String",
27746             "allowedValues": [
27747               "\"yes\"",
27748               "\"no\""
27749             ],
27750             "optional": true,
27751             "field": "dtlsenable",
27752             "description": ""
27753           },
27754           {
27755             "group": "Body",
27756             "type": "String",
27757             "allowedValues": [
27758               "\"yes\"",
27759               "\"no\"",
27760               "\"fingerprint\"",
27761               "\"certificate\""
27762             ],
27763             "optional": true,
27764             "field": "dtlsverify",
27765             "description": ""
27766           },
27767           {
27768             "group": "Body",
27769             "type": "Integer",
27770             "optional": true,
27771             "field": "dtlsrekey",
27772             "description": ""
27773           },
27774           {
27775             "group": "Body",
27776             "type": "String",
27777             "optional": true,
27778             "field": "dtlscertfile",
27779             "description": ""
27780           },
27781           {
27782             "group": "Body",
27783             "type": "String",
27784             "optional": true,
27785             "field": "dtlsprivatekey",
27786             "description": ""
27787           },
27788           {
27789             "group": "Body",
27790             "type": "String",
27791             "optional": true,
27792             "field": "dtlscipher",
27793             "description": ""
27794           },
27795           {
27796             "group": "Body",
27797             "type": "String",
27798             "optional": true,
27799             "field": "dtlscafile",
27800             "description": ""
27801           },
27802           {
27803             "group": "Body",
27804             "type": "String",
27805             "optional": true,
27806             "field": "dtlscapath",
27807             "description": ""
27808           },
27809           {
27810             "group": "Body",
27811             "type": "String",
27812             "allowedValues": [
27813               "\"active\"",
27814               "\"passive\"",
27815               "\"actpass\""
27816             ],
27817             "optional": true,
27818             "field": "dtlssetup",
27819             "description": ""
27820           },
27821           {
27822             "group": "Body",
27823             "type": "String",
27824             "optional": true,
27825             "field": "dtlsfingerprint",
27826             "description": ""
27827           },
27828           {
27829             "group": "Body",
27830             "type": "String",
27831             "allowedValues": [
27832               "\"yes\"",
27833               "\"no\""
27834             ],
27835             "optional": true,
27836             "field": "usereqphone",
27837             "description": ""
27838           },
27839           {
27840             "group": "Body",
27841             "type": "String",
27842             "optional": true,
27843             "field": "recordonfeature",
27844             "description": ""
27845           },
27846           {
27847             "group": "Body",
27848             "type": "String",
27849             "optional": true,
27850             "field": "recordofffeature",
27851             "description": ""
27852           },
27853           {
27854             "group": "Body",
27855             "type": "Integer",
27856             "optional": true,
27857             "field": "call_limit",
27858             "description": ""
27859           },
27860           {
27861             "group": "Body",
27862             "type": "String",
27863             "allowedValues": [
27864               "\"yes\"",
27865               "\"no\""
27866             ],
27867             "optional": true,
27868             "field": "registertrying",
27869             "description": ""
27870           },
27871           {
27872             "group": "Body",
27873             "type": "String",
27874             "allowedValues": [
27875               "\"yes\"",
27876               "\"no\""
27877             ],
27878             "optional": true,
27879             "field": "subscribemwi",
27880             "description": ""
27881           },
27882           {
27883             "group": "Body",
27884             "type": "String",
27885             "optional": true,
27886             "field": "vmexten",
27887             "description": ""
27888           },
27889           {
27890             "group": "Body",
27891             "type": "String",
27892             "optional": true,
27893             "field": "mohinterpret",
27894             "description": ""
27895           },
27896           {
27897             "group": "Body",
27898             "type": "String",
27899             "optional": true,
27900             "field": "mohsuggest",
27901             "description": ""
27902           },
27903           {
27904             "group": "Body",
27905             "type": "String",
27906             "optional": true,
27907             "field": "parkinglot",
27908             "description": ""
27909           },
27910           {
27911             "group": "Body",
27912             "type": "String",
27913             "optional": true,
27914             "field": "description",
27915             "description": ""
27916           },
27917           {
27918             "group": "Body",
27919             "type": "String",
27920             "optional": true,
27921             "field": "host",
27922             "description": ""
27923           },
27924           {
27925             "group": "Body",
27926             "type": "String",
27927             "allowedValues": [
27928               "\"yes\"",
27929               "\"no\"",
27930               "\"nonat\"",
27931               "\"update\"",
27932               "\"update,nonat\""
27933             ],
27934             "optional": true,
27935             "field": "canreinvite",
27936             "description": ""
27937           },
27938           {
27939             "group": "Body",
27940             "type": "String",
27941             "optional": true,
27942             "field": "registry",
27943             "description": ""
27944           },
27945           {
27946             "group": "Body",
27947             "type": "String",
27948             "optional": true,
27949             "field": "otherFields",
27950             "description": ""
27951           },
27952           {
27953             "group": "Body",
27954             "type": "Boolean",
27955             "optional": false,
27956             "field": "active",
27957             "description": ""
27958           },
27959           {
27960             "group": "Body",
27961             "type": "String",
27962             "optional": true,
27963             "field": "t38pt_udptl",
27964             "description": ""
27965           }
27966         ]
27967       }
27968     },
27969     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27970     "version": "0.0.0",
27971     "filename": "server/api/trunk/index.js",
27972     "groupTitle": "Trunks"
27973   },
27974   {
27975     "type": "delete",
27976     "url": "/api/trunks/{id}",
27977     "title": "Deletes a trunk",
27978     "examples": [
27979       {
27980         "title": "Example usage:",
27981         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27982         "type": "json"
27983       }
27984     ],
27985     "name": "Delete",
27986     "group": "Trunks",
27987     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27988     "version": "0.0.0",
27989     "filename": "server/api/trunk/index.js",
27990     "groupTitle": "Trunks"
27991   },
27992   {
27993     "type": "get",
27994     "url": "/api/trunks",
27995     "title": "Gets a list of Trunks",
27996     "examples": [
27997       {
27998         "title": "Example usage:",
27999         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28000         "type": "json"
28001       }
28002     ],
28003     "name": "GetTrunks",
28004     "group": "Trunks",
28005     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/trunks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/trunks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/trunks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/trunks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/trunks?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28006     "version": "0.0.0",
28007     "filename": "server/api/trunk/index.js",
28008     "groupTitle": "Trunks"
28009   },
28010   {
28011     "type": "get",
28012     "url": "/api/trunks/{id}",
28013     "title": "Gets a single Trunk",
28014     "examples": [
28015       {
28016         "title": "Example usage:",
28017         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28018         "type": "json"
28019       }
28020     ],
28021     "name": "ShowTrunks",
28022     "group": "Trunks",
28023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28024     "version": "0.0.0",
28025     "filename": "server/api/trunk/index.js",
28026     "groupTitle": "Trunks"
28027   },
28028   {
28029     "type": "put",
28030     "url": "/api/trunks/{id}",
28031     "title": "Update an existing trunk",
28032     "examples": [
28033       {
28034         "title": "Example usage:",
28035         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28036         "type": "json"
28037       }
28038     ],
28039     "name": "Update",
28040     "group": "Trunks",
28041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28042     "version": "0.0.0",
28043     "filename": "server/api/trunk/index.js",
28044     "groupTitle": "Trunks"
28045   },
28046   {
28047     "type": "post",
28048     "url": "/api/userNotifications",
28049     "title": "Send notification to user",
28050     "examples": [
28051       {
28052         "title": "Example usage:",
28053         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28054         "type": "json"
28055       }
28056     ],
28057     "name": "Send",
28058     "group": "UserNotifications",
28059     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28060     "version": "0.0.0",
28061     "filename": "server/api/userNotification/index.js",
28062     "groupTitle": "UserNotifications"
28063   },
28064   {
28065     "type": "post",
28066     "url": "/api/userProfile/resources",
28067     "title": "Creates a new User Profile Resource",
28068     "examples": [
28069       {
28070         "title": "Example usage:",
28071         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28072         "type": "json"
28073       }
28074     ],
28075     "name": "CreateUser_Profile_Resources",
28076     "group": "User_Profile_Resources",
28077     "parameter": {
28078       "fields": {
28079         "Body": [
28080           {
28081             "group": "Body",
28082             "type": "String",
28083             "optional": false,
28084             "field": "name",
28085             "description": ""
28086           },
28087           {
28088             "group": "Body",
28089             "type": "Integer",
28090             "optional": false,
28091             "field": "resourceId",
28092             "description": ""
28093           },
28094           {
28095             "group": "Body",
28096             "type": "String",
28097             "optional": false,
28098             "field": "type",
28099             "description": ""
28100           }
28101         ]
28102       }
28103     },
28104     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28105     "version": "0.0.0",
28106     "filename": "server/api/userProfileResource/index.js",
28107     "groupTitle": "User_Profile_Resources"
28108   },
28109   {
28110     "type": "delete",
28111     "url": "/api/userProfile/resources/{id}",
28112     "title": "Deletes a User Profile Resource",
28113     "examples": [
28114       {
28115         "title": "Example usage:",
28116         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28117         "type": "json"
28118       }
28119     ],
28120     "name": "DeleteUser_Profile_Resources",
28121     "group": "User_Profile_Resources",
28122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28123     "version": "0.0.0",
28124     "filename": "server/api/userProfileResource/index.js",
28125     "groupTitle": "User_Profile_Resources"
28126   },
28127   {
28128     "type": "get",
28129     "url": "/api/userProfile/resources/describe",
28130     "title": "Gets table info about User Profile Resources",
28131     "examples": [
28132       {
28133         "title": "Example usage:",
28134         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28135         "type": "json"
28136       }
28137     ],
28138     "name": "DescribeUser_Profile_Resources",
28139     "group": "User_Profile_Resources",
28140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28141     "version": "0.0.0",
28142     "filename": "server/api/userProfileResource/index.js",
28143     "groupTitle": "User_Profile_Resources"
28144   },
28145   {
28146     "type": "get",
28147     "url": "/api/userProfile/resources",
28148     "title": "Gets a list of User Profile Resources",
28149     "examples": [
28150       {
28151         "title": "Example usage:",
28152         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28153         "type": "json"
28154       }
28155     ],
28156     "name": "GetUser_Profile_Resources",
28157     "group": "User_Profile_Resources",
28158     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/resources?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/resources?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/resources?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/resources?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/resources?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28159     "version": "0.0.0",
28160     "filename": "server/api/userProfileResource/index.js",
28161     "groupTitle": "User_Profile_Resources"
28162   },
28163   {
28164     "type": "get",
28165     "url": "/api/userProfile/resources/{id}",
28166     "title": "Gets a single User Profile Resource",
28167     "examples": [
28168       {
28169         "title": "Example usage:",
28170         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28171         "type": "json"
28172       }
28173     ],
28174     "name": "ShowUser_Profile_Resources",
28175     "group": "User_Profile_Resources",
28176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28177     "version": "0.0.0",
28178     "filename": "server/api/userProfileResource/index.js",
28179     "groupTitle": "User_Profile_Resources"
28180   },
28181   {
28182     "type": "put",
28183     "url": "/api/userProfile/resources/{id}",
28184     "title": "Update an existing User Profile Resource",
28185     "examples": [
28186       {
28187         "title": "Example usage:",
28188         "content": "curl https://{domain}/api/userProfile/resources/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28189         "type": "json"
28190       }
28191     ],
28192     "name": "updateUser_Profile_Resources",
28193     "group": "User_Profile_Resources",
28194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28195     "version": "0.0.0",
28196     "filename": "server/api/userProfileResource/index.js",
28197     "groupTitle": "User_Profile_Resources"
28198   },
28199   {
28200     "type": "post",
28201     "url": "/api/userProfile/sections",
28202     "title": "Creates a new User Profile Section",
28203     "examples": [
28204       {
28205         "title": "Example usage:",
28206         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28207         "type": "json"
28208       }
28209     ],
28210     "name": "CreateUser_Profile_Sections",
28211     "group": "User_Profile_Sections",
28212     "parameter": {
28213       "fields": {
28214         "Body": [
28215           {
28216             "group": "Body",
28217             "type": "String",
28218             "optional": false,
28219             "field": "name",
28220             "description": ""
28221           },
28222           {
28223             "group": "Body",
28224             "type": "String",
28225             "optional": false,
28226             "field": "category",
28227             "description": ""
28228           },
28229           {
28230             "group": "Body",
28231             "type": "Integer",
28232             "optional": false,
28233             "field": "sectionId",
28234             "description": ""
28235           },
28236           {
28237             "group": "Body",
28238             "type": "Boolean",
28239             "optional": true,
28240             "field": "enabled",
28241             "description": ""
28242           },
28243           {
28244             "group": "Body",
28245             "type": "Boolean",
28246             "optional": true,
28247             "field": "autoAssociation",
28248             "description": ""
28249           },
28250           {
28251             "group": "Body",
28252             "type": "String",
28253             "optional": true,
28254             "field": "crudPermissions",
28255             "description": ""
28256           }
28257         ]
28258       }
28259     },
28260     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28261     "version": "0.0.0",
28262     "filename": "server/api/userProfileSection/index.js",
28263     "groupTitle": "User_Profile_Sections"
28264   },
28265   {
28266     "type": "delete",
28267     "url": "/api/userProfile/sections/{id}",
28268     "title": "Deletes a User Profile Section",
28269     "examples": [
28270       {
28271         "title": "Example usage:",
28272         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28273         "type": "json"
28274       }
28275     ],
28276     "name": "DeleteUser_Profile_Sections",
28277     "group": "User_Profile_Sections",
28278     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28279     "version": "0.0.0",
28280     "filename": "server/api/userProfileSection/index.js",
28281     "groupTitle": "User_Profile_Sections"
28282   },
28283   {
28284     "type": "get",
28285     "url": "/api/userProfile/sections/describe",
28286     "title": "Gets table info about User Profile Sections",
28287     "examples": [
28288       {
28289         "title": "Example usage:",
28290         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28291         "type": "json"
28292       }
28293     ],
28294     "name": "DescribeUser_Profile_Sections",
28295     "group": "User_Profile_Sections",
28296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28297     "version": "0.0.0",
28298     "filename": "server/api/userProfileSection/index.js",
28299     "groupTitle": "User_Profile_Sections"
28300   },
28301   {
28302     "type": "get",
28303     "url": "/api/userProfile/sections",
28304     "title": "Gets a list of User Profile Sections",
28305     "examples": [
28306       {
28307         "title": "Example usage:",
28308         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28309         "type": "json"
28310       }
28311     ],
28312     "name": "GetUser_Profile_Sections",
28313     "group": "User_Profile_Sections",
28314     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/sections?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/sections?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/sections?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/sections?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/sections?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28315     "version": "0.0.0",
28316     "filename": "server/api/userProfileSection/index.js",
28317     "groupTitle": "User_Profile_Sections"
28318   },
28319   {
28320     "type": "get",
28321     "url": "/api/userProfile/sections/{id}",
28322     "title": "Gets a single User Profile Section",
28323     "examples": [
28324       {
28325         "title": "Example usage:",
28326         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28327         "type": "json"
28328       }
28329     ],
28330     "name": "ShowUser_Profile_Sections",
28331     "group": "User_Profile_Sections",
28332     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28333     "version": "0.0.0",
28334     "filename": "server/api/userProfileSection/index.js",
28335     "groupTitle": "User_Profile_Sections"
28336   },
28337   {
28338     "type": "put",
28339     "url": "/api/userProfile/sections/{id}",
28340     "title": "Update an existing User Profile Section",
28341     "examples": [
28342       {
28343         "title": "Example usage:",
28344         "content": "curl https://{domain}/api/userProfile/sections/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28345         "type": "json"
28346       }
28347     ],
28348     "name": "updateUser_Profile_Sections",
28349     "group": "User_Profile_Sections",
28350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28351     "version": "0.0.0",
28352     "filename": "server/api/userProfileSection/index.js",
28353     "groupTitle": "User_Profile_Sections"
28354   },
28355   {
28356     "type": "post",
28357     "url": "/api/userProfiles/{id}/resources",
28358     "title": "Add resources' permissions to User Profile",
28359     "examples": [
28360       {
28361         "title": "Example usage:",
28362         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28363         "type": "json"
28364       }
28365     ],
28366     "name": "AddResources",
28367     "group": "User_Profiles",
28368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28369     "version": "0.0.0",
28370     "filename": "server/api/userProfile/index.js",
28371     "groupTitle": "User_Profiles"
28372   },
28373   {
28374     "type": "post",
28375     "url": "/api/userProfiles/{id}/sections",
28376     "title": "Add sections' permissions to User Profile",
28377     "examples": [
28378       {
28379         "title": "Example usage:",
28380         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28381         "type": "json"
28382       }
28383     ],
28384     "name": "AddSections",
28385     "group": "User_Profiles",
28386     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28387     "version": "0.0.0",
28388     "filename": "server/api/userProfile/index.js",
28389     "groupTitle": "User_Profiles"
28390   },
28391   {
28392     "type": "post",
28393     "url": "/api/userProfiles/clone",
28394     "title": "Clone an existing User Profile",
28395     "examples": [
28396       {
28397         "title": "Example usage:",
28398         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28399         "type": "json"
28400       }
28401     ],
28402     "name": "CloneUser_Profiles",
28403     "group": "User_Profiles",
28404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28405     "version": "0.0.0",
28406     "filename": "server/api/userProfile/index.js",
28407     "groupTitle": "User_Profiles"
28408   },
28409   {
28410     "type": "post",
28411     "url": "/api/userProfiles",
28412     "title": "Creates a new User Profile",
28413     "examples": [
28414       {
28415         "title": "Example usage:",
28416         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28417         "type": "json"
28418       }
28419     ],
28420     "name": "CreateUser_Profiles",
28421     "group": "User_Profiles",
28422     "parameter": {
28423       "fields": {
28424         "Body": [
28425           {
28426             "group": "Body",
28427             "type": "String",
28428             "optional": false,
28429             "field": "name",
28430             "description": ""
28431           },
28432           {
28433             "group": "Body",
28434             "type": "String",
28435             "optional": false,
28436             "field": "crudPermissions",
28437             "description": ""
28438           },
28439           {
28440             "group": "Body",
28441             "type": "String",
28442             "optional": true,
28443             "field": "description",
28444             "description": ""
28445           },
28446           {
28447             "group": "Body",
28448             "type": "Boolean",
28449             "optional": true,
28450             "field": "privacyEnabled",
28451             "description": ""
28452           },
28453           {
28454             "group": "Body",
28455             "type": "Boolean",
28456             "optional": true,
28457             "field": "downloadAttachments",
28458             "description": ""
28459           },
28460           {
28461             "group": "Body",
28462             "type": "Boolean",
28463             "optional": true,
28464             "field": "downloadCallySquareRecordings",
28465             "description": ""
28466           },
28467           {
28468             "group": "Body",
28469             "type": "Boolean",
28470             "optional": true,
28471             "field": "downloadContactManagerLists",
28472             "description": ""
28473           },
28474           {
28475             "group": "Body",
28476             "type": "Boolean",
28477             "optional": true,
28478             "field": "downloadJscriptySessions",
28479             "description": ""
28480           },
28481           {
28482             "group": "Body",
28483             "type": "Boolean",
28484             "optional": true,
28485             "field": "downloadOmnichannelInteractions",
28486             "description": ""
28487           },
28488           {
28489             "group": "Body",
28490             "type": "Boolean",
28491             "optional": true,
28492             "field": "downloadScreenRecordings",
28493             "description": ""
28494           },
28495           {
28496             "group": "Body",
28497             "type": "Boolean",
28498             "optional": true,
28499             "field": "downloadVoiceRecordings",
28500             "description": ""
28501           }
28502         ]
28503       }
28504     },
28505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28506     "version": "0.0.0",
28507     "filename": "server/api/userProfile/index.js",
28508     "groupTitle": "User_Profiles"
28509   },
28510   {
28511     "type": "delete",
28512     "url": "/api/userProfiles/{id}",
28513     "title": "Deletes a User Profile",
28514     "examples": [
28515       {
28516         "title": "Example usage:",
28517         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28518         "type": "json"
28519       }
28520     ],
28521     "name": "DeleteUser_Profiles",
28522     "group": "User_Profiles",
28523     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28524     "version": "0.0.0",
28525     "filename": "server/api/userProfile/index.js",
28526     "groupTitle": "User_Profiles"
28527   },
28528   {
28529     "type": "get",
28530     "url": "/api/userProfiles/describe",
28531     "title": "Gets table info about User Profiles",
28532     "examples": [
28533       {
28534         "title": "Example usage:",
28535         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28536         "type": "json"
28537       }
28538     ],
28539     "name": "DescribeUser_Profiles",
28540     "group": "User_Profiles",
28541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28542     "version": "0.0.0",
28543     "filename": "server/api/userProfile/index.js",
28544     "groupTitle": "User_Profiles"
28545   },
28546   {
28547     "type": "get",
28548     "url": "/api/userProfiles/{id}/resources?section={section}",
28549     "title": "Get Resources assigned to a Section",
28550     "examples": [
28551       {
28552         "title": "Example usage:",
28553         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28554         "type": "json"
28555       }
28556     ],
28557     "name": "GetResources",
28558     "group": "User_Profiles",
28559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28560     "version": "0.0.0",
28561     "filename": "server/api/userProfile/index.js",
28562     "groupTitle": "User_Profiles"
28563   },
28564   {
28565     "type": "get",
28566     "url": "/api/userProfiles/{id}/sections",
28567     "title": "Get sections associated to a User Profile",
28568     "examples": [
28569       {
28570         "title": "Example usage:",
28571         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28572         "type": "json"
28573       }
28574     ],
28575     "name": "GetSections",
28576     "group": "User_Profiles",
28577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28578     "version": "0.0.0",
28579     "filename": "server/api/userProfile/index.js",
28580     "groupTitle": "User_Profiles"
28581   },
28582   {
28583     "type": "get",
28584     "url": "/api/userProfiles",
28585     "title": "Gets a list of User Profiles",
28586     "examples": [
28587       {
28588         "title": "Example usage:",
28589         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28590         "type": "json"
28591       }
28592     ],
28593     "name": "GetUser_Profiles",
28594     "group": "User_Profiles",
28595     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfiles?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfiles?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfiles?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfiles?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfiles?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28596     "version": "0.0.0",
28597     "filename": "server/api/userProfile/index.js",
28598     "groupTitle": "User_Profiles"
28599   },
28600   {
28601     "type": "delete",
28602     "url": "/api/userProfiles/{id}/resources",
28603     "title": "Removes resources' permissions from User Profile",
28604     "examples": [
28605       {
28606         "title": "Example usage:",
28607         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28608         "type": "json"
28609       }
28610     ],
28611     "name": "RemoveResources",
28612     "group": "User_Profiles",
28613     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28614     "version": "0.0.0",
28615     "filename": "server/api/userProfile/index.js",
28616     "groupTitle": "User_Profiles"
28617   },
28618   {
28619     "type": "delete",
28620     "url": "/api/userProfiles/{id}/sections",
28621     "title": "Removes sections' permissions from User Profile",
28622     "examples": [
28623       {
28624         "title": "Example usage:",
28625         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28626         "type": "json"
28627       }
28628     ],
28629     "name": "RemoveSections",
28630     "group": "User_Profiles",
28631     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28632     "version": "0.0.0",
28633     "filename": "server/api/userProfile/index.js",
28634     "groupTitle": "User_Profiles"
28635   },
28636   {
28637     "type": "get",
28638     "url": "/api/userProfiles/{id}",
28639     "title": "Gets a single User Profile",
28640     "examples": [
28641       {
28642         "title": "Example usage:",
28643         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28644         "type": "json"
28645       }
28646     ],
28647     "name": "ShowUser_Profiles",
28648     "group": "User_Profiles",
28649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28650     "version": "0.0.0",
28651     "filename": "server/api/userProfile/index.js",
28652     "groupTitle": "User_Profiles"
28653   },
28654   {
28655     "type": "put",
28656     "url": "/api/userProfiles/{id}",
28657     "title": "Update an existing User Profile",
28658     "examples": [
28659       {
28660         "title": "Example usage:",
28661         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28662         "type": "json"
28663       }
28664     ],
28665     "name": "updateUser_Profiles",
28666     "group": "User_Profiles",
28667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28668     "version": "0.0.0",
28669     "filename": "server/api/userProfile/index.js",
28670     "groupTitle": "User_Profiles"
28671   },
28672   {
28673     "type": "post",
28674     "url": "/api/users/{id}/chat_interactions",
28675     "title": "Add chat interaction tabs to an agent",
28676     "examples": [
28677       {
28678         "title": "Example usage:",
28679         "content": "curl https://{domain}/api/users/{id}/chat_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28680         "type": "json"
28681       }
28682     ],
28683     "name": "AddChatInteractions",
28684     "group": "Users",
28685     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28686     "version": "0.0.0",
28687     "filename": "server/api/user/index.js",
28688     "groupTitle": "Users"
28689   },
28690   {
28691     "type": "post",
28692     "url": "/api/users/{id}/chat_websites",
28693     "title": "Add a Chat Website to a user",
28694     "examples": [
28695       {
28696         "title": "Example usage:",
28697         "content": "curl https://{domain}/api/users/{id}/chat_websites -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28698         "type": "json"
28699       }
28700     ],
28701     "name": "AddChatWebsites",
28702     "group": "Users",
28703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28704     "version": "0.0.0",
28705     "filename": "server/api/user/index.js",
28706     "groupTitle": "Users"
28707   },
28708   {
28709     "type": "post",
28710     "url": "/api/users/{id}/contacts",
28711     "title": "Add contacts to a user",
28712     "examples": [
28713       {
28714         "title": "Example usage:",
28715         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28716         "type": "json"
28717       }
28718     ],
28719     "name": "AddContacts",
28720     "group": "Users",
28721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28722     "version": "0.0.0",
28723     "filename": "server/api/user/index.js",
28724     "groupTitle": "Users"
28725   },
28726   {
28727     "type": "post",
28728     "url": "/api/users/{id}/fax_accounts",
28729     "title": "Add a Fax Account to a user",
28730     "examples": [
28731       {
28732         "title": "Example usage:",
28733         "content": "curl https://{domain}/api/users/{id}/fax_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28734         "type": "json"
28735       }
28736     ],
28737     "name": "AddFaxAccounts",
28738     "group": "Users",
28739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28740     "version": "0.0.0",
28741     "filename": "server/api/user/index.js",
28742     "groupTitle": "Users"
28743   },
28744   {
28745     "type": "post",
28746     "url": "/api/users/{id}/fax_interactions",
28747     "title": "Add fax interaction tabs to an agent",
28748     "examples": [
28749       {
28750         "title": "Example usage:",
28751         "content": "curl https://{domain}/api/users/{id}/fax_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28752         "type": "json"
28753       }
28754     ],
28755     "name": "AddFaxInteractions",
28756     "group": "Users",
28757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28758     "version": "0.0.0",
28759     "filename": "server/api/user/index.js",
28760     "groupTitle": "Users"
28761   },
28762   {
28763     "type": "post",
28764     "url": "/api/users/{id}/mail_accounts",
28765     "title": "Add a Mail Account to a user",
28766     "examples": [
28767       {
28768         "title": "Example usage:",
28769         "content": "curl https://{domain}/api/users/{id}/mail_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28770         "type": "json"
28771       }
28772     ],
28773     "name": "AddMailAccounts",
28774     "group": "Users",
28775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28776     "version": "0.0.0",
28777     "filename": "server/api/user/index.js",
28778     "groupTitle": "Users"
28779   },
28780   {
28781     "type": "post",
28782     "url": "/api/users/{id}/mail_interactions",
28783     "title": "Add mail interaction tabs to an agent",
28784     "examples": [
28785       {
28786         "title": "Example usage:",
28787         "content": "curl https://{domain}/api/users/{id}/mail_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28788         "type": "json"
28789       }
28790     ],
28791     "name": "AddMailInteractions",
28792     "group": "Users",
28793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28794     "version": "0.0.0",
28795     "filename": "server/api/user/index.js",
28796     "groupTitle": "Users"
28797   },
28798   {
28799     "type": "post",
28800     "url": "/api/users/{id}/openchannel_accounts",
28801     "title": "Add a Open Channel Account to a user",
28802     "examples": [
28803       {
28804         "title": "Example usage:",
28805         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28806         "type": "json"
28807       }
28808     ],
28809     "name": "AddOpenchannelAccounts",
28810     "group": "Users",
28811     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28812     "version": "0.0.0",
28813     "filename": "server/api/user/index.js",
28814     "groupTitle": "Users"
28815   },
28816   {
28817     "type": "post",
28818     "url": "/api/users/{id}/openchannel_interactions",
28819     "title": "Add openchannel interaction tabs to an agent",
28820     "examples": [
28821       {
28822         "title": "Example usage:",
28823         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28824         "type": "json"
28825       }
28826     ],
28827     "name": "AddOpenchannelInteractions",
28828     "group": "Users",
28829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28830     "version": "0.0.0",
28831     "filename": "server/api/user/index.js",
28832     "groupTitle": "Users"
28833   },
28834   {
28835     "type": "post",
28836     "url": "/api/users/{id}/queues",
28837     "title": "Add queues to an agent",
28838     "examples": [
28839       {
28840         "title": "Example usage:",
28841         "content": "curl https://{domain}/api/users/{id}/queues -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28842         "type": "json"
28843       }
28844     ],
28845     "name": "AddQueues",
28846     "group": "Users",
28847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28848     "version": "0.0.0",
28849     "filename": "server/api/user/index.js",
28850     "groupTitle": "Users"
28851   },
28852   {
28853     "type": "post",
28854     "url": "/api/users/{id}/sms_accounts",
28855     "title": "Add a Sms Account to a user",
28856     "examples": [
28857       {
28858         "title": "Example usage:",
28859         "content": "curl https://{domain}/api/users/{id}/sms_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28860         "type": "json"
28861       }
28862     ],
28863     "name": "AddSmsAccounts",
28864     "group": "Users",
28865     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28866     "version": "0.0.0",
28867     "filename": "server/api/user/index.js",
28868     "groupTitle": "Users"
28869   },
28870   {
28871     "type": "post",
28872     "url": "/api/users/{id}/sms_interactions",
28873     "title": "Add sms interaction tabs to an agent",
28874     "examples": [
28875       {
28876         "title": "Example usage:",
28877         "content": "curl https://{domain}/api/users/{id}/sms_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28878         "type": "json"
28879       }
28880     ],
28881     "name": "AddSmsInteractions",
28882     "group": "Users",
28883     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28884     "version": "0.0.0",
28885     "filename": "server/api/user/index.js",
28886     "groupTitle": "Users"
28887   },
28888   {
28889     "type": "post",
28890     "url": "/api/users/{id}/square_projects",
28891     "title": "Add a Square Project to a user",
28892     "examples": [
28893       {
28894         "title": "Example usage:",
28895         "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28896         "type": "json"
28897       }
28898     ],
28899     "name": "AddSquareProjects",
28900     "group": "Users",
28901     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28902     "version": "0.0.0",
28903     "filename": "server/api/user/index.js",
28904     "groupTitle": "Users"
28905   },
28906   {
28907     "type": "post",
28908     "url": "/api/users/{id}/teams",
28909     "title": "Add teams to an agent",
28910     "examples": [
28911       {
28912         "title": "Example usage:",
28913         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28914         "type": "json"
28915       }
28916     ],
28917     "name": "AddTeams",
28918     "group": "Users",
28919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28920     "version": "0.0.0",
28921     "filename": "server/api/user/index.js",
28922     "groupTitle": "Users"
28923   },
28924   {
28925     "type": "post",
28926     "url": "/api/users/{id}/whatsapp_accounts",
28927     "title": "Add a Whatsapp Account to a user",
28928     "examples": [
28929       {
28930         "title": "Example usage:",
28931         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28932         "type": "json"
28933       }
28934     ],
28935     "name": "AddWhatsappAccounts",
28936     "group": "Users",
28937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28938     "version": "0.0.0",
28939     "filename": "server/api/user/index.js",
28940     "groupTitle": "Users"
28941   },
28942   {
28943     "type": "post",
28944     "url": "/api/users/{id}/whatsapp_interactions",
28945     "title": "Add Whatsapp interaction tabs to an agent",
28946     "examples": [
28947       {
28948         "title": "Example usage:",
28949         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28950         "type": "json"
28951       }
28952     ],
28953     "name": "AddWhatsappInteractions",
28954     "group": "Users",
28955     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28956     "version": "0.0.0",
28957     "filename": "server/api/user/index.js",
28958     "groupTitle": "Users"
28959   },
28960   {
28961     "type": "put",
28962     "url": "/api/users/{id}/password",
28963     "title": "Change user password",
28964     "examples": [
28965       {
28966         "title": "Example usage:",
28967         "content": "curl https://{domain}/api/users/{id}/password -d '{\"oldPassword\": \"1234\", \"newPassword\": \"5678\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
28968         "type": "json"
28969       }
28970     ],
28971     "name": "ChangePwd",
28972     "group": "Users",
28973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28974     "version": "0.0.0",
28975     "filename": "server/api/user/index.js",
28976     "groupTitle": "Users"
28977   },
28978   {
28979     "type": "post",
28980     "url": "/api/users",
28981     "title": "Create a new user",
28982     "examples": [
28983       {
28984         "title": "Example usage:",
28985         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28986         "type": "json"
28987       }
28988     ],
28989     "name": "Create",
28990     "group": "Users",
28991     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28992     "version": "0.0.0",
28993     "filename": "server/api/user/index.js",
28994     "groupTitle": "Users"
28995   },
28996   {
28997     "type": "post",
28998     "url": "/api/users/{id}/api_key",
28999     "title": "Create a new API access key for the user",
29000     "examples": [
29001       {
29002         "title": "Example usage:",
29003         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29004         "type": "json"
29005       }
29006     ],
29007     "name": "CreateApiKey",
29008     "group": "Users",
29009     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29010     "version": "0.0.0",
29011     "filename": "server/api/user/index.js",
29012     "groupTitle": "Users"
29013   },
29014   {
29015     "type": "delete",
29016     "url": "/api/users/{id}",
29017     "title": "Deletes a user",
29018     "examples": [
29019       {
29020         "title": "Example usage:",
29021         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29022         "type": "json"
29023       }
29024     ],
29025     "name": "Delete",
29026     "group": "Users",
29027     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29028     "version": "0.0.0",
29029     "filename": "server/api/user/index.js",
29030     "groupTitle": "Users"
29031   },
29032   {
29033     "type": "get",
29034     "url": "/api/users/describe",
29035     "title": "Gets table info about Users",
29036     "examples": [
29037       {
29038         "title": "Example usage:",
29039         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29040         "type": "json"
29041       }
29042     ],
29043     "name": "DescribeUsers",
29044     "group": "Users",
29045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29046     "version": "0.0.0",
29047     "filename": "server/api/user/index.js",
29048     "groupTitle": "Users"
29049   },
29050   {
29051     "type": "get",
29052     "url": "/api/users/{id}/agents",
29053     "title": "GetAgents",
29054     "examples": [
29055       {
29056         "title": "Example usage:",
29057         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29058         "type": "json"
29059       }
29060     ],
29061     "name": "GetAgents",
29062     "group": "Users",
29063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29064     "version": "0.0.0",
29065     "filename": "server/api/user/index.js",
29066     "groupTitle": "Users"
29067   },
29068   {
29069     "type": "get",
29070     "url": "/api/users/{id}/api_key",
29071     "title": "Get the API access key for the user",
29072     "examples": [
29073       {
29074         "title": "Example usage:",
29075         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29076         "type": "json"
29077       }
29078     ],
29079     "name": "GetApiKey",
29080     "group": "Users",
29081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29082     "version": "0.0.0",
29083     "filename": "server/api/user/index.js",
29084     "groupTitle": "Users"
29085   },
29086   {
29087     "type": "get",
29088     "url": "/api/users/{id}/groups",
29089     "title": "GetChatGroups",
29090     "examples": [
29091       {
29092         "title": "Example usage:",
29093         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29094         "type": "json"
29095       }
29096     ],
29097     "name": "GetChatGroups",
29098     "group": "Users",
29099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29100     "version": "0.0.0",
29101     "filename": "server/api/user/index.js",
29102     "groupTitle": "Users"
29103   },
29104   {
29105     "type": "get",
29106     "url": "/api/users/{id}/chat/interactions",
29107     "title": "GetChatInteractions",
29108     "examples": [
29109       {
29110         "title": "Example usage:",
29111         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29112         "type": "json"
29113       }
29114     ],
29115     "name": "GetChatInteractions",
29116     "group": "Users",
29117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29118     "version": "0.0.0",
29119     "filename": "server/api/user/index.js",
29120     "groupTitle": "Users"
29121   },
29122   {
29123     "type": "get",
29124     "url": "/api/users/{id}/chat_websites",
29125     "title": "GetChatWebsites",
29126     "examples": [
29127       {
29128         "title": "Example usage:",
29129         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29130         "type": "json"
29131       }
29132     ],
29133     "name": "GetChatWebsites",
29134     "group": "Users",
29135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29136     "version": "0.0.0",
29137     "filename": "server/api/user/index.js",
29138     "groupTitle": "Users"
29139   },
29140   {
29141     "type": "get",
29142     "url": "/api/users/{id}/contacts",
29143     "title": "GetContacts",
29144     "examples": [
29145       {
29146         "title": "Example usage:",
29147         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29148         "type": "json"
29149       }
29150     ],
29151     "name": "GetContacts",
29152     "group": "Users",
29153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29154     "version": "0.0.0",
29155     "filename": "server/api/user/index.js",
29156     "groupTitle": "Users"
29157   },
29158   {
29159     "type": "get",
29160     "url": "/api/users/{id}/fax_accounts",
29161     "title": "GetFaxAccounts",
29162     "examples": [
29163       {
29164         "title": "Example usage:",
29165         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29166         "type": "json"
29167       }
29168     ],
29169     "name": "GetFaxAccounts",
29170     "group": "Users",
29171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29172     "version": "0.0.0",
29173     "filename": "server/api/user/index.js",
29174     "groupTitle": "Users"
29175   },
29176   {
29177     "type": "get",
29178     "url": "/api/users/{id}/fax/interactions",
29179     "title": "GetFaxInteractions",
29180     "examples": [
29181       {
29182         "title": "Example usage:",
29183         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29184         "type": "json"
29185       }
29186     ],
29187     "name": "GetFaxInteractions",
29188     "group": "Users",
29189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29190     "version": "0.0.0",
29191     "filename": "server/api/user/index.js",
29192     "groupTitle": "Users"
29193   },
29194   {
29195     "type": "get",
29196     "url": "/api/users/{id}/lists",
29197     "title": "GetLists",
29198     "examples": [
29199       {
29200         "title": "Example usage:",
29201         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29202         "type": "json"
29203       }
29204     ],
29205     "name": "GetLists",
29206     "group": "Users",
29207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29208     "version": "0.0.0",
29209     "filename": "server/api/user/index.js",
29210     "groupTitle": "Users"
29211   },
29212   {
29213     "type": "get",
29214     "url": "/api/users/{id}/mail_accounts",
29215     "title": "GetMailAccounts",
29216     "examples": [
29217       {
29218         "title": "Example usage:",
29219         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29220         "type": "json"
29221       }
29222     ],
29223     "name": "GetMailAccounts",
29224     "group": "Users",
29225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29226     "version": "0.0.0",
29227     "filename": "server/api/user/index.js",
29228     "groupTitle": "Users"
29229   },
29230   {
29231     "type": "get",
29232     "url": "/api/users/{id}/mail/interactions",
29233     "title": "GetMailInteractions",
29234     "examples": [
29235       {
29236         "title": "Example usage:",
29237         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29238         "type": "json"
29239       }
29240     ],
29241     "name": "GetMailInteractions",
29242     "group": "Users",
29243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29244     "version": "0.0.0",
29245     "filename": "server/api/user/index.js",
29246     "groupTitle": "Users"
29247   },
29248   {
29249     "type": "get",
29250     "url": "/api/users/{id}/openchannel_accounts",
29251     "title": "GetOpenchannelAccounts",
29252     "examples": [
29253       {
29254         "title": "Example usage:",
29255         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29256         "type": "json"
29257       }
29258     ],
29259     "name": "GetOpenchannelAccounts",
29260     "group": "Users",
29261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29262     "version": "0.0.0",
29263     "filename": "server/api/user/index.js",
29264     "groupTitle": "Users"
29265   },
29266   {
29267     "type": "get",
29268     "url": "/api/users/{id}/openchannel/interactions",
29269     "title": "GetOpenchannelInteractions",
29270     "examples": [
29271       {
29272         "title": "Example usage:",
29273         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29274         "type": "json"
29275       }
29276     ],
29277     "name": "GetOpenchannelInteractions",
29278     "group": "Users",
29279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29280     "version": "0.0.0",
29281     "filename": "server/api/user/index.js",
29282     "groupTitle": "Users"
29283   },
29284   {
29285     "type": "get",
29286     "url": "/api/users/{id}/prefixes",
29287     "title": "GetPrefixes",
29288     "examples": [
29289       {
29290         "title": "Example usage:",
29291         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29292         "type": "json"
29293       }
29294     ],
29295     "name": "GetPrefixes",
29296     "group": "Users",
29297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29298     "version": "0.0.0",
29299     "filename": "server/api/user/index.js",
29300     "groupTitle": "Users"
29301   },
29302   {
29303     "type": "get",
29304     "url": "/api/users/{id}/queues?channel={channel}",
29305     "title": "Gets Queues list",
29306     "examples": [
29307       {
29308         "title": "Example usage:",
29309         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29310         "type": "json"
29311       }
29312     ],
29313     "name": "GetQueues",
29314     "group": "Users",
29315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29316     "version": "0.0.0",
29317     "filename": "server/api/user/index.js",
29318     "groupTitle": "Users"
29319   },
29320   {
29321     "type": "get",
29322     "url": "/api/users/{id}/recordings",
29323     "title": "GetRecordings",
29324     "examples": [
29325       {
29326         "title": "Example usage:",
29327         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29328         "type": "json"
29329       }
29330     ],
29331     "name": "GetRecordings",
29332     "group": "Users",
29333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29334     "version": "0.0.0",
29335     "filename": "server/api/user/index.js",
29336     "groupTitle": "Users"
29337   },
29338   {
29339     "type": "get",
29340     "url": "/api/users/{id}/scheduled_calls",
29341     "title": "GetScheduledCalls",
29342     "examples": [
29343       {
29344         "title": "Example usage:",
29345         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29346         "type": "json"
29347       }
29348     ],
29349     "name": "GetScheduledCalls",
29350     "group": "Users",
29351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29352     "version": "0.0.0",
29353     "filename": "server/api/user/index.js",
29354     "groupTitle": "Users"
29355   },
29356   {
29357     "type": "get",
29358     "url": "/api/users/{id}/screen_recordings",
29359     "title": "GetScreenRecordings",
29360     "examples": [
29361       {
29362         "title": "Example usage:",
29363         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29364         "type": "json"
29365       }
29366     ],
29367     "name": "GetScreenRecordings",
29368     "group": "Users",
29369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29370     "version": "0.0.0",
29371     "filename": "server/api/user/index.js",
29372     "groupTitle": "Users"
29373   },
29374   {
29375     "type": "get",
29376     "url": "/api/users/{id}/sms_accounts",
29377     "title": "GetSmsAccounts",
29378     "examples": [
29379       {
29380         "title": "Example usage:",
29381         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29382         "type": "json"
29383       }
29384     ],
29385     "name": "GetSmsAccounts",
29386     "group": "Users",
29387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29388     "version": "0.0.0",
29389     "filename": "server/api/user/index.js",
29390     "groupTitle": "Users"
29391   },
29392   {
29393     "type": "get",
29394     "url": "/api/users/{id}/sms/interactions",
29395     "title": "GetSmsInteractions",
29396     "examples": [
29397       {
29398         "title": "Example usage:",
29399         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29400         "type": "json"
29401       }
29402     ],
29403     "name": "GetSmsInteractions",
29404     "group": "Users",
29405     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29406     "version": "0.0.0",
29407     "filename": "server/api/user/index.js",
29408     "groupTitle": "Users"
29409   },
29410   {
29411     "type": "get",
29412     "url": "/api/users/{id}/square_projects",
29413     "title": "GetSquareProjects",
29414     "examples": [
29415       {
29416         "title": "Example usage:",
29417         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29418         "type": "json"
29419       }
29420     ],
29421     "name": "GetSquareProjects",
29422     "group": "Users",
29423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29424     "version": "0.0.0",
29425     "filename": "server/api/user/index.js",
29426     "groupTitle": "Users"
29427   },
29428   {
29429     "type": "get",
29430     "url": "/api/users/{id}/teams",
29431     "title": "GetTeams",
29432     "examples": [
29433       {
29434         "title": "Example usage:",
29435         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29436         "type": "json"
29437       }
29438     ],
29439     "name": "GetTeams",
29440     "group": "Users",
29441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29442     "version": "0.0.0",
29443     "filename": "server/api/user/index.js",
29444     "groupTitle": "Users"
29445   },
29446   {
29447     "type": "get",
29448     "url": "/api/users",
29449     "title": "Gets a list of Users",
29450     "examples": [
29451       {
29452         "title": "Example usage:",
29453         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29454         "type": "json"
29455       }
29456     ],
29457     "name": "GetUsers",
29458     "group": "Users",
29459     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/users?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/users?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/users?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/users?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/users?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
29460     "version": "0.0.0",
29461     "filename": "server/api/user/index.js",
29462     "groupTitle": "Users"
29463   },
29464   {
29465     "type": "get",
29466     "url": "/api/users/{id}/queues_rt",
29467     "title": "GetVoiceQueuesRt",
29468     "examples": [
29469       {
29470         "title": "Example usage:",
29471         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29472         "type": "json"
29473       }
29474     ],
29475     "name": "GetVoiceQueuesRt",
29476     "group": "Users",
29477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29478     "version": "0.0.0",
29479     "filename": "server/api/user/index.js",
29480     "groupTitle": "Users"
29481   },
29482   {
29483     "type": "get",
29484     "url": "/api/users/{id}/whatsapp_accounts",
29485     "title": "GetWhatsappAccounts",
29486     "examples": [
29487       {
29488         "title": "Example usage:",
29489         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29490         "type": "json"
29491       }
29492     ],
29493     "name": "GetWhatsappAccounts",
29494     "group": "Users",
29495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29496     "version": "0.0.0",
29497     "filename": "server/api/user/index.js",
29498     "groupTitle": "Users"
29499   },
29500   {
29501     "type": "get",
29502     "url": "/api/users/{id}/whatsapp/interactions",
29503     "title": "GetWhatsappInteractions",
29504     "examples": [
29505       {
29506         "title": "Example usage:",
29507         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29508         "type": "json"
29509       }
29510     ],
29511     "name": "GetWhatsappInteractions",
29512     "group": "Users",
29513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29514     "version": "0.0.0",
29515     "filename": "server/api/user/index.js",
29516     "groupTitle": "Users"
29517   },
29518   {
29519     "type": "post",
29520     "url": "/api/users/{id}/login",
29521     "title": "Login",
29522     "examples": [
29523       {
29524         "title": "Example usage:",
29525         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29526         "type": "json"
29527       }
29528     ],
29529     "name": "Login",
29530     "group": "Users",
29531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29532     "version": "0.0.0",
29533     "filename": "server/api/user/index.js",
29534     "groupTitle": "Users"
29535   },
29536   {
29537     "type": "post",
29538     "url": "/api/users/{id}/logout",
29539     "title": "Logout",
29540     "examples": [
29541       {
29542         "title": "Example usage:",
29543         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29544         "type": "json"
29545       }
29546     ],
29547     "name": "Logout",
29548     "group": "Users",
29549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29550     "version": "0.0.0",
29551     "filename": "server/api/user/index.js",
29552     "groupTitle": "Users"
29553   },
29554   {
29555     "type": "post",
29556     "url": "/api/users/{id}/pause",
29557     "title": "Pause",
29558     "examples": [
29559       {
29560         "title": "Example usage:",
29561         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29562         "type": "json"
29563       }
29564     ],
29565     "name": "Pause",
29566     "group": "Users",
29567     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29568     "version": "0.0.0",
29569     "filename": "server/api/user/index.js",
29570     "groupTitle": "Users"
29571   },
29572   {
29573     "type": "delete",
29574     "url": "/api/users/{id}/api_key",
29575     "title": "Remove API access key for the user",
29576     "examples": [
29577       {
29578         "title": "Example usage:",
29579         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29580         "type": "json"
29581       }
29582     ],
29583     "name": "RemoveApiKey",
29584     "group": "Users",
29585     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29586     "version": "0.0.0",
29587     "filename": "server/api/user/index.js",
29588     "groupTitle": "Users"
29589   },
29590   {
29591     "type": "delete",
29592     "url": "/api/users/{id}/chat_interactions",
29593     "title": "Removes interactions from an agent",
29594     "examples": [
29595       {
29596         "title": "Example usage:",
29597         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29598         "type": "json"
29599       }
29600     ],
29601     "name": "RemoveChatInteractions",
29602     "group": "Users",
29603     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29604     "version": "0.0.0",
29605     "filename": "server/api/user/index.js",
29606     "groupTitle": "Users"
29607   },
29608   {
29609     "type": "delete",
29610     "url": "/api/users/{id}/chat_websites",
29611     "title": "Removes a Chat Website from a user",
29612     "examples": [
29613       {
29614         "title": "Example usage:",
29615         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29616         "type": "json"
29617       }
29618     ],
29619     "name": "RemoveChatWebsites",
29620     "group": "Users",
29621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29622     "version": "0.0.0",
29623     "filename": "server/api/user/index.js",
29624     "groupTitle": "Users"
29625   },
29626   {
29627     "type": "delete",
29628     "url": "/api/users/{id}/fax_accounts",
29629     "title": "Removes a Fax Account from a user",
29630     "examples": [
29631       {
29632         "title": "Example usage:",
29633         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29634         "type": "json"
29635       }
29636     ],
29637     "name": "RemoveFaxAccounts",
29638     "group": "Users",
29639     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29640     "version": "0.0.0",
29641     "filename": "server/api/user/index.js",
29642     "groupTitle": "Users"
29643   },
29644   {
29645     "type": "delete",
29646     "url": "/api/users/{id}/fax_interactions",
29647     "title": "Removes interactions from an agent",
29648     "examples": [
29649       {
29650         "title": "Example usage:",
29651         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29652         "type": "json"
29653       }
29654     ],
29655     "name": "RemoveFaxInteractions",
29656     "group": "Users",
29657     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29658     "version": "0.0.0",
29659     "filename": "server/api/user/index.js",
29660     "groupTitle": "Users"
29661   },
29662   {
29663     "type": "delete",
29664     "url": "/api/users/{id}/mail_accounts",
29665     "title": "Removes a Mail Account from a user",
29666     "examples": [
29667       {
29668         "title": "Example usage:",
29669         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29670         "type": "json"
29671       }
29672     ],
29673     "name": "RemoveMailAccounts",
29674     "group": "Users",
29675     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29676     "version": "0.0.0",
29677     "filename": "server/api/user/index.js",
29678     "groupTitle": "Users"
29679   },
29680   {
29681     "type": "delete",
29682     "url": "/api/users/{id}/mail_interactions",
29683     "title": "Removes interactions from an agent",
29684     "examples": [
29685       {
29686         "title": "Example usage:",
29687         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29688         "type": "json"
29689       }
29690     ],
29691     "name": "RemoveMailInteractions",
29692     "group": "Users",
29693     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29694     "version": "0.0.0",
29695     "filename": "server/api/user/index.js",
29696     "groupTitle": "Users"
29697   },
29698   {
29699     "type": "delete",
29700     "url": "/api/users/{id}/openchannel_accounts",
29701     "title": "Removes a Open Channel Account from a user",
29702     "examples": [
29703       {
29704         "title": "Example usage:",
29705         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29706         "type": "json"
29707       }
29708     ],
29709     "name": "RemoveOpenchannelAccounts",
29710     "group": "Users",
29711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29712     "version": "0.0.0",
29713     "filename": "server/api/user/index.js",
29714     "groupTitle": "Users"
29715   },
29716   {
29717     "type": "delete",
29718     "url": "/api/users/{id}/openchannel_interactions",
29719     "title": "Removes openchannel interactions from an agent",
29720     "examples": [
29721       {
29722         "title": "Example usage:",
29723         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29724         "type": "json"
29725       }
29726     ],
29727     "name": "RemoveOpenchannelInteractions",
29728     "group": "Users",
29729     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29730     "version": "0.0.0",
29731     "filename": "server/api/user/index.js",
29732     "groupTitle": "Users"
29733   },
29734   {
29735     "type": "delete",
29736     "url": "/api/users/{id}/queues",
29737     "title": "Remove queues to an agent",
29738     "examples": [
29739       {
29740         "title": "Example usage:",
29741         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29742         "type": "json"
29743       }
29744     ],
29745     "name": "RemoveQueues",
29746     "group": "Users",
29747     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29748     "version": "0.0.0",
29749     "filename": "server/api/user/index.js",
29750     "groupTitle": "Users"
29751   },
29752   {
29753     "type": "delete",
29754     "url": "/api/users/{id}/sms_accounts",
29755     "title": "Removes a Sms Account from a user",
29756     "examples": [
29757       {
29758         "title": "Example usage:",
29759         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29760         "type": "json"
29761       }
29762     ],
29763     "name": "RemoveSmsAccounts",
29764     "group": "Users",
29765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29766     "version": "0.0.0",
29767     "filename": "server/api/user/index.js",
29768     "groupTitle": "Users"
29769   },
29770   {
29771     "type": "delete",
29772     "url": "/api/users/{id}/sms_interactions",
29773     "title": "Removes interactions from an agent",
29774     "examples": [
29775       {
29776         "title": "Example usage:",
29777         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29778         "type": "json"
29779       }
29780     ],
29781     "name": "RemoveSmsInteractions",
29782     "group": "Users",
29783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29784     "version": "0.0.0",
29785     "filename": "server/api/user/index.js",
29786     "groupTitle": "Users"
29787   },
29788   {
29789     "type": "delete",
29790     "url": "/api/users/{id}/square_projects",
29791     "title": "Removes a Square Project from a user",
29792     "examples": [
29793       {
29794         "title": "Example usage:",
29795         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29796         "type": "json"
29797       }
29798     ],
29799     "name": "RemoveSquareProjects",
29800     "group": "Users",
29801     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29802     "version": "0.0.0",
29803     "filename": "server/api/user/index.js",
29804     "groupTitle": "Users"
29805   },
29806   {
29807     "type": "delete",
29808     "url": "/api/users/{id}/teams",
29809     "title": "Removes teams from an agent",
29810     "examples": [
29811       {
29812         "title": "Example usage:",
29813         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29814         "type": "json"
29815       }
29816     ],
29817     "name": "RemoveTeams",
29818     "group": "Users",
29819     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29820     "version": "0.0.0",
29821     "filename": "server/api/user/index.js",
29822     "groupTitle": "Users"
29823   },
29824   {
29825     "type": "delete",
29826     "url": "/api/users/{id}/whatsapp_accounts",
29827     "title": "Removes a Whatsapp Account from a user",
29828     "examples": [
29829       {
29830         "title": "Example usage:",
29831         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29832         "type": "json"
29833       }
29834     ],
29835     "name": "RemoveWhatsappAccounts",
29836     "group": "Users",
29837     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29838     "version": "0.0.0",
29839     "filename": "server/api/user/index.js",
29840     "groupTitle": "Users"
29841   },
29842   {
29843     "type": "delete",
29844     "url": "/api/users/{id}/whatsapp_interactions",
29845     "title": "Removes Whatsapp interactions from an agent",
29846     "examples": [
29847       {
29848         "title": "Example usage:",
29849         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29850         "type": "json"
29851       }
29852     ],
29853     "name": "RemoveWhatsappInteractions",
29854     "group": "Users",
29855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29856     "version": "0.0.0",
29857     "filename": "server/api/user/index.js",
29858     "groupTitle": "Users"
29859   },
29860   {
29861     "type": "get",
29862     "url": "/api/users/{id}",
29863     "title": "Gets a single User",
29864     "examples": [
29865       {
29866         "title": "Example usage:",
29867         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29868         "type": "json"
29869       }
29870     ],
29871     "name": "ShowUsers",
29872     "group": "Users",
29873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29874     "version": "0.0.0",
29875     "filename": "server/api/user/index.js",
29876     "groupTitle": "Users"
29877   },
29878   {
29879     "type": "post",
29880     "url": "/api/users/{id}/unpause",
29881     "title": "Unpause",
29882     "examples": [
29883       {
29884         "title": "Example usage:",
29885         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29886         "type": "json"
29887       }
29888     ],
29889     "name": "Unpause",
29890     "group": "Users",
29891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29892     "version": "0.0.0",
29893     "filename": "server/api/user/index.js",
29894     "groupTitle": "Users"
29895   },
29896   {
29897     "type": "get",
29898     "url": "/api/users/whoami",
29899     "title": "WhoAmI",
29900     "examples": [
29901       {
29902         "title": "Example usage:",
29903         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29904         "type": "json"
29905       }
29906     ],
29907     "name": "WhoAmI",
29908     "group": "Users",
29909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29910     "version": "0.0.0",
29911     "filename": "server/api/user/index.js",
29912     "groupTitle": "Users"
29913   },
29914   {
29915     "type": "post",
29916     "url": "/api/users/{id}/avatar",
29917     "title": "Add avatar",
29918     "examples": [
29919       {
29920         "title": "Example usage:",
29921         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29922         "type": "json"
29923       }
29924     ],
29925     "name": "addAvatar",
29926     "group": "Users",
29927     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29928     "version": "0.0.0",
29929     "filename": "server/api/user/index.js",
29930     "groupTitle": "Users"
29931   },
29932   {
29933     "type": "post",
29934     "url": "/api/users/create_many",
29935     "title": "Create Users",
29936     "examples": [
29937       {
29938         "title": "Example usage:",
29939         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29940         "type": "json"
29941       }
29942     ],
29943     "name": "bulkCreate",
29944     "group": "Users",
29945     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29946     "version": "0.0.0",
29947     "filename": "server/api/user/index.js",
29948     "groupTitle": "Users"
29949   },
29950   {
29951     "type": "get",
29952     "url": "/api/users/{id}/avatar",
29953     "title": "Get avatar",
29954     "examples": [
29955       {
29956         "title": "Example usage:",
29957         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29958         "type": "json"
29959       }
29960     ],
29961     "name": "getAvatar",
29962     "group": "Users",
29963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29964     "version": "0.0.0",
29965     "filename": "server/api/user/index.js",
29966     "groupTitle": "Users"
29967   },
29968   {
29969     "type": "get",
29970     "url": "/api/users/{id}/open_tabs",
29971     "title": "Get interactions opened tabs",
29972     "examples": [
29973       {
29974         "title": "Example usage:",
29975         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29976         "type": "json"
29977       }
29978     ],
29979     "name": "getOpenTabs",
29980     "group": "Users",
29981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29982     "version": "0.0.0",
29983     "filename": "server/api/user/index.js",
29984     "groupTitle": "Users"
29985   },
29986   {
29987     "type": "get",
29988     "url": "/api/users/presence",
29989     "title": "Gets agent presence",
29990     "examples": [
29991       {
29992         "title": "Example usage:",
29993         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29994         "type": "json"
29995       }
29996     ],
29997     "name": "getPresence",
29998     "group": "Users",
29999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30000     "version": "0.0.0",
30001     "filename": "server/api/user/index.js",
30002     "groupTitle": "Users"
30003   },
30004   {
30005     "type": "put",
30006     "url": "/api/users/{id}",
30007     "title": "Update an existing User",
30008     "examples": [
30009       {
30010         "title": "Example usage:",
30011         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30012         "type": "json"
30013       }
30014     ],
30015     "name": "updateUsers",
30016     "group": "Users",
30017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30018     "version": "0.0.0",
30019     "filename": "server/api/user/index.js",
30020     "groupTitle": "Users"
30021   },
30022   {
30023     "type": "post",
30024     "url": "/api/variables",
30025     "title": "Creates a new Variable",
30026     "examples": [
30027       {
30028         "title": "Example usage:",
30029         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30030         "type": "json"
30031       }
30032     ],
30033     "name": "CreateVariables",
30034     "group": "Variables",
30035     "parameter": {
30036       "fields": {
30037         "Body": [
30038           {
30039             "group": "Body",
30040             "type": "String",
30041             "optional": false,
30042             "field": "name",
30043             "description": ""
30044           },
30045           {
30046             "group": "Body",
30047             "type": "String",
30048             "optional": true,
30049             "field": "description",
30050             "description": ""
30051           }
30052         ]
30053       }
30054     },
30055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30056     "version": "0.0.0",
30057     "filename": "server/api/variable/index.js",
30058     "groupTitle": "Variables"
30059   },
30060   {
30061     "type": "delete",
30062     "url": "/api/variables/{id}",
30063     "title": "Deletes a Variable",
30064     "examples": [
30065       {
30066         "title": "Example usage:",
30067         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30068         "type": "json"
30069       }
30070     ],
30071     "name": "DeleteVariables",
30072     "group": "Variables",
30073     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30074     "version": "0.0.0",
30075     "filename": "server/api/variable/index.js",
30076     "groupTitle": "Variables"
30077   },
30078   {
30079     "type": "get",
30080     "url": "/api/variables",
30081     "title": "Gets a list of Variables",
30082     "examples": [
30083       {
30084         "title": "Example usage:",
30085         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30086         "type": "json"
30087       }
30088     ],
30089     "name": "GetVariables",
30090     "group": "Variables",
30091     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/variables?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/variables?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/variables?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/variables?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/variables?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30092     "version": "0.0.0",
30093     "filename": "server/api/variable/index.js",
30094     "groupTitle": "Variables"
30095   },
30096   {
30097     "type": "get",
30098     "url": "/api/variables/{id}",
30099     "title": "Gets a single Variable",
30100     "examples": [
30101       {
30102         "title": "Example usage:",
30103         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30104         "type": "json"
30105       }
30106     ],
30107     "name": "ShowVariables",
30108     "group": "Variables",
30109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30110     "version": "0.0.0",
30111     "filename": "server/api/variable/index.js",
30112     "groupTitle": "Variables"
30113   },
30114   {
30115     "type": "put",
30116     "url": "/api/variables/{id}",
30117     "title": "Update an existing Variable",
30118     "examples": [
30119       {
30120         "title": "Example usage:",
30121         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30122         "type": "json"
30123       }
30124     ],
30125     "name": "updateVariables",
30126     "group": "Variables",
30127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30128     "version": "0.0.0",
30129     "filename": "server/api/variable/index.js",
30130     "groupTitle": "Variables"
30131   },
30132   {
30133     "type": "get",
30134     "url": "/api/version/fetch",
30135     "title": "Fetch git version",
30136     "examples": [
30137       {
30138         "title": "Example usage:",
30139         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30140         "type": "json"
30141       }
30142     ],
30143     "name": "FetchVersion",
30144     "group": "Version",
30145     "description": "<p>Motion run the following command: git fetch origin master</p>",
30146     "version": "0.0.0",
30147     "filename": "server/api/version/index.js",
30148     "groupTitle": "Version"
30149   },
30150   {
30151     "type": "get",
30152     "url": "/api/version",
30153     "title": "Gets version",
30154     "examples": [
30155       {
30156         "title": "Example usage:",
30157         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30158         "type": "json"
30159       }
30160     ],
30161     "name": "GetVersion",
30162     "group": "Version",
30163     "description": "<p>Motion returns the current and latest motion version.</p>",
30164     "version": "0.0.0",
30165     "filename": "server/api/version/index.js",
30166     "groupTitle": "Version"
30167   },
30168   {
30169     "type": "get",
30170     "url": "/api/version/migrations",
30171     "title": "Launch database migrations",
30172     "examples": [
30173       {
30174         "title": "Example usage:",
30175         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30176         "type": "json"
30177       }
30178     ],
30179     "name": "MigrateVersion",
30180     "group": "Version",
30181     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30182     "version": "0.0.0",
30183     "filename": "server/api/version/index.js",
30184     "groupTitle": "Version"
30185   },
30186   {
30187     "type": "get",
30188     "url": "/api/version/pull",
30189     "title": "Pull git version",
30190     "examples": [
30191       {
30192         "title": "Example usage:",
30193         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30194         "type": "json"
30195       }
30196     ],
30197     "name": "PullVersion",
30198     "group": "Version",
30199     "description": "<p>Motion run the following command: git pull</p>",
30200     "version": "0.0.0",
30201     "filename": "server/api/version/index.js",
30202     "groupTitle": "Version"
30203   },
30204   {
30205     "type": "get",
30206     "url": "/api/version/reset",
30207     "title": "Reset git version",
30208     "examples": [
30209       {
30210         "title": "Example usage:",
30211         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30212         "type": "json"
30213       }
30214     ],
30215     "name": "ResetVersion",
30216     "group": "Version",
30217     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30218     "version": "0.0.0",
30219     "filename": "server/api/version/index.js",
30220     "groupTitle": "Version"
30221   },
30222   {
30223     "type": "get",
30224     "url": "/api/version/restart",
30225     "title": "Restart motion2 after update",
30226     "examples": [
30227       {
30228         "title": "Example usage:",
30229         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30230         "type": "json"
30231       }
30232     ],
30233     "name": "RestartVersion",
30234     "group": "Version",
30235     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30236     "version": "0.0.0",
30237     "filename": "server/api/version/index.js",
30238     "groupTitle": "Version"
30239   },
30240   {
30241     "type": "get",
30242     "url": "/api/voice/agents/reports/describe",
30243     "title": "Gets table info about Agent Reports",
30244     "examples": [
30245       {
30246         "title": "Example usage:",
30247         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30248         "type": "json"
30249       }
30250     ],
30251     "name": "DescribeAgent_Reports",
30252     "group": "Voice_Agent_Reports",
30253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30254     "version": "0.0.0",
30255     "filename": "server/api/voiceAgentReport/index.js",
30256     "groupTitle": "Voice_Agent_Reports"
30257   },
30258   {
30259     "type": "get",
30260     "url": "/api/voice/agents/reports",
30261     "title": "Gets a list of Agent Reports",
30262     "examples": [
30263       {
30264         "title": "Example usage:",
30265         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30266         "type": "json"
30267       }
30268     ],
30269     "name": "GetAgent_Reports",
30270     "group": "Voice_Agent_Reports",
30271     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/agents/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/agents/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/agents/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/agents/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/agents/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30272     "version": "0.0.0",
30273     "filename": "server/api/voiceAgentReport/index.js",
30274     "groupTitle": "Voice_Agent_Reports"
30275   },
30276   {
30277     "type": "get",
30278     "url": "/api/voice/agents/reports/{id}",
30279     "title": "Gets a single Agent Report",
30280     "examples": [
30281       {
30282         "title": "Example usage:",
30283         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30284         "type": "json"
30285       }
30286     ],
30287     "name": "ShowAgent_Reports",
30288     "group": "Voice_Agent_Reports",
30289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30290     "version": "0.0.0",
30291     "filename": "server/api/voiceAgentReport/index.js",
30292     "groupTitle": "Voice_Agent_Reports"
30293   },
30294   {
30295     "type": "get",
30296     "url": "/api/voice/calls/reports/describe",
30297     "title": "Gets table info about Call Reports",
30298     "examples": [
30299       {
30300         "title": "Example usage:",
30301         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30302         "type": "json"
30303       }
30304     ],
30305     "name": "DescribeCall_Reports",
30306     "group": "Voice_Call_Reports",
30307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30308     "version": "0.0.0",
30309     "filename": "server/api/voiceCallReport/index.js",
30310     "groupTitle": "Voice_Call_Reports"
30311   },
30312   {
30313     "type": "get",
30314     "url": "/api/voice/calls/reports",
30315     "title": "Gets a list of Call Reports",
30316     "examples": [
30317       {
30318         "title": "Example usage:",
30319         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30320         "type": "json"
30321       }
30322     ],
30323     "name": "GetCall_Reports",
30324     "group": "Voice_Call_Reports",
30325     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/calls/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/calls/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/calls/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/calls/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/calls/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30326     "version": "0.0.0",
30327     "filename": "server/api/voiceCallReport/index.js",
30328     "groupTitle": "Voice_Call_Reports"
30329   },
30330   {
30331     "type": "get",
30332     "url": "/api/voice/calls/reports/{id}",
30333     "title": "Gets a single Call Report",
30334     "examples": [
30335       {
30336         "title": "Example usage:",
30337         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30338         "type": "json"
30339       }
30340     ],
30341     "name": "ShowCall_Reports",
30342     "group": "Voice_Call_Reports",
30343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30344     "version": "0.0.0",
30345     "filename": "server/api/voiceCallReport/index.js",
30346     "groupTitle": "Voice_Call_Reports"
30347   },
30348   {
30349     "type": "put",
30350     "url": "/api/voice/calls/reports/{id}",
30351     "title": "Update a single cdr",
30352     "examples": [
30353       {
30354         "title": "Example usage:",
30355         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30356         "type": "json"
30357       }
30358     ],
30359     "name": "update",
30360     "group": "Voice_Call_Reports",
30361     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30362     "version": "0.0.0",
30363     "filename": "server/api/voiceCallReport/index.js",
30364     "groupTitle": "Voice_Call_Reports"
30365   },
30366   {
30367     "type": "post",
30368     "url": "/api/voice/chanspy",
30369     "title": "Creates a new ChanSpy",
30370     "examples": [
30371       {
30372         "title": "Example usage:",
30373         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30374         "type": "json"
30375       }
30376     ],
30377     "name": "CreateChanSpy",
30378     "group": "Voice_ChanSpy",
30379     "parameter": {
30380       "fields": {
30381         "Body": [
30382           {
30383             "group": "Body",
30384             "type": "String",
30385             "optional": true,
30386             "field": "name",
30387             "description": ""
30388           },
30389           {
30390             "group": "Body",
30391             "type": "String",
30392             "optional": false,
30393             "field": "prefix",
30394             "description": ""
30395           },
30396           {
30397             "group": "Body",
30398             "type": "String",
30399             "optional": true,
30400             "field": "options",
30401             "description": ""
30402           },
30403           {
30404             "group": "Body",
30405             "type": "Boolean",
30406             "optional": true,
30407             "field": "auth",
30408             "description": ""
30409           },
30410           {
30411             "group": "Body",
30412             "type": "String",
30413             "optional": true,
30414             "field": "password",
30415             "description": ""
30416           },
30417           {
30418             "group": "Body",
30419             "type": "Boolean",
30420             "optional": true,
30421             "field": "record",
30422             "description": ""
30423           },
30424           {
30425             "group": "Body",
30426             "type": "String",
30427             "optional": true,
30428             "field": "recordingFormat",
30429             "description": ""
30430           },
30431           {
30432             "group": "Body",
30433             "type": "String",
30434             "optional": true,
30435             "field": "description",
30436             "description": ""
30437           }
30438         ]
30439       }
30440     },
30441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30442     "version": "0.0.0",
30443     "filename": "server/api/voiceChanSpy/index.js",
30444     "groupTitle": "Voice_ChanSpy"
30445   },
30446   {
30447     "type": "delete",
30448     "url": "/api/voice/chanspy/{id}",
30449     "title": "Deletes a ChanSpy",
30450     "examples": [
30451       {
30452         "title": "Example usage:",
30453         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30454         "type": "json"
30455       }
30456     ],
30457     "name": "DeleteChanSpy",
30458     "group": "Voice_ChanSpy",
30459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30460     "version": "0.0.0",
30461     "filename": "server/api/voiceChanSpy/index.js",
30462     "groupTitle": "Voice_ChanSpy"
30463   },
30464   {
30465     "type": "get",
30466     "url": "/api/voice/chanspy",
30467     "title": "Gets a list of ChanSpy",
30468     "examples": [
30469       {
30470         "title": "Example usage:",
30471         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30472         "type": "json"
30473       }
30474     ],
30475     "name": "GetChanSpy",
30476     "group": "Voice_ChanSpy",
30477     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/chanspy?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/chanspy?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/chanspy?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/chanspy?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/chanspy?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30478     "version": "0.0.0",
30479     "filename": "server/api/voiceChanSpy/index.js",
30480     "groupTitle": "Voice_ChanSpy"
30481   },
30482   {
30483     "type": "get",
30484     "url": "/api/voice/chanspy/{id}",
30485     "title": "Gets a single ChanSpy",
30486     "examples": [
30487       {
30488         "title": "Example usage:",
30489         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30490         "type": "json"
30491       }
30492     ],
30493     "name": "ShowChanSpy",
30494     "group": "Voice_ChanSpy",
30495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30496     "version": "0.0.0",
30497     "filename": "server/api/voiceChanSpy/index.js",
30498     "groupTitle": "Voice_ChanSpy"
30499   },
30500   {
30501     "type": "put",
30502     "url": "/api/voice/chanspy/{id}",
30503     "title": "Update an existing ChanSpy",
30504     "examples": [
30505       {
30506         "title": "Example usage:",
30507         "content": "curl https://{domain}/api/voice/chanspy/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30508         "type": "json"
30509       }
30510     ],
30511     "name": "updateChanSpy",
30512     "group": "Voice_ChanSpy",
30513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30514     "version": "0.0.0",
30515     "filename": "server/api/voiceChanSpy/index.js",
30516     "groupTitle": "Voice_ChanSpy"
30517   },
30518   {
30519     "type": "post",
30520     "url": "/api/voice/contexts",
30521     "title": "Create a new context",
30522     "examples": [
30523       {
30524         "title": "Example usage:",
30525         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30526         "type": "json"
30527       }
30528     ],
30529     "name": "Create",
30530     "group": "Voice_Contexts",
30531     "parameter": {
30532       "fields": {
30533         "Body": [
30534           {
30535             "group": "Body",
30536             "type": "String",
30537             "optional": true,
30538             "field": "name",
30539             "description": ""
30540           },
30541           {
30542             "group": "Body",
30543             "type": "String",
30544             "optional": true,
30545             "field": "description",
30546             "description": ""
30547           },
30548           {
30549             "group": "Body",
30550             "type": "Boolean",
30551             "optional": true,
30552             "field": "defaultEntry",
30553             "description": ""
30554           }
30555         ]
30556       }
30557     },
30558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30559     "version": "0.0.0",
30560     "filename": "server/api/voiceContext/index.js",
30561     "groupTitle": "Voice_Contexts"
30562   },
30563   {
30564     "type": "delete",
30565     "url": "/api/voice/contexts/{id}",
30566     "title": "Deletes a context",
30567     "examples": [
30568       {
30569         "title": "Example usage:",
30570         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30571         "type": "json"
30572       }
30573     ],
30574     "name": "Delete",
30575     "group": "Voice_Contexts",
30576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30577     "version": "0.0.0",
30578     "filename": "server/api/voiceContext/index.js",
30579     "groupTitle": "Voice_Contexts"
30580   },
30581   {
30582     "type": "get",
30583     "url": "/api/voice/contexts",
30584     "title": "Gets a list of Contexts",
30585     "examples": [
30586       {
30587         "title": "Example usage:",
30588         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30589         "type": "json"
30590       }
30591     ],
30592     "name": "GetContexts",
30593     "group": "Voice_Contexts",
30594     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/contexts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/contexts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/contexts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/contexts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/contexts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30595     "version": "0.0.0",
30596     "filename": "server/api/voiceContext/index.js",
30597     "groupTitle": "Voice_Contexts"
30598   },
30599   {
30600     "type": "get",
30601     "url": "/api/voice/contexts/{id}",
30602     "title": "Gets a single Context",
30603     "examples": [
30604       {
30605         "title": "Example usage:",
30606         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30607         "type": "json"
30608       }
30609     ],
30610     "name": "ShowContexts",
30611     "group": "Voice_Contexts",
30612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30613     "version": "0.0.0",
30614     "filename": "server/api/voiceContext/index.js",
30615     "groupTitle": "Voice_Contexts"
30616   },
30617   {
30618     "type": "put",
30619     "url": "/api/voice/contexts/{id}",
30620     "title": "Update an existing context",
30621     "examples": [
30622       {
30623         "title": "Example usage:",
30624         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30625         "type": "json"
30626       }
30627     ],
30628     "name": "Update",
30629     "group": "Voice_Contexts",
30630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30631     "version": "0.0.0",
30632     "filename": "server/api/voiceContext/index.js",
30633     "groupTitle": "Voice_Contexts"
30634   },
30635   {
30636     "type": "get",
30637     "url": "/api/voice/dials/reports/describe",
30638     "title": "Gets table info about Dial Reports",
30639     "examples": [
30640       {
30641         "title": "Example usage:",
30642         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30643         "type": "json"
30644       }
30645     ],
30646     "name": "DescribeDial_Reports",
30647     "group": "Voice_Dial_Reports",
30648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30649     "version": "0.0.0",
30650     "filename": "server/api/voiceDialReport/index.js",
30651     "groupTitle": "Voice_Dial_Reports"
30652   },
30653   {
30654     "type": "get",
30655     "url": "/api/voice/dials/reports",
30656     "title": "Gets a list of Dial Reports",
30657     "examples": [
30658       {
30659         "title": "Example usage:",
30660         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30661         "type": "json"
30662       }
30663     ],
30664     "name": "GetDial_Reports",
30665     "group": "Voice_Dial_Reports",
30666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/dials/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/dials/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/dials/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/dials/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/dials/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30667     "version": "0.0.0",
30668     "filename": "server/api/voiceDialReport/index.js",
30669     "groupTitle": "Voice_Dial_Reports"
30670   },
30671   {
30672     "type": "get",
30673     "url": "/api/voice/dials/reports/{id}",
30674     "title": "Gets a single Dial Report",
30675     "examples": [
30676       {
30677         "title": "Example usage:",
30678         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30679         "type": "json"
30680       }
30681     ],
30682     "name": "ShowDial_Reports",
30683     "group": "Voice_Dial_Reports",
30684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30685     "version": "0.0.0",
30686     "filename": "server/api/voiceDialReport/index.js",
30687     "groupTitle": "Voice_Dial_Reports"
30688   },
30689   {
30690     "type": "delete",
30691     "url": "/api/voice/extensions/{id}",
30692     "title": "Deletes a Extension",
30693     "examples": [
30694       {
30695         "title": "Example usage:",
30696         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30697         "type": "json"
30698       }
30699     ],
30700     "name": "DeleteExtensions",
30701     "group": "Voice_Extensions",
30702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30703     "version": "0.0.0",
30704     "filename": "server/api/voiceExtension/index.js",
30705     "groupTitle": "Voice_Extensions"
30706   },
30707   {
30708     "type": "get",
30709     "url": "/api/voice/extensions",
30710     "title": "Gets a list of Extensions",
30711     "examples": [
30712       {
30713         "title": "Example usage:",
30714         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30715         "type": "json"
30716       }
30717     ],
30718     "name": "GetExtensions",
30719     "group": "Voice_Extensions",
30720     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/extensions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/extensions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/extensions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/extensions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/extensions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30721     "version": "0.0.0",
30722     "filename": "server/api/voiceExtension/index.js",
30723     "groupTitle": "Voice_Extensions"
30724   },
30725   {
30726     "type": "get",
30727     "url": "/api/voice/extensions/{id}",
30728     "title": "Gets a single Extension",
30729     "examples": [
30730       {
30731         "title": "Example usage:",
30732         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30733         "type": "json"
30734       }
30735     ],
30736     "name": "ShowExtensions",
30737     "group": "Voice_Extensions",
30738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30739     "version": "0.0.0",
30740     "filename": "server/api/voiceExtension/index.js",
30741     "groupTitle": "Voice_Extensions"
30742   },
30743   {
30744     "type": "post",
30745     "url": "/api/voice/extensions",
30746     "title": "Create new applications",
30747     "examples": [
30748       {
30749         "title": "Example usage:",
30750         "content": "curl https://{domain}/api/voice/extensions/{id}/applications -d '[{\"app\": \"Set\", \"appdata\": \"CALLERDNID=${CALLER(dnid)}\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30751         "type": "json"
30752       }
30753     ],
30754     "name": "addApplications",
30755     "group": "Voice_Extensions",
30756     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30757     "version": "0.0.0",
30758     "filename": "server/api/voiceExtension/index.js",
30759     "groupTitle": "Voice_Extensions"
30760   },
30761   {
30762     "type": "post",
30763     "url": "/api/voice/extensions",
30764     "title": "Create an extension",
30765     "examples": [
30766       {
30767         "title": "Example usage:",
30768         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30769         "type": "json"
30770       }
30771     ],
30772     "name": "create",
30773     "group": "Voice_Extensions",
30774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30775     "version": "0.0.0",
30776     "filename": "server/api/voiceExtension/index.js",
30777     "groupTitle": "Voice_Extensions"
30778   },
30779   {
30780     "type": "put",
30781     "url": "/api/voice/extensions/{id}",
30782     "title": "Update an extension",
30783     "examples": [
30784       {
30785         "title": "Example usage:",
30786         "content": "curl https://{domain}/api/voice/extensions/{id} -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
30787         "type": "json"
30788       }
30789     ],
30790     "name": "update",
30791     "group": "Voice_Extensions",
30792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30793     "version": "0.0.0",
30794     "filename": "server/api/voiceExtension/index.js",
30795     "groupTitle": "Voice_Extensions"
30796   },
30797   {
30798     "type": "post",
30799     "url": "/api/voice/mohs",
30800     "title": "Create a new a new MOH",
30801     "examples": [
30802       {
30803         "title": "Example usage:",
30804         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30805         "type": "json"
30806       }
30807     ],
30808     "name": "AddMoh",
30809     "group": "Voice_MOHs",
30810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30811     "version": "0.0.0",
30812     "filename": "server/api/voiceMusicOnHold/index.js",
30813     "groupTitle": "Voice_MOHs"
30814   },
30815   {
30816     "type": "post",
30817     "url": "/api/voice/mohs/{id}/sounds",
30818     "title": "Add sound to MOH",
30819     "examples": [
30820       {
30821         "title": "Example usage:",
30822         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30823         "type": "json"
30824       }
30825     ],
30826     "name": "AddSound",
30827     "group": "Voice_MOHs",
30828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30829     "version": "0.0.0",
30830     "filename": "server/api/voiceMusicOnHold/index.js",
30831     "groupTitle": "Voice_MOHs"
30832   },
30833   {
30834     "type": "delete",
30835     "url": "/api/voice/mohs/{id}",
30836     "title": "Deletes an MOH",
30837     "examples": [
30838       {
30839         "title": "Example usage:",
30840         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30841         "type": "json"
30842       }
30843     ],
30844     "name": "DestroyMoh",
30845     "group": "Voice_MOHs",
30846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30847     "version": "0.0.0",
30848     "filename": "server/api/voiceMusicOnHold/index.js",
30849     "groupTitle": "Voice_MOHs"
30850   },
30851   {
30852     "type": "get",
30853     "url": "/api/voice/mohs",
30854     "title": "Gets a list of Music On Holds",
30855     "examples": [
30856       {
30857         "title": "Example usage:",
30858         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30859         "type": "json"
30860       }
30861     ],
30862     "name": "GetMusic_On_Holds",
30863     "group": "Voice_MOHs",
30864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mohs?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mohs?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mohs?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mohs?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mohs?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30865     "version": "0.0.0",
30866     "filename": "server/api/voiceMusicOnHold/index.js",
30867     "groupTitle": "Voice_MOHs"
30868   },
30869   {
30870     "type": "get",
30871     "url": "/api/voice/mohs/{id}/sounds",
30872     "title": "Gets sounds from MOH",
30873     "examples": [
30874       {
30875         "title": "Example usage:",
30876         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30877         "type": "json"
30878       }
30879     ],
30880     "name": "GetSounds",
30881     "group": "Voice_MOHs",
30882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30883     "version": "0.0.0",
30884     "filename": "server/api/voiceMusicOnHold/index.js",
30885     "groupTitle": "Voice_MOHs"
30886   },
30887   {
30888     "type": "delete",
30889     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30890     "title": "Remove sound from MOH",
30891     "examples": [
30892       {
30893         "title": "Example usage:",
30894         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30895         "type": "json"
30896       }
30897     ],
30898     "name": "RemoveSound",
30899     "group": "Voice_MOHs",
30900     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30901     "version": "0.0.0",
30902     "filename": "server/api/voiceMusicOnHold/index.js",
30903     "groupTitle": "Voice_MOHs"
30904   },
30905   {
30906     "type": "get",
30907     "url": "/api/voice/mohs/{id}",
30908     "title": "Gets a single Music On Hold",
30909     "examples": [
30910       {
30911         "title": "Example usage:",
30912         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30913         "type": "json"
30914       }
30915     ],
30916     "name": "ShowMusic_On_Holds",
30917     "group": "Voice_MOHs",
30918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30919     "version": "0.0.0",
30920     "filename": "server/api/voiceMusicOnHold/index.js",
30921     "groupTitle": "Voice_MOHs"
30922   },
30923   {
30924     "type": "put",
30925     "url": "/api/voice/mohs/{id}",
30926     "title": "Update an existing Music On Hold",
30927     "examples": [
30928       {
30929         "title": "Example usage:",
30930         "content": "curl https://{domain}/api/voice/mohs/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30931         "type": "json"
30932       }
30933     ],
30934     "name": "updateMusic_On_Holds",
30935     "group": "Voice_MOHs",
30936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30937     "version": "0.0.0",
30938     "filename": "server/api/voiceMusicOnHold/index.js",
30939     "groupTitle": "Voice_MOHs"
30940   },
30941   {
30942     "type": "post",
30943     "url": "/api/voice/mails",
30944     "title": "Creates a new Mail",
30945     "examples": [
30946       {
30947         "title": "Example usage:",
30948         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30949         "type": "json"
30950       }
30951     ],
30952     "name": "CreateMails",
30953     "group": "Voice_Mails",
30954     "parameter": {
30955       "fields": {
30956         "Body": [
30957           {
30958             "group": "Body",
30959             "type": "String",
30960             "optional": true,
30961             "field": "customer_id",
30962             "description": ""
30963           },
30964           {
30965             "group": "Body",
30966             "type": "String",
30967             "optional": true,
30968             "field": "context",
30969             "description": ""
30970           },
30971           {
30972             "group": "Body",
30973             "type": "String",
30974             "optional": false,
30975             "field": "mailbox",
30976             "description": ""
30977           },
30978           {
30979             "group": "Body",
30980             "type": "String",
30981             "optional": true,
30982             "field": "password",
30983             "description": ""
30984           },
30985           {
30986             "group": "Body",
30987             "type": "String",
30988             "optional": true,
30989             "field": "fullname",
30990             "description": ""
30991           },
30992           {
30993             "group": "Body",
30994             "type": "String",
30995             "optional": true,
30996             "field": "email",
30997             "description": ""
30998           },
30999           {
31000             "group": "Body",
31001             "type": "String",
31002             "optional": true,
31003             "field": "pager",
31004             "description": ""
31005           },
31006           {
31007             "group": "Body",
31008             "type": "String",
31009             "optional": true,
31010             "field": "tz",
31011             "description": ""
31012           },
31013           {
31014             "group": "Body",
31015             "type": "String",
31016             "allowedValues": [
31017               "\"yes\"",
31018               "\"no\""
31019             ],
31020             "optional": false,
31021             "field": "attach",
31022             "description": ""
31023           },
31024           {
31025             "group": "Body",
31026             "type": "String",
31027             "allowedValues": [
31028               "\"yes\"",
31029               "\"no\""
31030             ],
31031             "optional": false,
31032             "field": "saycid",
31033             "description": ""
31034           },
31035           {
31036             "group": "Body",
31037             "type": "String",
31038             "optional": true,
31039             "field": "dialout",
31040             "description": ""
31041           },
31042           {
31043             "group": "Body",
31044             "type": "String",
31045             "optional": true,
31046             "field": "callback",
31047             "description": ""
31048           },
31049           {
31050             "group": "Body",
31051             "type": "String",
31052             "allowedValues": [
31053               "\"yes\"",
31054               "\"no\""
31055             ],
31056             "optional": false,
31057             "field": "review",
31058             "description": ""
31059           },
31060           {
31061             "group": "Body",
31062             "type": "String",
31063             "allowedValues": [
31064               "\"yes\"",
31065               "\"no\""
31066             ],
31067             "optional": false,
31068             "field": "operator",
31069             "description": ""
31070           },
31071           {
31072             "group": "Body",
31073             "type": "String",
31074             "allowedValues": [
31075               "\"yes\"",
31076               "\"no\""
31077             ],
31078             "optional": false,
31079             "field": "envelope",
31080             "description": ""
31081           },
31082           {
31083             "group": "Body",
31084             "type": "String",
31085             "allowedValues": [
31086               "\"yes\"",
31087               "\"no\""
31088             ],
31089             "optional": false,
31090             "field": "sayduration",
31091             "description": ""
31092           },
31093           {
31094             "group": "Body",
31095             "type": "String",
31096             "optional": false,
31097             "field": "saydurationm",
31098             "description": ""
31099           },
31100           {
31101             "group": "Body",
31102             "type": "String",
31103             "allowedValues": [
31104               "\"yes\"",
31105               "\"no\""
31106             ],
31107             "optional": false,
31108             "field": "sendvoicemail",
31109             "description": ""
31110           },
31111           {
31112             "group": "Body",
31113             "type": "String",
31114             "allowedValues": [
31115               "\"yes\"",
31116               "\"no\""
31117             ],
31118             "optional": false,
31119             "field": "delete",
31120             "description": ""
31121           },
31122           {
31123             "group": "Body",
31124             "type": "String",
31125             "allowedValues": [
31126               "\"yes\"",
31127               "\"no\""
31128             ],
31129             "optional": false,
31130             "field": "nextaftercmd",
31131             "description": ""
31132           },
31133           {
31134             "group": "Body",
31135             "type": "String",
31136             "allowedValues": [
31137               "\"yes\"",
31138               "\"no\""
31139             ],
31140             "optional": false,
31141             "field": "forcename",
31142             "description": ""
31143           },
31144           {
31145             "group": "Body",
31146             "type": "String",
31147             "allowedValues": [
31148               "\"yes\"",
31149               "\"no\""
31150             ],
31151             "optional": false,
31152             "field": "forcegreetings",
31153             "description": ""
31154           },
31155           {
31156             "group": "Body",
31157             "type": "String",
31158             "allowedValues": [
31159               "\"yes\"",
31160               "\"no\""
31161             ],
31162             "optional": false,
31163             "field": "hidefromdir",
31164             "description": ""
31165           },
31166           {
31167             "group": "Body",
31168             "type": "String",
31169             "optional": true,
31170             "field": "stamp",
31171             "description": ""
31172           },
31173           {
31174             "group": "Body",
31175             "type": "String",
31176             "optional": true,
31177             "field": "emailsubject",
31178             "description": ""
31179           },
31180           {
31181             "group": "Body",
31182             "type": "String",
31183             "optional": true,
31184             "field": "emailbody",
31185             "description": ""
31186           },
31187           {
31188             "group": "Body",
31189             "type": "Integer",
31190             "optional": false,
31191             "field": "maxsecs",
31192             "description": ""
31193           },
31194           {
31195             "group": "Body",
31196             "type": "Integer",
31197             "optional": false,
31198             "field": "maxmsg",
31199             "description": ""
31200           },
31201           {
31202             "group": "Body",
31203             "type": "Virtual",
31204             "optional": true,
31205             "field": "name",
31206             "description": ""
31207           }
31208         ]
31209       }
31210     },
31211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31212     "version": "0.0.0",
31213     "filename": "server/api/voiceMail/index.js",
31214     "groupTitle": "Voice_Mails"
31215   },
31216   {
31217     "type": "delete",
31218     "url": "/api/voice/mails/{id}",
31219     "title": "Deletes a Mail",
31220     "examples": [
31221       {
31222         "title": "Example usage:",
31223         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31224         "type": "json"
31225       }
31226     ],
31227     "name": "DeleteMails",
31228     "group": "Voice_Mails",
31229     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31230     "version": "0.0.0",
31231     "filename": "server/api/voiceMail/index.js",
31232     "groupTitle": "Voice_Mails"
31233   },
31234   {
31235     "type": "get",
31236     "url": "/api/voice/mails",
31237     "title": "Gets a list of Mails",
31238     "examples": [
31239       {
31240         "title": "Example usage:",
31241         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31242         "type": "json"
31243       }
31244     ],
31245     "name": "GetMails",
31246     "group": "Voice_Mails",
31247     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31248     "version": "0.0.0",
31249     "filename": "server/api/voiceMail/index.js",
31250     "groupTitle": "Voice_Mails"
31251   },
31252   {
31253     "type": "get",
31254     "url": "/api/voice/mails/{id}",
31255     "title": "Gets a single Mail",
31256     "examples": [
31257       {
31258         "title": "Example usage:",
31259         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31260         "type": "json"
31261       }
31262     ],
31263     "name": "ShowMails",
31264     "group": "Voice_Mails",
31265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31266     "version": "0.0.0",
31267     "filename": "server/api/voiceMail/index.js",
31268     "groupTitle": "Voice_Mails"
31269   },
31270   {
31271     "type": "get",
31272     "url": "/api/voice/mails/{id}/messages",
31273     "title": "Gets voice mail messages",
31274     "examples": [
31275       {
31276         "title": "Example usage:",
31277         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31278         "type": "json"
31279       }
31280     ],
31281     "name": "getMessages",
31282     "group": "Voice_Mails",
31283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31284     "version": "0.0.0",
31285     "filename": "server/api/voiceMail/index.js",
31286     "groupTitle": "Voice_Mails"
31287   },
31288   {
31289     "type": "put",
31290     "url": "/api/voice/mails/{id}",
31291     "title": "Update an existing Mail",
31292     "examples": [
31293       {
31294         "title": "Example usage:",
31295         "content": "curl https://{domain}/api/voice/mails/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31296         "type": "json"
31297       }
31298     ],
31299     "name": "updateMails",
31300     "group": "Voice_Mails",
31301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31302     "version": "0.0.0",
31303     "filename": "server/api/voiceMail/index.js",
31304     "groupTitle": "Voice_Mails"
31305   },
31306   {
31307     "type": "post",
31308     "url": "/api/voice/mails/messages",
31309     "title": "Creates a new Message",
31310     "examples": [
31311       {
31312         "title": "Example usage:",
31313         "content": "curl https://{domain}/api/voice/mails/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31314         "type": "json"
31315       }
31316     ],
31317     "name": "CreateMessages",
31318     "group": "Voice_Messages",
31319     "parameter": {
31320       "fields": {
31321         "Body": [
31322           {
31323             "group": "Body",
31324             "type": "Virtual",
31325             "optional": true,
31326             "field": "name",
31327             "description": ""
31328           },
31329           {
31330             "group": "Body",
31331             "type": "Integer",
31332             "optional": false,
31333             "field": "msgnum",
31334             "description": ""
31335           },
31336           {
31337             "group": "Body",
31338             "type": "String",
31339             "optional": true,
31340             "field": "dir",
31341             "description": ""
31342           },
31343           {
31344             "group": "Body",
31345             "type": "String",
31346             "optional": true,
31347             "field": "context",
31348             "description": ""
31349           },
31350           {
31351             "group": "Body",
31352             "type": "String",
31353             "optional": true,
31354             "field": "macrocontext",
31355             "description": ""
31356           },
31357           {
31358             "group": "Body",
31359             "type": "String",
31360             "optional": true,
31361             "field": "callerid",
31362             "description": ""
31363           },
31364           {
31365             "group": "Body",
31366             "type": "String",
31367             "optional": true,
31368             "field": "origtime",
31369             "description": ""
31370           },
31371           {
31372             "group": "Body",
31373             "type": "String",
31374             "optional": true,
31375             "field": "duration",
31376             "description": ""
31377           },
31378           {
31379             "group": "Body",
31380             "type": "String",
31381             "optional": true,
31382             "field": "mailboxuser",
31383             "description": ""
31384           },
31385           {
31386             "group": "Body",
31387             "type": "String",
31388             "optional": true,
31389             "field": "mailboxcontext",
31390             "description": ""
31391           },
31392           {
31393             "group": "Body",
31394             "type": "Blob",
31395             "optional": true,
31396             "field": "recording",
31397             "description": ""
31398           },
31399           {
31400             "group": "Body",
31401             "type": "String",
31402             "optional": true,
31403             "field": "flag",
31404             "description": ""
31405           },
31406           {
31407             "group": "Body",
31408             "type": "String",
31409             "optional": true,
31410             "field": "msg_id",
31411             "description": ""
31412           },
31413           {
31414             "group": "Body",
31415             "type": "String",
31416             "optional": true,
31417             "field": "stamp",
31418             "description": ""
31419           }
31420         ]
31421       }
31422     },
31423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31424     "version": "0.0.0",
31425     "filename": "server/api/voiceMailMessage/index.js",
31426     "groupTitle": "Voice_Messages"
31427   },
31428   {
31429     "type": "delete",
31430     "url": "/api/voice/mails/messages/{id}",
31431     "title": "Deletes a Message",
31432     "examples": [
31433       {
31434         "title": "Example usage:",
31435         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31436         "type": "json"
31437       }
31438     ],
31439     "name": "DeleteMessages",
31440     "group": "Voice_Messages",
31441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31442     "version": "0.0.0",
31443     "filename": "server/api/voiceMailMessage/index.js",
31444     "groupTitle": "Voice_Messages"
31445   },
31446   {
31447     "type": "get",
31448     "url": "/api/voice/mails/messages",
31449     "title": "Gets a list of Messages",
31450     "examples": [
31451       {
31452         "title": "Example usage:",
31453         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31454         "type": "json"
31455       }
31456     ],
31457     "name": "GetMessages",
31458     "group": "Voice_Messages",
31459     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31460     "version": "0.0.0",
31461     "filename": "server/api/voiceMailMessage/index.js",
31462     "groupTitle": "Voice_Messages"
31463   },
31464   {
31465     "type": "get",
31466     "url": "/api/voice/mails/messages/{id}",
31467     "title": "Gets a single Message",
31468     "examples": [
31469       {
31470         "title": "Example usage:",
31471         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31472         "type": "json"
31473       }
31474     ],
31475     "name": "ShowMessages",
31476     "group": "Voice_Messages",
31477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31478     "version": "0.0.0",
31479     "filename": "server/api/voiceMailMessage/index.js",
31480     "groupTitle": "Voice_Messages"
31481   },
31482   {
31483     "type": "get",
31484     "url": "voice/mails/messages/{id}/download",
31485     "title": "Download Voice Message",
31486     "examples": [
31487       {
31488         "title": "Example usage:",
31489         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31490         "type": "json"
31491       }
31492     ],
31493     "name": "download",
31494     "group": "Voice_Messages",
31495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31496     "version": "0.0.0",
31497     "filename": "server/api/voiceMailMessage/index.js",
31498     "groupTitle": "Voice_Messages"
31499   },
31500   {
31501     "type": "put",
31502     "url": "/api/voice/mails/messages/{id}",
31503     "title": "Update an existing Message",
31504     "examples": [
31505       {
31506         "title": "Example usage:",
31507         "content": "curl https://{domain}/api/voice/mails/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31508         "type": "json"
31509       }
31510     ],
31511     "name": "updateMessages",
31512     "group": "Voice_Messages",
31513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31514     "version": "0.0.0",
31515     "filename": "server/api/voiceMailMessage/index.js",
31516     "groupTitle": "Voice_Messages"
31517   },
31518   {
31519     "type": "post",
31520     "url": "/api/voice/prefixes/{id}/teams",
31521     "title": "Add teams to voice prefix",
31522     "examples": [
31523       {
31524         "title": "Example usage:",
31525         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31526         "type": "json"
31527       }
31528     ],
31529     "name": "AddTeams",
31530     "group": "Voice_Prefix",
31531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31532     "version": "0.0.0",
31533     "filename": "server/api/voicePrefix/index.js",
31534     "groupTitle": "Voice_Prefix"
31535   },
31536   {
31537     "type": "get",
31538     "url": "/api/voice/prefixes/{id}/teams",
31539     "title": "Gets voice prefix team",
31540     "examples": [
31541       {
31542         "title": "Example usage:",
31543         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
31544         "type": "json"
31545       }
31546     ],
31547     "name": "GetTeams",
31548     "group": "Voice_Prefix",
31549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31550     "version": "0.0.0",
31551     "filename": "server/api/voicePrefix/index.js",
31552     "groupTitle": "Voice_Prefix"
31553   },
31554   {
31555     "type": "post",
31556     "url": "/api/voice/prefixes/{id}/users",
31557     "title": "Add agents to a prefix",
31558     "examples": [
31559       {
31560         "title": "Example usage:",
31561         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31562         "type": "json"
31563       }
31564     ],
31565     "name": "AddAgents",
31566     "group": "Voice_Prefixes",
31567     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31568     "version": "0.0.0",
31569     "filename": "server/api/voicePrefix/index.js",
31570     "groupTitle": "Voice_Prefixes"
31571   },
31572   {
31573     "type": "delete",
31574     "url": "/api/voice/prefixes/{id}",
31575     "title": "Deletes a Prefix",
31576     "examples": [
31577       {
31578         "title": "Example usage:",
31579         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31580         "type": "json"
31581       }
31582     ],
31583     "name": "DeletePrefixes",
31584     "group": "Voice_Prefixes",
31585     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31586     "version": "0.0.0",
31587     "filename": "server/api/voicePrefix/index.js",
31588     "groupTitle": "Voice_Prefixes"
31589   },
31590   {
31591     "type": "get",
31592     "url": "/api/voice/prefixes/describe",
31593     "title": "Gets table info about Prefixes",
31594     "examples": [
31595       {
31596         "title": "Example usage:",
31597         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31598         "type": "json"
31599       }
31600     ],
31601     "name": "DescribePrefixes",
31602     "group": "Voice_Prefixes",
31603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31604     "version": "0.0.0",
31605     "filename": "server/api/voicePrefix/index.js",
31606     "groupTitle": "Voice_Prefixes"
31607   },
31608   {
31609     "type": "get",
31610     "url": "/api/voice/prefixes/{id}/users",
31611     "title": "Gets agents from prefix",
31612     "examples": [
31613       {
31614         "title": "Example usage:",
31615         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31616         "type": "json"
31617       }
31618     ],
31619     "name": "GetAgents",
31620     "group": "Voice_Prefixes",
31621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31622     "version": "0.0.0",
31623     "filename": "server/api/voicePrefix/index.js",
31624     "groupTitle": "Voice_Prefixes"
31625   },
31626   {
31627     "type": "get",
31628     "url": "/api/voice/prefixes",
31629     "title": "Gets a list of Prefixes",
31630     "examples": [
31631       {
31632         "title": "Example usage:",
31633         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31634         "type": "json"
31635       }
31636     ],
31637     "name": "GetPrefixes",
31638     "group": "Voice_Prefixes",
31639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/prefixes?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/prefixes?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/prefixes?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/prefixes?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/prefixes?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31640     "version": "0.0.0",
31641     "filename": "server/api/voicePrefix/index.js",
31642     "groupTitle": "Voice_Prefixes"
31643   },
31644   {
31645     "type": "delete",
31646     "url": "/api/voice/prefixes/{id}/users",
31647     "title": "Removes agents from a prefix",
31648     "examples": [
31649       {
31650         "title": "Example usage:",
31651         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31652         "type": "json"
31653       }
31654     ],
31655     "name": "RemoveAgents",
31656     "group": "Voice_Prefixes",
31657     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31658     "version": "0.0.0",
31659     "filename": "server/api/voicePrefix/index.js",
31660     "groupTitle": "Voice_Prefixes"
31661   },
31662   {
31663     "type": "get",
31664     "url": "/api/voice/prefixes/{id}",
31665     "title": "Gets a single Prefix",
31666     "examples": [
31667       {
31668         "title": "Example usage:",
31669         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31670         "type": "json"
31671       }
31672     ],
31673     "name": "ShowPrefixes",
31674     "group": "Voice_Prefixes",
31675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31676     "version": "0.0.0",
31677     "filename": "server/api/voicePrefix/index.js",
31678     "groupTitle": "Voice_Prefixes"
31679   },
31680   {
31681     "type": "put",
31682     "url": "/api/voice/prefixes/{id}",
31683     "title": "Update an existing prefix",
31684     "examples": [
31685       {
31686         "title": "Example usage:",
31687         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31688         "type": "json"
31689       }
31690     ],
31691     "name": "Update",
31692     "group": "Voice_Prefixes",
31693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31694     "version": "0.0.0",
31695     "filename": "server/api/voicePrefix/index.js",
31696     "groupTitle": "Voice_Prefixes"
31697   },
31698   {
31699     "type": "post",
31700     "url": "/api/voice/prefixes",
31701     "title": "Create a prefix",
31702     "examples": [
31703       {
31704         "title": "Example usage:",
31705         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31706         "type": "json"
31707       }
31708     ],
31709     "name": "create",
31710     "group": "Voice_Prefixes",
31711     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31712     "version": "0.0.0",
31713     "filename": "server/api/voicePrefix/index.js",
31714     "groupTitle": "Voice_Prefixes"
31715   },
31716   {
31717     "type": "get",
31718     "url": "/api/voice/queues/reports/describe",
31719     "title": "Gets table info about Queue Reports",
31720     "examples": [
31721       {
31722         "title": "Example usage:",
31723         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31724         "type": "json"
31725       }
31726     ],
31727     "name": "DescribeQueue_Reports",
31728     "group": "Voice_Queue_Reports",
31729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31730     "version": "0.0.0",
31731     "filename": "server/api/voiceQueueReport/index.js",
31732     "groupTitle": "Voice_Queue_Reports"
31733   },
31734   {
31735     "type": "get",
31736     "url": "/api/voice/queues/reports",
31737     "title": "Gets a list of Queue Reports",
31738     "examples": [
31739       {
31740         "title": "Example usage:",
31741         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31742         "type": "json"
31743       }
31744     ],
31745     "name": "GetQueue_Reports",
31746     "group": "Voice_Queue_Reports",
31747     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31748     "version": "0.0.0",
31749     "filename": "server/api/voiceQueueReport/index.js",
31750     "groupTitle": "Voice_Queue_Reports"
31751   },
31752   {
31753     "type": "get",
31754     "url": "/api/voice/queues/reports/{id}",
31755     "title": "Gets a single Queue Report",
31756     "examples": [
31757       {
31758         "title": "Example usage:",
31759         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31760         "type": "json"
31761       }
31762     ],
31763     "name": "ShowQueue_Reports",
31764     "group": "Voice_Queue_Reports",
31765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31766     "version": "0.0.0",
31767     "filename": "server/api/voiceQueueReport/index.js",
31768     "groupTitle": "Voice_Queue_Reports"
31769   },
31770   {
31771     "type": "get",
31772     "url": "/api/voice/queues/reports/index",
31773     "title": "Get Voice Queues Report",
31774     "examples": [
31775       {
31776         "title": "Example usage:",
31777         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31778         "type": "json"
31779       }
31780     ],
31781     "name": "getVoiceQueuesReport",
31782     "group": "Voice_Queue_Reports",
31783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31784     "version": "0.0.0",
31785     "filename": "server/api/voiceQueueReport/index.js",
31786     "groupTitle": "Voice_Queue_Reports"
31787   },
31788   {
31789     "type": "post",
31790     "url": "/api/voice/queues/{id}/users",
31791     "title": "Add agents to queue",
31792     "examples": [
31793       {
31794         "title": "Example usage:",
31795         "content": "curl https://{domain}/api/voice/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31796         "type": "json"
31797       }
31798     ],
31799     "name": "AddAgents",
31800     "group": "Voice_Queues",
31801     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31802     "version": "0.0.0",
31803     "filename": "server/api/voiceQueue/index.js",
31804     "groupTitle": "Voice_Queues"
31805   },
31806   {
31807     "type": "post",
31808     "url": "/api/voice/queues/{id}/blacklists",
31809     "title": "Add blacklists to a queue",
31810     "examples": [
31811       {
31812         "title": "Example usage:",
31813         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31814         "type": "json"
31815       }
31816     ],
31817     "name": "AddBlackLists",
31818     "group": "Voice_Queues",
31819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31820     "version": "0.0.0",
31821     "filename": "server/api/voiceQueue/index.js",
31822     "groupTitle": "Voice_Queues"
31823   },
31824   {
31825     "type": "post",
31826     "url": "/api/voice/queues/{id}/lists",
31827     "title": "Add lists to a queue",
31828     "examples": [
31829       {
31830         "title": "Example usage:",
31831         "content": "curl https://{domain}/api/voice/queues/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31832         "type": "json"
31833       }
31834     ],
31835     "name": "AddLists",
31836     "group": "Voice_Queues",
31837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31838     "version": "0.0.0",
31839     "filename": "server/api/voiceQueue/index.js",
31840     "groupTitle": "Voice_Queues"
31841   },
31842   {
31843     "type": "post",
31844     "url": "/api/voice/queues/{id}/teams",
31845     "title": "Add teams to queue",
31846     "examples": [
31847       {
31848         "title": "Example usage:",
31849         "content": "curl https://{domain}/api/voice/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31850         "type": "json"
31851       }
31852     ],
31853     "name": "AddTeams",
31854     "group": "Voice_Queues",
31855     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31856     "version": "0.0.0",
31857     "filename": "server/api/voiceQueue/index.js",
31858     "groupTitle": "Voice_Queues"
31859   },
31860   {
31861     "type": "post",
31862     "url": "/api/voice/queues/clone",
31863     "title": "Clone an existing Queue",
31864     "examples": [
31865       {
31866         "title": "Example usage:",
31867         "content": "curl https://{domain}/api/voice/queues/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31868         "type": "json"
31869       }
31870     ],
31871     "name": "CloneQueues",
31872     "group": "Voice_Queues",
31873     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31874     "version": "0.0.0",
31875     "filename": "server/api/voiceQueue/index.js",
31876     "groupTitle": "Voice_Queues"
31877   },
31878   {
31879     "type": "post",
31880     "url": "/api/voice/queues",
31881     "title": "Creates a new Queue",
31882     "examples": [
31883       {
31884         "title": "Example usage:",
31885         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31886         "type": "json"
31887       }
31888     ],
31889     "name": "CreateQueues",
31890     "group": "Voice_Queues",
31891     "parameter": {
31892       "fields": {
31893         "Body": [
31894           {
31895             "group": "Body",
31896             "type": "String",
31897             "optional": false,
31898             "field": "name",
31899             "description": ""
31900           },
31901           {
31902             "group": "Body",
31903             "type": "String",
31904             "allowedValues": [
31905               "\"inbound\"",
31906               "\"outbound\""
31907             ],
31908             "optional": false,
31909             "field": "type",
31910             "description": ""
31911           },
31912           {
31913             "group": "Body",
31914             "type": "String",
31915             "optional": true,
31916             "field": "musiconhold",
31917             "description": ""
31918           },
31919           {
31920             "group": "Body",
31921             "type": "String",
31922             "optional": true,
31923             "field": "announce",
31924             "description": ""
31925           },
31926           {
31927             "group": "Body",
31928             "type": "String",
31929             "allowedValues": [
31930               "\"rr\"",
31931               "\"ringall\"",
31932               "\"leastrecent\"",
31933               "\"fewestcalls\"",
31934               "\"random\"",
31935               "\"rrmemory\"",
31936               "\"linear\"",
31937               "\"wrandom\"",
31938               "\"rrordered\""
31939             ],
31940             "optional": false,
31941             "field": "strategy",
31942             "description": ""
31943           },
31944           {
31945             "group": "Body",
31946             "type": "Integer",
31947             "optional": true,
31948             "field": "servicelevel",
31949             "description": ""
31950           },
31951           {
31952             "group": "Body",
31953             "type": "String",
31954             "optional": true,
31955             "field": "context",
31956             "description": ""
31957           },
31958           {
31959             "group": "Body",
31960             "type": "Integer",
31961             "optional": true,
31962             "field": "penaltymemberslimit",
31963             "description": ""
31964           },
31965           {
31966             "group": "Body",
31967             "type": "Integer",
31968             "optional": true,
31969             "field": "timeout",
31970             "description": ""
31971           },
31972           {
31973             "group": "Body",
31974             "type": "Integer",
31975             "optional": true,
31976             "field": "retry",
31977             "description": ""
31978           },
31979           {
31980             "group": "Body",
31981             "type": "String",
31982             "optional": true,
31983             "field": "timeoutpriority",
31984             "description": ""
31985           },
31986           {
31987             "group": "Body",
31988             "type": "Integer",
31989             "optional": true,
31990             "field": "weight",
31991             "description": ""
31992           },
31993           {
31994             "group": "Body",
31995             "type": "Integer",
31996             "optional": true,
31997             "field": "wrapuptime",
31998             "description": ""
31999           },
32000           {
32001             "group": "Body",
32002             "type": "String",
32003             "allowedValues": [
32004               "\"yes\"",
32005               "\"no\""
32006             ],
32007             "optional": true,
32008             "field": "autofill",
32009             "description": ""
32010           },
32011           {
32012             "group": "Body",
32013             "type": "String",
32014             "allowedValues": [
32015               "\"yes\"",
32016               "\"no\"",
32017               "\"all\""
32018             ],
32019             "optional": true,
32020             "field": "autopause",
32021             "description": ""
32022           },
32023           {
32024             "group": "Body",
32025             "type": "Integer",
32026             "optional": true,
32027             "field": "autopausedelay",
32028             "description": ""
32029           },
32030           {
32031             "group": "Body",
32032             "type": "String",
32033             "allowedValues": [
32034               "\"yes\"",
32035               "\"no\""
32036             ],
32037             "optional": true,
32038             "field": "autopausebusy",
32039             "description": ""
32040           },
32041           {
32042             "group": "Body",
32043             "type": "String",
32044             "allowedValues": [
32045               "\"yes\"",
32046               "\"no\""
32047             ],
32048             "optional": true,
32049             "field": "autopauseunavail",
32050             "description": ""
32051           },
32052           {
32053             "group": "Body",
32054             "type": "Integer",
32055             "optional": true,
32056             "field": "maxlen",
32057             "description": ""
32058           },
32059           {
32060             "group": "Body",
32061             "type": "String",
32062             "allowedValues": [
32063               "\"yes\"",
32064               "\"no\""
32065             ],
32066             "optional": true,
32067             "field": "setinterfacevar",
32068             "description": ""
32069           },
32070           {
32071             "group": "Body",
32072             "type": "String",
32073             "allowedValues": [
32074               "\"yes\"",
32075               "\"no\""
32076             ],
32077             "optional": true,
32078             "field": "setqueueentryvar",
32079             "description": ""
32080           },
32081           {
32082             "group": "Body",
32083             "type": "String",
32084             "allowedValues": [
32085               "\"yes\"",
32086               "\"no\""
32087             ],
32088             "optional": true,
32089             "field": "setqueuevar",
32090             "description": ""
32091           },
32092           {
32093             "group": "Body",
32094             "type": "String",
32095             "allowedValues": [
32096               "\"yes\"",
32097               "\"no\""
32098             ],
32099             "optional": true,
32100             "field": "eventmemberstatus",
32101             "description": ""
32102           },
32103           {
32104             "group": "Body",
32105             "type": "String",
32106             "optional": true,
32107             "field": "membermacro",
32108             "description": ""
32109           },
32110           {
32111             "group": "Body",
32112             "type": "String",
32113             "optional": true,
32114             "field": "membergosub",
32115             "description": ""
32116           },
32117           {
32118             "group": "Body",
32119             "type": "Integer",
32120             "optional": true,
32121             "field": "announce_frequency",
32122             "description": ""
32123           },
32124           {
32125             "group": "Body",
32126             "type": "Integer",
32127             "optional": true,
32128             "field": "min_announce_frequency",
32129             "description": ""
32130           },
32131           {
32132             "group": "Body",
32133             "type": "Integer",
32134             "optional": true,
32135             "field": "periodic_announce_frequency",
32136             "description": ""
32137           },
32138           {
32139             "group": "Body",
32140             "type": "String",
32141             "allowedValues": [
32142               "\"yes\"",
32143               "\"no\""
32144             ],
32145             "optional": true,
32146             "field": "random_periodic_announce",
32147             "description": ""
32148           },
32149           {
32150             "group": "Body",
32151             "type": "String",
32152             "allowedValues": [
32153               "\"yes\"",
32154               "\"no\""
32155             ],
32156             "optional": true,
32157             "field": "relative_periodic_announce",
32158             "description": ""
32159           },
32160           {
32161             "group": "Body",
32162             "type": "String",
32163             "allowedValues": [
32164               "\"yes\"",
32165               "\"no\"",
32166               "\"once\""
32167             ],
32168             "optional": true,
32169             "field": "announce_holdtime",
32170             "description": ""
32171           },
32172           {
32173             "group": "Body",
32174             "type": "String",
32175             "optional": true,
32176             "field": "announce_position",
32177             "description": ""
32178           },
32179           {
32180             "group": "Body",
32181             "type": "String",
32182             "allowedValues": [
32183               "\"yes\"",
32184               "\"no\""
32185             ],
32186             "optional": true,
32187             "field": "announce_to_first_user",
32188             "description": ""
32189           },
32190           {
32191             "group": "Body",
32192             "type": "Integer",
32193             "optional": true,
32194             "field": "announce_position_limit",
32195             "description": ""
32196           },
32197           {
32198             "group": "Body",
32199             "type": "String",
32200             "allowedValues": [
32201               "\"0\"",
32202               "\"5\"",
32203               "\"10\"",
32204               "\"15\"",
32205               "\"20\"",
32206               "\"30\""
32207             ],
32208             "optional": true,
32209             "field": "announce_round_seconds",
32210             "description": ""
32211           },
32212           {
32213             "group": "Body",
32214             "type": "String",
32215             "optional": true,
32216             "field": "monitor_format",
32217             "description": ""
32218           },
32219           {
32220             "group": "Body",
32221             "type": "String",
32222             "optional": true,
32223             "field": "monitor_type",
32224             "description": ""
32225           },
32226           {
32227             "group": "Body",
32228             "type": "String",
32229             "optional": true,
32230             "field": "queue_youarenext",
32231             "description": ""
32232           },
32233           {
32234             "group": "Body",
32235             "type": "String",
32236             "optional": true,
32237             "field": "queue_thereare",
32238             "description": ""
32239           },
32240           {
32241             "group": "Body",
32242             "type": "String",
32243             "optional": true,
32244             "field": "queue_callswaiting",
32245             "description": ""
32246           },
32247           {
32248             "group": "Body",
32249             "type": "String",
32250             "optional": true,
32251             "field": "queue_holdtime",
32252             "description": ""
32253           },
32254           {
32255             "group": "Body",
32256             "type": "String",
32257             "optional": true,
32258             "field": "queue_minute",
32259             "description": ""
32260           },
32261           {
32262             "group": "Body",
32263             "type": "String",
32264             "optional": true,
32265             "field": "queue_minutes",
32266             "description": ""
32267           },
32268           {
32269             "group": "Body",
32270             "type": "String",
32271             "optional": true,
32272             "field": "queue_seconds",
32273             "description": ""
32274           },
32275           {
32276             "group": "Body",
32277             "type": "String",
32278             "optional": true,
32279             "field": "queue_thankyou",
32280             "description": ""
32281           },
32282           {
32283             "group": "Body",
32284             "type": "String",
32285             "optional": true,
32286             "field": "queue_reporthold",
32287             "description": ""
32288           },
32289           {
32290             "group": "Body",
32291             "type": "String",
32292             "optional": true,
32293             "field": "queue_quantity1",
32294             "description": ""
32295           },
32296           {
32297             "group": "Body",
32298             "type": "String",
32299             "optional": true,
32300             "field": "queue_quantity2",
32301             "description": ""
32302           },
32303           {
32304             "group": "Body",
32305             "type": "String",
32306             "optional": true,
32307             "field": "queue_periodic_announce",
32308             "description": ""
32309           },
32310           {
32311             "group": "Body",
32312             "type": "String",
32313             "optional": true,
32314             "field": "queue_less_than",
32315             "description": ""
32316           },
32317           {
32318             "group": "Body",
32319             "type": "Text",
32320             "optional": true,
32321             "field": "periodic_announce",
32322             "description": ""
32323           },
32324           {
32325             "group": "Body",
32326             "type": "String",
32327             "optional": true,
32328             "field": "joinempty",
32329             "description": ""
32330           },
32331           {
32332             "group": "Body",
32333             "type": "String",
32334             "optional": true,
32335             "field": "leavewhenempty",
32336             "description": ""
32337           },
32338           {
32339             "group": "Body",
32340             "type": "String",
32341             "allowedValues": [
32342               "\"yes\"",
32343               "\"no\""
32344             ],
32345             "optional": true,
32346             "field": "reportholdtime",
32347             "description": ""
32348           },
32349           {
32350             "group": "Body",
32351             "type": "String",
32352             "allowedValues": [
32353               "\"yes\"",
32354               "\"no\""
32355             ],
32356             "optional": true,
32357             "field": "ringinuse",
32358             "description": ""
32359           },
32360           {
32361             "group": "Body",
32362             "type": "Integer",
32363             "optional": true,
32364             "field": "memberdelay",
32365             "description": ""
32366           },
32367           {
32368             "group": "Body",
32369             "type": "String",
32370             "allowedValues": [
32371               "\"yes\"",
32372               "\"no\""
32373             ],
32374             "optional": true,
32375             "field": "timeoutrestart",
32376             "description": ""
32377           },
32378           {
32379             "group": "Body",
32380             "type": "String",
32381             "optional": true,
32382             "field": "defaultrule",
32383             "description": ""
32384           },
32385           {
32386             "group": "Body",
32387             "type": "String",
32388             "optional": true,
32389             "field": "description",
32390             "description": ""
32391           },
32392           {
32393             "group": "Body",
32394             "type": "Boolean",
32395             "optional": true,
32396             "field": "acw",
32397             "description": ""
32398           },
32399           {
32400             "group": "Body",
32401             "type": "Integer",
32402             "optional": true,
32403             "field": "acwTimeout",
32404             "description": ""
32405           },
32406           {
32407             "group": "Body",
32408             "type": "Boolean",
32409             "optional": true,
32410             "field": "dialActive",
32411             "description": "<p>Active/Disactive Campaign</p>"
32412           },
32413           {
32414             "group": "Body",
32415             "type": "String",
32416             "allowedValues": [
32417               "\"preview\"",
32418               "\"progressive\"",
32419               "\"power\"",
32420               "\"predictive\"",
32421               "\"booked\""
32422             ],
32423             "optional": true,
32424             "field": "dialMethod",
32425             "description": "<p>Dial Method.</p>"
32426           },
32427           {
32428             "group": "Body",
32429             "type": "Integer",
32430             "optional": true,
32431             "field": "dialLimitChannel",
32432             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32433           },
32434           {
32435             "group": "Body",
32436             "type": "Integer",
32437             "optional": true,
32438             "field": "dialLimitQueue",
32439             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32440           },
32441           {
32442             "group": "Body",
32443             "type": "Float",
32444             "optional": true,
32445             "field": "dialPowerLevel",
32446             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32447           },
32448           {
32449             "group": "Body",
32450             "type": "String",
32451             "allowedValues": [
32452               "\"agentBusyFactor\"",
32453               "\"dropRate\""
32454             ],
32455             "optional": true,
32456             "field": "dialPredictiveOptimization",
32457             "description": "<p>Only for predictive method.</p>"
32458           },
32459           {
32460             "group": "Body",
32461             "type": "Float",
32462             "optional": true,
32463             "field": "dialPredictiveOptimizationPercentage",
32464             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32465           },
32466           {
32467             "group": "Body",
32468             "type": "Integer",
32469             "optional": true,
32470             "field": "dialPredictiveInterval",
32471             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32472           },
32473           {
32474             "group": "Body",
32475             "type": "String",
32476             "optional": true,
32477             "field": "dialOriginateCallerIdName",
32478             "description": ""
32479           },
32480           {
32481             "group": "Body",
32482             "type": "String",
32483             "optional": true,
32484             "field": "dialOriginateCallerIdNumber",
32485             "description": ""
32486           },
32487           {
32488             "group": "Body",
32489             "type": "Integer",
32490             "optional": true,
32491             "field": "dialOriginateTimeout",
32492             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32493           },
32494           {
32495             "group": "Body",
32496             "type": "String",
32497             "optional": true,
32498             "field": "dialQueueOptions",
32499             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32500           },
32501           {
32502             "group": "Body",
32503             "type": "Integer",
32504             "optional": true,
32505             "field": "dialQueueTimeout",
32506             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32507           },
32508           {
32509             "group": "Body",
32510             "type": "String",
32511             "optional": true,
32512             "field": "dialQueueProject",
32513             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32514           },
32515           {
32516             "group": "Body",
32517             "type": "Integer",
32518             "optional": true,
32519             "field": "dialCongestionMaxRetry",
32520             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32521           },
32522           {
32523             "group": "Body",
32524             "type": "Integer",
32525             "optional": true,
32526             "field": "dialCongestionRetryFrequency",
32527             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32528           },
32529           {
32530             "group": "Body",
32531             "type": "Integer",
32532             "optional": true,
32533             "field": "dialBusyMaxRetry",
32534             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32535           },
32536           {
32537             "group": "Body",
32538             "type": "Integer",
32539             "optional": true,
32540             "field": "dialBusyRetryFrequency",
32541             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32542           },
32543           {
32544             "group": "Body",
32545             "type": "Integer",
32546             "optional": true,
32547             "field": "dialNoAnswerMaxRetry",
32548             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32549           },
32550           {
32551             "group": "Body",
32552             "type": "Integer",
32553             "optional": true,
32554             "field": "dialNoAnswerRetryFrequency",
32555             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32556           },
32557           {
32558             "group": "Body",
32559             "type": "Integer",
32560             "optional": true,
32561             "field": "dialGlobalMaxRetry",
32562             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32563           },
32564           {
32565             "group": "Body",
32566             "type": "String",
32567             "optional": true,
32568             "field": "dialTimezone",
32569             "description": ""
32570           },
32571           {
32572             "group": "Body",
32573             "type": "String",
32574             "optional": true,
32575             "field": "dialGlobalInterval",
32576             "description": ""
32577           },
32578           {
32579             "group": "Body",
32580             "type": "String",
32581             "optional": true,
32582             "field": "dialPrefix",
32583             "description": ""
32584           },
32585           {
32586             "group": "Body",
32587             "type": "String",
32588             "allowedValues": [
32589               "\"always\"",
32590               "\"never\"",
32591               "\"onlyIfOpen\""
32592             ],
32593             "optional": true,
32594             "field": "dialCheckDuplicateType",
32595             "description": ""
32596           },
32597           {
32598             "group": "Body",
32599             "type": "Boolean",
32600             "optional": true,
32601             "field": "dialAMDActive",
32602             "description": "<p>Active/Disactive AMD</p>"
32603           },
32604           {
32605             "group": "Body",
32606             "type": "Integer",
32607             "optional": true,
32608             "field": "dialAMDInitialSilence",
32609             "description": "<p>#AMD Initial Silence</p>"
32610           },
32611           {
32612             "group": "Body",
32613             "type": "Integer",
32614             "optional": true,
32615             "field": "dialAMDGreeting",
32616             "description": "<p>#AMD Greeting</p>"
32617           },
32618           {
32619             "group": "Body",
32620             "type": "Integer",
32621             "optional": true,
32622             "field": "dialAMDAfterGreetingSilence",
32623             "description": "<p>#AMD After Greeting Silence</p>"
32624           },
32625           {
32626             "group": "Body",
32627             "type": "Integer",
32628             "optional": true,
32629             "field": "dialAMDTotalAnalysisTime",
32630             "description": "<p>#AMD Total Analysis Time</p>"
32631           },
32632           {
32633             "group": "Body",
32634             "type": "Integer",
32635             "optional": true,
32636             "field": "dialAMDMinWordLength",
32637             "description": "<p>#AMD Min Word Length</p>"
32638           },
32639           {
32640             "group": "Body",
32641             "type": "Integer",
32642             "optional": true,
32643             "field": "dialAMDBetweenWordsSilence",
32644             "description": "<p>#AMD Between Words Silence</p>"
32645           },
32646           {
32647             "group": "Body",
32648             "type": "Integer",
32649             "optional": true,
32650             "field": "dialAMDMaximumNumberOfWords",
32651             "description": "<p>#AMD Maximum Number Of Words</p>"
32652           },
32653           {
32654             "group": "Body",
32655             "type": "Integer",
32656             "optional": true,
32657             "field": "dialAMDSilenceThreshold",
32658             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32659           },
32660           {
32661             "group": "Body",
32662             "type": "Integer",
32663             "optional": true,
32664             "field": "dialAMDMaximumWordLength",
32665             "description": "<p>#AMD Maximum Word Length</p>"
32666           },
32667           {
32668             "group": "Body",
32669             "type": "Integer",
32670             "optional": true,
32671             "field": "dialRecallMeTimeout",
32672             "description": "<p>#RecallMe Timeout (min:1)</p>"
32673           },
32674           {
32675             "group": "Body",
32676             "type": "Boolean",
32677             "optional": true,
32678             "field": "dialRecallInQueue",
32679             "description": "<p>Active/Disactive Recall In Queue</p>"
32680           },
32681           {
32682             "group": "Body",
32683             "type": "String",
32684             "allowedValues": [
32685               "\"DESC\"",
32686               "\"ASC\""
32687             ],
32688             "optional": true,
32689             "field": "dialOrderByScheduledAt",
32690             "description": ""
32691           },
32692           {
32693             "group": "Body",
32694             "type": "String",
32695             "optional": true,
32696             "field": "dialQueueProject2",
32697             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32698           },
32699           {
32700             "group": "Body",
32701             "type": "Boolean",
32702             "optional": true,
32703             "field": "dialAgiAfterHangupClient",
32704             "description": ""
32705           },
32706           {
32707             "group": "Body",
32708             "type": "Boolean",
32709             "optional": true,
32710             "field": "dialAgiAfterHangupAgent",
32711             "description": ""
32712           },
32713           {
32714             "group": "Body",
32715             "type": "Integer",
32716             "optional": true,
32717             "field": "dialRandomLastDigitCallerIdNumber",
32718             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32719           },
32720           {
32721             "group": "Body",
32722             "type": "Integer",
32723             "optional": true,
32724             "field": "dialCutDigit",
32725             "description": "<p>Cut Digit (min:1, max:15)</p>"
32726           },
32727           {
32728             "group": "Body",
32729             "type": "Integer",
32730             "optional": true,
32731             "field": "dialNoSuchNumberMaxRetry",
32732             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32733           },
32734           {
32735             "group": "Body",
32736             "type": "Integer",
32737             "optional": true,
32738             "field": "dialNoSuchNumberRetryFrequency",
32739             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32740           },
32741           {
32742             "group": "Body",
32743             "type": "Integer",
32744             "optional": true,
32745             "field": "dialDropMaxRetry",
32746             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32747           },
32748           {
32749             "group": "Body",
32750             "type": "Integer",
32751             "optional": true,
32752             "field": "dialDropRetryFrequency",
32753             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32754           },
32755           {
32756             "group": "Body",
32757             "type": "Integer",
32758             "optional": true,
32759             "field": "dialAbandonedMaxRetry",
32760             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32761           },
32762           {
32763             "group": "Body",
32764             "type": "Integer",
32765             "optional": true,
32766             "field": "dialAbandonedRetryFrequency",
32767             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32768           },
32769           {
32770             "group": "Body",
32771             "type": "Integer",
32772             "optional": true,
32773             "field": "dialMachineMaxRetry",
32774             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32775           },
32776           {
32777             "group": "Body",
32778             "type": "Integer",
32779             "optional": true,
32780             "field": "dialMachineRetryFrequency",
32781             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32782           },
32783           {
32784             "group": "Body",
32785             "type": "Integer",
32786             "optional": true,
32787             "field": "dialAgentRejectMaxRetry",
32788             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32789           },
32790           {
32791             "group": "Body",
32792             "type": "Integer",
32793             "optional": true,
32794             "field": "dialAgentRejectRetryFrequency",
32795             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32796           },
32797           {
32798             "group": "Body",
32799             "type": "Integer",
32800             "optional": true,
32801             "field": "mandatoryDispositionPauseId",
32802             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32803           },
32804           {
32805             "group": "Body",
32806             "type": "Boolean",
32807             "optional": true,
32808             "field": "mandatoryDisposition",
32809             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32810           },
32811           {
32812             "group": "Body",
32813             "type": "Integer",
32814             "optional": true,
32815             "field": "dialPredictiveIntervalMaxThreshold",
32816             "description": ""
32817           },
32818           {
32819             "group": "Body",
32820             "type": "Integer",
32821             "optional": true,
32822             "field": "dialPredictiveIntervalMinThreshold",
32823             "description": ""
32824           },
32825           {
32826             "group": "Body",
32827             "type": "Boolean",
32828             "optional": true,
32829             "field": "dialPreviewAutoRecallMe",
32830             "description": ""
32831           }
32832         ]
32833       }
32834     },
32835     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32836     "version": "0.0.0",
32837     "filename": "server/api/voiceQueue/index.js",
32838     "groupTitle": "Voice_Queues"
32839   },
32840   {
32841     "type": "delete",
32842     "url": "/api/voice/queues/{id}",
32843     "title": "Deletes a Queue",
32844     "examples": [
32845       {
32846         "title": "Example usage:",
32847         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32848         "type": "json"
32849       }
32850     ],
32851     "name": "DeleteQueues",
32852     "group": "Voice_Queues",
32853     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32854     "version": "0.0.0",
32855     "filename": "server/api/voiceQueue/index.js",
32856     "groupTitle": "Voice_Queues"
32857   },
32858   {
32859     "type": "get",
32860     "url": "/api/voice/queues/{id}/users",
32861     "title": "Gets queue agents",
32862     "examples": [
32863       {
32864         "title": "Example usage:",
32865         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32866         "type": "json"
32867       }
32868     ],
32869     "name": "GetAgents",
32870     "group": "Voice_Queues",
32871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32872     "version": "0.0.0",
32873     "filename": "server/api/voiceQueue/index.js",
32874     "groupTitle": "Voice_Queues"
32875   },
32876   {
32877     "type": "get",
32878     "url": "/api/voice/queues/{id}/blacklists",
32879     "title": "Get queue blacklists",
32880     "examples": [
32881       {
32882         "title": "Example usage:",
32883         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32884         "type": "json"
32885       }
32886     ],
32887     "name": "GetBlackLists",
32888     "group": "Voice_Queues",
32889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32890     "version": "0.0.0",
32891     "filename": "server/api/voiceQueue/index.js",
32892     "groupTitle": "Voice_Queues"
32893   },
32894   {
32895     "type": "get",
32896     "url": "/api/voice/queues/{id}/finals",
32897     "title": "Gets queue hopper finals",
32898     "examples": [
32899       {
32900         "title": "Example usage:",
32901         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32902         "type": "json"
32903       }
32904     ],
32905     "name": "GetHopperFinals",
32906     "group": "Voice_Queues",
32907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32908     "version": "0.0.0",
32909     "filename": "server/api/voiceQueue/index.js",
32910     "groupTitle": "Voice_Queues"
32911   },
32912   {
32913     "type": "get",
32914     "url": "/api/voice/queues/{id}/hopper_histories",
32915     "title": "Gets queue hopper histories",
32916     "examples": [
32917       {
32918         "title": "Example usage:",
32919         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32920         "type": "json"
32921       }
32922     ],
32923     "name": "GetHopperHistories",
32924     "group": "Voice_Queues",
32925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32926     "version": "0.0.0",
32927     "filename": "server/api/voiceQueue/index.js",
32928     "groupTitle": "Voice_Queues"
32929   },
32930   {
32931     "type": "get",
32932     "url": "/api/voice/queues/{id}/hoppers",
32933     "title": "Gets queue hoppers",
32934     "examples": [
32935       {
32936         "title": "Example usage:",
32937         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32938         "type": "json"
32939       }
32940     ],
32941     "name": "GetHoppers",
32942     "group": "Voice_Queues",
32943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32944     "version": "0.0.0",
32945     "filename": "server/api/voiceQueue/index.js",
32946     "groupTitle": "Voice_Queues"
32947   },
32948   {
32949     "type": "get",
32950     "url": "/api/voice/queues/{id}/lists",
32951     "title": "Get queue lists",
32952     "examples": [
32953       {
32954         "title": "Example usage:",
32955         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32956         "type": "json"
32957       }
32958     ],
32959     "name": "GetLists",
32960     "group": "Voice_Queues",
32961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32962     "version": "0.0.0",
32963     "filename": "server/api/voiceQueue/index.js",
32964     "groupTitle": "Voice_Queues"
32965   },
32966   {
32967     "type": "get",
32968     "url": "/api/voice/queues/{id}/members",
32969     "title": "Gets queue members",
32970     "examples": [
32971       {
32972         "title": "Example usage:",
32973         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32974         "type": "json"
32975       }
32976     ],
32977     "name": "GetMembers",
32978     "group": "Voice_Queues",
32979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32980     "version": "0.0.0",
32981     "filename": "server/api/voiceQueue/index.js",
32982     "groupTitle": "Voice_Queues"
32983   },
32984   {
32985     "type": "get",
32986     "url": "/api/voice/queues",
32987     "title": "Gets a list of Queues",
32988     "examples": [
32989       {
32990         "title": "Example usage:",
32991         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32992         "type": "json"
32993       }
32994     ],
32995     "name": "GetQueues",
32996     "group": "Voice_Queues",
32997     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32998     "version": "0.0.0",
32999     "filename": "server/api/voiceQueue/index.js",
33000     "groupTitle": "Voice_Queues"
33001   },
33002   {
33003     "type": "get",
33004     "url": "/api/voice/queues/{id}/teams",
33005     "title": "Gets queue team",
33006     "examples": [
33007       {
33008         "title": "Example usage:",
33009         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33010         "type": "json"
33011       }
33012     ],
33013     "name": "GetTeams",
33014     "group": "Voice_Queues",
33015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33016     "version": "0.0.0",
33017     "filename": "server/api/voiceQueue/index.js",
33018     "groupTitle": "Voice_Queues"
33019   },
33020   {
33021     "type": "delete",
33022     "url": "/api/voice/queues/{id}/users",
33023     "title": "Removes agents from a queue",
33024     "examples": [
33025       {
33026         "title": "Example usage:",
33027         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33028         "type": "json"
33029       }
33030     ],
33031     "name": "RemoveAgents",
33032     "group": "Voice_Queues",
33033     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33034     "version": "0.0.0",
33035     "filename": "server/api/voiceQueue/index.js",
33036     "groupTitle": "Voice_Queues"
33037   },
33038   {
33039     "type": "delete",
33040     "url": "/api/voice/queues/{id}/blacklists",
33041     "title": "Remove blacklists from a queue",
33042     "examples": [
33043       {
33044         "title": "Example usage:",
33045         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33046         "type": "json"
33047       }
33048     ],
33049     "name": "RemoveBlackLists",
33050     "group": "Voice_Queues",
33051     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33052     "version": "0.0.0",
33053     "filename": "server/api/voiceQueue/index.js",
33054     "groupTitle": "Voice_Queues"
33055   },
33056   {
33057     "type": "delete",
33058     "url": "/api/voice/queues/{id}/lists",
33059     "title": "Remove lists from a queue",
33060     "examples": [
33061       {
33062         "title": "Example usage:",
33063         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33064         "type": "json"
33065       }
33066     ],
33067     "name": "RemoveLists",
33068     "group": "Voice_Queues",
33069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33070     "version": "0.0.0",
33071     "filename": "server/api/voiceQueue/index.js",
33072     "groupTitle": "Voice_Queues"
33073   },
33074   {
33075     "type": "get",
33076     "url": "/api/voice/queues/{id}",
33077     "title": "Gets a single Queue",
33078     "examples": [
33079       {
33080         "title": "Example usage:",
33081         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33082         "type": "json"
33083       }
33084     ],
33085     "name": "ShowQueues",
33086     "group": "Voice_Queues",
33087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33088     "version": "0.0.0",
33089     "filename": "server/api/voiceQueue/index.js",
33090     "groupTitle": "Voice_Queues"
33091   },
33092   {
33093     "type": "get",
33094     "url": "/api/voice/queues/{id}/blacks",
33095     "title": "Gets queue hopper blacks",
33096     "examples": [
33097       {
33098         "title": "Example usage:",
33099         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33100         "type": "json"
33101       }
33102     ],
33103     "name": "getHopperBlacks",
33104     "group": "Voice_Queues",
33105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33106     "version": "0.0.0",
33107     "filename": "server/api/voiceQueue/index.js",
33108     "groupTitle": "Voice_Queues"
33109   },
33110   {
33111     "type": "put",
33112     "url": "/api/voice/queues/{id}",
33113     "title": "Update an existing Queue",
33114     "examples": [
33115       {
33116         "title": "Example usage:",
33117         "content": "curl https://{domain}/api/voice/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33118         "type": "json"
33119       }
33120     ],
33121     "name": "updateQueues",
33122     "group": "Voice_Queues",
33123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33124     "version": "0.0.0",
33125     "filename": "server/api/voiceQueue/index.js",
33126     "groupTitle": "Voice_Queues"
33127   },
33128   {
33129     "type": "post",
33130     "url": "/api/voice/recordings",
33131     "title": "Creates a new Recording",
33132     "examples": [
33133       {
33134         "title": "Example usage:",
33135         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33136         "type": "json"
33137       }
33138     ],
33139     "name": "CreateRecordings",
33140     "group": "Voice_Recordings",
33141     "parameter": {
33142       "fields": {
33143         "Body": [
33144           {
33145             "group": "Body",
33146             "type": "Virtual",
33147             "optional": true,
33148             "field": "format",
33149             "description": ""
33150           },
33151           {
33152             "group": "Body",
33153             "type": "String",
33154             "optional": true,
33155             "field": "uniqueid",
33156             "description": ""
33157           },
33158           {
33159             "group": "Body",
33160             "type": "String",
33161             "optional": true,
33162             "field": "channel",
33163             "description": ""
33164           },
33165           {
33166             "group": "Body",
33167             "type": "String",
33168             "optional": true,
33169             "field": "membername",
33170             "description": ""
33171           },
33172           {
33173             "group": "Body",
33174             "type": "String",
33175             "optional": true,
33176             "field": "calleridnum",
33177             "description": ""
33178           },
33179           {
33180             "group": "Body",
33181             "type": "String",
33182             "optional": true,
33183             "field": "calleridname",
33184             "description": ""
33185           },
33186           {
33187             "group": "Body",
33188             "type": "String",
33189             "optional": true,
33190             "field": "connectedlinenum",
33191             "description": ""
33192           },
33193           {
33194             "group": "Body",
33195             "type": "String",
33196             "optional": true,
33197             "field": "connectedlinename",
33198             "description": ""
33199           },
33200           {
33201             "group": "Body",
33202             "type": "String",
33203             "optional": true,
33204             "field": "accountcode",
33205             "description": ""
33206           },
33207           {
33208             "group": "Body",
33209             "type": "String",
33210             "optional": true,
33211             "field": "context",
33212             "description": ""
33213           },
33214           {
33215             "group": "Body",
33216             "type": "String",
33217             "optional": true,
33218             "field": "exten",
33219             "description": ""
33220           },
33221           {
33222             "group": "Body",
33223             "type": "String",
33224             "optional": true,
33225             "field": "value",
33226             "description": ""
33227           },
33228           {
33229             "group": "Body",
33230             "type": "String",
33231             "optional": true,
33232             "field": "type",
33233             "description": ""
33234           },
33235           {
33236             "group": "Body",
33237             "type": "Integer",
33238             "optional": true,
33239             "field": "rating",
33240             "description": ""
33241           },
33242           {
33243             "group": "Body",
33244             "type": "String",
33245             "optional": true,
33246             "field": "queue",
33247             "description": ""
33248           },
33249           {
33250             "group": "Body",
33251             "type": "String",
33252             "optional": true,
33253             "field": "userDisposition",
33254             "description": ""
33255           },
33256           {
33257             "group": "Body",
33258             "type": "String",
33259             "optional": true,
33260             "field": "userSecondDisposition",
33261             "description": ""
33262           },
33263           {
33264             "group": "Body",
33265             "type": "String",
33266             "optional": true,
33267             "field": "userThirdDisposition",
33268             "description": ""
33269           },
33270           {
33271             "group": "Body",
33272             "type": "Text",
33273             "optional": true,
33274             "field": "location",
33275             "description": ""
33276           },
33277           {
33278             "group": "Body",
33279             "type": "String",
33280             "optional": true,
33281             "field": "transcribeName",
33282             "description": ""
33283           },
33284           {
33285             "group": "Body",
33286             "type": "String",
33287             "optional": true,
33288             "field": "transcribeStatus",
33289             "description": ""
33290           },
33291           {
33292             "group": "Body",
33293             "type": "Text",
33294             "optional": true,
33295             "field": "fileUri",
33296             "description": ""
33297           },
33298           {
33299             "group": "Body",
33300             "type": "Text",
33301             "optional": true,
33302             "field": "fileText",
33303             "description": ""
33304           },
33305           {
33306             "group": "Body",
33307             "type": "Text",
33308             "optional": true,
33309             "field": "failureReason",
33310             "description": ""
33311           },
33312           {
33313             "group": "Body",
33314             "type": "String",
33315             "optional": true,
33316             "field": "sentiment",
33317             "description": ""
33318           },
33319           {
33320             "group": "Body",
33321             "type": "Float",
33322             "optional": true,
33323             "field": "sPositive",
33324             "description": ""
33325           },
33326           {
33327             "group": "Body",
33328             "type": "Float",
33329             "optional": true,
33330             "field": "sNegative",
33331             "description": ""
33332           },
33333           {
33334             "group": "Body",
33335             "type": "Float",
33336             "optional": true,
33337             "field": "sNeutral",
33338             "description": ""
33339           },
33340           {
33341             "group": "Body",
33342             "type": "Float",
33343             "optional": true,
33344             "field": "sMixed",
33345             "description": ""
33346           },
33347           {
33348             "group": "Body",
33349             "type": "Boolean",
33350             "optional": true,
33351             "field": "tempSentiment",
33352             "description": ""
33353           },
33354           {
33355             "group": "Body",
33356             "type": "String",
33357             "optional": true,
33358             "field": "createdAt",
33359             "description": ""
33360           },
33361           {
33362             "group": "Body",
33363             "type": "String",
33364             "optional": true,
33365             "field": "updatedAt",
33366             "description": ""
33367           }
33368         ]
33369       }
33370     },
33371     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33372     "version": "0.0.0",
33373     "filename": "server/api/voiceRecording/index.js",
33374     "groupTitle": "Voice_Recordings"
33375   },
33376   {
33377     "type": "get",
33378     "url": "/api/voice/recordings/describe",
33379     "title": "Gets table info about Recordings",
33380     "examples": [
33381       {
33382         "title": "Example usage:",
33383         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33384         "type": "json"
33385       }
33386     ],
33387     "name": "DescribeRecordings",
33388     "group": "Voice_Recordings",
33389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33390     "version": "0.0.0",
33391     "filename": "server/api/voiceRecording/index.js",
33392     "groupTitle": "Voice_Recordings"
33393   },
33394   {
33395     "type": "get",
33396     "url": "/api/voice/recordings",
33397     "title": "Gets a list of Recordings",
33398     "examples": [
33399       {
33400         "title": "Example usage:",
33401         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33402         "type": "json"
33403       }
33404     ],
33405     "name": "GetRecordings",
33406     "group": "Voice_Recordings",
33407     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/recordings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33408     "version": "0.0.0",
33409     "filename": "server/api/voiceRecording/index.js",
33410     "groupTitle": "Voice_Recordings"
33411   },
33412   {
33413     "type": "get",
33414     "url": "/api/voice/recordings/{id}",
33415     "title": "Gets a single Recording",
33416     "examples": [
33417       {
33418         "title": "Example usage:",
33419         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33420         "type": "json"
33421       }
33422     ],
33423     "name": "ShowRecordings",
33424     "group": "Voice_Recordings",
33425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33426     "version": "0.0.0",
33427     "filename": "server/api/voiceRecording/index.js",
33428     "groupTitle": "Voice_Recordings"
33429   },
33430   {
33431     "type": "delete",
33432     "url": "/api/voice/recordings/{id}",
33433     "title": "Delete voice recording",
33434     "examples": [
33435       {
33436         "title": "Example usage:",
33437         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33438         "type": "json"
33439       }
33440     ],
33441     "name": "destroy",
33442     "group": "Voice_Recordings",
33443     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33444     "version": "0.0.0",
33445     "filename": "server/api/voiceRecording/index.js",
33446     "groupTitle": "Voice_Recordings"
33447   },
33448   {
33449     "type": "get",
33450     "url": "/api/voice/recordings/{id}/download",
33451     "title": "Download Recording",
33452     "examples": [
33453       {
33454         "title": "Example usage:",
33455         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33456         "type": "json"
33457       }
33458     ],
33459     "name": "download",
33460     "group": "Voice_Recordings",
33461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33462     "version": "0.0.0",
33463     "filename": "server/api/voiceRecording/index.js",
33464     "groupTitle": "Voice_Recordings"
33465   },
33466   {
33467     "type": "get",
33468     "url": "/api/voice/recordings/{id}/downloads",
33469     "title": "Download Recording",
33470     "examples": [
33471       {
33472         "title": "Example usage:",
33473         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33474         "type": "json"
33475       }
33476     ],
33477     "name": "downloads",
33478     "group": "Voice_Recordings",
33479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33480     "version": "0.0.0",
33481     "filename": "server/api/voiceRecording/index.js",
33482     "groupTitle": "Voice_Recordings"
33483   },
33484   {
33485     "type": "post",
33486     "url": "/api/voice/recordings/{id}/transcribe",
33487     "title": "Run Transcribe Recording",
33488     "examples": [
33489       {
33490         "title": "Example usage:",
33491         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33492         "type": "json"
33493       }
33494     ],
33495     "name": "transcribe",
33496     "group": "Voice_Recordings",
33497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33498     "version": "0.0.0",
33499     "filename": "server/api/voiceRecording/index.js",
33500     "groupTitle": "Voice_Recordings"
33501   },
33502   {
33503     "type": "get",
33504     "url": "/api/voice/recordings/{id}/transcribe",
33505     "title": "Run Transcribe Recording",
33506     "examples": [
33507       {
33508         "title": "Example usage:",
33509         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33510         "type": "json"
33511       }
33512     ],
33513     "name": "transcribe",
33514     "group": "Voice_Recordings",
33515     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33516     "version": "0.0.0",
33517     "filename": "server/api/voiceRecording/index.js",
33518     "groupTitle": "Voice_Recordings"
33519   },
33520   {
33521     "type": "put",
33522     "url": "/api/voice/recordings/{id}",
33523     "title": "Update an existing Recording",
33524     "examples": [
33525       {
33526         "title": "Example usage:",
33527         "content": "curl https://{domain}/api/voice/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33528         "type": "json"
33529       }
33530     ],
33531     "name": "updateRecordings",
33532     "group": "Voice_Recordings",
33533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33534     "version": "0.0.0",
33535     "filename": "server/api/voiceRecording/index.js",
33536     "groupTitle": "Voice_Recordings"
33537   },
33538   {
33539     "type": "post",
33540     "url": "/api/voice/transfers/reports",
33541     "title": "Creates a new Transfer Report",
33542     "examples": [
33543       {
33544         "title": "Example usage:",
33545         "content": "curl https://{domain}/api/voice/transfers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33546         "type": "json"
33547       }
33548     ],
33549     "name": "CreateTransfer_Reports",
33550     "group": "Voice_Transfer_Reports",
33551     "parameter": {
33552       "fields": {
33553         "Body": [
33554           {
33555             "group": "Body",
33556             "type": "String",
33557             "allowedValues": [
33558               "\"blind\"",
33559               "\"attended\""
33560             ],
33561             "optional": true,
33562             "field": "type",
33563             "description": ""
33564           },
33565           {
33566             "group": "Body",
33567             "type": "String",
33568             "optional": true,
33569             "field": "result",
33570             "description": ""
33571           },
33572           {
33573             "group": "Body",
33574             "type": "String",
33575             "optional": true,
33576             "field": "transfererchannel",
33577             "description": ""
33578           },
33579           {
33580             "group": "Body",
33581             "type": "String",
33582             "optional": true,
33583             "field": "transferercalleridnum",
33584             "description": ""
33585           },
33586           {
33587             "group": "Body",
33588             "type": "String",
33589             "optional": true,
33590             "field": "transferercalleridname",
33591             "description": ""
33592           },
33593           {
33594             "group": "Body",
33595             "type": "String",
33596             "optional": true,
33597             "field": "transfererconnectedlinenum",
33598             "description": ""
33599           },
33600           {
33601             "group": "Body",
33602             "type": "String",
33603             "optional": true,
33604             "field": "transfererconnectedlinename",
33605             "description": ""
33606           },
33607           {
33608             "group": "Body",
33609             "type": "String",
33610             "optional": true,
33611             "field": "transfereraccountcode",
33612             "description": ""
33613           },
33614           {
33615             "group": "Body",
33616             "type": "String",
33617             "optional": true,
33618             "field": "transferercontext",
33619             "description": ""
33620           },
33621           {
33622             "group": "Body",
33623             "type": "String",
33624             "optional": true,
33625             "field": "transfererexten",
33626             "description": ""
33627           },
33628           {
33629             "group": "Body",
33630             "type": "String",
33631             "optional": true,
33632             "field": "transfererlinkedid",
33633             "description": ""
33634           },
33635           {
33636             "group": "Body",
33637             "type": "String",
33638             "optional": true,
33639             "field": "transfereechannel",
33640             "description": ""
33641           },
33642           {
33643             "group": "Body",
33644             "type": "String",
33645             "optional": true,
33646             "field": "transfereecalleridnum",
33647             "description": ""
33648           },
33649           {
33650             "group": "Body",
33651             "type": "String",
33652             "optional": true,
33653             "field": "transfereecalleridname",
33654             "description": ""
33655           },
33656           {
33657             "group": "Body",
33658             "type": "String",
33659             "optional": true,
33660             "field": "transfereeconnectedlinenum",
33661             "description": ""
33662           },
33663           {
33664             "group": "Body",
33665             "type": "String",
33666             "optional": true,
33667             "field": "transfereeconnectedlinename",
33668             "description": ""
33669           },
33670           {
33671             "group": "Body",
33672             "type": "String",
33673             "optional": true,
33674             "field": "transfereeaccountcode",
33675             "description": ""
33676           },
33677           {
33678             "group": "Body",
33679             "type": "String",
33680             "optional": true,
33681             "field": "transfereecontext",
33682             "description": ""
33683           },
33684           {
33685             "group": "Body",
33686             "type": "String",
33687             "optional": true,
33688             "field": "transfereeexten",
33689             "description": ""
33690           },
33691           {
33692             "group": "Body",
33693             "type": "String",
33694             "optional": true,
33695             "field": "transfereelinkedid",
33696             "description": ""
33697           },
33698           {
33699             "group": "Body",
33700             "type": "String",
33701             "allowedValues": [
33702               "\"Yes\"",
33703               "\"No\""
33704             ],
33705             "optional": true,
33706             "field": "isexternal",
33707             "description": ""
33708           },
33709           {
33710             "group": "Body",
33711             "type": "String",
33712             "optional": true,
33713             "field": "context",
33714             "description": ""
33715           },
33716           {
33717             "group": "Body",
33718             "type": "String",
33719             "optional": true,
33720             "field": "extension",
33721             "description": ""
33722           }
33723         ]
33724       }
33725     },
33726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33727     "version": "0.0.0",
33728     "filename": "server/api/voiceTransferReport/index.js",
33729     "groupTitle": "Voice_Transfer_Reports"
33730   },
33731   {
33732     "type": "delete",
33733     "url": "/api/voice/transfers/reports/{id}",
33734     "title": "Deletes a Transfer Report",
33735     "examples": [
33736       {
33737         "title": "Example usage:",
33738         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33739         "type": "json"
33740       }
33741     ],
33742     "name": "DeleteTransfer_Reports",
33743     "group": "Voice_Transfer_Reports",
33744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33745     "version": "0.0.0",
33746     "filename": "server/api/voiceTransferReport/index.js",
33747     "groupTitle": "Voice_Transfer_Reports"
33748   },
33749   {
33750     "type": "get",
33751     "url": "/api/voice/transfers/reports/describe",
33752     "title": "Gets table info about Transfer Reports",
33753     "examples": [
33754       {
33755         "title": "Example usage:",
33756         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33757         "type": "json"
33758       }
33759     ],
33760     "name": "DescribeTransfer_Reports",
33761     "group": "Voice_Transfer_Reports",
33762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33763     "version": "0.0.0",
33764     "filename": "server/api/voiceTransferReport/index.js",
33765     "groupTitle": "Voice_Transfer_Reports"
33766   },
33767   {
33768     "type": "get",
33769     "url": "/api/voice/transfers/reports",
33770     "title": "Gets a list of Transfer Reports",
33771     "examples": [
33772       {
33773         "title": "Example usage:",
33774         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33775         "type": "json"
33776       }
33777     ],
33778     "name": "GetTransfer_Reports",
33779     "group": "Voice_Transfer_Reports",
33780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/transfers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/transfers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/transfers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/transfers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/transfers/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33781     "version": "0.0.0",
33782     "filename": "server/api/voiceTransferReport/index.js",
33783     "groupTitle": "Voice_Transfer_Reports"
33784   },
33785   {
33786     "type": "get",
33787     "url": "/api/voice/transfers/reports/{id}",
33788     "title": "Gets a single Transfer Report",
33789     "examples": [
33790       {
33791         "title": "Example usage:",
33792         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33793         "type": "json"
33794       }
33795     ],
33796     "name": "ShowTransfer_Reports",
33797     "group": "Voice_Transfer_Reports",
33798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33799     "version": "0.0.0",
33800     "filename": "server/api/voiceTransferReport/index.js",
33801     "groupTitle": "Voice_Transfer_Reports"
33802   },
33803   {
33804     "type": "put",
33805     "url": "/api/voice/transfers/reports/{id}",
33806     "title": "Update an existing Transfer Report",
33807     "examples": [
33808       {
33809         "title": "Example usage:",
33810         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33811         "type": "json"
33812       }
33813     ],
33814     "name": "updateTransfer_Reports",
33815     "group": "Voice_Transfer_Reports",
33816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33817     "version": "0.0.0",
33818     "filename": "server/api/voiceTransferReport/index.js",
33819     "groupTitle": "Voice_Transfer_Reports"
33820   },
33821   {
33822     "type": "post",
33823     "url": "/api/integrations/vtiger/accounts",
33824     "title": "Creates a new Vtiger Account",
33825     "examples": [
33826       {
33827         "title": "Example usage:",
33828         "content": "curl https://{domain}/api/integrations/vtiger/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33829         "type": "json"
33830       }
33831     ],
33832     "name": "CreateVtiger_Accounts",
33833     "group": "Vtiger_Accounts",
33834     "parameter": {
33835       "fields": {
33836         "Body": [
33837           {
33838             "group": "Body",
33839             "type": "String",
33840             "optional": false,
33841             "field": "name",
33842             "description": ""
33843           },
33844           {
33845             "group": "Body",
33846             "type": "String",
33847             "optional": true,
33848             "field": "description",
33849             "description": ""
33850           },
33851           {
33852             "group": "Body",
33853             "type": "String",
33854             "optional": false,
33855             "field": "username",
33856             "description": ""
33857           },
33858           {
33859             "group": "Body",
33860             "type": "String",
33861             "optional": false,
33862             "field": "moduleName",
33863             "description": ""
33864           },
33865           {
33866             "group": "Body",
33867             "type": "String",
33868             "optional": false,
33869             "field": "remoteUri",
33870             "description": ""
33871           },
33872           {
33873             "group": "Body",
33874             "type": "String",
33875             "optional": false,
33876             "field": "serverUrl",
33877             "description": ""
33878           },
33879           {
33880             "group": "Body",
33881             "type": "String",
33882             "optional": false,
33883             "field": "accessKey",
33884             "description": ""
33885           }
33886         ]
33887       }
33888     },
33889     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33890     "version": "0.0.0",
33891     "filename": "server/api/intVtigerAccount/index.js",
33892     "groupTitle": "Vtiger_Accounts"
33893   },
33894   {
33895     "type": "delete",
33896     "url": "/api/integrations/vtiger/accounts/{id}",
33897     "title": "Deletes a Vtiger Account",
33898     "examples": [
33899       {
33900         "title": "Example usage:",
33901         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33902         "type": "json"
33903       }
33904     ],
33905     "name": "DeleteVtiger_Accounts",
33906     "group": "Vtiger_Accounts",
33907     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33908     "version": "0.0.0",
33909     "filename": "server/api/intVtigerAccount/index.js",
33910     "groupTitle": "Vtiger_Accounts"
33911   },
33912   {
33913     "type": "get",
33914     "url": "/api/integrations/vtiger/accounts",
33915     "title": "Gets a list of Vtiger Accounts",
33916     "examples": [
33917       {
33918         "title": "Example usage:",
33919         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33920         "type": "json"
33921       }
33922     ],
33923     "name": "GetVtiger_Accounts",
33924     "group": "Vtiger_Accounts",
33925     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33926     "version": "0.0.0",
33927     "filename": "server/api/intVtigerAccount/index.js",
33928     "groupTitle": "Vtiger_Accounts"
33929   },
33930   {
33931     "type": "get",
33932     "url": "/api/integrations/vtiger/accounts/{id}",
33933     "title": "Gets a single Vtiger Account",
33934     "examples": [
33935       {
33936         "title": "Example usage:",
33937         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33938         "type": "json"
33939       }
33940     ],
33941     "name": "ShowVtiger_Accounts",
33942     "group": "Vtiger_Accounts",
33943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33944     "version": "0.0.0",
33945     "filename": "server/api/intVtigerAccount/index.js",
33946     "groupTitle": "Vtiger_Accounts"
33947   },
33948   {
33949     "type": "post",
33950     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33951     "title": "Creates new configuration",
33952     "examples": [
33953       {
33954         "title": "Example usage:",
33955         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33956         "type": "json"
33957       }
33958     ],
33959     "name": "addConfiguration",
33960     "group": "Vtiger_Accounts",
33961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33962     "version": "0.0.0",
33963     "filename": "server/api/intVtigerAccount/index.js",
33964     "groupTitle": "Vtiger_Accounts"
33965   },
33966   {
33967     "type": "get",
33968     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33969     "title": "Gets account configurations",
33970     "examples": [
33971       {
33972         "title": "Example usage:",
33973         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33974         "type": "json"
33975       }
33976     ],
33977     "name": "getConfigurations",
33978     "group": "Vtiger_Accounts",
33979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33980     "version": "0.0.0",
33981     "filename": "server/api/intVtigerAccount/index.js",
33982     "groupTitle": "Vtiger_Accounts"
33983   },
33984   {
33985     "type": "get",
33986     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33987     "title": "Gets account fields",
33988     "examples": [
33989       {
33990         "title": "Example usage:",
33991         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33992         "type": "json"
33993       }
33994     ],
33995     "name": "getFields",
33996     "group": "Vtiger_Accounts",
33997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33998     "version": "0.0.0",
33999     "filename": "server/api/intVtigerAccount/index.js",
34000     "groupTitle": "Vtiger_Accounts"
34001   },
34002   {
34003     "type": "put",
34004     "url": "/api/integrations/vtiger/accounts/{id}",
34005     "title": "Update an existing Vtiger Account",
34006     "examples": [
34007       {
34008         "title": "Example usage:",
34009         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34010         "type": "json"
34011       }
34012     ],
34013     "name": "updateVtiger_Accounts",
34014     "group": "Vtiger_Accounts",
34015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34016     "version": "0.0.0",
34017     "filename": "server/api/intVtigerAccount/index.js",
34018     "groupTitle": "Vtiger_Accounts"
34019   },
34020   {
34021     "type": "post",
34022     "url": "/api/integrations/vtiger/configurations",
34023     "title": "Creates a new Vtiger Configuration",
34024     "examples": [
34025       {
34026         "title": "Example usage:",
34027         "content": "curl https://{domain}/api/integrations/vtiger/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34028         "type": "json"
34029       }
34030     ],
34031     "name": "CreateVtiger_Configurations",
34032     "group": "Vtiger_Configurations",
34033     "parameter": {
34034       "fields": {
34035         "Body": [
34036           {
34037             "group": "Body",
34038             "type": "String",
34039             "optional": true,
34040             "field": "name",
34041             "description": ""
34042           },
34043           {
34044             "group": "Body",
34045             "type": "String",
34046             "optional": true,
34047             "field": "description",
34048             "description": ""
34049           }
34050         ]
34051       }
34052     },
34053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34054     "version": "0.0.0",
34055     "filename": "server/api/intVtigerConfiguration/index.js",
34056     "groupTitle": "Vtiger_Configurations"
34057   },
34058   {
34059     "type": "delete",
34060     "url": "/api/integrations/vtiger/configurations/{id}",
34061     "title": "Deletes a Vtiger Configuration",
34062     "examples": [
34063       {
34064         "title": "Example usage:",
34065         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34066         "type": "json"
34067       }
34068     ],
34069     "name": "DeleteVtiger_Configurations",
34070     "group": "Vtiger_Configurations",
34071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34072     "version": "0.0.0",
34073     "filename": "server/api/intVtigerConfiguration/index.js",
34074     "groupTitle": "Vtiger_Configurations"
34075   },
34076   {
34077     "type": "get",
34078     "url": "/api/integrations/vtiger/configurations",
34079     "title": "Gets a list of Vtiger Configurations",
34080     "examples": [
34081       {
34082         "title": "Example usage:",
34083         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34084         "type": "json"
34085       }
34086     ],
34087     "name": "GetVtiger_Configurations",
34088     "group": "Vtiger_Configurations",
34089     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34090     "version": "0.0.0",
34091     "filename": "server/api/intVtigerConfiguration/index.js",
34092     "groupTitle": "Vtiger_Configurations"
34093   },
34094   {
34095     "type": "get",
34096     "url": "/api/integrations/vtiger/configurations/{id}",
34097     "title": "Gets a single Vtiger Configuration",
34098     "examples": [
34099       {
34100         "title": "Example usage:",
34101         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34102         "type": "json"
34103       }
34104     ],
34105     "name": "ShowVtiger_Configurations",
34106     "group": "Vtiger_Configurations",
34107     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34108     "version": "0.0.0",
34109     "filename": "server/api/intVtigerConfiguration/index.js",
34110     "groupTitle": "Vtiger_Configurations"
34111   },
34112   {
34113     "type": "get",
34114     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34115     "title": "Gets configurations descriptions",
34116     "examples": [
34117       {
34118         "title": "Example usage:",
34119         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34120         "type": "json"
34121       }
34122     ],
34123     "name": "getDescriptions",
34124     "group": "Vtiger_Configurations",
34125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34126     "version": "0.0.0",
34127     "filename": "server/api/intVtigerConfiguration/index.js",
34128     "groupTitle": "Vtiger_Configurations"
34129   },
34130   {
34131     "type": "get",
34132     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34133     "title": "Gets configurations fields",
34134     "examples": [
34135       {
34136         "title": "Example usage:",
34137         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34138         "type": "json"
34139       }
34140     ],
34141     "name": "getFields",
34142     "group": "Vtiger_Configurations",
34143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34144     "version": "0.0.0",
34145     "filename": "server/api/intVtigerConfiguration/index.js",
34146     "groupTitle": "Vtiger_Configurations"
34147   },
34148   {
34149     "type": "get",
34150     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34151     "title": "Gets configurations subjects",
34152     "examples": [
34153       {
34154         "title": "Example usage:",
34155         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34156         "type": "json"
34157       }
34158     ],
34159     "name": "getSubjects",
34160     "group": "Vtiger_Configurations",
34161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34162     "version": "0.0.0",
34163     "filename": "server/api/intVtigerConfiguration/index.js",
34164     "groupTitle": "Vtiger_Configurations"
34165   },
34166   {
34167     "type": "put",
34168     "url": "/api/integrations/vtiger/configurations/{id}",
34169     "title": "Update an existing Vtiger Configuration",
34170     "examples": [
34171       {
34172         "title": "Example usage:",
34173         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34174         "type": "json"
34175       }
34176     ],
34177     "name": "updateVtiger_Configurations",
34178     "group": "Vtiger_Configurations",
34179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34180     "version": "0.0.0",
34181     "filename": "server/api/intVtigerConfiguration/index.js",
34182     "groupTitle": "Vtiger_Configurations"
34183   },
34184   {
34185     "type": "post",
34186     "url": "/api/integrations/vtiger/fields",
34187     "title": "Creates a new Vtiger Field",
34188     "examples": [
34189       {
34190         "title": "Example usage:",
34191         "content": "curl https://{domain}/api/integrations/vtiger/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34192         "type": "json"
34193       }
34194     ],
34195     "name": "CreateVtiger_Fields",
34196     "group": "Vtiger_Fields",
34197     "parameter": {
34198       "fields": {
34199         "Body": [
34200           {
34201             "group": "Body",
34202             "type": "String",
34203             "allowedValues": [
34204               "\"string\"",
34205               "\"variable\"",
34206               "\"customVariable\"",
34207               "\"keyValue\"",
34208               "\"picklist\""
34209             ],
34210             "optional": true,
34211             "field": "type",
34212             "description": ""
34213           },
34214           {
34215             "group": "Body",
34216             "type": "String",
34217             "optional": true,
34218             "field": "content",
34219             "description": ""
34220           },
34221           {
34222             "group": "Body",
34223             "type": "String",
34224             "optional": true,
34225             "field": "key",
34226             "description": ""
34227           },
34228           {
34229             "group": "Body",
34230             "type": "String",
34231             "allowedValues": [
34232               "\"string\"",
34233               "\"variable\"",
34234               "\"customVariable\""
34235             ],
34236             "optional": true,
34237             "field": "keyType",
34238             "description": ""
34239           },
34240           {
34241             "group": "Body",
34242             "type": "String",
34243             "optional": true,
34244             "field": "keyContent",
34245             "description": ""
34246           },
34247           {
34248             "group": "Body",
34249             "type": "String",
34250             "optional": true,
34251             "field": "idField",
34252             "description": ""
34253           },
34254           {
34255             "group": "Body",
34256             "type": "String",
34257             "optional": true,
34258             "field": "nameField",
34259             "description": ""
34260           },
34261           {
34262             "group": "Body",
34263             "type": "Boolean",
34264             "optional": true,
34265             "field": "customField",
34266             "description": ""
34267           },
34268           {
34269             "group": "Body",
34270             "type": "String",
34271             "optional": true,
34272             "field": "variableName",
34273             "description": ""
34274           }
34275         ]
34276       }
34277     },
34278     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34279     "version": "0.0.0",
34280     "filename": "server/api/intVtigerField/index.js",
34281     "groupTitle": "Vtiger_Fields"
34282   },
34283   {
34284     "type": "delete",
34285     "url": "/api/integrations/vtiger/fields/{id}",
34286     "title": "Deletes a Vtiger Field",
34287     "examples": [
34288       {
34289         "title": "Example usage:",
34290         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34291         "type": "json"
34292       }
34293     ],
34294     "name": "DeleteVtiger_Fields",
34295     "group": "Vtiger_Fields",
34296     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34297     "version": "0.0.0",
34298     "filename": "server/api/intVtigerField/index.js",
34299     "groupTitle": "Vtiger_Fields"
34300   },
34301   {
34302     "type": "get",
34303     "url": "/api/integrations/vtiger/fields",
34304     "title": "Gets a list of Vtiger Fields",
34305     "examples": [
34306       {
34307         "title": "Example usage:",
34308         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34309         "type": "json"
34310       }
34311     ],
34312     "name": "GetVtiger_Fields",
34313     "group": "Vtiger_Fields",
34314     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34315     "version": "0.0.0",
34316     "filename": "server/api/intVtigerField/index.js",
34317     "groupTitle": "Vtiger_Fields"
34318   },
34319   {
34320     "type": "get",
34321     "url": "/api/integrations/vtiger/fields/{id}",
34322     "title": "Gets a single Vtiger Field",
34323     "examples": [
34324       {
34325         "title": "Example usage:",
34326         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34327         "type": "json"
34328       }
34329     ],
34330     "name": "ShowVtiger_Fields",
34331     "group": "Vtiger_Fields",
34332     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34333     "version": "0.0.0",
34334     "filename": "server/api/intVtigerField/index.js",
34335     "groupTitle": "Vtiger_Fields"
34336   },
34337   {
34338     "type": "put",
34339     "url": "/api/integrations/vtiger/fields/{id}",
34340     "title": "Update an existing Vtiger Field",
34341     "examples": [
34342       {
34343         "title": "Example usage:",
34344         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34345         "type": "json"
34346       }
34347     ],
34348     "name": "updateVtiger_Fields",
34349     "group": "Vtiger_Fields",
34350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34351     "version": "0.0.0",
34352     "filename": "server/api/intVtigerField/index.js",
34353     "groupTitle": "Vtiger_Fields"
34354   },
34355   {
34356     "type": "post",
34357     "url": "/api/webbar/answer",
34358     "title": "answer webrtc call",
34359     "examples": [
34360       {
34361         "title": "Example usage:",
34362         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34363         "type": "json"
34364       }
34365     ],
34366     "name": "Web_Bar_answer",
34367     "group": "WebBar",
34368     "parameter": {
34369       "fields": {
34370         "Body": [
34371           {
34372             "group": "Body",
34373             "type": "String",
34374             "optional": false,
34375             "field": "sessionId",
34376             "description": ""
34377           },
34378           {
34379             "group": "Body",
34380             "type": "number",
34381             "optional": false,
34382             "field": "userId",
34383             "description": ""
34384           }
34385         ]
34386       }
34387     },
34388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34389     "version": "0.0.0",
34390     "filename": "server/api/webbar/index.js",
34391     "groupTitle": "WebBar"
34392   },
34393   {
34394     "type": "post",
34395     "url": "/api/webbar/calls",
34396     "title": "webrtc call list",
34397     "examples": [
34398       {
34399         "title": "Example usage:",
34400         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34401         "type": "json"
34402       }
34403     ],
34404     "name": "Web_Bar_calls",
34405     "group": "WebBar",
34406     "parameter": {
34407       "fields": {
34408         "Body": [
34409           {
34410             "group": "Body",
34411             "type": "number",
34412             "optional": false,
34413             "field": "userId",
34414             "description": ""
34415           }
34416         ]
34417       }
34418     },
34419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34420     "version": "0.0.0",
34421     "filename": "server/api/webbar/index.js",
34422     "groupTitle": "WebBar"
34423   },
34424   {
34425     "type": "post",
34426     "url": "/api/webbar/hangup",
34427     "title": "hangup webrtc call",
34428     "examples": [
34429       {
34430         "title": "Example usage:",
34431         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34432         "type": "json"
34433       }
34434     ],
34435     "name": "Web_Bar_hangup",
34436     "group": "WebBar",
34437     "parameter": {
34438       "fields": {
34439         "Body": [
34440           {
34441             "group": "Body",
34442             "type": "String",
34443             "optional": false,
34444             "field": "sessionId",
34445             "description": ""
34446           },
34447           {
34448             "group": "Body",
34449             "type": "number",
34450             "optional": false,
34451             "field": "userId",
34452             "description": ""
34453           }
34454         ]
34455       }
34456     },
34457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34458     "version": "0.0.0",
34459     "filename": "server/api/webbar/index.js",
34460     "groupTitle": "WebBar"
34461   },
34462   {
34463     "type": "post",
34464     "url": "/api/webbar/unhold",
34465     "title": "unhold webrtc call",
34466     "examples": [
34467       {
34468         "title": "Example usage:",
34469         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34470         "type": "json"
34471       }
34472     ],
34473     "name": "Web_Bar_hold",
34474     "group": "WebBar",
34475     "parameter": {
34476       "fields": {
34477         "Body": [
34478           {
34479             "group": "Body",
34480             "type": "String",
34481             "optional": false,
34482             "field": "sessionId",
34483             "description": ""
34484           },
34485           {
34486             "group": "Body",
34487             "type": "number",
34488             "optional": false,
34489             "field": "userId",
34490             "description": ""
34491           }
34492         ]
34493       }
34494     },
34495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34496     "version": "0.0.0",
34497     "filename": "server/api/webbar/index.js",
34498     "groupTitle": "WebBar"
34499   },
34500   {
34501     "type": "post",
34502     "url": "/api/webbar/hold",
34503     "title": "hold webrtc call",
34504     "examples": [
34505       {
34506         "title": "Example usage:",
34507         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34508         "type": "json"
34509       }
34510     ],
34511     "name": "Web_Bar_hold",
34512     "group": "WebBar",
34513     "parameter": {
34514       "fields": {
34515         "Body": [
34516           {
34517             "group": "Body",
34518             "type": "String",
34519             "optional": true,
34520             "field": "sessionId",
34521             "description": ""
34522           },
34523           {
34524             "group": "Body",
34525             "type": "number",
34526             "optional": false,
34527             "field": "userId",
34528             "description": ""
34529           }
34530         ]
34531       }
34532     },
34533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34534     "version": "0.0.0",
34535     "filename": "server/api/webbar/index.js",
34536     "groupTitle": "WebBar"
34537   },
34538   {
34539     "type": "post",
34540     "url": "/api/webbar/originate",
34541     "title": "Originate new webrtc call",
34542     "examples": [
34543       {
34544         "title": "Example usage:",
34545         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34546         "type": "json"
34547       }
34548     ],
34549     "name": "Web_Bar_originate",
34550     "group": "WebBar",
34551     "parameter": {
34552       "fields": {
34553         "Body": [
34554           {
34555             "group": "Body",
34556             "type": "String",
34557             "optional": false,
34558             "field": "callNumber",
34559             "description": ""
34560           },
34561           {
34562             "group": "Body",
34563             "type": "number",
34564             "optional": false,
34565             "field": "userId",
34566             "description": ""
34567           },
34568           {
34569             "group": "Body",
34570             "type": "String",
34571             "optional": false,
34572             "field": "callerId",
34573             "description": ""
34574           },
34575           {
34576             "group": "Body",
34577             "type": "String",
34578             "optional": false,
34579             "field": "callbackUrl",
34580             "description": ""
34581           }
34582         ]
34583       }
34584     },
34585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34586     "version": "0.0.0",
34587     "filename": "server/api/webbar/index.js",
34588     "groupTitle": "WebBar"
34589   },
34590   {
34591     "type": "post",
34592     "url": "/api/webbar/transfer",
34593     "title": "blind transfer webrtc call",
34594     "examples": [
34595       {
34596         "title": "Example usage:",
34597         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34598         "type": "json"
34599       }
34600     ],
34601     "name": "Web_Bar_transfer",
34602     "group": "WebBar",
34603     "parameter": {
34604       "fields": {
34605         "Body": [
34606           {
34607             "group": "Body",
34608             "type": "number",
34609             "optional": false,
34610             "field": "userId",
34611             "description": ""
34612           },
34613           {
34614             "group": "Body",
34615             "type": "string",
34616             "optional": false,
34617             "field": "sessionId",
34618             "description": ""
34619           },
34620           {
34621             "group": "Body",
34622             "type": "string",
34623             "optional": false,
34624             "field": "transferNumber",
34625             "description": ""
34626           }
34627         ]
34628       }
34629     },
34630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34631     "version": "0.0.0",
34632     "filename": "server/api/webbar/index.js",
34633     "groupTitle": "WebBar"
34634   },
34635   {
34636     "type": "post",
34637     "url": "/api/whatsapp/accounts/{id}/users",
34638     "title": "Add agents to a whatsapp account",
34639     "examples": [
34640       {
34641         "title": "Example usage:",
34642         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34643         "type": "json"
34644       }
34645     ],
34646     "name": "AddAgents",
34647     "group": "Whatsapp_Accounts",
34648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34649     "version": "0.0.0",
34650     "filename": "server/api/whatsappAccount/index.js",
34651     "groupTitle": "Whatsapp_Accounts"
34652   },
34653   {
34654     "type": "post",
34655     "url": "/api/whatsapp/accounts",
34656     "title": "Creates a new Account",
34657     "examples": [
34658       {
34659         "title": "Example usage:",
34660         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34661         "type": "json"
34662       }
34663     ],
34664     "name": "CreateAccounts",
34665     "group": "Whatsapp_Accounts",
34666     "parameter": {
34667       "fields": {
34668         "Body": [
34669           {
34670             "group": "Body",
34671             "type": "String",
34672             "optional": false,
34673             "field": "name",
34674             "description": ""
34675           },
34676           {
34677             "group": "Body",
34678             "type": "String",
34679             "optional": false,
34680             "field": "key",
34681             "description": ""
34682           },
34683           {
34684             "group": "Body",
34685             "type": "String",
34686             "optional": false,
34687             "field": "remote",
34688             "description": ""
34689           },
34690           {
34691             "group": "Body",
34692             "type": "String",
34693             "optional": true,
34694             "field": "token",
34695             "description": ""
34696           },
34697           {
34698             "group": "Body",
34699             "type": "String",
34700             "optional": true,
34701             "field": "phone",
34702             "description": ""
34703           },
34704           {
34705             "group": "Body",
34706             "type": "String",
34707             "allowedValues": [
34708               "\"twilio\""
34709             ],
34710             "optional": true,
34711             "field": "type",
34712             "description": ""
34713           },
34714           {
34715             "group": "Body",
34716             "type": "String",
34717             "optional": true,
34718             "field": "accountSid",
34719             "description": ""
34720           },
34721           {
34722             "group": "Body",
34723             "type": "String",
34724             "optional": true,
34725             "field": "authToken",
34726             "description": ""
34727           },
34728           {
34729             "group": "Body",
34730             "type": "Text",
34731             "optional": true,
34732             "field": "notificationTemplate",
34733             "description": ""
34734           },
34735           {
34736             "group": "Body",
34737             "type": "Boolean",
34738             "optional": true,
34739             "field": "notificationSound",
34740             "description": ""
34741           },
34742           {
34743             "group": "Body",
34744             "type": "Boolean",
34745             "optional": true,
34746             "field": "notificationShake",
34747             "description": ""
34748           },
34749           {
34750             "group": "Body",
34751             "type": "Integer",
34752             "optional": true,
34753             "field": "waitForTheAssignedAgent",
34754             "description": ""
34755           },
34756           {
34757             "group": "Body",
34758             "type": "Boolean",
34759             "optional": true,
34760             "field": "queueTransfer",
34761             "description": ""
34762           },
34763           {
34764             "group": "Body",
34765             "type": "Integer",
34766             "optional": true,
34767             "field": "queueTransferTimeout",
34768             "description": ""
34769           },
34770           {
34771             "group": "Body",
34772             "type": "Boolean",
34773             "optional": true,
34774             "field": "agentTransfer",
34775             "description": ""
34776           },
34777           {
34778             "group": "Body",
34779             "type": "Integer",
34780             "optional": true,
34781             "field": "agentTransferTimeout",
34782             "description": ""
34783           },
34784           {
34785             "group": "Body",
34786             "type": "Integer",
34787             "optional": true,
34788             "field": "mandatoryDispositionPauseId",
34789             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34790           },
34791           {
34792             "group": "Body",
34793             "type": "Boolean",
34794             "optional": true,
34795             "field": "mandatoryDisposition",
34796             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34797           },
34798           {
34799             "group": "Body",
34800             "type": "String",
34801             "optional": true,
34802             "field": "description",
34803             "description": ""
34804           }
34805         ]
34806       }
34807     },
34808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34809     "version": "0.0.0",
34810     "filename": "server/api/whatsappAccount/index.js",
34811     "groupTitle": "Whatsapp_Accounts"
34812   },
34813   {
34814     "type": "delete",
34815     "url": "/api/whatsapp/accounts/{id}",
34816     "title": "Deletes a Account",
34817     "examples": [
34818       {
34819         "title": "Example usage:",
34820         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34821         "type": "json"
34822       }
34823     ],
34824     "name": "DeleteAccounts",
34825     "group": "Whatsapp_Accounts",
34826     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34827     "version": "0.0.0",
34828     "filename": "server/api/whatsappAccount/index.js",
34829     "groupTitle": "Whatsapp_Accounts"
34830   },
34831   {
34832     "type": "get",
34833     "url": "/api/whatsapp/accounts/describe",
34834     "title": "Gets table info about Accounts",
34835     "examples": [
34836       {
34837         "title": "Example usage:",
34838         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34839         "type": "json"
34840       }
34841     ],
34842     "name": "DescribeAccounts",
34843     "group": "Whatsapp_Accounts",
34844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34845     "version": "0.0.0",
34846     "filename": "server/api/whatsappAccount/index.js",
34847     "groupTitle": "Whatsapp_Accounts"
34848   },
34849   {
34850     "type": "get",
34851     "url": "/api/whatsapp/accounts",
34852     "title": "Gets a list of Accounts",
34853     "examples": [
34854       {
34855         "title": "Example usage:",
34856         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34857         "type": "json"
34858       }
34859     ],
34860     "name": "GetAccounts",
34861     "group": "Whatsapp_Accounts",
34862     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34863     "version": "0.0.0",
34864     "filename": "server/api/whatsappAccount/index.js",
34865     "groupTitle": "Whatsapp_Accounts"
34866   },
34867   {
34868     "type": "get",
34869     "url": "/api/whatsapp/accounts/{id}/users",
34870     "title": "Gets agents from whatsapp account",
34871     "examples": [
34872       {
34873         "title": "Example usage:",
34874         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34875         "type": "json"
34876       }
34877     ],
34878     "name": "GetAgents",
34879     "group": "Whatsapp_Accounts",
34880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34881     "version": "0.0.0",
34882     "filename": "server/api/whatsappAccount/index.js",
34883     "groupTitle": "Whatsapp_Accounts"
34884   },
34885   {
34886     "type": "delete",
34887     "url": "/api/whatsapp/accounts/{id}/users",
34888     "title": "Removes agents from a whatsapp account",
34889     "examples": [
34890       {
34891         "title": "Example usage:",
34892         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34893         "type": "json"
34894       }
34895     ],
34896     "name": "RemoveAgents",
34897     "group": "Whatsapp_Accounts",
34898     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34899     "version": "0.0.0",
34900     "filename": "server/api/whatsappAccount/index.js",
34901     "groupTitle": "Whatsapp_Accounts"
34902   },
34903   {
34904     "type": "delete",
34905     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34906     "title": "Removes canned answers from account",
34907     "examples": [
34908       {
34909         "title": "Example usage:",
34910         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34911         "type": "json"
34912       }
34913     ],
34914     "name": "RemoveAnswers",
34915     "group": "Whatsapp_Accounts",
34916     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34917     "version": "0.0.0",
34918     "filename": "server/api/whatsappAccount/index.js",
34919     "groupTitle": "Whatsapp_Accounts"
34920   },
34921   {
34922     "type": "delete",
34923     "url": "/api/whatsapp/accounts/{id}/dispositions",
34924     "title": "Removes dispositions from account",
34925     "examples": [
34926       {
34927         "title": "Example usage:",
34928         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34929         "type": "json"
34930       }
34931     ],
34932     "name": "RemoveDispositions",
34933     "group": "Whatsapp_Accounts",
34934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34935     "version": "0.0.0",
34936     "filename": "server/api/whatsappAccount/index.js",
34937     "groupTitle": "Whatsapp_Accounts"
34938   },
34939   {
34940     "type": "get",
34941     "url": "/api/whatsapp/accounts/{id}",
34942     "title": "Gets a single Account",
34943     "examples": [
34944       {
34945         "title": "Example usage:",
34946         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34947         "type": "json"
34948       }
34949     ],
34950     "name": "ShowAccounts",
34951     "group": "Whatsapp_Accounts",
34952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34953     "version": "0.0.0",
34954     "filename": "server/api/whatsappAccount/index.js",
34955     "groupTitle": "Whatsapp_Accounts"
34956   },
34957   {
34958     "type": "put",
34959     "url": "/api/whatsapp/messages/{id}/accept",
34960     "title": "Accepts message",
34961     "examples": [
34962       {
34963         "title": "Example usage:",
34964         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34965         "type": "json"
34966       }
34967     ],
34968     "name": "acceptMessage",
34969     "group": "Whatsapp_Accounts",
34970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34971     "version": "0.0.0",
34972     "filename": "server/api/whatsappMessage/index.js",
34973     "groupTitle": "Whatsapp_Accounts"
34974   },
34975   {
34976     "type": "post",
34977     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34978     "title": "Creates new canned answer",
34979     "examples": [
34980       {
34981         "title": "Example usage:",
34982         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34983         "type": "json"
34984       }
34985     ],
34986     "name": "addAnswer",
34987     "group": "Whatsapp_Accounts",
34988     "parameter": {
34989       "fields": {
34990         "Body": [
34991           {
34992             "group": "Body",
34993             "type": "String",
34994             "optional": false,
34995             "field": "key",
34996             "description": ""
34997           },
34998           {
34999             "group": "Body",
35000             "type": "Text",
35001             "optional": false,
35002             "field": "value",
35003             "description": ""
35004           },
35005           {
35006             "group": "Body",
35007             "type": "String",
35008             "optional": true,
35009             "field": "description",
35010             "description": ""
35011           },
35012           {
35013             "group": "Body",
35014             "type": "Virtual",
35015             "optional": true,
35016             "field": "name",
35017             "description": ""
35018           }
35019         ]
35020       }
35021     },
35022     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35023     "version": "0.0.0",
35024     "filename": "server/api/whatsappAccount/index.js",
35025     "groupTitle": "Whatsapp_Accounts"
35026   },
35027   {
35028     "type": "post",
35029     "url": "/api/whatsapp/accounts/{id}/applications",
35030     "title": "Creates new applications",
35031     "examples": [
35032       {
35033         "title": "Example usage:",
35034         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35035         "type": "json"
35036       }
35037     ],
35038     "name": "addApplications",
35039     "group": "Whatsapp_Accounts",
35040     "parameter": {
35041       "fields": {
35042         "Body": [
35043           {
35044             "group": "Body",
35045             "type": "Integer",
35046             "optional": false,
35047             "field": "priority",
35048             "description": ""
35049           },
35050           {
35051             "group": "Body",
35052             "type": "String",
35053             "optional": false,
35054             "field": "app",
35055             "description": ""
35056           },
35057           {
35058             "group": "Body",
35059             "type": "Text",
35060             "optional": true,
35061             "field": "appdata",
35062             "description": ""
35063           },
35064           {
35065             "group": "Body",
35066             "type": "String",
35067             "optional": true,
35068             "field": "description",
35069             "description": ""
35070           },
35071           {
35072             "group": "Body",
35073             "type": "String",
35074             "optional": true,
35075             "field": "interval",
35076             "description": ""
35077           }
35078         ]
35079       }
35080     },
35081     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35082     "version": "0.0.0",
35083     "filename": "server/api/whatsappAccount/index.js",
35084     "groupTitle": "Whatsapp_Accounts"
35085   },
35086   {
35087     "type": "post",
35088     "url": "/api/whatsapp/accounts/{id}/dispositions",
35089     "title": "Creates new disposition",
35090     "examples": [
35091       {
35092         "title": "Example usage:",
35093         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35094         "type": "json"
35095       }
35096     ],
35097     "name": "addDisposition",
35098     "group": "Whatsapp_Accounts",
35099     "parameter": {
35100       "fields": {
35101         "Body": [
35102           {
35103             "group": "Body",
35104             "type": "String",
35105             "optional": false,
35106             "field": "name",
35107             "description": ""
35108           },
35109           {
35110             "group": "Body",
35111             "type": "String",
35112             "allowedValues": [
35113               "\"first\"",
35114               "\"second\"",
35115               "\"third\""
35116             ],
35117             "optional": false,
35118             "field": "level",
35119             "description": ""
35120           },
35121           {
35122             "group": "Body",
35123             "type": "String",
35124             "optional": true,
35125             "field": "description",
35126             "description": ""
35127           }
35128         ]
35129       }
35130     },
35131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35132     "version": "0.0.0",
35133     "filename": "server/api/whatsappAccount/index.js",
35134     "groupTitle": "Whatsapp_Accounts"
35135   },
35136   {
35137     "type": "get",
35138     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35139     "title": "Gets account canned answers",
35140     "examples": [
35141       {
35142         "title": "Example usage:",
35143         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35144         "type": "json"
35145       }
35146     ],
35147     "name": "getAnswers",
35148     "group": "Whatsapp_Accounts",
35149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35150     "version": "0.0.0",
35151     "filename": "server/api/whatsappAccount/index.js",
35152     "groupTitle": "Whatsapp_Accounts"
35153   },
35154   {
35155     "type": "get",
35156     "url": "/api/whatsapp/accounts/{id}/applications",
35157     "title": "Gets account applications",
35158     "examples": [
35159       {
35160         "title": "Example usage:",
35161         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35162         "type": "json"
35163       }
35164     ],
35165     "name": "getApplications",
35166     "group": "Whatsapp_Accounts",
35167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35168     "version": "0.0.0",
35169     "filename": "server/api/whatsappAccount/index.js",
35170     "groupTitle": "Whatsapp_Accounts"
35171   },
35172   {
35173     "type": "get",
35174     "url": "/api/whatsapp/accounts/{id}/dispositions",
35175     "title": "Gets account dispositions",
35176     "examples": [
35177       {
35178         "title": "Example usage:",
35179         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35180         "type": "json"
35181       }
35182     ],
35183     "name": "getDispositions",
35184     "group": "Whatsapp_Accounts",
35185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35186     "version": "0.0.0",
35187     "filename": "server/api/whatsappAccount/index.js",
35188     "groupTitle": "Whatsapp_Accounts"
35189   },
35190   {
35191     "type": "post",
35192     "url": "/api/whatsapp/accounts/{id}/notify",
35193     "title": "Notify new message",
35194     "examples": [
35195       {
35196         "title": "Example usage:",
35197         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35198         "type": "json"
35199       }
35200     ],
35201     "name": "notify",
35202     "group": "Whatsapp_Accounts",
35203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new whatsapp message to be sent to the system.</p>",
35204     "version": "0.0.0",
35205     "filename": "server/api/whatsappAccount/index.js",
35206     "groupTitle": "Whatsapp_Accounts"
35207   },
35208   {
35209     "type": "put",
35210     "url": "/api/whatsapp/messages/{id}/reject",
35211     "title": "Rejects message",
35212     "examples": [
35213       {
35214         "title": "Example usage:",
35215         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35216         "type": "json"
35217       }
35218     ],
35219     "name": "rejectMessage",
35220     "group": "Whatsapp_Accounts",
35221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35222     "version": "0.0.0",
35223     "filename": "server/api/whatsappMessage/index.js",
35224     "groupTitle": "Whatsapp_Accounts"
35225   },
35226   {
35227     "type": "post",
35228     "url": "/api/whatsapp/accounts/{id}/send",
35229     "title": "Send new whatsapp message",
35230     "examples": [
35231       {
35232         "title": "Example usage:",
35233         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35234         "type": "json"
35235       }
35236     ],
35237     "name": "sendWhatsapp",
35238     "group": "Whatsapp_Accounts",
35239     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35240     "version": "0.0.0",
35241     "filename": "server/api/whatsappAccount/index.js",
35242     "groupTitle": "Whatsapp_Accounts"
35243   },
35244   {
35245     "type": "post",
35246     "url": "/api/whatsapp/messages/{id}/status",
35247     "title": "Receive message status",
35248     "examples": [
35249       {
35250         "title": "Example usage:",
35251         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35252         "type": "json"
35253       }
35254     ],
35255     "name": "statusMessage",
35256     "group": "Whatsapp_Accounts",
35257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35258     "version": "0.0.0",
35259     "filename": "server/api/whatsappMessage/index.js",
35260     "groupTitle": "Whatsapp_Accounts"
35261   },
35262   {
35263     "type": "put",
35264     "url": "/api/whatsapp/accounts/{id}",
35265     "title": "Update an existing Account",
35266     "examples": [
35267       {
35268         "title": "Example usage:",
35269         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35270         "type": "json"
35271       }
35272     ],
35273     "name": "updateAccounts",
35274     "group": "Whatsapp_Accounts",
35275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35276     "version": "0.0.0",
35277     "filename": "server/api/whatsappAccount/index.js",
35278     "groupTitle": "Whatsapp_Accounts"
35279   },
35280   {
35281     "type": "post",
35282     "url": "/api/whatsapp/applications",
35283     "title": "Creates a new Application",
35284     "examples": [
35285       {
35286         "title": "Example usage:",
35287         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35288         "type": "json"
35289       }
35290     ],
35291     "name": "CreateApplications",
35292     "group": "Whatsapp_Applications",
35293     "parameter": {
35294       "fields": {
35295         "Body": [
35296           {
35297             "group": "Body",
35298             "type": "Integer",
35299             "optional": false,
35300             "field": "priority",
35301             "description": ""
35302           },
35303           {
35304             "group": "Body",
35305             "type": "String",
35306             "optional": false,
35307             "field": "app",
35308             "description": ""
35309           },
35310           {
35311             "group": "Body",
35312             "type": "Text",
35313             "optional": true,
35314             "field": "appdata",
35315             "description": ""
35316           },
35317           {
35318             "group": "Body",
35319             "type": "String",
35320             "optional": true,
35321             "field": "description",
35322             "description": ""
35323           },
35324           {
35325             "group": "Body",
35326             "type": "String",
35327             "optional": true,
35328             "field": "interval",
35329             "description": ""
35330           }
35331         ]
35332       }
35333     },
35334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35335     "version": "0.0.0",
35336     "filename": "server/api/whatsappApplication/index.js",
35337     "groupTitle": "Whatsapp_Applications"
35338   },
35339   {
35340     "type": "delete",
35341     "url": "/api/whatsapp/applications/{id}",
35342     "title": "Deletes a Application",
35343     "examples": [
35344       {
35345         "title": "Example usage:",
35346         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35347         "type": "json"
35348       }
35349     ],
35350     "name": "DeleteApplications",
35351     "group": "Whatsapp_Applications",
35352     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35353     "version": "0.0.0",
35354     "filename": "server/api/whatsappApplication/index.js",
35355     "groupTitle": "Whatsapp_Applications"
35356   },
35357   {
35358     "type": "get",
35359     "url": "/api/whatsapp/applications",
35360     "title": "Gets a list of Applications",
35361     "examples": [
35362       {
35363         "title": "Example usage:",
35364         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35365         "type": "json"
35366       }
35367     ],
35368     "name": "GetApplications",
35369     "group": "Whatsapp_Applications",
35370     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35371     "version": "0.0.0",
35372     "filename": "server/api/whatsappApplication/index.js",
35373     "groupTitle": "Whatsapp_Applications"
35374   },
35375   {
35376     "type": "get",
35377     "url": "/api/whatsapp/applications/{id}",
35378     "title": "Gets a single Application",
35379     "examples": [
35380       {
35381         "title": "Example usage:",
35382         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35383         "type": "json"
35384       }
35385     ],
35386     "name": "ShowApplications",
35387     "group": "Whatsapp_Applications",
35388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35389     "version": "0.0.0",
35390     "filename": "server/api/whatsappApplication/index.js",
35391     "groupTitle": "Whatsapp_Applications"
35392   },
35393   {
35394     "type": "put",
35395     "url": "/api/whatsapp/applications/{id}",
35396     "title": "Update an existing Application",
35397     "examples": [
35398       {
35399         "title": "Example usage:",
35400         "content": "curl https://{domain}/api/whatsapp/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35401         "type": "json"
35402       }
35403     ],
35404     "name": "updateApplications",
35405     "group": "Whatsapp_Applications",
35406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35407     "version": "0.0.0",
35408     "filename": "server/api/whatsappApplication/index.js",
35409     "groupTitle": "Whatsapp_Applications"
35410   },
35411   {
35412     "type": "post",
35413     "url": "/api/whatsapp/interactions/{id}/tags",
35414     "title": "Add tags to the interaction",
35415     "examples": [
35416       {
35417         "title": "Example usage:",
35418         "content": "curl https://{domain}/api/whatsapp/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35419         "type": "json"
35420       }
35421     ],
35422     "name": "AddTags",
35423     "group": "Whatsapp_Interactions",
35424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35425     "version": "0.0.0",
35426     "filename": "server/api/whatsappInteraction/index.js",
35427     "groupTitle": "Whatsapp_Interactions"
35428   },
35429   {
35430     "type": "post",
35431     "url": "/api/whatsapp/interactions",
35432     "title": "Creates a new Interaction",
35433     "examples": [
35434       {
35435         "title": "Example usage:",
35436         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35437         "type": "json"
35438       }
35439     ],
35440     "name": "CreateInteractions",
35441     "group": "Whatsapp_Interactions",
35442     "parameter": {
35443       "fields": {
35444         "Body": [
35445           {
35446             "group": "Body",
35447             "type": "Boolean",
35448             "optional": true,
35449             "field": "closed",
35450             "description": ""
35451           },
35452           {
35453             "group": "Body",
35454             "type": "String",
35455             "optional": true,
35456             "field": "closedAt",
35457             "description": ""
35458           },
35459           {
35460             "group": "Body",
35461             "type": "String",
35462             "optional": true,
35463             "field": "disposition",
35464             "description": ""
35465           },
35466           {
35467             "group": "Body",
35468             "type": "String",
35469             "optional": true,
35470             "field": "secondDisposition",
35471             "description": ""
35472           },
35473           {
35474             "group": "Body",
35475             "type": "String",
35476             "optional": true,
35477             "field": "thirdDisposition",
35478             "description": ""
35479           },
35480           {
35481             "group": "Body",
35482             "type": "String",
35483             "optional": true,
35484             "field": "note",
35485             "description": ""
35486           },
35487           {
35488             "group": "Body",
35489             "type": "String",
35490             "optional": true,
35491             "field": "phone",
35492             "description": ""
35493           },
35494           {
35495             "group": "Body",
35496             "type": "String",
35497             "optional": true,
35498             "field": "read1stAt",
35499             "description": ""
35500           },
35501           {
35502             "group": "Body",
35503             "type": "String",
35504             "allowedValues": [
35505               "\"in\"",
35506               "\"out\""
35507             ],
35508             "optional": false,
35509             "field": "firstMsgDirection",
35510             "description": ""
35511           },
35512           {
35513             "group": "Body",
35514             "type": "String",
35515             "optional": true,
35516             "field": "lastMsgAt",
35517             "description": ""
35518           },
35519           {
35520             "group": "Body",
35521             "type": "String",
35522             "allowedValues": [
35523               "\"in\"",
35524               "\"out\""
35525             ],
35526             "optional": false,
35527             "field": "lastMsgDirection",
35528             "description": ""
35529           },
35530           {
35531             "group": "Body",
35532             "type": "Boolean",
35533             "optional": true,
35534             "field": "autoreplyExecuted",
35535             "description": ""
35536           }
35537         ]
35538       }
35539     },
35540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35541     "version": "0.0.0",
35542     "filename": "server/api/whatsappInteraction/index.js",
35543     "groupTitle": "Whatsapp_Interactions"
35544   },
35545   {
35546     "type": "delete",
35547     "url": "/api/whatsapp/interactions/{id}",
35548     "title": "Deletes a Interaction",
35549     "examples": [
35550       {
35551         "title": "Example usage:",
35552         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35553         "type": "json"
35554       }
35555     ],
35556     "name": "DeleteInteractions",
35557     "group": "Whatsapp_Interactions",
35558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35559     "version": "0.0.0",
35560     "filename": "server/api/whatsappInteraction/index.js",
35561     "groupTitle": "Whatsapp_Interactions"
35562   },
35563   {
35564     "type": "get",
35565     "url": "/api/whatsapp/interactions/describe",
35566     "title": "Gets table info about Interactions",
35567     "examples": [
35568       {
35569         "title": "Example usage:",
35570         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35571         "type": "json"
35572       }
35573     ],
35574     "name": "DescribeInteractions",
35575     "group": "Whatsapp_Interactions",
35576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35577     "version": "0.0.0",
35578     "filename": "server/api/whatsappInteraction/index.js",
35579     "groupTitle": "Whatsapp_Interactions"
35580   },
35581   {
35582     "type": "get",
35583     "url": "/api/whatsapp/interactions",
35584     "title": "Gets a list of Interactions",
35585     "examples": [
35586       {
35587         "title": "Example usage:",
35588         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35589         "type": "json"
35590       }
35591     ],
35592     "name": "GetInteractions",
35593     "group": "Whatsapp_Interactions",
35594     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35595     "version": "0.0.0",
35596     "filename": "server/api/whatsappInteraction/index.js",
35597     "groupTitle": "Whatsapp_Interactions"
35598   },
35599   {
35600     "type": "delete",
35601     "url": "/api/whatsapp/interactions/{id}/tags",
35602     "title": "Removes tags from interaction",
35603     "examples": [
35604       {
35605         "title": "Example usage:",
35606         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35607         "type": "json"
35608       }
35609     ],
35610     "name": "RemoveTags",
35611     "group": "Whatsapp_Interactions",
35612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35613     "version": "0.0.0",
35614     "filename": "server/api/whatsappInteraction/index.js",
35615     "groupTitle": "Whatsapp_Interactions"
35616   },
35617   {
35618     "type": "get",
35619     "url": "/api/whatsapp/interactions/{id}",
35620     "title": "Gets a single Interaction",
35621     "examples": [
35622       {
35623         "title": "Example usage:",
35624         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35625         "type": "json"
35626       }
35627     ],
35628     "name": "ShowInteractions",
35629     "group": "Whatsapp_Interactions",
35630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631     "version": "0.0.0",
35632     "filename": "server/api/whatsappInteraction/index.js",
35633     "groupTitle": "Whatsapp_Interactions"
35634   },
35635   {
35636     "type": "post",
35637     "url": "/api/whatsapp/interactions/{id}/messages",
35638     "title": "Creates new messages",
35639     "examples": [
35640       {
35641         "title": "Example usage:",
35642         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35643         "type": "json"
35644       }
35645     ],
35646     "name": "addMessage",
35647     "group": "Whatsapp_Interactions",
35648     "parameter": {
35649       "fields": {
35650         "Body": [
35651           {
35652             "group": "Body",
35653             "type": "Text",
35654             "optional": false,
35655             "field": "body",
35656             "description": ""
35657           },
35658           {
35659             "group": "Body",
35660             "type": "Boolean",
35661             "optional": true,
35662             "field": "read",
35663             "description": ""
35664           },
35665           {
35666             "group": "Body",
35667             "type": "String",
35668             "allowedValues": [
35669               "\"in\"",
35670               "\"out\""
35671             ],
35672             "optional": false,
35673             "field": "direction",
35674             "description": ""
35675           },
35676           {
35677             "group": "Body",
35678             "type": "String",
35679             "optional": true,
35680             "field": "messageId",
35681             "description": ""
35682           },
35683           {
35684             "group": "Body",
35685             "type": "String",
35686             "optional": true,
35687             "field": "phone",
35688             "description": ""
35689           },
35690           {
35691             "group": "Body",
35692             "type": "String",
35693             "optional": true,
35694             "field": "readAt",
35695             "description": ""
35696           },
35697           {
35698             "group": "Body",
35699             "type": "Boolean",
35700             "optional": true,
35701             "field": "secret",
35702             "description": ""
35703           },
35704           {
35705             "group": "Body",
35706             "type": "String",
35707             "optional": true,
35708             "field": "providerName",
35709             "description": ""
35710           },
35711           {
35712             "group": "Body",
35713             "type": "Text",
35714             "optional": true,
35715             "field": "providerResponse",
35716             "description": ""
35717           }
35718         ]
35719       }
35720     },
35721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35722     "version": "0.0.0",
35723     "filename": "server/api/whatsappInteraction/index.js",
35724     "groupTitle": "Whatsapp_Interactions"
35725   },
35726   {
35727     "type": "get",
35728     "url": "/api/whatsapp/interactions/{id}/download",
35729     "title": "Gets interaction",
35730     "examples": [
35731       {
35732         "title": "Example usage:",
35733         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35734         "type": "json"
35735       }
35736     ],
35737     "name": "download",
35738     "group": "Whatsapp_Interactions",
35739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35740     "version": "0.0.0",
35741     "filename": "server/api/whatsappInteraction/index.js",
35742     "groupTitle": "Whatsapp_Interactions"
35743   },
35744   {
35745     "type": "get",
35746     "url": "/api/whatsapp/interactions/{id}/messages",
35747     "title": "Gets interaction messages",
35748     "examples": [
35749       {
35750         "title": "Example usage:",
35751         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35752         "type": "json"
35753       }
35754     ],
35755     "name": "getMessages",
35756     "group": "Whatsapp_Interactions",
35757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35758     "version": "0.0.0",
35759     "filename": "server/api/whatsappInteraction/index.js",
35760     "groupTitle": "Whatsapp_Interactions"
35761   },
35762   {
35763     "type": "put",
35764     "url": "/api/whatsapp/interactions/{id}",
35765     "title": "Update an existing Interaction",
35766     "examples": [
35767       {
35768         "title": "Example usage:",
35769         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35770         "type": "json"
35771       }
35772     ],
35773     "name": "updateInteractions",
35774     "group": "Whatsapp_Interactions",
35775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35776     "version": "0.0.0",
35777     "filename": "server/api/whatsappInteraction/index.js",
35778     "groupTitle": "Whatsapp_Interactions"
35779   },
35780   {
35781     "type": "post",
35782     "url": "/api/whatsapp/messages",
35783     "title": "Creates a new Message",
35784     "examples": [
35785       {
35786         "title": "Example usage:",
35787         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35788         "type": "json"
35789       }
35790     ],
35791     "name": "CreateMessages",
35792     "group": "Whatsapp_Messages",
35793     "parameter": {
35794       "fields": {
35795         "Body": [
35796           {
35797             "group": "Body",
35798             "type": "Text",
35799             "optional": false,
35800             "field": "body",
35801             "description": ""
35802           },
35803           {
35804             "group": "Body",
35805             "type": "Boolean",
35806             "optional": true,
35807             "field": "read",
35808             "description": ""
35809           },
35810           {
35811             "group": "Body",
35812             "type": "String",
35813             "allowedValues": [
35814               "\"in\"",
35815               "\"out\""
35816             ],
35817             "optional": false,
35818             "field": "direction",
35819             "description": ""
35820           },
35821           {
35822             "group": "Body",
35823             "type": "String",
35824             "optional": true,
35825             "field": "messageId",
35826             "description": ""
35827           },
35828           {
35829             "group": "Body",
35830             "type": "String",
35831             "optional": true,
35832             "field": "phone",
35833             "description": ""
35834           },
35835           {
35836             "group": "Body",
35837             "type": "String",
35838             "optional": true,
35839             "field": "readAt",
35840             "description": ""
35841           },
35842           {
35843             "group": "Body",
35844             "type": "Boolean",
35845             "optional": true,
35846             "field": "secret",
35847             "description": ""
35848           },
35849           {
35850             "group": "Body",
35851             "type": "String",
35852             "optional": true,
35853             "field": "providerName",
35854             "description": ""
35855           },
35856           {
35857             "group": "Body",
35858             "type": "Text",
35859             "optional": true,
35860             "field": "providerResponse",
35861             "description": ""
35862           }
35863         ]
35864       }
35865     },
35866     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35867     "version": "0.0.0",
35868     "filename": "server/api/whatsappMessage/index.js",
35869     "groupTitle": "Whatsapp_Messages"
35870   },
35871   {
35872     "type": "delete",
35873     "url": "/api/whatsapp/messages/{id}",
35874     "title": "Deletes a Message",
35875     "examples": [
35876       {
35877         "title": "Example usage:",
35878         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35879         "type": "json"
35880       }
35881     ],
35882     "name": "DeleteMessages",
35883     "group": "Whatsapp_Messages",
35884     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35885     "version": "0.0.0",
35886     "filename": "server/api/whatsappMessage/index.js",
35887     "groupTitle": "Whatsapp_Messages"
35888   },
35889   {
35890     "type": "get",
35891     "url": "/api/whatsapp/messages/describe",
35892     "title": "Gets table info about Messages",
35893     "examples": [
35894       {
35895         "title": "Example usage:",
35896         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35897         "type": "json"
35898       }
35899     ],
35900     "name": "DescribeMessages",
35901     "group": "Whatsapp_Messages",
35902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35903     "version": "0.0.0",
35904     "filename": "server/api/whatsappMessage/index.js",
35905     "groupTitle": "Whatsapp_Messages"
35906   },
35907   {
35908     "type": "get",
35909     "url": "/api/whatsapp/messages",
35910     "title": "Gets a list of Messages",
35911     "examples": [
35912       {
35913         "title": "Example usage:",
35914         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35915         "type": "json"
35916       }
35917     ],
35918     "name": "GetMessages",
35919     "group": "Whatsapp_Messages",
35920     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35921     "version": "0.0.0",
35922     "filename": "server/api/whatsappMessage/index.js",
35923     "groupTitle": "Whatsapp_Messages"
35924   },
35925   {
35926     "type": "get",
35927     "url": "/api/whatsapp/messages/{id}",
35928     "title": "Gets a single Message",
35929     "examples": [
35930       {
35931         "title": "Example usage:",
35932         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35933         "type": "json"
35934       }
35935     ],
35936     "name": "ShowMessages",
35937     "group": "Whatsapp_Messages",
35938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35939     "version": "0.0.0",
35940     "filename": "server/api/whatsappMessage/index.js",
35941     "groupTitle": "Whatsapp_Messages"
35942   },
35943   {
35944     "type": "put",
35945     "url": "/api/whatsapp/messages/{id}",
35946     "title": "Update an existing Message",
35947     "examples": [
35948       {
35949         "title": "Example usage:",
35950         "content": "curl https://{domain}/api/whatsapp/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35951         "type": "json"
35952       }
35953     ],
35954     "name": "updateMessages",
35955     "group": "Whatsapp_Messages",
35956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35957     "version": "0.0.0",
35958     "filename": "server/api/whatsappMessage/index.js",
35959     "groupTitle": "Whatsapp_Messages"
35960   },
35961   {
35962     "type": "post",
35963     "url": "/api/whatsapp/reports/queue",
35964     "title": "Creates a new Whatsapp Queue Report",
35965     "examples": [
35966       {
35967         "title": "Example usage:",
35968         "content": "curl https://{domain}/api/whatsapp/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35969         "type": "json"
35970       }
35971     ],
35972     "name": "CreateWhatsapp_Queue_Reports",
35973     "group": "Whatsapp_Queue_Reports",
35974     "parameter": {
35975       "fields": {
35976         "Body": [
35977           {
35978             "group": "Body",
35979             "type": "String",
35980             "optional": false,
35981             "field": "uniqueid",
35982             "description": ""
35983           },
35984           {
35985             "group": "Body",
35986             "type": "String",
35987             "optional": true,
35988             "field": "from",
35989             "description": ""
35990           },
35991           {
35992             "group": "Body",
35993             "type": "String",
35994             "optional": true,
35995             "field": "joinAt",
35996             "description": ""
35997           },
35998           {
35999             "group": "Body",
36000             "type": "String",
36001             "optional": true,
36002             "field": "leaveAt",
36003             "description": ""
36004           },
36005           {
36006             "group": "Body",
36007             "type": "String",
36008             "optional": true,
36009             "field": "acceptAt",
36010             "description": ""
36011           },
36012           {
36013             "group": "Body",
36014             "type": "String",
36015             "optional": true,
36016             "field": "exitAt",
36017             "description": ""
36018           },
36019           {
36020             "group": "Body",
36021             "type": "String",
36022             "optional": true,
36023             "field": "reason",
36024             "description": ""
36025           }
36026         ]
36027       }
36028     },
36029     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36030     "version": "0.0.0",
36031     "filename": "server/api/whatsappQueueReport/index.js",
36032     "groupTitle": "Whatsapp_Queue_Reports"
36033   },
36034   {
36035     "type": "delete",
36036     "url": "/api/whatsapp/reports/queue/{id}",
36037     "title": "Deletes a Whatsapp Queue Report",
36038     "examples": [
36039       {
36040         "title": "Example usage:",
36041         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36042         "type": "json"
36043       }
36044     ],
36045     "name": "DeleteWhatsapp_Queue_Reports",
36046     "group": "Whatsapp_Queue_Reports",
36047     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36048     "version": "0.0.0",
36049     "filename": "server/api/whatsappQueueReport/index.js",
36050     "groupTitle": "Whatsapp_Queue_Reports"
36051   },
36052   {
36053     "type": "get",
36054     "url": "/api/whatsapp/reports/queue/describe",
36055     "title": "Gets table info about Whatsapp Queue Reports",
36056     "examples": [
36057       {
36058         "title": "Example usage:",
36059         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36060         "type": "json"
36061       }
36062     ],
36063     "name": "DescribeWhatsapp_Queue_Reports",
36064     "group": "Whatsapp_Queue_Reports",
36065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36066     "version": "0.0.0",
36067     "filename": "server/api/whatsappQueueReport/index.js",
36068     "groupTitle": "Whatsapp_Queue_Reports"
36069   },
36070   {
36071     "type": "get",
36072     "url": "/api/whatsapp/reports/queue",
36073     "title": "Gets a list of Whatsapp Queue Reports",
36074     "examples": [
36075       {
36076         "title": "Example usage:",
36077         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36078         "type": "json"
36079       }
36080     ],
36081     "name": "GetWhatsapp_Queue_Reports",
36082     "group": "Whatsapp_Queue_Reports",
36083     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36084     "version": "0.0.0",
36085     "filename": "server/api/whatsappQueueReport/index.js",
36086     "groupTitle": "Whatsapp_Queue_Reports"
36087   },
36088   {
36089     "type": "get",
36090     "url": "/api/whatsapp/reports/queue/{id}",
36091     "title": "Gets a single Whatsapp Queue Report",
36092     "examples": [
36093       {
36094         "title": "Example usage:",
36095         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36096         "type": "json"
36097       }
36098     ],
36099     "name": "ShowWhatsapp_Queue_Reports",
36100     "group": "Whatsapp_Queue_Reports",
36101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36102     "version": "0.0.0",
36103     "filename": "server/api/whatsappQueueReport/index.js",
36104     "groupTitle": "Whatsapp_Queue_Reports"
36105   },
36106   {
36107     "type": "put",
36108     "url": "/api/whatsapp/reports/queue/{id}",
36109     "title": "Update an existing Whatsapp Queue Report",
36110     "examples": [
36111       {
36112         "title": "Example usage:",
36113         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36114         "type": "json"
36115       }
36116     ],
36117     "name": "updateWhatsapp_Queue_Reports",
36118     "group": "Whatsapp_Queue_Reports",
36119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36120     "version": "0.0.0",
36121     "filename": "server/api/whatsappQueueReport/index.js",
36122     "groupTitle": "Whatsapp_Queue_Reports"
36123   },
36124   {
36125     "type": "post",
36126     "url": "/api/whatsapp/queues/{id}/users",
36127     "title": "Add agents to a queue",
36128     "examples": [
36129       {
36130         "title": "Example usage:",
36131         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36132         "type": "json"
36133       }
36134     ],
36135     "name": "AddAgents",
36136     "group": "Whatsapp_Queues",
36137     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36138     "version": "0.0.0",
36139     "filename": "server/api/whatsappQueue/index.js",
36140     "groupTitle": "Whatsapp_Queues"
36141   },
36142   {
36143     "type": "post",
36144     "url": "/api/whatsapp/queues/{id}/teams",
36145     "title": "Add teams to a queue",
36146     "examples": [
36147       {
36148         "title": "Example usage:",
36149         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36150         "type": "json"
36151       }
36152     ],
36153     "name": "AddTeams",
36154     "group": "Whatsapp_Queues",
36155     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36156     "version": "0.0.0",
36157     "filename": "server/api/whatsappQueue/index.js",
36158     "groupTitle": "Whatsapp_Queues"
36159   },
36160   {
36161     "type": "post",
36162     "url": "/api/whatsapp/queues",
36163     "title": "Creates a new Queue",
36164     "examples": [
36165       {
36166         "title": "Example usage:",
36167         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36168         "type": "json"
36169       }
36170     ],
36171     "name": "CreateQueues",
36172     "group": "Whatsapp_Queues",
36173     "parameter": {
36174       "fields": {
36175         "Body": [
36176           {
36177             "group": "Body",
36178             "type": "String",
36179             "optional": true,
36180             "field": "name",
36181             "description": ""
36182           },
36183           {
36184             "group": "Body",
36185             "type": "Integer",
36186             "optional": true,
36187             "field": "timeout",
36188             "description": ""
36189           },
36190           {
36191             "group": "Body",
36192             "type": "String",
36193             "allowedValues": [
36194               "\"rrmemory\"",
36195               "\"beepall\"",
36196               "\"roundrobin\""
36197             ],
36198             "optional": true,
36199             "field": "strategy",
36200             "description": ""
36201           },
36202           {
36203             "group": "Body",
36204             "type": "String",
36205             "optional": true,
36206             "field": "description",
36207             "description": ""
36208           }
36209         ]
36210       }
36211     },
36212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36213     "version": "0.0.0",
36214     "filename": "server/api/whatsappQueue/index.js",
36215     "groupTitle": "Whatsapp_Queues"
36216   },
36217   {
36218     "type": "delete",
36219     "url": "/api/whatsapp/queues/{id}",
36220     "title": "Deletes a Queue",
36221     "examples": [
36222       {
36223         "title": "Example usage:",
36224         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36225         "type": "json"
36226       }
36227     ],
36228     "name": "DeleteQueues",
36229     "group": "Whatsapp_Queues",
36230     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36231     "version": "0.0.0",
36232     "filename": "server/api/whatsappQueue/index.js",
36233     "groupTitle": "Whatsapp_Queues"
36234   },
36235   {
36236     "type": "get",
36237     "url": "/api/whatsapp/queues/describe",
36238     "title": "Gets table info about Queues",
36239     "examples": [
36240       {
36241         "title": "Example usage:",
36242         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36243         "type": "json"
36244       }
36245     ],
36246     "name": "DescribeQueues",
36247     "group": "Whatsapp_Queues",
36248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36249     "version": "0.0.0",
36250     "filename": "server/api/whatsappQueue/index.js",
36251     "groupTitle": "Whatsapp_Queues"
36252   },
36253   {
36254     "type": "get",
36255     "url": "/api/whatsapp/queues/{id}/users",
36256     "title": "Gets queue agents",
36257     "examples": [
36258       {
36259         "title": "Example usage:",
36260         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36261         "type": "json"
36262       }
36263     ],
36264     "name": "GetAgents",
36265     "group": "Whatsapp_Queues",
36266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36267     "version": "0.0.0",
36268     "filename": "server/api/whatsappQueue/index.js",
36269     "groupTitle": "Whatsapp_Queues"
36270   },
36271   {
36272     "type": "get",
36273     "url": "/api/whatsapp/queues/{id}/members",
36274     "title": "GetMembers",
36275     "examples": [
36276       {
36277         "title": "Example usage:",
36278         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36279         "type": "json"
36280       }
36281     ],
36282     "name": "GetMembers",
36283     "group": "Whatsapp_Queues",
36284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36285     "version": "0.0.0",
36286     "filename": "server/api/whatsappQueue/index.js",
36287     "groupTitle": "Whatsapp_Queues"
36288   },
36289   {
36290     "type": "get",
36291     "url": "/api/whatsapp/queues",
36292     "title": "Gets a list of Queues",
36293     "examples": [
36294       {
36295         "title": "Example usage:",
36296         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36297         "type": "json"
36298       }
36299     ],
36300     "name": "GetQueues",
36301     "group": "Whatsapp_Queues",
36302     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36303     "version": "0.0.0",
36304     "filename": "server/api/whatsappQueue/index.js",
36305     "groupTitle": "Whatsapp_Queues"
36306   },
36307   {
36308     "type": "get",
36309     "url": "/api/whatsapp/queues/{id}/teams",
36310     "title": "Gets queues list",
36311     "examples": [
36312       {
36313         "title": "Example usage:",
36314         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36315         "type": "json"
36316       }
36317     ],
36318     "name": "GetTeams",
36319     "group": "Whatsapp_Queues",
36320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36321     "version": "0.0.0",
36322     "filename": "server/api/whatsappQueue/index.js",
36323     "groupTitle": "Whatsapp_Queues"
36324   },
36325   {
36326     "type": "delete",
36327     "url": "/api/whatsapp/queues/{id}/users",
36328     "title": "Removes agents from a queue",
36329     "examples": [
36330       {
36331         "title": "Example usage:",
36332         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36333         "type": "json"
36334       }
36335     ],
36336     "name": "RemoveAgents",
36337     "group": "Whatsapp_Queues",
36338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36339     "version": "0.0.0",
36340     "filename": "server/api/whatsappQueue/index.js",
36341     "groupTitle": "Whatsapp_Queues"
36342   },
36343   {
36344     "type": "get",
36345     "url": "/api/whatsapp/queues/{id}",
36346     "title": "Gets a single Queue",
36347     "examples": [
36348       {
36349         "title": "Example usage:",
36350         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36351         "type": "json"
36352       }
36353     ],
36354     "name": "ShowQueues",
36355     "group": "Whatsapp_Queues",
36356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36357     "version": "0.0.0",
36358     "filename": "server/api/whatsappQueue/index.js",
36359     "groupTitle": "Whatsapp_Queues"
36360   },
36361   {
36362     "type": "put",
36363     "url": "/api/whatsapp/queues/{id}",
36364     "title": "Update an existing Queue",
36365     "examples": [
36366       {
36367         "title": "Example usage:",
36368         "content": "curl https://{domain}/api/whatsapp/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36369         "type": "json"
36370       }
36371     ],
36372     "name": "updateQueues",
36373     "group": "Whatsapp_Queues",
36374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36375     "version": "0.0.0",
36376     "filename": "server/api/whatsappQueue/index.js",
36377     "groupTitle": "Whatsapp_Queues"
36378   },
36379   {
36380     "type": "post",
36381     "url": "/api/whatsapp/reports/transfer",
36382     "title": "Creates a new Whatsapp Transfer Report",
36383     "examples": [
36384       {
36385         "title": "Example usage:",
36386         "content": "curl https://{domain}/api/whatsapp/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36387         "type": "json"
36388       }
36389     ],
36390     "name": "CreateWhatsapp_Transfer_Reports",
36391     "group": "Whatsapp_Transfer_Reports",
36392     "parameter": {
36393       "fields": {
36394         "Body": [
36395           {
36396             "group": "Body",
36397             "type": "String",
36398             "optional": false,
36399             "field": "uniqueid",
36400             "description": ""
36401           },
36402           {
36403             "group": "Body",
36404             "type": "String",
36405             "allowedValues": [
36406               "\"account\"",
36407               "\"agent\"",
36408               "\"queue\""
36409             ],
36410             "optional": false,
36411             "field": "type",
36412             "description": ""
36413           },
36414           {
36415             "group": "Body",
36416             "type": "String",
36417             "optional": true,
36418             "field": "transferredAt",
36419             "description": ""
36420           }
36421         ]
36422       }
36423     },
36424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36425     "version": "0.0.0",
36426     "filename": "server/api/whatsappTransferReport/index.js",
36427     "groupTitle": "Whatsapp_Transfer_Reports"
36428   },
36429   {
36430     "type": "delete",
36431     "url": "/api/whatsapp/reports/transfer/{id}",
36432     "title": "Deletes a Whatsapp Transfer Report",
36433     "examples": [
36434       {
36435         "title": "Example usage:",
36436         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36437         "type": "json"
36438       }
36439     ],
36440     "name": "DeleteWhatsapp_Transfer_Reports",
36441     "group": "Whatsapp_Transfer_Reports",
36442     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36443     "version": "0.0.0",
36444     "filename": "server/api/whatsappTransferReport/index.js",
36445     "groupTitle": "Whatsapp_Transfer_Reports"
36446   },
36447   {
36448     "type": "get",
36449     "url": "/api/whatsapp/reports/transfer/describe",
36450     "title": "Gets table info about Whatsapp Transfer Reports",
36451     "examples": [
36452       {
36453         "title": "Example usage:",
36454         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36455         "type": "json"
36456       }
36457     ],
36458     "name": "DescribeWhatsapp_Transfer_Reports",
36459     "group": "Whatsapp_Transfer_Reports",
36460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36461     "version": "0.0.0",
36462     "filename": "server/api/whatsappTransferReport/index.js",
36463     "groupTitle": "Whatsapp_Transfer_Reports"
36464   },
36465   {
36466     "type": "get",
36467     "url": "/api/whatsapp/reports/transfer",
36468     "title": "Gets a list of Whatsapp Transfer Reports",
36469     "examples": [
36470       {
36471         "title": "Example usage:",
36472         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36473         "type": "json"
36474       }
36475     ],
36476     "name": "GetWhatsapp_Transfer_Reports",
36477     "group": "Whatsapp_Transfer_Reports",
36478     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36479     "version": "0.0.0",
36480     "filename": "server/api/whatsappTransferReport/index.js",
36481     "groupTitle": "Whatsapp_Transfer_Reports"
36482   },
36483   {
36484     "type": "get",
36485     "url": "/api/whatsapp/reports/transfer/{id}",
36486     "title": "Gets a single Whatsapp Transfer Report",
36487     "examples": [
36488       {
36489         "title": "Example usage:",
36490         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36491         "type": "json"
36492       }
36493     ],
36494     "name": "ShowWhatsapp_Transfer_Reports",
36495     "group": "Whatsapp_Transfer_Reports",
36496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36497     "version": "0.0.0",
36498     "filename": "server/api/whatsappTransferReport/index.js",
36499     "groupTitle": "Whatsapp_Transfer_Reports"
36500   },
36501   {
36502     "type": "put",
36503     "url": "/api/whatsapp/reports/transfer/{id}",
36504     "title": "Update an existing Whatsapp Transfer Report",
36505     "examples": [
36506       {
36507         "title": "Example usage:",
36508         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36509         "type": "json"
36510       }
36511     ],
36512     "name": "updateWhatsapp_Transfer_Reports",
36513     "group": "Whatsapp_Transfer_Reports",
36514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36515     "version": "0.0.0",
36516     "filename": "server/api/whatsappTransferReport/index.js",
36517     "groupTitle": "Whatsapp_Transfer_Reports"
36518   },
36519   {
36520     "type": "post",
36521     "url": "/api/integrations/zendesk/accounts",
36522     "title": "Creates a new Zendesk Account",
36523     "examples": [
36524       {
36525         "title": "Example usage:",
36526         "content": "curl https://{domain}/api/integrations/zendesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36527         "type": "json"
36528       }
36529     ],
36530     "name": "CreateZendesk_Accounts",
36531     "group": "Zendesk_Accounts",
36532     "parameter": {
36533       "fields": {
36534         "Body": [
36535           {
36536             "group": "Body",
36537             "type": "String",
36538             "optional": true,
36539             "field": "name",
36540             "description": ""
36541           },
36542           {
36543             "group": "Body",
36544             "type": "String",
36545             "optional": true,
36546             "field": "description",
36547             "description": ""
36548           },
36549           {
36550             "group": "Body",
36551             "type": "String",
36552             "optional": true,
36553             "field": "username",
36554             "description": ""
36555           },
36556           {
36557             "group": "Body",
36558             "type": "String",
36559             "optional": true,
36560             "field": "password",
36561             "description": ""
36562           },
36563           {
36564             "group": "Body",
36565             "type": "String",
36566             "optional": true,
36567             "field": "token",
36568             "description": ""
36569           },
36570           {
36571             "group": "Body",
36572             "type": "String",
36573             "optional": true,
36574             "field": "remoteUri",
36575             "description": ""
36576           },
36577           {
36578             "group": "Body",
36579             "type": "String",
36580             "allowedValues": [
36581               "\"password\"",
36582               "\"token\""
36583             ],
36584             "optional": true,
36585             "field": "authType",
36586             "description": ""
36587           },
36588           {
36589             "group": "Body",
36590             "type": "String",
36591             "optional": false,
36592             "field": "serverUrl",
36593             "description": ""
36594           },
36595           {
36596             "group": "Body",
36597             "type": "String",
36598             "allowedValues": [
36599               "\"integrationTab\"",
36600               "\"newTab\""
36601             ],
36602             "optional": true,
36603             "field": "type",
36604             "description": ""
36605           }
36606         ]
36607       }
36608     },
36609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36610     "version": "0.0.0",
36611     "filename": "server/api/intZendeskAccount/index.js",
36612     "groupTitle": "Zendesk_Accounts"
36613   },
36614   {
36615     "type": "delete",
36616     "url": "/api/integrations/zendesk/accounts/{id}",
36617     "title": "Deletes a Zendesk Account",
36618     "examples": [
36619       {
36620         "title": "Example usage:",
36621         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36622         "type": "json"
36623       }
36624     ],
36625     "name": "DeleteZendesk_Accounts",
36626     "group": "Zendesk_Accounts",
36627     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36628     "version": "0.0.0",
36629     "filename": "server/api/intZendeskAccount/index.js",
36630     "groupTitle": "Zendesk_Accounts"
36631   },
36632   {
36633     "type": "get",
36634     "url": "/api/integrations/zendesk/accounts",
36635     "title": "Gets a list of Zendesk Accounts",
36636     "examples": [
36637       {
36638         "title": "Example usage:",
36639         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36640         "type": "json"
36641       }
36642     ],
36643     "name": "GetZendesk_Accounts",
36644     "group": "Zendesk_Accounts",
36645     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36646     "version": "0.0.0",
36647     "filename": "server/api/intZendeskAccount/index.js",
36648     "groupTitle": "Zendesk_Accounts"
36649   },
36650   {
36651     "type": "get",
36652     "url": "/api/integrations/zendesk/accounts/{id}",
36653     "title": "Gets a single Zendesk Account",
36654     "examples": [
36655       {
36656         "title": "Example usage:",
36657         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36658         "type": "json"
36659       }
36660     ],
36661     "name": "ShowZendesk_Accounts",
36662     "group": "Zendesk_Accounts",
36663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36664     "version": "0.0.0",
36665     "filename": "server/api/intZendeskAccount/index.js",
36666     "groupTitle": "Zendesk_Accounts"
36667   },
36668   {
36669     "type": "post",
36670     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36671     "title": "Creates new configuration",
36672     "examples": [
36673       {
36674         "title": "Example usage:",
36675         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36676         "type": "json"
36677       }
36678     ],
36679     "name": "addConfiguration",
36680     "group": "Zendesk_Accounts",
36681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36682     "version": "0.0.0",
36683     "filename": "server/api/intZendeskAccount/index.js",
36684     "groupTitle": "Zendesk_Accounts"
36685   },
36686   {
36687     "type": "get",
36688     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36689     "title": "Gets account configurations",
36690     "examples": [
36691       {
36692         "title": "Example usage:",
36693         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36694         "type": "json"
36695       }
36696     ],
36697     "name": "getConfigurations",
36698     "group": "Zendesk_Accounts",
36699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36700     "version": "0.0.0",
36701     "filename": "server/api/intZendeskAccount/index.js",
36702     "groupTitle": "Zendesk_Accounts"
36703   },
36704   {
36705     "type": "get",
36706     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36707     "title": "Gets account fields",
36708     "examples": [
36709       {
36710         "title": "Example usage:",
36711         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36712         "type": "json"
36713       }
36714     ],
36715     "name": "getFields",
36716     "group": "Zendesk_Accounts",
36717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36718     "version": "0.0.0",
36719     "filename": "server/api/intZendeskAccount/index.js",
36720     "groupTitle": "Zendesk_Accounts"
36721   },
36722   {
36723     "type": "put",
36724     "url": "/api/integrations/zendesk/accounts/{id}",
36725     "title": "Update an existing Zendesk Account",
36726     "examples": [
36727       {
36728         "title": "Example usage:",
36729         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36730         "type": "json"
36731       }
36732     ],
36733     "name": "updateZendesk_Accounts",
36734     "group": "Zendesk_Accounts",
36735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36736     "version": "0.0.0",
36737     "filename": "server/api/intZendeskAccount/index.js",
36738     "groupTitle": "Zendesk_Accounts"
36739   },
36740   {
36741     "type": "post",
36742     "url": "/api/integrations/zendesk/configurations",
36743     "title": "Creates a new Zendesk Configuration",
36744     "examples": [
36745       {
36746         "title": "Example usage:",
36747         "content": "curl https://{domain}/api/integrations/zendesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36748         "type": "json"
36749       }
36750     ],
36751     "name": "CreateZendesk_Configurations",
36752     "group": "Zendesk_Configurations",
36753     "parameter": {
36754       "fields": {
36755         "Body": [
36756           {
36757             "group": "Body",
36758             "type": "String",
36759             "optional": true,
36760             "field": "name",
36761             "description": ""
36762           },
36763           {
36764             "group": "Body",
36765             "type": "String",
36766             "optional": true,
36767             "field": "description",
36768             "description": ""
36769           }
36770         ]
36771       }
36772     },
36773     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36774     "version": "0.0.0",
36775     "filename": "server/api/intZendeskConfiguration/index.js",
36776     "groupTitle": "Zendesk_Configurations"
36777   },
36778   {
36779     "type": "delete",
36780     "url": "/api/integrations/zendesk/configurations/{id}",
36781     "title": "Deletes a Zendesk Configuration",
36782     "examples": [
36783       {
36784         "title": "Example usage:",
36785         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36786         "type": "json"
36787       }
36788     ],
36789     "name": "DeleteZendesk_Configurations",
36790     "group": "Zendesk_Configurations",
36791     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36792     "version": "0.0.0",
36793     "filename": "server/api/intZendeskConfiguration/index.js",
36794     "groupTitle": "Zendesk_Configurations"
36795   },
36796   {
36797     "type": "get",
36798     "url": "/api/integrations/zendesk/configurations",
36799     "title": "Gets a list of Zendesk Configurations",
36800     "examples": [
36801       {
36802         "title": "Example usage:",
36803         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36804         "type": "json"
36805       }
36806     ],
36807     "name": "GetZendesk_Configurations",
36808     "group": "Zendesk_Configurations",
36809     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36810     "version": "0.0.0",
36811     "filename": "server/api/intZendeskConfiguration/index.js",
36812     "groupTitle": "Zendesk_Configurations"
36813   },
36814   {
36815     "type": "get",
36816     "url": "/api/integrations/zendesk/configurations/{id}",
36817     "title": "Gets a single Zendesk Configuration",
36818     "examples": [
36819       {
36820         "title": "Example usage:",
36821         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36822         "type": "json"
36823       }
36824     ],
36825     "name": "ShowZendesk_Configurations",
36826     "group": "Zendesk_Configurations",
36827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36828     "version": "0.0.0",
36829     "filename": "server/api/intZendeskConfiguration/index.js",
36830     "groupTitle": "Zendesk_Configurations"
36831   },
36832   {
36833     "type": "get",
36834     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36835     "title": "Gets configurations descriptions",
36836     "examples": [
36837       {
36838         "title": "Example usage:",
36839         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36840         "type": "json"
36841       }
36842     ],
36843     "name": "getDescriptions",
36844     "group": "Zendesk_Configurations",
36845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36846     "version": "0.0.0",
36847     "filename": "server/api/intZendeskConfiguration/index.js",
36848     "groupTitle": "Zendesk_Configurations"
36849   },
36850   {
36851     "type": "get",
36852     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36853     "title": "Gets configurations fields",
36854     "examples": [
36855       {
36856         "title": "Example usage:",
36857         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36858         "type": "json"
36859       }
36860     ],
36861     "name": "getFields",
36862     "group": "Zendesk_Configurations",
36863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36864     "version": "0.0.0",
36865     "filename": "server/api/intZendeskConfiguration/index.js",
36866     "groupTitle": "Zendesk_Configurations"
36867   },
36868   {
36869     "type": "get",
36870     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36871     "title": "Gets configurations subjects",
36872     "examples": [
36873       {
36874         "title": "Example usage:",
36875         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36876         "type": "json"
36877       }
36878     ],
36879     "name": "getSubjects",
36880     "group": "Zendesk_Configurations",
36881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36882     "version": "0.0.0",
36883     "filename": "server/api/intZendeskConfiguration/index.js",
36884     "groupTitle": "Zendesk_Configurations"
36885   },
36886   {
36887     "type": "get",
36888     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36889     "title": "Gets configurations tags",
36890     "examples": [
36891       {
36892         "title": "Example usage:",
36893         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36894         "type": "json"
36895       }
36896     ],
36897     "name": "getTags",
36898     "group": "Zendesk_Configurations",
36899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36900     "version": "0.0.0",
36901     "filename": "server/api/intZendeskConfiguration/index.js",
36902     "groupTitle": "Zendesk_Configurations"
36903   },
36904   {
36905     "type": "post",
36906     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36907     "title": "Sets new tags",
36908     "examples": [
36909       {
36910         "title": "Example usage:",
36911         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36912         "type": "json"
36913       }
36914     ],
36915     "name": "setTags",
36916     "group": "Zendesk_Configurations",
36917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36918     "version": "0.0.0",
36919     "filename": "server/api/intZendeskConfiguration/index.js",
36920     "groupTitle": "Zendesk_Configurations"
36921   },
36922   {
36923     "type": "put",
36924     "url": "/api/integrations/zendesk/configurations/{id}",
36925     "title": "Update an existing Zendesk Configuration",
36926     "examples": [
36927       {
36928         "title": "Example usage:",
36929         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36930         "type": "json"
36931       }
36932     ],
36933     "name": "updateZendesk_Configurations",
36934     "group": "Zendesk_Configurations",
36935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36936     "version": "0.0.0",
36937     "filename": "server/api/intZendeskConfiguration/index.js",
36938     "groupTitle": "Zendesk_Configurations"
36939   },
36940   {
36941     "type": "post",
36942     "url": "/api/integrations/zendesk/fields",
36943     "title": "Creates a new Zendesk Field",
36944     "examples": [
36945       {
36946         "title": "Example usage:",
36947         "content": "curl https://{domain}/api/integrations/zendesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36948         "type": "json"
36949       }
36950     ],
36951     "name": "CreateZendesk_Fields",
36952     "group": "Zendesk_Fields",
36953     "parameter": {
36954       "fields": {
36955         "Body": [
36956           {
36957             "group": "Body",
36958             "type": "String",
36959             "allowedValues": [
36960               "\"string\"",
36961               "\"variable\"",
36962               "\"customVariable\"",
36963               "\"keyValue\"",
36964               "\"picklist\""
36965             ],
36966             "optional": true,
36967             "field": "type",
36968             "description": ""
36969           },
36970           {
36971             "group": "Body",
36972             "type": "String",
36973             "optional": true,
36974             "field": "content",
36975             "description": ""
36976           },
36977           {
36978             "group": "Body",
36979             "type": "String",
36980             "optional": true,
36981             "field": "key",
36982             "description": ""
36983           },
36984           {
36985             "group": "Body",
36986             "type": "String",
36987             "allowedValues": [
36988               "\"string\"",
36989               "\"variable\"",
36990               "\"customVariable\""
36991             ],
36992             "optional": true,
36993             "field": "keyType",
36994             "description": ""
36995           },
36996           {
36997             "group": "Body",
36998             "type": "String",
36999             "optional": true,
37000             "field": "keyContent",
37001             "description": ""
37002           },
37003           {
37004             "group": "Body",
37005             "type": "String",
37006             "optional": true,
37007             "field": "idField",
37008             "description": ""
37009           },
37010           {
37011             "group": "Body",
37012             "type": "String",
37013             "optional": true,
37014             "field": "nameField",
37015             "description": ""
37016           },
37017           {
37018             "group": "Body",
37019             "type": "Boolean",
37020             "optional": true,
37021             "field": "customField",
37022             "description": ""
37023           },
37024           {
37025             "group": "Body",
37026             "type": "String",
37027             "optional": true,
37028             "field": "variableName",
37029             "description": ""
37030           }
37031         ]
37032       }
37033     },
37034     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37035     "version": "0.0.0",
37036     "filename": "server/api/intZendeskField/index.js",
37037     "groupTitle": "Zendesk_Fields"
37038   },
37039   {
37040     "type": "delete",
37041     "url": "/api/integrations/zendesk/fields/{id}",
37042     "title": "Deletes a Zendesk Field",
37043     "examples": [
37044       {
37045         "title": "Example usage:",
37046         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37047         "type": "json"
37048       }
37049     ],
37050     "name": "DeleteZendesk_Fields",
37051     "group": "Zendesk_Fields",
37052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37053     "version": "0.0.0",
37054     "filename": "server/api/intZendeskField/index.js",
37055     "groupTitle": "Zendesk_Fields"
37056   },
37057   {
37058     "type": "get",
37059     "url": "/api/integrations/zendesk/fields",
37060     "title": "Gets a list of Zendesk Fields",
37061     "examples": [
37062       {
37063         "title": "Example usage:",
37064         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37065         "type": "json"
37066       }
37067     ],
37068     "name": "GetZendesk_Fields",
37069     "group": "Zendesk_Fields",
37070     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37071     "version": "0.0.0",
37072     "filename": "server/api/intZendeskField/index.js",
37073     "groupTitle": "Zendesk_Fields"
37074   },
37075   {
37076     "type": "get",
37077     "url": "/api/integrations/zendesk/fields/{id}",
37078     "title": "Gets a single Zendesk Field",
37079     "examples": [
37080       {
37081         "title": "Example usage:",
37082         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37083         "type": "json"
37084       }
37085     ],
37086     "name": "ShowZendesk_Fields",
37087     "group": "Zendesk_Fields",
37088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37089     "version": "0.0.0",
37090     "filename": "server/api/intZendeskField/index.js",
37091     "groupTitle": "Zendesk_Fields"
37092   },
37093   {
37094     "type": "put",
37095     "url": "/api/integrations/zendesk/fields/{id}",
37096     "title": "Update an existing Zendesk Field",
37097     "examples": [
37098       {
37099         "title": "Example usage:",
37100         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37101         "type": "json"
37102       }
37103     ],
37104     "name": "updateZendesk_Fields",
37105     "group": "Zendesk_Fields",
37106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37107     "version": "0.0.0",
37108     "filename": "server/api/intZendeskField/index.js",
37109     "groupTitle": "Zendesk_Fields"
37110   },
37111   {
37112     "type": "post",
37113     "url": "/api/integrations/zoho/accounts",
37114     "title": "Creates a new Zoho Account",
37115     "examples": [
37116       {
37117         "title": "Example usage:",
37118         "content": "curl https://{domain}/api/integrations/zoho/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37119         "type": "json"
37120       }
37121     ],
37122     "name": "CreateZoho_Accounts",
37123     "group": "Zoho_Accounts",
37124     "parameter": {
37125       "fields": {
37126         "Body": [
37127           {
37128             "group": "Body",
37129             "type": "String",
37130             "optional": true,
37131             "field": "name",
37132             "description": ""
37133           },
37134           {
37135             "group": "Body",
37136             "type": "String",
37137             "optional": true,
37138             "field": "description",
37139             "description": ""
37140           },
37141           {
37142             "group": "Body",
37143             "type": "String",
37144             "optional": true,
37145             "field": "host",
37146             "description": ""
37147           },
37148           {
37149             "group": "Body",
37150             "type": "String",
37151             "optional": true,
37152             "field": "zone",
37153             "description": ""
37154           },
37155           {
37156             "group": "Body",
37157             "type": "String",
37158             "optional": true,
37159             "field": "clientId",
37160             "description": ""
37161           },
37162           {
37163             "group": "Body",
37164             "type": "String",
37165             "optional": true,
37166             "field": "clientSecret",
37167             "description": ""
37168           },
37169           {
37170             "group": "Body",
37171             "type": "String",
37172             "optional": false,
37173             "field": "serverUrl",
37174             "description": ""
37175           },
37176           {
37177             "group": "Body",
37178             "type": "String",
37179             "optional": true,
37180             "field": "code",
37181             "description": ""
37182           },
37183           {
37184             "group": "Body",
37185             "type": "String",
37186             "optional": true,
37187             "field": "refreshToken",
37188             "description": ""
37189           }
37190         ]
37191       }
37192     },
37193     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37194     "version": "0.0.0",
37195     "filename": "server/api/intZohoAccount/index.js",
37196     "groupTitle": "Zoho_Accounts"
37197   },
37198   {
37199     "type": "delete",
37200     "url": "/api/integrations/zoho/accounts/{id}",
37201     "title": "Deletes a Zoho Account",
37202     "examples": [
37203       {
37204         "title": "Example usage:",
37205         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37206         "type": "json"
37207       }
37208     ],
37209     "name": "DeleteZoho_Accounts",
37210     "group": "Zoho_Accounts",
37211     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37212     "version": "0.0.0",
37213     "filename": "server/api/intZohoAccount/index.js",
37214     "groupTitle": "Zoho_Accounts"
37215   },
37216   {
37217     "type": "get",
37218     "url": "/api/integrations/zoho/accounts",
37219     "title": "Gets a list of Zoho Accounts",
37220     "examples": [
37221       {
37222         "title": "Example usage:",
37223         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37224         "type": "json"
37225       }
37226     ],
37227     "name": "GetZoho_Accounts",
37228     "group": "Zoho_Accounts",
37229     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37230     "version": "0.0.0",
37231     "filename": "server/api/intZohoAccount/index.js",
37232     "groupTitle": "Zoho_Accounts"
37233   },
37234   {
37235     "type": "get",
37236     "url": "/api/integrations/zoho/accounts/{id}",
37237     "title": "Gets a single Zoho Account",
37238     "examples": [
37239       {
37240         "title": "Example usage:",
37241         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37242         "type": "json"
37243       }
37244     ],
37245     "name": "ShowZoho_Accounts",
37246     "group": "Zoho_Accounts",
37247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37248     "version": "0.0.0",
37249     "filename": "server/api/intZohoAccount/index.js",
37250     "groupTitle": "Zoho_Accounts"
37251   },
37252   {
37253     "type": "post",
37254     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37255     "title": "Creates new configuration",
37256     "examples": [
37257       {
37258         "title": "Example usage:",
37259         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37260         "type": "json"
37261       }
37262     ],
37263     "name": "addConfiguration",
37264     "group": "Zoho_Accounts",
37265     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37266     "version": "0.0.0",
37267     "filename": "server/api/intZohoAccount/index.js",
37268     "groupTitle": "Zoho_Accounts"
37269   },
37270   {
37271     "type": "get",
37272     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37273     "title": "Gets account configurations",
37274     "examples": [
37275       {
37276         "title": "Example usage:",
37277         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37278         "type": "json"
37279       }
37280     ],
37281     "name": "getConfigurations",
37282     "group": "Zoho_Accounts",
37283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37284     "version": "0.0.0",
37285     "filename": "server/api/intZohoAccount/index.js",
37286     "groupTitle": "Zoho_Accounts"
37287   },
37288   {
37289     "type": "get",
37290     "url": "/api/integrations/zoho/accounts/{id}/fields",
37291     "title": "Gets account fields",
37292     "examples": [
37293       {
37294         "title": "Example usage:",
37295         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37296         "type": "json"
37297       }
37298     ],
37299     "name": "getFields",
37300     "group": "Zoho_Accounts",
37301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37302     "version": "0.0.0",
37303     "filename": "server/api/intZohoAccount/index.js",
37304     "groupTitle": "Zoho_Accounts"
37305   },
37306   {
37307     "type": "put",
37308     "url": "/api/integrations/zoho/accounts/{id}",
37309     "title": "Update an existing Zoho Account",
37310     "examples": [
37311       {
37312         "title": "Example usage:",
37313         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37314         "type": "json"
37315       }
37316     ],
37317     "name": "updateZoho_Accounts",
37318     "group": "Zoho_Accounts",
37319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37320     "version": "0.0.0",
37321     "filename": "server/api/intZohoAccount/index.js",
37322     "groupTitle": "Zoho_Accounts"
37323   },
37324   {
37325     "type": "post",
37326     "url": "/api/integrations/zoho/configurations",
37327     "title": "Creates a new Zoho Configuration",
37328     "examples": [
37329       {
37330         "title": "Example usage:",
37331         "content": "curl https://{domain}/api/integrations/zoho/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37332         "type": "json"
37333       }
37334     ],
37335     "name": "CreateZoho_Configurations",
37336     "group": "Zoho_Configurations",
37337     "parameter": {
37338       "fields": {
37339         "Body": [
37340           {
37341             "group": "Body",
37342             "type": "String",
37343             "optional": true,
37344             "field": "name",
37345             "description": ""
37346           },
37347           {
37348             "group": "Body",
37349             "type": "String",
37350             "allowedValues": [
37351               "\"lead\"",
37352               "\"contact\"",
37353               "\"nothing\""
37354             ],
37355             "optional": true,
37356             "field": "moduleCreate",
37357             "description": ""
37358           },
37359           {
37360             "group": "Body",
37361             "type": "String",
37362             "allowedValues": [
37363               "\"contact_lead\"",
37364               "\"contact\"",
37365               "\"lead\""
37366             ],
37367             "optional": true,
37368             "field": "moduleSearch",
37369             "description": ""
37370           },
37371           {
37372             "group": "Body",
37373             "type": "String",
37374             "optional": true,
37375             "field": "description",
37376             "description": ""
37377           }
37378         ]
37379       }
37380     },
37381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37382     "version": "0.0.0",
37383     "filename": "server/api/intZohoConfiguration/index.js",
37384     "groupTitle": "Zoho_Configurations"
37385   },
37386   {
37387     "type": "delete",
37388     "url": "/api/integrations/zoho/configurations/{id}",
37389     "title": "Deletes a Zoho Configuration",
37390     "examples": [
37391       {
37392         "title": "Example usage:",
37393         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37394         "type": "json"
37395       }
37396     ],
37397     "name": "DeleteZoho_Configurations",
37398     "group": "Zoho_Configurations",
37399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37400     "version": "0.0.0",
37401     "filename": "server/api/intZohoConfiguration/index.js",
37402     "groupTitle": "Zoho_Configurations"
37403   },
37404   {
37405     "type": "get",
37406     "url": "/api/integrations/zoho/configurations",
37407     "title": "Gets a list of Zoho Configurations",
37408     "examples": [
37409       {
37410         "title": "Example usage:",
37411         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37412         "type": "json"
37413       }
37414     ],
37415     "name": "GetZoho_Configurations",
37416     "group": "Zoho_Configurations",
37417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37418     "version": "0.0.0",
37419     "filename": "server/api/intZohoConfiguration/index.js",
37420     "groupTitle": "Zoho_Configurations"
37421   },
37422   {
37423     "type": "get",
37424     "url": "/api/integrations/zoho/configurations/{id}",
37425     "title": "Gets a single Zoho Configuration",
37426     "examples": [
37427       {
37428         "title": "Example usage:",
37429         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37430         "type": "json"
37431       }
37432     ],
37433     "name": "ShowZoho_Configurations",
37434     "group": "Zoho_Configurations",
37435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37436     "version": "0.0.0",
37437     "filename": "server/api/intZohoConfiguration/index.js",
37438     "groupTitle": "Zoho_Configurations"
37439   },
37440   {
37441     "type": "get",
37442     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37443     "title": "Gets configurations descriptions",
37444     "examples": [
37445       {
37446         "title": "Example usage:",
37447         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37448         "type": "json"
37449       }
37450     ],
37451     "name": "getDescriptions",
37452     "group": "Zoho_Configurations",
37453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37454     "version": "0.0.0",
37455     "filename": "server/api/intZohoConfiguration/index.js",
37456     "groupTitle": "Zoho_Configurations"
37457   },
37458   {
37459     "type": "get",
37460     "url": "/api/integrations/zoho/configurations/{id}/fields",
37461     "title": "Gets configurations fields",
37462     "examples": [
37463       {
37464         "title": "Example usage:",
37465         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37466         "type": "json"
37467       }
37468     ],
37469     "name": "getFields",
37470     "group": "Zoho_Configurations",
37471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37472     "version": "0.0.0",
37473     "filename": "server/api/intZohoConfiguration/index.js",
37474     "groupTitle": "Zoho_Configurations"
37475   },
37476   {
37477     "type": "get",
37478     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37479     "title": "Gets configurations subjects",
37480     "examples": [
37481       {
37482         "title": "Example usage:",
37483         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37484         "type": "json"
37485       }
37486     ],
37487     "name": "getSubjects",
37488     "group": "Zoho_Configurations",
37489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37490     "version": "0.0.0",
37491     "filename": "server/api/intZohoConfiguration/index.js",
37492     "groupTitle": "Zoho_Configurations"
37493   },
37494   {
37495     "type": "put",
37496     "url": "/api/integrations/zoho/configurations/{id}",
37497     "title": "Update an existing Zoho Configuration",
37498     "examples": [
37499       {
37500         "title": "Example usage:",
37501         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37502         "type": "json"
37503       }
37504     ],
37505     "name": "updateZoho_Configurations",
37506     "group": "Zoho_Configurations",
37507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37508     "version": "0.0.0",
37509     "filename": "server/api/intZohoConfiguration/index.js",
37510     "groupTitle": "Zoho_Configurations"
37511   },
37512   {
37513     "type": "post",
37514     "url": "/api/integrations/zoho/fields",
37515     "title": "Creates a new Zoho Field",
37516     "examples": [
37517       {
37518         "title": "Example usage:",
37519         "content": "curl https://{domain}/api/integrations/zoho/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37520         "type": "json"
37521       }
37522     ],
37523     "name": "CreateZoho_Fields",
37524     "group": "Zoho_Fields",
37525     "parameter": {
37526       "fields": {
37527         "Body": [
37528           {
37529             "group": "Body",
37530             "type": "String",
37531             "allowedValues": [
37532               "\"string\"",
37533               "\"variable\"",
37534               "\"customVariable\"",
37535               "\"keyValue\"",
37536               "\"picklist\""
37537             ],
37538             "optional": true,
37539             "field": "type",
37540             "description": ""
37541           },
37542           {
37543             "group": "Body",
37544             "type": "String",
37545             "optional": true,
37546             "field": "content",
37547             "description": ""
37548           },
37549           {
37550             "group": "Body",
37551             "type": "String",
37552             "optional": true,
37553             "field": "key",
37554             "description": ""
37555           },
37556           {
37557             "group": "Body",
37558             "type": "String",
37559             "allowedValues": [
37560               "\"string\"",
37561               "\"variable\"",
37562               "\"customVariable\""
37563             ],
37564             "optional": true,
37565             "field": "keyType",
37566             "description": ""
37567           },
37568           {
37569             "group": "Body",
37570             "type": "String",
37571             "optional": true,
37572             "field": "keyContent",
37573             "description": ""
37574           },
37575           {
37576             "group": "Body",
37577             "type": "String",
37578             "optional": true,
37579             "field": "idField",
37580             "description": ""
37581           },
37582           {
37583             "group": "Body",
37584             "type": "String",
37585             "optional": true,
37586             "field": "nameField",
37587             "description": ""
37588           },
37589           {
37590             "group": "Body",
37591             "type": "Boolean",
37592             "optional": true,
37593             "field": "customField",
37594             "description": ""
37595           },
37596           {
37597             "group": "Body",
37598             "type": "String",
37599             "optional": true,
37600             "field": "variableName",
37601             "description": ""
37602           }
37603         ]
37604       }
37605     },
37606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37607     "version": "0.0.0",
37608     "filename": "server/api/intZohoField/index.js",
37609     "groupTitle": "Zoho_Fields"
37610   },
37611   {
37612     "type": "delete",
37613     "url": "/api/integrations/zoho/fields/{id}",
37614     "title": "Deletes a Zoho Field",
37615     "examples": [
37616       {
37617         "title": "Example usage:",
37618         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37619         "type": "json"
37620       }
37621     ],
37622     "name": "DeleteZoho_Fields",
37623     "group": "Zoho_Fields",
37624     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37625     "version": "0.0.0",
37626     "filename": "server/api/intZohoField/index.js",
37627     "groupTitle": "Zoho_Fields"
37628   },
37629   {
37630     "type": "get",
37631     "url": "/api/integrations/zoho/fields",
37632     "title": "Gets a list of Zoho Fields",
37633     "examples": [
37634       {
37635         "title": "Example usage:",
37636         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37637         "type": "json"
37638       }
37639     ],
37640     "name": "GetZoho_Fields",
37641     "group": "Zoho_Fields",
37642     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37643     "version": "0.0.0",
37644     "filename": "server/api/intZohoField/index.js",
37645     "groupTitle": "Zoho_Fields"
37646   },
37647   {
37648     "type": "get",
37649     "url": "/api/integrations/zoho/fields/{id}",
37650     "title": "Gets a single Zoho Field",
37651     "examples": [
37652       {
37653         "title": "Example usage:",
37654         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37655         "type": "json"
37656       }
37657     ],
37658     "name": "ShowZoho_Fields",
37659     "group": "Zoho_Fields",
37660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37661     "version": "0.0.0",
37662     "filename": "server/api/intZohoField/index.js",
37663     "groupTitle": "Zoho_Fields"
37664   },
37665   {
37666     "type": "put",
37667     "url": "/api/integrations/zoho/fields/{id}",
37668     "title": "Update an existing Zoho Field",
37669     "examples": [
37670       {
37671         "title": "Example usage:",
37672         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37673         "type": "json"
37674       }
37675     ],
37676     "name": "updateZoho_Fields",
37677     "group": "Zoho_Fields",
37678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37679     "version": "0.0.0",
37680     "filename": "server/api/intZohoField/index.js",
37681     "groupTitle": "Zoho_Fields"
37682   },
37683   {
37684     "type": "post",
37685     "url": "/api/cdr",
37686     "title": "Creates a new Cdr",
37687     "examples": [
37688       {
37689         "title": "Example usage:",
37690         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37691         "type": "json"
37692       }
37693     ],
37694     "name": "CreateCdrs",
37695     "group": "cdr",
37696     "parameter": {
37697       "fields": {
37698         "Body": [
37699           {
37700             "group": "Body",
37701             "type": "String",
37702             "optional": false,
37703             "field": "calldate",
37704             "description": ""
37705           },
37706           {
37707             "group": "Body",
37708             "type": "String",
37709             "optional": true,
37710             "field": "clid",
37711             "description": ""
37712           },
37713           {
37714             "group": "Body",
37715             "type": "String",
37716             "optional": true,
37717             "field": "src",
37718             "description": ""
37719           },
37720           {
37721             "group": "Body",
37722             "type": "String",
37723             "optional": true,
37724             "field": "dst",
37725             "description": ""
37726           },
37727           {
37728             "group": "Body",
37729             "type": "String",
37730             "optional": true,
37731             "field": "dcontext",
37732             "description": ""
37733           },
37734           {
37735             "group": "Body",
37736             "type": "String",
37737             "optional": true,
37738             "field": "channel",
37739             "description": ""
37740           },
37741           {
37742             "group": "Body",
37743             "type": "String",
37744             "optional": true,
37745             "field": "dstchannel",
37746             "description": ""
37747           },
37748           {
37749             "group": "Body",
37750             "type": "String",
37751             "optional": true,
37752             "field": "lastapp",
37753             "description": ""
37754           },
37755           {
37756             "group": "Body",
37757             "type": "String",
37758             "optional": true,
37759             "field": "lastdata",
37760             "description": ""
37761           },
37762           {
37763             "group": "Body",
37764             "type": "Integer",
37765             "optional": false,
37766             "field": "duration",
37767             "description": ""
37768           },
37769           {
37770             "group": "Body",
37771             "type": "Integer",
37772             "optional": false,
37773             "field": "billsec",
37774             "description": ""
37775           },
37776           {
37777             "group": "Body",
37778             "type": "String",
37779             "optional": true,
37780             "field": "disposition",
37781             "description": ""
37782           },
37783           {
37784             "group": "Body",
37785             "type": "Integer",
37786             "optional": false,
37787             "field": "amaflags",
37788             "description": ""
37789           },
37790           {
37791             "group": "Body",
37792             "type": "String",
37793             "optional": true,
37794             "field": "accountcode",
37795             "description": ""
37796           },
37797           {
37798             "group": "Body",
37799             "type": "String",
37800             "optional": true,
37801             "field": "userfield",
37802             "description": ""
37803           },
37804           {
37805             "group": "Body",
37806             "type": "String",
37807             "optional": true,
37808             "field": "uniqueid",
37809             "description": ""
37810           },
37811           {
37812             "group": "Body",
37813             "type": "String",
37814             "optional": true,
37815             "field": "linkedid",
37816             "description": ""
37817           },
37818           {
37819             "group": "Body",
37820             "type": "String",
37821             "optional": true,
37822             "field": "sequence",
37823             "description": ""
37824           },
37825           {
37826             "group": "Body",
37827             "type": "String",
37828             "optional": true,
37829             "field": "peeraccount",
37830             "description": ""
37831           },
37832           {
37833             "group": "Body",
37834             "type": "String",
37835             "optional": true,
37836             "field": "type",
37837             "description": ""
37838           },
37839           {
37840             "group": "Body",
37841             "type": "String",
37842             "optional": true,
37843             "field": "tag",
37844             "description": ""
37845           }
37846         ]
37847       }
37848     },
37849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37850     "version": "0.0.0",
37851     "filename": "server/api/cdr/index.js",
37852     "groupTitle": "cdr"
37853   },
37854   {
37855     "type": "delete",
37856     "url": "/api/cdr/{id}",
37857     "title": "Deletes a Cdr",
37858     "examples": [
37859       {
37860         "title": "Example usage:",
37861         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37862         "type": "json"
37863       }
37864     ],
37865     "name": "DeleteCdrs",
37866     "group": "cdr",
37867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37868     "version": "0.0.0",
37869     "filename": "server/api/cdr/index.js",
37870     "groupTitle": "cdr"
37871   },
37872   {
37873     "type": "get",
37874     "url": "/api/cdr/describe",
37875     "title": "Gets table info about Cdrs",
37876     "examples": [
37877       {
37878         "title": "Example usage:",
37879         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37880         "type": "json"
37881       }
37882     ],
37883     "name": "DescribeCdrs",
37884     "group": "cdr",
37885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37886     "version": "0.0.0",
37887     "filename": "server/api/cdr/index.js",
37888     "groupTitle": "cdr"
37889   },
37890   {
37891     "type": "get",
37892     "url": "/api/cdr",
37893     "title": "Gets a list of Cdrs",
37894     "examples": [
37895       {
37896         "title": "Example usage:",
37897         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37898         "type": "json"
37899       }
37900     ],
37901     "name": "GetCdrs",
37902     "group": "cdr",
37903     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cdr?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cdr?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cdr?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cdr?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cdr?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37904     "version": "0.0.0",
37905     "filename": "server/api/cdr/index.js",
37906     "groupTitle": "cdr"
37907   },
37908   {
37909     "type": "get",
37910     "url": "/api/cdr/{id}",
37911     "title": "Gets a single Cdr",
37912     "examples": [
37913       {
37914         "title": "Example usage:",
37915         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37916         "type": "json"
37917       }
37918     ],
37919     "name": "ShowCdrs",
37920     "group": "cdr",
37921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37922     "version": "0.0.0",
37923     "filename": "server/api/cdr/index.js",
37924     "groupTitle": "cdr"
37925   },
37926   {
37927     "type": "put",
37928     "url": "/api/cdr/{id}",
37929     "title": "Update an existing Cdr",
37930     "examples": [
37931       {
37932         "title": "Example usage:",
37933         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37934         "type": "json"
37935       }
37936     ],
37937     "name": "updateCdrs",
37938     "group": "cdr",
37939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37940     "version": "0.0.0",
37941     "filename": "server/api/cdr/index.js",
37942     "groupTitle": "cdr"
37943   },
37944   {
37945     "type": "post",
37946     "url": "/api/voiceQueuesLog",
37947     "title": "Creates a new VoiceQueuesLog",
37948     "examples": [
37949       {
37950         "title": "Example usage:",
37951         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37952         "type": "json"
37953       }
37954     ],
37955     "name": "CreateVoiceQueuesLogs",
37956     "group": "voiceQueuesLog",
37957     "parameter": {
37958       "fields": {
37959         "Body": [
37960           {
37961             "group": "Body",
37962             "type": "String",
37963             "optional": true,
37964             "field": "time",
37965             "description": ""
37966           },
37967           {
37968             "group": "Body",
37969             "type": "String",
37970             "optional": false,
37971             "field": "callid",
37972             "description": ""
37973           },
37974           {
37975             "group": "Body",
37976             "type": "String",
37977             "optional": false,
37978             "field": "queuename",
37979             "description": ""
37980           },
37981           {
37982             "group": "Body",
37983             "type": "String",
37984             "optional": false,
37985             "field": "agent",
37986             "description": ""
37987           },
37988           {
37989             "group": "Body",
37990             "type": "String",
37991             "optional": false,
37992             "field": "event",
37993             "description": ""
37994           },
37995           {
37996             "group": "Body",
37997             "type": "String",
37998             "optional": false,
37999             "field": "data",
38000             "description": ""
38001           },
38002           {
38003             "group": "Body",
38004             "type": "String",
38005             "optional": false,
38006             "field": "data1",
38007             "description": ""
38008           },
38009           {
38010             "group": "Body",
38011             "type": "String",
38012             "optional": false,
38013             "field": "data2",
38014             "description": ""
38015           },
38016           {
38017             "group": "Body",
38018             "type": "String",
38019             "optional": false,
38020             "field": "data3",
38021             "description": ""
38022           },
38023           {
38024             "group": "Body",
38025             "type": "String",
38026             "optional": false,
38027             "field": "data4",
38028             "description": ""
38029           },
38030           {
38031             "group": "Body",
38032             "type": "String",
38033             "optional": false,
38034             "field": "data5",
38035             "description": ""
38036           },
38037           {
38038             "group": "Body",
38039             "type": "String",
38040             "optional": false,
38041             "field": "dtm",
38042             "description": ""
38043           }
38044         ]
38045       }
38046     },
38047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38048     "version": "0.0.0",
38049     "filename": "server/api/voiceQueuesLog/index.js",
38050     "groupTitle": "voiceQueuesLog"
38051   },
38052   {
38053     "type": "delete",
38054     "url": "/api/voiceQueuesLog/{id}",
38055     "title": "Deletes a VoiceQueuesLog",
38056     "examples": [
38057       {
38058         "title": "Example usage:",
38059         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38060         "type": "json"
38061       }
38062     ],
38063     "name": "DeleteVoiceQueuesLogs",
38064     "group": "voiceQueuesLog",
38065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38066     "version": "0.0.0",
38067     "filename": "server/api/voiceQueuesLog/index.js",
38068     "groupTitle": "voiceQueuesLog"
38069   },
38070   {
38071     "type": "get",
38072     "url": "/api/voiceQueuesLog",
38073     "title": "Gets a list of VoiceQueuesLogs",
38074     "examples": [
38075       {
38076         "title": "Example usage:",
38077         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38078         "type": "json"
38079       }
38080     ],
38081     "name": "GetVoiceQueuesLogs",
38082     "group": "voiceQueuesLog",
38083     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voiceQueuesLog?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voiceQueuesLog?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voiceQueuesLog?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voiceQueuesLog?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voiceQueuesLog?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38084     "version": "0.0.0",
38085     "filename": "server/api/voiceQueuesLog/index.js",
38086     "groupTitle": "voiceQueuesLog"
38087   },
38088   {
38089     "type": "get",
38090     "url": "/api/voiceQueuesLog/{id}",
38091     "title": "Gets a single VoiceQueuesLog",
38092     "examples": [
38093       {
38094         "title": "Example usage:",
38095         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38096         "type": "json"
38097       }
38098     ],
38099     "name": "ShowVoiceQueuesLogs",
38100     "group": "voiceQueuesLog",
38101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38102     "version": "0.0.0",
38103     "filename": "server/api/voiceQueuesLog/index.js",
38104     "groupTitle": "voiceQueuesLog"
38105   },
38106   {
38107     "type": "put",
38108     "url": "/api/voiceQueuesLog/{id}",
38109     "title": "Update an existing VoiceQueuesLog",
38110     "examples": [
38111       {
38112         "title": "Example usage:",
38113         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38114         "type": "json"
38115       }
38116     ],
38117     "name": "updateVoiceQueuesLogs",
38118     "group": "voiceQueuesLog",
38119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38120     "version": "0.0.0",
38121     "filename": "server/api/voiceQueuesLog/index.js",
38122     "groupTitle": "voiceQueuesLog"
38123   }
38124 ]