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/local",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/local -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/authLocal/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/activedirectory",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/activedirectory -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/authActiveDirectory/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/auth/google",
1381     "title": "Creates a new User token",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/auth/google -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/authGoogle/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": "put",
7305     "url": "/api/cm/hopper/{id}",
7306     "title": "Update an existing Hopper",
7307     "examples": [
7308       {
7309         "title": "Example usage:",
7310         "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",
7311         "type": "json"
7312       }
7313     ],
7314     "name": "updateHopper",
7315     "group": "Cm_Hopper",
7316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
7323     "url": "/api/cm/lists",
7324     "title": "Creates a new List",
7325     "examples": [
7326       {
7327         "title": "Example usage:",
7328         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7329         "type": "json"
7330       }
7331     ],
7332     "name": "CreateLists",
7333     "group": "Cm_Lists",
7334     "parameter": {
7335       "fields": {
7336         "Body": [
7337           {
7338             "group": "Body",
7339             "type": "String",
7340             "optional": false,
7341             "field": "name",
7342             "description": ""
7343           },
7344           {
7345             "group": "Body",
7346             "type": "String",
7347             "optional": true,
7348             "field": "description",
7349             "description": ""
7350           },
7351           {
7352             "group": "Body",
7353             "type": "String",
7354             "optional": true,
7355             "field": "dialPrefix",
7356             "description": ""
7357           }
7358         ]
7359       }
7360     },
7361     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7362     "version": "0.0.0",
7363     "filename": "server/api/cmList/index.js",
7364     "groupTitle": "Cm_Lists"
7365   },
7366   {
7367     "type": "delete",
7368     "url": "/api/cm/lists/{id}",
7369     "title": "Deletes a List",
7370     "examples": [
7371       {
7372         "title": "Example usage:",
7373         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7374         "type": "json"
7375       }
7376     ],
7377     "name": "DeleteLists",
7378     "group": "Cm_Lists",
7379     "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>",
7380     "version": "0.0.0",
7381     "filename": "server/api/cmList/index.js",
7382     "groupTitle": "Cm_Lists"
7383   },
7384   {
7385     "type": "get",
7386     "url": "/api/cm/lists/describe",
7387     "title": "Gets table info about Lists",
7388     "examples": [
7389       {
7390         "title": "Example usage:",
7391         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7392         "type": "json"
7393       }
7394     ],
7395     "name": "DescribeLists",
7396     "group": "Cm_Lists",
7397     "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>",
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/{id}/users",
7405     "title": "Gets agents from list",
7406     "examples": [
7407       {
7408         "title": "Example usage:",
7409         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7410         "type": "json"
7411       }
7412     ],
7413     "name": "GetAgents",
7414     "group": "Cm_Lists",
7415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
7423     "title": "Gets a list of Lists",
7424     "examples": [
7425       {
7426         "title": "Example usage:",
7427         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7428         "type": "json"
7429       }
7430     ],
7431     "name": "GetLists",
7432     "group": "Cm_Lists",
7433     "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>",
7434     "version": "0.0.0",
7435     "filename": "server/api/cmList/index.js",
7436     "groupTitle": "Cm_Lists"
7437   },
7438   {
7439     "type": "delete",
7440     "url": "/api/cm/lists/{id}/users",
7441     "title": "Removes agents from a list",
7442     "examples": [
7443       {
7444         "title": "Example usage:",
7445         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7446         "type": "json"
7447       }
7448     ],
7449     "name": "RemoveAgents",
7450     "group": "Cm_Lists",
7451     "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>",
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}/dispositions",
7459     "title": "Removes dispositions from account",
7460     "examples": [
7461       {
7462         "title": "Example usage:",
7463         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7464         "type": "json"
7465       }
7466     ],
7467     "name": "RemoveDispositions",
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": "get",
7476     "url": "/api/cm/lists/{id}",
7477     "title": "Gets a single List",
7478     "examples": [
7479       {
7480         "title": "Example usage:",
7481         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7482         "type": "json"
7483       }
7484     ],
7485     "name": "ShowLists",
7486     "group": "Cm_Lists",
7487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
7494     "url": "/api/cm/lists/{id}/users",
7495     "title": "Adds agents to a list",
7496     "examples": [
7497       {
7498         "title": "Example usage:",
7499         "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",
7500         "type": "json"
7501       }
7502     ],
7503     "name": "addAgents",
7504     "group": "Cm_Lists",
7505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/contacts",
7513     "title": "Creates new contacts",
7514     "examples": [
7515       {
7516         "title": "Example usage:",
7517         "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",
7518         "type": "json"
7519       }
7520     ],
7521     "name": "addContacts",
7522     "group": "Cm_Lists",
7523     "parameter": {
7524       "fields": {
7525         "Body": [
7526           {
7527             "group": "Body",
7528             "type": "String",
7529             "optional": false,
7530             "field": "firstName",
7531             "description": ""
7532           },
7533           {
7534             "group": "Body",
7535             "type": "String",
7536             "optional": true,
7537             "field": "lastName",
7538             "description": ""
7539           },
7540           {
7541             "group": "Body",
7542             "type": "String",
7543             "optional": true,
7544             "field": "street",
7545             "description": ""
7546           },
7547           {
7548             "group": "Body",
7549             "type": "String",
7550             "optional": true,
7551             "field": "postalCode",
7552             "description": ""
7553           },
7554           {
7555             "group": "Body",
7556             "type": "String",
7557             "optional": true,
7558             "field": "city",
7559             "description": ""
7560           },
7561           {
7562             "group": "Body",
7563             "type": "String",
7564             "optional": true,
7565             "field": "country",
7566             "description": ""
7567           },
7568           {
7569             "group": "Body",
7570             "type": "String",
7571             "optional": true,
7572             "field": "dateOfBirth",
7573             "description": ""
7574           },
7575           {
7576             "group": "Body",
7577             "type": "Text",
7578             "optional": true,
7579             "field": "description",
7580             "description": ""
7581           },
7582           {
7583             "group": "Body",
7584             "type": "String",
7585             "optional": true,
7586             "field": "phone",
7587             "description": ""
7588           },
7589           {
7590             "group": "Body",
7591             "type": "String",
7592             "optional": true,
7593             "field": "mobile",
7594             "description": ""
7595           },
7596           {
7597             "group": "Body",
7598             "type": "String",
7599             "optional": true,
7600             "field": "fax",
7601             "description": ""
7602           },
7603           {
7604             "group": "Body",
7605             "type": "String",
7606             "optional": true,
7607             "field": "email",
7608             "description": ""
7609           },
7610           {
7611             "group": "Body",
7612             "type": "String",
7613             "optional": true,
7614             "field": "url",
7615             "description": ""
7616           },
7617           {
7618             "group": "Body",
7619             "type": "String",
7620             "optional": true,
7621             "field": "facebook",
7622             "description": ""
7623           },
7624           {
7625             "group": "Body",
7626             "type": "String",
7627             "optional": true,
7628             "field": "fb_data",
7629             "description": ""
7630           },
7631           {
7632             "group": "Body",
7633             "type": "String",
7634             "optional": true,
7635             "field": "twitter",
7636             "description": ""
7637           },
7638           {
7639             "group": "Body",
7640             "type": "String",
7641             "optional": true,
7642             "field": "skype",
7643             "description": ""
7644           },
7645           {
7646             "group": "Body",
7647             "type": "String",
7648             "optional": true,
7649             "field": "teams",
7650             "description": ""
7651           },
7652           {
7653             "group": "Body",
7654             "type": "String",
7655             "optional": true,
7656             "field": "viber",
7657             "description": ""
7658           },
7659           {
7660             "group": "Body",
7661             "type": "String",
7662             "optional": true,
7663             "field": "line",
7664             "description": ""
7665           },
7666           {
7667             "group": "Body",
7668             "type": "String",
7669             "optional": true,
7670             "field": "wechat",
7671             "description": ""
7672           },
7673           {
7674             "group": "Body",
7675             "type": "String",
7676             "optional": true,
7677             "field": "telegram",
7678             "description": ""
7679           },
7680           {
7681             "group": "Body",
7682             "type": "Integer",
7683             "optional": true,
7684             "field": "UserId",
7685             "description": ""
7686           },
7687           {
7688             "group": "Body",
7689             "type": "Integer",
7690             "optional": true,
7691             "field": "priority",
7692             "description": ""
7693           },
7694           {
7695             "group": "Body",
7696             "type": "String",
7697             "optional": true,
7698             "field": "scheduledat",
7699             "description": ""
7700           }
7701         ]
7702       }
7703     },
7704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7705     "version": "0.0.0",
7706     "filename": "server/api/cmList/index.js",
7707     "groupTitle": "Cm_Lists"
7708   },
7709   {
7710     "type": "post",
7711     "url": "/api/cm/lists/{id}/fields",
7712     "title": "Creates a new custom field",
7713     "examples": [
7714       {
7715         "title": "Example usage:",
7716         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7717         "type": "json"
7718       }
7719     ],
7720     "name": "addCustomField",
7721     "group": "Cm_Lists",
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}/dispositions",
7730     "title": "Creates new disposition",
7731     "examples": [
7732       {
7733         "title": "Example usage:",
7734         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7735         "type": "json"
7736       }
7737     ],
7738     "name": "addDisposition",
7739     "group": "Cm_Lists",
7740     "parameter": {
7741       "fields": {
7742         "Body": [
7743           {
7744             "group": "Body",
7745             "type": "String",
7746             "optional": false,
7747             "field": "name",
7748             "description": ""
7749           },
7750           {
7751             "group": "Body",
7752             "type": "String",
7753             "allowedValues": [
7754               "\"first\"",
7755               "\"second\"",
7756               "\"third\""
7757             ],
7758             "optional": false,
7759             "field": "level",
7760             "description": ""
7761           },
7762           {
7763             "group": "Body",
7764             "type": "String",
7765             "optional": true,
7766             "field": "description",
7767             "description": ""
7768           }
7769         ]
7770       }
7771     },
7772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7773     "version": "0.0.0",
7774     "filename": "server/api/cmList/index.js",
7775     "groupTitle": "Cm_Lists"
7776   },
7777   {
7778     "type": "get",
7779     "url": "/api/cm/lists/{id}/contacts",
7780     "title": "Gets List Contacts",
7781     "examples": [
7782       {
7783         "title": "Example usage:",
7784         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7785         "type": "json"
7786       }
7787     ],
7788     "name": "getContacts",
7789     "group": "Cm_Lists",
7790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
7798     "title": "Gets Custom Fields",
7799     "examples": [
7800       {
7801         "title": "Example usage:",
7802         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7803         "type": "json"
7804       }
7805     ],
7806     "name": "getCustomFields",
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}/dispositions",
7816     "title": "Gets list dispositions",
7817     "examples": [
7818       {
7819         "title": "Example usage:",
7820         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7821         "type": "json"
7822       }
7823     ],
7824     "name": "getDispositions",
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}/contacts/csv",
7834     "title": "Gets CSV List Contacts",
7835     "examples": [
7836       {
7837         "title": "Example usage:",
7838         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7839         "type": "json"
7840       }
7841     ],
7842     "name": "grunt",
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": "put",
7851     "url": "/api/cm/lists/{id}",
7852     "title": "Update an existing List",
7853     "examples": [
7854       {
7855         "title": "Example usage:",
7856         "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",
7857         "type": "json"
7858       }
7859     ],
7860     "name": "updateLists",
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": "post",
7869     "url": "/api/cm/contacts/upload/:id",
7870     "title": "Import new contacts by csv",
7871     "examples": [
7872       {
7873         "title": "Example usage:",
7874         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7875         "type": "json"
7876       }
7877     ],
7878     "name": "import",
7879     "group": "Cm_contacts",
7880     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7881     "version": "0.0.0",
7882     "filename": "server/api/cmContact/index.js",
7883     "groupTitle": "Cm_contacts"
7884   },
7885   {
7886     "type": "post",
7887     "url": "/api/cm/contacts/upload",
7888     "title": "Upload csv",
7889     "examples": [
7890       {
7891         "title": "Example usage:",
7892         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7893         "type": "json"
7894       }
7895     ],
7896     "name": "upload",
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/csv",
7906     "title": "Create new contacts by csv",
7907     "examples": [
7908       {
7909         "title": "Example usage:",
7910         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7911         "type": "json"
7912       }
7913     ],
7914     "name": "uploadCsv",
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": "delete",
7923     "url": "/api/conditions/{id}",
7924     "title": "Deletes a Condition",
7925     "examples": [
7926       {
7927         "title": "Example usage:",
7928         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7929         "type": "json"
7930       }
7931     ],
7932     "name": "DeleteConditions",
7933     "group": "Conditions",
7934     "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>",
7935     "version": "0.0.0",
7936     "filename": "server/api/condition/index.js",
7937     "groupTitle": "Conditions"
7938   },
7939   {
7940     "type": "put",
7941     "url": "/api/conditions/{id}",
7942     "title": "Update an existing Condition",
7943     "examples": [
7944       {
7945         "title": "Example usage:",
7946         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7947         "type": "json"
7948       }
7949     ],
7950     "name": "updateConditions",
7951     "group": "Conditions",
7952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
7959     "url": "/api/cm/custom_field",
7960     "title": "Create a new custom field",
7961     "examples": [
7962       {
7963         "title": "Example usage:",
7964         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7965         "type": "json"
7966       }
7967     ],
7968     "name": "CreateCustomField",
7969     "group": "Custom_Fields",
7970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7971     "version": "0.0.0",
7972     "filename": "server/api/cmCustomField/index.js",
7973     "groupTitle": "Custom_Fields"
7974   },
7975   {
7976     "type": "post",
7977     "url": "/api/dashboards/items",
7978     "title": "Create dasboard item",
7979     "examples": [
7980       {
7981         "title": "Example usage:",
7982         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7983         "type": "json"
7984       }
7985     ],
7986     "name": "Create",
7987     "group": "Dashboard_Items",
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/dashboardItem/index.js",
7991     "groupTitle": "Dashboard_Items"
7992   },
7993   {
7994     "type": "delete",
7995     "url": "/api/dashboards/items/{id}",
7996     "title": "Deletes a Dashboard Item",
7997     "examples": [
7998       {
7999         "title": "Example usage:",
8000         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8001         "type": "json"
8002       }
8003     ],
8004     "name": "DeleteDashboard_Items",
8005     "group": "Dashboard_Items",
8006     "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>",
8007     "version": "0.0.0",
8008     "filename": "server/api/dashboardItem/index.js",
8009     "groupTitle": "Dashboard_Items"
8010   },
8011   {
8012     "type": "get",
8013     "url": "/api/dashboards/items/{id}",
8014     "title": "Gets a single Dashboard Item",
8015     "examples": [
8016       {
8017         "title": "Example usage:",
8018         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8019         "type": "json"
8020       }
8021     ],
8022     "name": "ShowDashboard_Items",
8023     "group": "Dashboard_Items",
8024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
8031     "url": "/api/dashboards/items/{id}",
8032     "title": "Update an existing item",
8033     "examples": [
8034       {
8035         "title": "Example usage:",
8036         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8037         "type": "json"
8038       }
8039     ],
8040     "name": "Update",
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": "post",
8049     "url": "/api/dashboards/clone",
8050     "title": "Clone an existing Dashboard",
8051     "examples": [
8052       {
8053         "title": "Example usage:",
8054         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8055         "type": "json"
8056       }
8057     ],
8058     "name": "CloneDashboards",
8059     "group": "Dashboards",
8060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8061     "version": "0.0.0",
8062     "filename": "server/api/dashboard/index.js",
8063     "groupTitle": "Dashboards"
8064   },
8065   {
8066     "type": "post",
8067     "url": "/api/dashboards",
8068     "title": "Creates a new Dashboard",
8069     "examples": [
8070       {
8071         "title": "Example usage:",
8072         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8073         "type": "json"
8074       }
8075     ],
8076     "name": "CreateDashboards",
8077     "group": "Dashboards",
8078     "parameter": {
8079       "fields": {
8080         "Body": [
8081           {
8082             "group": "Body",
8083             "type": "String",
8084             "optional": false,
8085             "field": "name",
8086             "description": ""
8087           },
8088           {
8089             "group": "Body",
8090             "type": "String",
8091             "optional": true,
8092             "field": "description",
8093             "description": ""
8094           }
8095         ]
8096       }
8097     },
8098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8099     "version": "0.0.0",
8100     "filename": "server/api/dashboard/index.js",
8101     "groupTitle": "Dashboards"
8102   },
8103   {
8104     "type": "delete",
8105     "url": "/api/dashboards/{id}",
8106     "title": "Deletes a Dashboard",
8107     "examples": [
8108       {
8109         "title": "Example usage:",
8110         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8111         "type": "json"
8112       }
8113     ],
8114     "name": "DeleteDashboards",
8115     "group": "Dashboards",
8116     "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>",
8117     "version": "0.0.0",
8118     "filename": "server/api/dashboard/index.js",
8119     "groupTitle": "Dashboards"
8120   },
8121   {
8122     "type": "get",
8123     "url": "/api/dashboards",
8124     "title": "Gets a list of Dashboards",
8125     "examples": [
8126       {
8127         "title": "Example usage:",
8128         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8129         "type": "json"
8130       }
8131     ],
8132     "name": "GetDashboards",
8133     "group": "Dashboards",
8134     "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>",
8135     "version": "0.0.0",
8136     "filename": "server/api/dashboard/index.js",
8137     "groupTitle": "Dashboards"
8138   },
8139   {
8140     "type": "get",
8141     "url": "/api/dashboards/{id}",
8142     "title": "Gets a single Dashboard",
8143     "examples": [
8144       {
8145         "title": "Example usage:",
8146         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8147         "type": "json"
8148       }
8149     ],
8150     "name": "ShowDashboards",
8151     "group": "Dashboards",
8152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8153     "version": "0.0.0",
8154     "filename": "server/api/dashboard/index.js",
8155     "groupTitle": "Dashboards"
8156   },
8157   {
8158     "type": "post",
8159     "url": "/api/dashboards/{id}/items",
8160     "title": "Creates new item",
8161     "examples": [
8162       {
8163         "title": "Example usage:",
8164         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8165         "type": "json"
8166       }
8167     ],
8168     "name": "addItem",
8169     "group": "Dashboards",
8170     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
8177     "url": "/api/dashboards/{id}/items",
8178     "title": "Gets items",
8179     "examples": [
8180       {
8181         "title": "Example usage:",
8182         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8183         "type": "json"
8184       }
8185     ],
8186     "name": "getItems",
8187     "group": "Dashboards",
8188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
8195     "url": "/api/dashboards/{id}",
8196     "title": "Update an existing Dashboard",
8197     "examples": [
8198       {
8199         "title": "Example usage:",
8200         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8201         "type": "json"
8202       }
8203     ],
8204     "name": "updateDashboards",
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": "post",
8213     "url": "/api/integrations/desk/accounts",
8214     "title": "Creates a new Desk Account",
8215     "examples": [
8216       {
8217         "title": "Example usage:",
8218         "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",
8219         "type": "json"
8220       }
8221     ],
8222     "name": "CreateDesk_Accounts",
8223     "group": "Desk_Accounts",
8224     "parameter": {
8225       "fields": {
8226         "Body": [
8227           {
8228             "group": "Body",
8229             "type": "String",
8230             "optional": true,
8231             "field": "name",
8232             "description": ""
8233           },
8234           {
8235             "group": "Body",
8236             "type": "String",
8237             "optional": true,
8238             "field": "description",
8239             "description": ""
8240           },
8241           {
8242             "group": "Body",
8243             "type": "String",
8244             "optional": true,
8245             "field": "username",
8246             "description": ""
8247           },
8248           {
8249             "group": "Body",
8250             "type": "String",
8251             "optional": true,
8252             "field": "remoteUri",
8253             "description": ""
8254           },
8255           {
8256             "group": "Body",
8257             "type": "String",
8258             "allowedValues": [
8259               "\"basic\""
8260             ],
8261             "optional": true,
8262             "field": "authType",
8263             "description": ""
8264           },
8265           {
8266             "group": "Body",
8267             "type": "String",
8268             "optional": true,
8269             "field": "password",
8270             "description": ""
8271           },
8272           {
8273             "group": "Body",
8274             "type": "String",
8275             "optional": true,
8276             "field": "consumerKey",
8277             "description": ""
8278           },
8279           {
8280             "group": "Body",
8281             "type": "String",
8282             "optional": true,
8283             "field": "consumerSecret",
8284             "description": ""
8285           },
8286           {
8287             "group": "Body",
8288             "type": "String",
8289             "optional": true,
8290             "field": "token",
8291             "description": ""
8292           },
8293           {
8294             "group": "Body",
8295             "type": "String",
8296             "optional": true,
8297             "field": "tokenSecret",
8298             "description": ""
8299           },
8300           {
8301             "group": "Body",
8302             "type": "String",
8303             "optional": false,
8304             "field": "serverUrl",
8305             "description": ""
8306           },
8307           {
8308             "group": "Body",
8309             "type": "String",
8310             "allowedValues": [
8311               "\"integrationTab\"",
8312               "\"newTab\""
8313             ],
8314             "optional": true,
8315             "field": "type",
8316             "description": ""
8317           }
8318         ]
8319       }
8320     },
8321     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8322     "version": "0.0.0",
8323     "filename": "server/api/intDeskAccount/index.js",
8324     "groupTitle": "Desk_Accounts"
8325   },
8326   {
8327     "type": "delete",
8328     "url": "/api/integrations/desk/accounts/{id}",
8329     "title": "Deletes a Desk Account",
8330     "examples": [
8331       {
8332         "title": "Example usage:",
8333         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8334         "type": "json"
8335       }
8336     ],
8337     "name": "DeleteDesk_Accounts",
8338     "group": "Desk_Accounts",
8339     "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>",
8340     "version": "0.0.0",
8341     "filename": "server/api/intDeskAccount/index.js",
8342     "groupTitle": "Desk_Accounts"
8343   },
8344   {
8345     "type": "get",
8346     "url": "/api/integrations/desk/accounts",
8347     "title": "Gets a list of Desk Accounts",
8348     "examples": [
8349       {
8350         "title": "Example usage:",
8351         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8352         "type": "json"
8353       }
8354     ],
8355     "name": "GetDesk_Accounts",
8356     "group": "Desk_Accounts",
8357     "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>",
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/{id}",
8365     "title": "Gets a single Desk Account",
8366     "examples": [
8367       {
8368         "title": "Example usage:",
8369         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8370         "type": "json"
8371       }
8372     ],
8373     "name": "ShowDesk_Accounts",
8374     "group": "Desk_Accounts",
8375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8376     "version": "0.0.0",
8377     "filename": "server/api/intDeskAccount/index.js",
8378     "groupTitle": "Desk_Accounts"
8379   },
8380   {
8381     "type": "post",
8382     "url": "/api/integrations/desk/accounts/{id}/configurations",
8383     "title": "Creates new configuration",
8384     "examples": [
8385       {
8386         "title": "Example usage:",
8387         "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",
8388         "type": "json"
8389       }
8390     ],
8391     "name": "addConfiguration",
8392     "group": "Desk_Accounts",
8393     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
8400     "url": "/api/integrations/desk/accounts/{id}/configurations",
8401     "title": "Gets account configurations",
8402     "examples": [
8403       {
8404         "title": "Example usage:",
8405         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8406         "type": "json"
8407       }
8408     ],
8409     "name": "getConfigurations",
8410     "group": "Desk_Accounts",
8411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
8419     "title": "Gets account fields",
8420     "examples": [
8421       {
8422         "title": "Example usage:",
8423         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8424         "type": "json"
8425       }
8426     ],
8427     "name": "getFields",
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": "put",
8436     "url": "/api/integrations/desk/accounts/{id}",
8437     "title": "Update an existing Desk Account",
8438     "examples": [
8439       {
8440         "title": "Example usage:",
8441         "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",
8442         "type": "json"
8443       }
8444     ],
8445     "name": "updateDesk_Accounts",
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": "post",
8454     "url": "/api/integrations/desk/configurations",
8455     "title": "Creates a new Desk Configuration",
8456     "examples": [
8457       {
8458         "title": "Example usage:",
8459         "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",
8460         "type": "json"
8461       }
8462     ],
8463     "name": "CreateDesk_Configurations",
8464     "group": "Desk_Configurations",
8465     "parameter": {
8466       "fields": {
8467         "Body": [
8468           {
8469             "group": "Body",
8470             "type": "String",
8471             "optional": true,
8472             "field": "name",
8473             "description": ""
8474           },
8475           {
8476             "group": "Body",
8477             "type": "String",
8478             "optional": true,
8479             "field": "description",
8480             "description": ""
8481           }
8482         ]
8483       }
8484     },
8485     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8486     "version": "0.0.0",
8487     "filename": "server/api/intDeskConfiguration/index.js",
8488     "groupTitle": "Desk_Configurations"
8489   },
8490   {
8491     "type": "delete",
8492     "url": "/api/integrations/desk/configurations/{id}",
8493     "title": "Deletes a Desk Configuration",
8494     "examples": [
8495       {
8496         "title": "Example usage:",
8497         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8498         "type": "json"
8499       }
8500     ],
8501     "name": "DeleteDesk_Configurations",
8502     "group": "Desk_Configurations",
8503     "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>",
8504     "version": "0.0.0",
8505     "filename": "server/api/intDeskConfiguration/index.js",
8506     "groupTitle": "Desk_Configurations"
8507   },
8508   {
8509     "type": "get",
8510     "url": "/api/integrations/desk/configurations",
8511     "title": "Gets a list of Desk Configurations",
8512     "examples": [
8513       {
8514         "title": "Example usage:",
8515         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8516         "type": "json"
8517       }
8518     ],
8519     "name": "GetDesk_Configurations",
8520     "group": "Desk_Configurations",
8521     "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>",
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/{id}",
8529     "title": "Gets a single Desk Configuration",
8530     "examples": [
8531       {
8532         "title": "Example usage:",
8533         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8534         "type": "json"
8535       }
8536     ],
8537     "name": "ShowDesk_Configurations",
8538     "group": "Desk_Configurations",
8539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
8547     "title": "Gets configurations descriptions",
8548     "examples": [
8549       {
8550         "title": "Example usage:",
8551         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8552         "type": "json"
8553       }
8554     ],
8555     "name": "getDescriptions",
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}/fields",
8565     "title": "Gets configurations fields",
8566     "examples": [
8567       {
8568         "title": "Example usage:",
8569         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8570         "type": "json"
8571       }
8572     ],
8573     "name": "getFields",
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}/subjects",
8583     "title": "Gets configurations subjects",
8584     "examples": [
8585       {
8586         "title": "Example usage:",
8587         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8588         "type": "json"
8589       }
8590     ],
8591     "name": "getSubjects",
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}/tags",
8601     "title": "Gets configurations tags",
8602     "examples": [
8603       {
8604         "title": "Example usage:",
8605         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8606         "type": "json"
8607       }
8608     ],
8609     "name": "getTags",
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": "post",
8618     "url": "/api/integrations/desk/configurations/{id}/tags",
8619     "title": "Sets new tags",
8620     "examples": [
8621       {
8622         "title": "Example usage:",
8623         "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",
8624         "type": "json"
8625       }
8626     ],
8627     "name": "setTags",
8628     "group": "Desk_Configurations",
8629     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
8636     "url": "/api/integrations/desk/configurations/{id}",
8637     "title": "Update an existing Desk Configuration",
8638     "examples": [
8639       {
8640         "title": "Example usage:",
8641         "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",
8642         "type": "json"
8643       }
8644     ],
8645     "name": "updateDesk_Configurations",
8646     "group": "Desk_Configurations",
8647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
8654     "url": "/api/integrations/desk/fields",
8655     "title": "Creates a new Desk Field",
8656     "examples": [
8657       {
8658         "title": "Example usage:",
8659         "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",
8660         "type": "json"
8661       }
8662     ],
8663     "name": "CreateDesk_Fields",
8664     "group": "Desk_Fields",
8665     "parameter": {
8666       "fields": {
8667         "Body": [
8668           {
8669             "group": "Body",
8670             "type": "String",
8671             "allowedValues": [
8672               "\"string\"",
8673               "\"variable\"",
8674               "\"customVariable\"",
8675               "\"keyValue\"",
8676               "\"picklist\""
8677             ],
8678             "optional": true,
8679             "field": "type",
8680             "description": ""
8681           },
8682           {
8683             "group": "Body",
8684             "type": "String",
8685             "optional": true,
8686             "field": "content",
8687             "description": ""
8688           },
8689           {
8690             "group": "Body",
8691             "type": "String",
8692             "optional": true,
8693             "field": "key",
8694             "description": ""
8695           },
8696           {
8697             "group": "Body",
8698             "type": "String",
8699             "allowedValues": [
8700               "\"string\"",
8701               "\"variable\"",
8702               "\"customVariable\""
8703             ],
8704             "optional": true,
8705             "field": "keyType",
8706             "description": ""
8707           },
8708           {
8709             "group": "Body",
8710             "type": "String",
8711             "optional": true,
8712             "field": "keyContent",
8713             "description": ""
8714           },
8715           {
8716             "group": "Body",
8717             "type": "String",
8718             "optional": true,
8719             "field": "idField",
8720             "description": ""
8721           },
8722           {
8723             "group": "Body",
8724             "type": "String",
8725             "optional": true,
8726             "field": "nameField",
8727             "description": ""
8728           },
8729           {
8730             "group": "Body",
8731             "type": "Boolean",
8732             "optional": true,
8733             "field": "customField",
8734             "description": ""
8735           },
8736           {
8737             "group": "Body",
8738             "type": "String",
8739             "optional": true,
8740             "field": "variableName",
8741             "description": ""
8742           }
8743         ]
8744       }
8745     },
8746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8747     "version": "0.0.0",
8748     "filename": "server/api/intDeskField/index.js",
8749     "groupTitle": "Desk_Fields"
8750   },
8751   {
8752     "type": "delete",
8753     "url": "/api/integrations/desk/fields/{id}",
8754     "title": "Deletes a Desk Field",
8755     "examples": [
8756       {
8757         "title": "Example usage:",
8758         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8759         "type": "json"
8760       }
8761     ],
8762     "name": "DeleteDesk_Fields",
8763     "group": "Desk_Fields",
8764     "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>",
8765     "version": "0.0.0",
8766     "filename": "server/api/intDeskField/index.js",
8767     "groupTitle": "Desk_Fields"
8768   },
8769   {
8770     "type": "get",
8771     "url": "/api/integrations/desk/fields",
8772     "title": "Gets a list of Desk Fields",
8773     "examples": [
8774       {
8775         "title": "Example usage:",
8776         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8777         "type": "json"
8778       }
8779     ],
8780     "name": "GetDesk_Fields",
8781     "group": "Desk_Fields",
8782     "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>",
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/{id}",
8790     "title": "Gets a single Desk Field",
8791     "examples": [
8792       {
8793         "title": "Example usage:",
8794         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8795         "type": "json"
8796       }
8797     ],
8798     "name": "ShowDesk_Fields",
8799     "group": "Desk_Fields",
8800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8801     "version": "0.0.0",
8802     "filename": "server/api/intDeskField/index.js",
8803     "groupTitle": "Desk_Fields"
8804   },
8805   {
8806     "type": "put",
8807     "url": "/api/integrations/desk/fields/{id}",
8808     "title": "Update an existing Desk Field",
8809     "examples": [
8810       {
8811         "title": "Example usage:",
8812         "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",
8813         "type": "json"
8814       }
8815     ],
8816     "name": "updateDesk_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": "post",
8825     "url": "/api/dispositions",
8826     "title": "Creates a new Disposition",
8827     "examples": [
8828       {
8829         "title": "Example usage:",
8830         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8831         "type": "json"
8832       }
8833     ],
8834     "name": "CreateDispositions",
8835     "group": "Dispositions",
8836     "parameter": {
8837       "fields": {
8838         "Body": [
8839           {
8840             "group": "Body",
8841             "type": "String",
8842             "optional": false,
8843             "field": "name",
8844             "description": ""
8845           },
8846           {
8847             "group": "Body",
8848             "type": "String",
8849             "allowedValues": [
8850               "\"first\"",
8851               "\"second\"",
8852               "\"third\""
8853             ],
8854             "optional": false,
8855             "field": "level",
8856             "description": ""
8857           },
8858           {
8859             "group": "Body",
8860             "type": "String",
8861             "optional": true,
8862             "field": "description",
8863             "description": ""
8864           }
8865         ]
8866       }
8867     },
8868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8869     "version": "0.0.0",
8870     "filename": "server/api/disposition/index.js",
8871     "groupTitle": "Dispositions"
8872   },
8873   {
8874     "type": "delete",
8875     "url": "/api/dispositions/{id}",
8876     "title": "Deletes a Disposition",
8877     "examples": [
8878       {
8879         "title": "Example usage:",
8880         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8881         "type": "json"
8882       }
8883     ],
8884     "name": "DeleteDispositions",
8885     "group": "Dispositions",
8886     "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>",
8887     "version": "0.0.0",
8888     "filename": "server/api/disposition/index.js",
8889     "groupTitle": "Dispositions"
8890   },
8891   {
8892     "type": "get",
8893     "url": "/api/dispositions",
8894     "title": "Gets a list of Dispositions",
8895     "examples": [
8896       {
8897         "title": "Example usage:",
8898         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8899         "type": "json"
8900       }
8901     ],
8902     "name": "GetDispositions",
8903     "group": "Dispositions",
8904     "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>",
8905     "version": "0.0.0",
8906     "filename": "server/api/disposition/index.js",
8907     "groupTitle": "Dispositions"
8908   },
8909   {
8910     "type": "get",
8911     "url": "/api/dispositions/{id}",
8912     "title": "Gets a single Disposition",
8913     "examples": [
8914       {
8915         "title": "Example usage:",
8916         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8917         "type": "json"
8918       }
8919     ],
8920     "name": "ShowDispositions",
8921     "group": "Dispositions",
8922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8923     "version": "0.0.0",
8924     "filename": "server/api/disposition/index.js",
8925     "groupTitle": "Dispositions"
8926   },
8927   {
8928     "type": "put",
8929     "url": "/api/dispositions/{id}",
8930     "title": "Update an existing Disposition",
8931     "examples": [
8932       {
8933         "title": "Example usage:",
8934         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8935         "type": "json"
8936       }
8937     ],
8938     "name": "updateDispositions",
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": "post",
8947     "url": "/api/integrations/dynamics365/accounts",
8948     "title": "Creates a new Dynamics365 Account",
8949     "examples": [
8950       {
8951         "title": "Example usage:",
8952         "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",
8953         "type": "json"
8954       }
8955     ],
8956     "name": "CreateDynamics365_Accounts",
8957     "group": "Dynamics365_Accounts",
8958     "parameter": {
8959       "fields": {
8960         "Body": [
8961           {
8962             "group": "Body",
8963             "type": "String",
8964             "optional": true,
8965             "field": "name",
8966             "description": ""
8967           },
8968           {
8969             "group": "Body",
8970             "type": "String",
8971             "optional": true,
8972             "field": "username",
8973             "description": ""
8974           },
8975           {
8976             "group": "Body",
8977             "type": "String",
8978             "optional": true,
8979             "field": "password",
8980             "description": ""
8981           },
8982           {
8983             "group": "Body",
8984             "type": "String",
8985             "optional": true,
8986             "field": "remoteUri",
8987             "description": ""
8988           },
8989           {
8990             "group": "Body",
8991             "type": "String",
8992             "optional": true,
8993             "field": "tenantId",
8994             "description": ""
8995           },
8996           {
8997             "group": "Body",
8998             "type": "String",
8999             "optional": true,
9000             "field": "clientId",
9001             "description": ""
9002           },
9003           {
9004             "group": "Body",
9005             "type": "String",
9006             "optional": true,
9007             "field": "clientSecret",
9008             "description": ""
9009           },
9010           {
9011             "group": "Body",
9012             "type": "String",
9013             "optional": false,
9014             "field": "serverUrl",
9015             "description": ""
9016           },
9017           {
9018             "group": "Body",
9019             "type": "String",
9020             "optional": true,
9021             "field": "description",
9022             "description": ""
9023           }
9024         ]
9025       }
9026     },
9027     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9028     "version": "0.0.0",
9029     "filename": "server/api/intDynamics365Account/index.js",
9030     "groupTitle": "Dynamics365_Accounts"
9031   },
9032   {
9033     "type": "delete",
9034     "url": "/api/integrations/dynamics365/accounts/{id}",
9035     "title": "Deletes a Dynamics365 Account",
9036     "examples": [
9037       {
9038         "title": "Example usage:",
9039         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9040         "type": "json"
9041       }
9042     ],
9043     "name": "DeleteDynamics365_Accounts",
9044     "group": "Dynamics365_Accounts",
9045     "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>",
9046     "version": "0.0.0",
9047     "filename": "server/api/intDynamics365Account/index.js",
9048     "groupTitle": "Dynamics365_Accounts"
9049   },
9050   {
9051     "type": "get",
9052     "url": "/api/integrations/dynamics365/accounts",
9053     "title": "Gets a list of Dynamics365 Accounts",
9054     "examples": [
9055       {
9056         "title": "Example usage:",
9057         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9058         "type": "json"
9059       }
9060     ],
9061     "name": "GetDynamics365_Accounts",
9062     "group": "Dynamics365_Accounts",
9063     "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>",
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/{id}",
9071     "title": "Gets a single Dynamics365 Account",
9072     "examples": [
9073       {
9074         "title": "Example usage:",
9075         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9076         "type": "json"
9077       }
9078     ],
9079     "name": "ShowDynamics365_Accounts",
9080     "group": "Dynamics365_Accounts",
9081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9082     "version": "0.0.0",
9083     "filename": "server/api/intDynamics365Account/index.js",
9084     "groupTitle": "Dynamics365_Accounts"
9085   },
9086   {
9087     "type": "post",
9088     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9089     "title": "Creates new configuration",
9090     "examples": [
9091       {
9092         "title": "Example usage:",
9093         "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",
9094         "type": "json"
9095       }
9096     ],
9097     "name": "addConfiguration",
9098     "group": "Dynamics365_Accounts",
9099     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
9106     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9107     "title": "Gets account configurations",
9108     "examples": [
9109       {
9110         "title": "Example usage:",
9111         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9112         "type": "json"
9113       }
9114     ],
9115     "name": "getConfigurations",
9116     "group": "Dynamics365_Accounts",
9117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
9125     "title": "Gets account fields",
9126     "examples": [
9127       {
9128         "title": "Example usage:",
9129         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9130         "type": "json"
9131       }
9132     ],
9133     "name": "getFields",
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": "put",
9142     "url": "/api/integrations/dynamics365/accounts/{id}",
9143     "title": "Update an existing Dynamics365 Account",
9144     "examples": [
9145       {
9146         "title": "Example usage:",
9147         "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",
9148         "type": "json"
9149       }
9150     ],
9151     "name": "updateDynamics365_Accounts",
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": "post",
9160     "url": "/api/integrations/dynamics365/configurations",
9161     "title": "Creates a new Dynamics365 Configuration",
9162     "examples": [
9163       {
9164         "title": "Example usage:",
9165         "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",
9166         "type": "json"
9167       }
9168     ],
9169     "name": "CreateDynamics365_Configurations",
9170     "group": "Dynamics365_Configurations",
9171     "parameter": {
9172       "fields": {
9173         "Body": [
9174           {
9175             "group": "Body",
9176             "type": "String",
9177             "optional": true,
9178             "field": "name",
9179             "description": ""
9180           },
9181           {
9182             "group": "Body",
9183             "type": "String",
9184             "optional": true,
9185             "field": "description",
9186             "description": ""
9187           },
9188           {
9189             "group": "Body",
9190             "type": "String",
9191             "allowedValues": [
9192               "\"incident\"",
9193               "\"phonecall\""
9194             ],
9195             "optional": true,
9196             "field": "ticketType",
9197             "description": ""
9198           }
9199         ]
9200       }
9201     },
9202     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9203     "version": "0.0.0",
9204     "filename": "server/api/intDynamics365Configuration/index.js",
9205     "groupTitle": "Dynamics365_Configurations"
9206   },
9207   {
9208     "type": "delete",
9209     "url": "/api/integrations/dynamics365/configurations/{id}",
9210     "title": "Deletes a Dynamics365 Configuration",
9211     "examples": [
9212       {
9213         "title": "Example usage:",
9214         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9215         "type": "json"
9216       }
9217     ],
9218     "name": "DeleteDynamics365_Configurations",
9219     "group": "Dynamics365_Configurations",
9220     "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>",
9221     "version": "0.0.0",
9222     "filename": "server/api/intDynamics365Configuration/index.js",
9223     "groupTitle": "Dynamics365_Configurations"
9224   },
9225   {
9226     "type": "get",
9227     "url": "/api/integrations/dynamics365/configurations",
9228     "title": "Gets a list of Dynamics365 Configurations",
9229     "examples": [
9230       {
9231         "title": "Example usage:",
9232         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9233         "type": "json"
9234       }
9235     ],
9236     "name": "GetDynamics365_Configurations",
9237     "group": "Dynamics365_Configurations",
9238     "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>",
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/{id}",
9246     "title": "Gets a single Dynamics365 Configuration",
9247     "examples": [
9248       {
9249         "title": "Example usage:",
9250         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9251         "type": "json"
9252       }
9253     ],
9254     "name": "ShowDynamics365_Configurations",
9255     "group": "Dynamics365_Configurations",
9256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
9264     "title": "Gets configurations descriptions",
9265     "examples": [
9266       {
9267         "title": "Example usage:",
9268         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9269         "type": "json"
9270       }
9271     ],
9272     "name": "getDescriptions",
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}/fields",
9282     "title": "Gets configurations fields",
9283     "examples": [
9284       {
9285         "title": "Example usage:",
9286         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9287         "type": "json"
9288       }
9289     ],
9290     "name": "getFields",
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/zoho/configurations/{id}/subjects",
9300     "title": "Gets configurations subjects",
9301     "examples": [
9302       {
9303         "title": "Example usage:",
9304         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9305         "type": "json"
9306       }
9307     ],
9308     "name": "getSubjects",
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": "put",
9317     "url": "/api/integrations/dynamics365/configurations/{id}",
9318     "title": "Update an existing Dynamics365 Configuration",
9319     "examples": [
9320       {
9321         "title": "Example usage:",
9322         "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",
9323         "type": "json"
9324       }
9325     ],
9326     "name": "updateDynamics365_Configurations",
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": "post",
9335     "url": "/api/integrations/dynamics365/fields",
9336     "title": "Creates a new Dynamics365 Field",
9337     "examples": [
9338       {
9339         "title": "Example usage:",
9340         "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",
9341         "type": "json"
9342       }
9343     ],
9344     "name": "CreateDynamics365_Fields",
9345     "group": "Dynamics365_Fields",
9346     "parameter": {
9347       "fields": {
9348         "Body": [
9349           {
9350             "group": "Body",
9351             "type": "String",
9352             "allowedValues": [
9353               "\"string\"",
9354               "\"variable\"",
9355               "\"customVariable\"",
9356               "\"keyValue\"",
9357               "\"picklist\""
9358             ],
9359             "optional": true,
9360             "field": "type",
9361             "description": ""
9362           },
9363           {
9364             "group": "Body",
9365             "type": "String",
9366             "optional": true,
9367             "field": "content",
9368             "description": ""
9369           },
9370           {
9371             "group": "Body",
9372             "type": "String",
9373             "optional": true,
9374             "field": "key",
9375             "description": ""
9376           },
9377           {
9378             "group": "Body",
9379             "type": "String",
9380             "allowedValues": [
9381               "\"string\"",
9382               "\"variable\"",
9383               "\"customVariable\""
9384             ],
9385             "optional": true,
9386             "field": "keyType",
9387             "description": ""
9388           },
9389           {
9390             "group": "Body",
9391             "type": "String",
9392             "optional": true,
9393             "field": "keyContent",
9394             "description": ""
9395           },
9396           {
9397             "group": "Body",
9398             "type": "String",
9399             "optional": true,
9400             "field": "idField",
9401             "description": ""
9402           },
9403           {
9404             "group": "Body",
9405             "type": "String",
9406             "optional": true,
9407             "field": "nameField",
9408             "description": ""
9409           },
9410           {
9411             "group": "Body",
9412             "type": "Boolean",
9413             "optional": true,
9414             "field": "customField",
9415             "description": ""
9416           },
9417           {
9418             "group": "Body",
9419             "type": "String",
9420             "optional": true,
9421             "field": "variableName",
9422             "description": ""
9423           }
9424         ]
9425       }
9426     },
9427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9428     "version": "0.0.0",
9429     "filename": "server/api/intDynamics365Field/index.js",
9430     "groupTitle": "Dynamics365_Fields"
9431   },
9432   {
9433     "type": "delete",
9434     "url": "/api/integrations/dynamics365/fields/{id}",
9435     "title": "Deletes a Dynamics365 Field",
9436     "examples": [
9437       {
9438         "title": "Example usage:",
9439         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9440         "type": "json"
9441       }
9442     ],
9443     "name": "DeleteDynamics365_Fields",
9444     "group": "Dynamics365_Fields",
9445     "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>",
9446     "version": "0.0.0",
9447     "filename": "server/api/intDynamics365Field/index.js",
9448     "groupTitle": "Dynamics365_Fields"
9449   },
9450   {
9451     "type": "get",
9452     "url": "/api/integrations/dynamics365/fields",
9453     "title": "Gets a list of Dynamics365 Fields",
9454     "examples": [
9455       {
9456         "title": "Example usage:",
9457         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9458         "type": "json"
9459       }
9460     ],
9461     "name": "GetDynamics365_Fields",
9462     "group": "Dynamics365_Fields",
9463     "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>",
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/{id}",
9471     "title": "Gets a single Dynamics365 Field",
9472     "examples": [
9473       {
9474         "title": "Example usage:",
9475         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9476         "type": "json"
9477       }
9478     ],
9479     "name": "ShowDynamics365_Fields",
9480     "group": "Dynamics365_Fields",
9481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9482     "version": "0.0.0",
9483     "filename": "server/api/intDynamics365Field/index.js",
9484     "groupTitle": "Dynamics365_Fields"
9485   },
9486   {
9487     "type": "put",
9488     "url": "/api/integrations/dynamics365/fields/{id}",
9489     "title": "Update an existing Dynamics365 Field",
9490     "examples": [
9491       {
9492         "title": "Example usage:",
9493         "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",
9494         "type": "json"
9495       }
9496     ],
9497     "name": "updateDynamics365_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": "post",
9506     "url": "/api/fax/accounts/{id}/users",
9507     "title": "Add agents to a fax account",
9508     "examples": [
9509       {
9510         "title": "Example usage:",
9511         "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",
9512         "type": "json"
9513       }
9514     ],
9515     "name": "AddAgents",
9516     "group": "Fax_Accounts",
9517     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9518     "version": "0.0.0",
9519     "filename": "server/api/faxAccount/index.js",
9520     "groupTitle": "Fax_Accounts"
9521   },
9522   {
9523     "type": "post",
9524     "url": "/api/fax/accounts",
9525     "title": "Creates a new Account",
9526     "examples": [
9527       {
9528         "title": "Example usage:",
9529         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9530         "type": "json"
9531       }
9532     ],
9533     "name": "CreateAccounts",
9534     "group": "Fax_Accounts",
9535     "parameter": {
9536       "fields": {
9537         "Body": [
9538           {
9539             "group": "Body",
9540             "type": "String",
9541             "optional": false,
9542             "field": "name",
9543             "description": ""
9544           },
9545           {
9546             "group": "Body",
9547             "type": "String",
9548             "optional": true,
9549             "field": "description",
9550             "description": ""
9551           },
9552           {
9553             "group": "Body",
9554             "type": "String",
9555             "allowedValues": [
9556               "\"yes\"",
9557               "\"no\""
9558             ],
9559             "optional": true,
9560             "field": "ecm",
9561             "description": ""
9562           },
9563           {
9564             "group": "Body",
9565             "type": "String",
9566             "optional": true,
9567             "field": "headerinfo",
9568             "description": ""
9569           },
9570           {
9571             "group": "Body",
9572             "type": "String",
9573             "optional": true,
9574             "field": "localstationid",
9575             "description": ""
9576           },
9577           {
9578             "group": "Body",
9579             "type": "String",
9580             "allowedValues": [
9581               "\"2400\"",
9582               "\"4800\"",
9583               "\"7200\"",
9584               "\"9600\"",
9585               "\"12000\"",
9586               "\"14400\""
9587             ],
9588             "optional": true,
9589             "field": "minrate",
9590             "description": ""
9591           },
9592           {
9593             "group": "Body",
9594             "type": "String",
9595             "allowedValues": [
9596               "\"2400\"",
9597               "\"4800\"",
9598               "\"7200\"",
9599               "\"9600\"",
9600               "\"12000\"",
9601               "\"14400\""
9602             ],
9603             "optional": true,
9604             "field": "maxrate",
9605             "description": ""
9606           },
9607           {
9608             "group": "Body",
9609             "type": "String",
9610             "optional": true,
9611             "field": "modem",
9612             "description": ""
9613           },
9614           {
9615             "group": "Body",
9616             "type": "String",
9617             "optional": true,
9618             "field": "gateway",
9619             "description": ""
9620           },
9621           {
9622             "group": "Body",
9623             "type": "String",
9624             "optional": true,
9625             "field": "faxdetect",
9626             "description": ""
9627           },
9628           {
9629             "group": "Body",
9630             "type": "Integer",
9631             "optional": true,
9632             "field": "t38timeout",
9633             "description": ""
9634           },
9635           {
9636             "group": "Body",
9637             "type": "String",
9638             "allowedValues": [
9639               "\"SIP\"",
9640               "\"IAX\"",
9641               "\"DADHI\"",
9642               "\"KHOMP\""
9643             ],
9644             "optional": true,
9645             "field": "tech",
9646             "description": ""
9647           },
9648           {
9649             "group": "Body",
9650             "type": "String",
9651             "optional": false,
9652             "field": "key",
9653             "description": ""
9654           },
9655           {
9656             "group": "Body",
9657             "type": "Text",
9658             "optional": true,
9659             "field": "notificationTemplate",
9660             "description": ""
9661           },
9662           {
9663             "group": "Body",
9664             "type": "Boolean",
9665             "optional": true,
9666             "field": "notificationSound",
9667             "description": ""
9668           },
9669           {
9670             "group": "Body",
9671             "type": "Boolean",
9672             "optional": true,
9673             "field": "notificationShake",
9674             "description": ""
9675           },
9676           {
9677             "group": "Body",
9678             "type": "Integer",
9679             "optional": true,
9680             "field": "waitForTheAssignedAgent",
9681             "description": ""
9682           },
9683           {
9684             "group": "Body",
9685             "type": "Boolean",
9686             "optional": true,
9687             "field": "queueTransfer",
9688             "description": ""
9689           },
9690           {
9691             "group": "Body",
9692             "type": "Integer",
9693             "optional": true,
9694             "field": "queueTransferTimeout",
9695             "description": ""
9696           },
9697           {
9698             "group": "Body",
9699             "type": "Boolean",
9700             "optional": true,
9701             "field": "agentTransfer",
9702             "description": ""
9703           },
9704           {
9705             "group": "Body",
9706             "type": "Integer",
9707             "optional": true,
9708             "field": "agentTransferTimeout",
9709             "description": ""
9710           },
9711           {
9712             "group": "Body",
9713             "type": "Integer",
9714             "optional": true,
9715             "field": "mandatoryDispositionPauseId",
9716             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9717           },
9718           {
9719             "group": "Body",
9720             "type": "Boolean",
9721             "optional": true,
9722             "field": "mandatoryDisposition",
9723             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9724           }
9725         ]
9726       }
9727     },
9728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9729     "version": "0.0.0",
9730     "filename": "server/api/faxAccount/index.js",
9731     "groupTitle": "Fax_Accounts"
9732   },
9733   {
9734     "type": "delete",
9735     "url": "/api/fax/accounts/{id}",
9736     "title": "Deletes a Account",
9737     "examples": [
9738       {
9739         "title": "Example usage:",
9740         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9741         "type": "json"
9742       }
9743     ],
9744     "name": "DeleteAccounts",
9745     "group": "Fax_Accounts",
9746     "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>",
9747     "version": "0.0.0",
9748     "filename": "server/api/faxAccount/index.js",
9749     "groupTitle": "Fax_Accounts"
9750   },
9751   {
9752     "type": "get",
9753     "url": "/api/fax/accounts/describe",
9754     "title": "Gets table info about Accounts",
9755     "examples": [
9756       {
9757         "title": "Example usage:",
9758         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9759         "type": "json"
9760       }
9761     ],
9762     "name": "DescribeAccounts",
9763     "group": "Fax_Accounts",
9764     "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>",
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",
9772     "title": "Gets a list of Accounts",
9773     "examples": [
9774       {
9775         "title": "Example usage:",
9776         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9777         "type": "json"
9778       }
9779     ],
9780     "name": "GetAccounts",
9781     "group": "Fax_Accounts",
9782     "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>",
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/{id}/users",
9790     "title": "Gets agents from fax account",
9791     "examples": [
9792       {
9793         "title": "Example usage:",
9794         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9795         "type": "json"
9796       }
9797     ],
9798     "name": "GetAgents",
9799     "group": "Fax_Accounts",
9800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9801     "version": "0.0.0",
9802     "filename": "server/api/faxAccount/index.js",
9803     "groupTitle": "Fax_Accounts"
9804   },
9805   {
9806     "type": "delete",
9807     "url": "/api/fax/accounts/{id}/users",
9808     "title": "Removes agents from a fax account",
9809     "examples": [
9810       {
9811         "title": "Example usage:",
9812         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9813         "type": "json"
9814       }
9815     ],
9816     "name": "RemoveAgents",
9817     "group": "Fax_Accounts",
9818     "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>",
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}/canned_answers",
9826     "title": "Removes canned answers from account",
9827     "examples": [
9828       {
9829         "title": "Example usage:",
9830         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9831         "type": "json"
9832       }
9833     ],
9834     "name": "RemoveAnswers",
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}/dispositions",
9844     "title": "Removes dispositions from account",
9845     "examples": [
9846       {
9847         "title": "Example usage:",
9848         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9849         "type": "json"
9850       }
9851     ],
9852     "name": "RemoveDispositions",
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": "get",
9861     "url": "/api/fax/accounts/{id}",
9862     "title": "Gets a single Account",
9863     "examples": [
9864       {
9865         "title": "Example usage:",
9866         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9867         "type": "json"
9868       }
9869     ],
9870     "name": "ShowAccounts",
9871     "group": "Fax_Accounts",
9872     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
9879     "url": "/api/fax/accounts/{id}/canned_answers",
9880     "title": "Creates new canned answer",
9881     "examples": [
9882       {
9883         "title": "Example usage:",
9884         "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",
9885         "type": "json"
9886       }
9887     ],
9888     "name": "addAnswer",
9889     "group": "Fax_Accounts",
9890     "parameter": {
9891       "fields": {
9892         "Body": [
9893           {
9894             "group": "Body",
9895             "type": "String",
9896             "optional": false,
9897             "field": "key",
9898             "description": ""
9899           },
9900           {
9901             "group": "Body",
9902             "type": "Text",
9903             "optional": false,
9904             "field": "value",
9905             "description": ""
9906           },
9907           {
9908             "group": "Body",
9909             "type": "String",
9910             "optional": true,
9911             "field": "description",
9912             "description": ""
9913           },
9914           {
9915             "group": "Body",
9916             "type": "Virtual",
9917             "optional": true,
9918             "field": "name",
9919             "description": ""
9920           }
9921         ]
9922       }
9923     },
9924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9925     "version": "0.0.0",
9926     "filename": "server/api/faxAccount/index.js",
9927     "groupTitle": "Fax_Accounts"
9928   },
9929   {
9930     "type": "post",
9931     "url": "/api/fax/accounts/{id}/applications",
9932     "title": "Creates new applications",
9933     "examples": [
9934       {
9935         "title": "Example usage:",
9936         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9937         "type": "json"
9938       }
9939     ],
9940     "name": "addApplications",
9941     "group": "Fax_Accounts",
9942     "parameter": {
9943       "fields": {
9944         "Body": [
9945           {
9946             "group": "Body",
9947             "type": "Integer",
9948             "optional": false,
9949             "field": "priority",
9950             "description": ""
9951           },
9952           {
9953             "group": "Body",
9954             "type": "String",
9955             "optional": false,
9956             "field": "app",
9957             "description": ""
9958           },
9959           {
9960             "group": "Body",
9961             "type": "Text",
9962             "optional": true,
9963             "field": "appdata",
9964             "description": ""
9965           },
9966           {
9967             "group": "Body",
9968             "type": "String",
9969             "optional": true,
9970             "field": "description",
9971             "description": ""
9972           },
9973           {
9974             "group": "Body",
9975             "type": "String",
9976             "optional": true,
9977             "field": "interval",
9978             "description": ""
9979           }
9980         ]
9981       }
9982     },
9983     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9984     "version": "0.0.0",
9985     "filename": "server/api/faxAccount/index.js",
9986     "groupTitle": "Fax_Accounts"
9987   },
9988   {
9989     "type": "post",
9990     "url": "/api/fax/accounts/addaccountapplications",
9991     "title": "Creates new account and applications",
9992     "examples": [
9993       {
9994         "title": "Example usage:",
9995         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9996         "type": "json"
9997       }
9998     ],
9999     "name": "addApplications",
10000     "group": "Fax_Accounts",
10001     "parameter": {
10002       "fields": {
10003         "Body": [
10004           {
10005             "group": "Body",
10006             "type": "Integer",
10007             "optional": false,
10008             "field": "priority",
10009             "description": ""
10010           },
10011           {
10012             "group": "Body",
10013             "type": "String",
10014             "optional": false,
10015             "field": "app",
10016             "description": ""
10017           },
10018           {
10019             "group": "Body",
10020             "type": "Text",
10021             "optional": true,
10022             "field": "appdata",
10023             "description": ""
10024           },
10025           {
10026             "group": "Body",
10027             "type": "String",
10028             "optional": true,
10029             "field": "description",
10030             "description": ""
10031           },
10032           {
10033             "group": "Body",
10034             "type": "String",
10035             "optional": true,
10036             "field": "interval",
10037             "description": ""
10038           }
10039         ]
10040       }
10041     },
10042     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10043     "version": "0.0.0",
10044     "filename": "server/api/faxAccount/index.js",
10045     "groupTitle": "Fax_Accounts"
10046   },
10047   {
10048     "type": "post",
10049     "url": "/api/fax/accounts/{id}/dispositions",
10050     "title": "Creates new disposition",
10051     "examples": [
10052       {
10053         "title": "Example usage:",
10054         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10055         "type": "json"
10056       }
10057     ],
10058     "name": "addDisposition",
10059     "group": "Fax_Accounts",
10060     "parameter": {
10061       "fields": {
10062         "Body": [
10063           {
10064             "group": "Body",
10065             "type": "String",
10066             "optional": false,
10067             "field": "name",
10068             "description": ""
10069           },
10070           {
10071             "group": "Body",
10072             "type": "String",
10073             "allowedValues": [
10074               "\"first\"",
10075               "\"second\"",
10076               "\"third\""
10077             ],
10078             "optional": false,
10079             "field": "level",
10080             "description": ""
10081           },
10082           {
10083             "group": "Body",
10084             "type": "String",
10085             "optional": true,
10086             "field": "description",
10087             "description": ""
10088           }
10089         ]
10090       }
10091     },
10092     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10093     "version": "0.0.0",
10094     "filename": "server/api/faxAccount/index.js",
10095     "groupTitle": "Fax_Accounts"
10096   },
10097   {
10098     "type": "post",
10099     "url": "/api/fax/accounts/{id}/interactions",
10100     "title": "Creates new interactions",
10101     "examples": [
10102       {
10103         "title": "Example usage:",
10104         "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",
10105         "type": "json"
10106       }
10107     ],
10108     "name": "addInteraction",
10109     "group": "Fax_Accounts",
10110     "parameter": {
10111       "fields": {
10112         "Body": [
10113           {
10114             "group": "Body",
10115             "type": "Boolean",
10116             "optional": true,
10117             "field": "closed",
10118             "description": ""
10119           },
10120           {
10121             "group": "Body",
10122             "type": "String",
10123             "optional": true,
10124             "field": "closedAt",
10125             "description": ""
10126           },
10127           {
10128             "group": "Body",
10129             "type": "String",
10130             "optional": true,
10131             "field": "disposition",
10132             "description": ""
10133           },
10134           {
10135             "group": "Body",
10136             "type": "String",
10137             "optional": true,
10138             "field": "secondDisposition",
10139             "description": ""
10140           },
10141           {
10142             "group": "Body",
10143             "type": "String",
10144             "optional": true,
10145             "field": "thirdDisposition",
10146             "description": ""
10147           },
10148           {
10149             "group": "Body",
10150             "type": "String",
10151             "optional": true,
10152             "field": "note",
10153             "description": ""
10154           },
10155           {
10156             "group": "Body",
10157             "type": "String",
10158             "optional": true,
10159             "field": "read1stAt",
10160             "description": ""
10161           },
10162           {
10163             "group": "Body",
10164             "type": "String",
10165             "optional": true,
10166             "field": "fax",
10167             "description": ""
10168           },
10169           {
10170             "group": "Body",
10171             "type": "String",
10172             "allowedValues": [
10173               "\"in\"",
10174               "\"out\""
10175             ],
10176             "optional": false,
10177             "field": "firstMsgDirection",
10178             "description": ""
10179           },
10180           {
10181             "group": "Body",
10182             "type": "String",
10183             "optional": true,
10184             "field": "lastMsgAt",
10185             "description": ""
10186           },
10187           {
10188             "group": "Body",
10189             "type": "String",
10190             "allowedValues": [
10191               "\"in\"",
10192               "\"out\""
10193             ],
10194             "optional": false,
10195             "field": "lastMsgDirection",
10196             "description": ""
10197           }
10198         ]
10199       }
10200     },
10201     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10202     "version": "0.0.0",
10203     "filename": "server/api/faxAccount/index.js",
10204     "groupTitle": "Fax_Accounts"
10205   },
10206   {
10207     "type": "get",
10208     "url": "/api/fax/accounts/{id}/canned_answers",
10209     "title": "Gets account canned answers",
10210     "examples": [
10211       {
10212         "title": "Example usage:",
10213         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10214         "type": "json"
10215       }
10216     ],
10217     "name": "getAnswers",
10218     "group": "Fax_Accounts",
10219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
10227     "title": "Gets account pplications",
10228     "examples": [
10229       {
10230         "title": "Example usage:",
10231         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10232         "type": "json"
10233       }
10234     ],
10235     "name": "getApplications",
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}/dispositions",
10245     "title": "Gets account dispositions",
10246     "examples": [
10247       {
10248         "title": "Example usage:",
10249         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10250         "type": "json"
10251       }
10252     ],
10253     "name": "getDispositions",
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}/interactions",
10263     "title": "Gets account interactions",
10264     "examples": [
10265       {
10266         "title": "Example usage:",
10267         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10268         "type": "json"
10269       }
10270     ],
10271     "name": "getInteraction",
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}/messages",
10281     "title": "Gets account messages",
10282     "examples": [
10283       {
10284         "title": "Example usage:",
10285         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10286         "type": "json"
10287       }
10288     ],
10289     "name": "getMessages",
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": "post",
10298     "url": "/api/fax/accounts/{id}/send",
10299     "title": "Send new fax",
10300     "examples": [
10301       {
10302         "title": "Example usage:",
10303         "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",
10304         "type": "json"
10305       }
10306     ],
10307     "name": "sendFax",
10308     "group": "Fax_Accounts",
10309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
10316     "url": "/api/fax/accounts/{id}",
10317     "title": "Update an existing Account",
10318     "examples": [
10319       {
10320         "title": "Example usage:",
10321         "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",
10322         "type": "json"
10323       }
10324     ],
10325     "name": "updateAccounts",
10326     "group": "Fax_Accounts",
10327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
10334     "url": "/api/fax/accounts/updateaccountapplications",
10335     "title": "Update account and applications",
10336     "examples": [
10337       {
10338         "title": "Example usage:",
10339         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10340         "type": "json"
10341       }
10342     ],
10343     "name": "updateApplications",
10344     "group": "Fax_Accounts",
10345     "parameter": {
10346       "fields": {
10347         "Body": [
10348           {
10349             "group": "Body",
10350             "type": "Integer",
10351             "optional": false,
10352             "field": "priority",
10353             "description": ""
10354           },
10355           {
10356             "group": "Body",
10357             "type": "String",
10358             "optional": false,
10359             "field": "app",
10360             "description": ""
10361           },
10362           {
10363             "group": "Body",
10364             "type": "Text",
10365             "optional": true,
10366             "field": "appdata",
10367             "description": ""
10368           },
10369           {
10370             "group": "Body",
10371             "type": "String",
10372             "optional": true,
10373             "field": "description",
10374             "description": ""
10375           },
10376           {
10377             "group": "Body",
10378             "type": "String",
10379             "optional": true,
10380             "field": "interval",
10381             "description": ""
10382           }
10383         ]
10384       }
10385     },
10386     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10387     "version": "0.0.0",
10388     "filename": "server/api/faxAccount/index.js",
10389     "groupTitle": "Fax_Accounts"
10390   },
10391   {
10392     "type": "post",
10393     "url": "/api/fax/applications",
10394     "title": "Creates a new Application",
10395     "examples": [
10396       {
10397         "title": "Example usage:",
10398         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10399         "type": "json"
10400       }
10401     ],
10402     "name": "CreateApplications",
10403     "group": "Fax_Applications",
10404     "parameter": {
10405       "fields": {
10406         "Body": [
10407           {
10408             "group": "Body",
10409             "type": "Integer",
10410             "optional": false,
10411             "field": "priority",
10412             "description": ""
10413           },
10414           {
10415             "group": "Body",
10416             "type": "String",
10417             "optional": false,
10418             "field": "app",
10419             "description": ""
10420           },
10421           {
10422             "group": "Body",
10423             "type": "Text",
10424             "optional": true,
10425             "field": "appdata",
10426             "description": ""
10427           },
10428           {
10429             "group": "Body",
10430             "type": "String",
10431             "optional": true,
10432             "field": "description",
10433             "description": ""
10434           },
10435           {
10436             "group": "Body",
10437             "type": "String",
10438             "optional": true,
10439             "field": "interval",
10440             "description": ""
10441           }
10442         ]
10443       }
10444     },
10445     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10446     "version": "0.0.0",
10447     "filename": "server/api/faxApplication/index.js",
10448     "groupTitle": "Fax_Applications"
10449   },
10450   {
10451     "type": "delete",
10452     "url": "/api/fax/applications/{id}",
10453     "title": "Deletes a Application",
10454     "examples": [
10455       {
10456         "title": "Example usage:",
10457         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10458         "type": "json"
10459       }
10460     ],
10461     "name": "DeleteApplications",
10462     "group": "Fax_Applications",
10463     "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>",
10464     "version": "0.0.0",
10465     "filename": "server/api/faxApplication/index.js",
10466     "groupTitle": "Fax_Applications"
10467   },
10468   {
10469     "type": "get",
10470     "url": "/api/fax/applications",
10471     "title": "Gets a list of Applications",
10472     "examples": [
10473       {
10474         "title": "Example usage:",
10475         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10476         "type": "json"
10477       }
10478     ],
10479     "name": "GetApplications",
10480     "group": "Fax_Applications",
10481     "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>",
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/{id}",
10489     "title": "Gets a single Application",
10490     "examples": [
10491       {
10492         "title": "Example usage:",
10493         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10494         "type": "json"
10495       }
10496     ],
10497     "name": "ShowApplications",
10498     "group": "Fax_Applications",
10499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10500     "version": "0.0.0",
10501     "filename": "server/api/faxApplication/index.js",
10502     "groupTitle": "Fax_Applications"
10503   },
10504   {
10505     "type": "put",
10506     "url": "/api/fax/applications/{id}",
10507     "title": "Update an existing Application",
10508     "examples": [
10509       {
10510         "title": "Example usage:",
10511         "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",
10512         "type": "json"
10513       }
10514     ],
10515     "name": "updateApplications",
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": "post",
10524     "url": "/api/fax/interactions/{id}/tags",
10525     "title": "Add tags to the interaction",
10526     "examples": [
10527       {
10528         "title": "Example usage:",
10529         "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",
10530         "type": "json"
10531       }
10532     ],
10533     "name": "AddTags",
10534     "group": "Fax_Interactions",
10535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10536     "version": "0.0.0",
10537     "filename": "server/api/faxInteraction/index.js",
10538     "groupTitle": "Fax_Interactions"
10539   },
10540   {
10541     "type": "post",
10542     "url": "/api/fax/interactions",
10543     "title": "Creates a new Interaction",
10544     "examples": [
10545       {
10546         "title": "Example usage:",
10547         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10548         "type": "json"
10549       }
10550     ],
10551     "name": "CreateInteractions",
10552     "group": "Fax_Interactions",
10553     "parameter": {
10554       "fields": {
10555         "Body": [
10556           {
10557             "group": "Body",
10558             "type": "Boolean",
10559             "optional": true,
10560             "field": "closed",
10561             "description": ""
10562           },
10563           {
10564             "group": "Body",
10565             "type": "String",
10566             "optional": true,
10567             "field": "closedAt",
10568             "description": ""
10569           },
10570           {
10571             "group": "Body",
10572             "type": "String",
10573             "optional": true,
10574             "field": "disposition",
10575             "description": ""
10576           },
10577           {
10578             "group": "Body",
10579             "type": "String",
10580             "optional": true,
10581             "field": "secondDisposition",
10582             "description": ""
10583           },
10584           {
10585             "group": "Body",
10586             "type": "String",
10587             "optional": true,
10588             "field": "thirdDisposition",
10589             "description": ""
10590           },
10591           {
10592             "group": "Body",
10593             "type": "String",
10594             "optional": true,
10595             "field": "note",
10596             "description": ""
10597           },
10598           {
10599             "group": "Body",
10600             "type": "String",
10601             "optional": true,
10602             "field": "read1stAt",
10603             "description": ""
10604           },
10605           {
10606             "group": "Body",
10607             "type": "String",
10608             "optional": true,
10609             "field": "fax",
10610             "description": ""
10611           },
10612           {
10613             "group": "Body",
10614             "type": "String",
10615             "allowedValues": [
10616               "\"in\"",
10617               "\"out\""
10618             ],
10619             "optional": false,
10620             "field": "firstMsgDirection",
10621             "description": ""
10622           },
10623           {
10624             "group": "Body",
10625             "type": "String",
10626             "optional": true,
10627             "field": "lastMsgAt",
10628             "description": ""
10629           },
10630           {
10631             "group": "Body",
10632             "type": "String",
10633             "allowedValues": [
10634               "\"in\"",
10635               "\"out\""
10636             ],
10637             "optional": false,
10638             "field": "lastMsgDirection",
10639             "description": ""
10640           }
10641         ]
10642       }
10643     },
10644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10645     "version": "0.0.0",
10646     "filename": "server/api/faxInteraction/index.js",
10647     "groupTitle": "Fax_Interactions"
10648   },
10649   {
10650     "type": "delete",
10651     "url": "/api/fax/interactions/{id}",
10652     "title": "Deletes a Interaction",
10653     "examples": [
10654       {
10655         "title": "Example usage:",
10656         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10657         "type": "json"
10658       }
10659     ],
10660     "name": "DeleteInteractions",
10661     "group": "Fax_Interactions",
10662     "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>",
10663     "version": "0.0.0",
10664     "filename": "server/api/faxInteraction/index.js",
10665     "groupTitle": "Fax_Interactions"
10666   },
10667   {
10668     "type": "get",
10669     "url": "/api/fax/interactions/describe",
10670     "title": "Gets table info about Interactions",
10671     "examples": [
10672       {
10673         "title": "Example usage:",
10674         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10675         "type": "json"
10676       }
10677     ],
10678     "name": "DescribeInteractions",
10679     "group": "Fax_Interactions",
10680     "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>",
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",
10688     "title": "Gets a list of Interactions",
10689     "examples": [
10690       {
10691         "title": "Example usage:",
10692         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10693         "type": "json"
10694       }
10695     ],
10696     "name": "GetInteractions",
10697     "group": "Fax_Interactions",
10698     "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>",
10699     "version": "0.0.0",
10700     "filename": "server/api/faxInteraction/index.js",
10701     "groupTitle": "Fax_Interactions"
10702   },
10703   {
10704     "type": "delete",
10705     "url": "/api/fax/interactions/{id}/tags",
10706     "title": "Removes tags from interaction",
10707     "examples": [
10708       {
10709         "title": "Example usage:",
10710         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10711         "type": "json"
10712       }
10713     ],
10714     "name": "RemoveTags",
10715     "group": "Fax_Interactions",
10716     "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>",
10717     "version": "0.0.0",
10718     "filename": "server/api/faxInteraction/index.js",
10719     "groupTitle": "Fax_Interactions"
10720   },
10721   {
10722     "type": "get",
10723     "url": "/api/fax/interactions/{id}",
10724     "title": "Gets a single Interaction",
10725     "examples": [
10726       {
10727         "title": "Example usage:",
10728         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10729         "type": "json"
10730       }
10731     ],
10732     "name": "ShowInteractions",
10733     "group": "Fax_Interactions",
10734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
10741     "url": "/api/fax/interactions/{id}/messages",
10742     "title": "Creates new messages",
10743     "examples": [
10744       {
10745         "title": "Example usage:",
10746         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10747         "type": "json"
10748       }
10749     ],
10750     "name": "addMessage",
10751     "group": "Fax_Interactions",
10752     "parameter": {
10753       "fields": {
10754         "Body": [
10755           {
10756             "group": "Body",
10757             "type": "Text",
10758             "optional": false,
10759             "field": "body",
10760             "description": ""
10761           },
10762           {
10763             "group": "Body",
10764             "type": "Boolean",
10765             "optional": true,
10766             "field": "read",
10767             "description": ""
10768           },
10769           {
10770             "group": "Body",
10771             "type": "String",
10772             "allowedValues": [
10773               "\"in\"",
10774               "\"out\""
10775             ],
10776             "optional": false,
10777             "field": "direction",
10778             "description": ""
10779           },
10780           {
10781             "group": "Body",
10782             "type": "Text",
10783             "optional": true,
10784             "field": "failMessage",
10785             "description": ""
10786           },
10787           {
10788             "group": "Body",
10789             "type": "String",
10790             "optional": true,
10791             "field": "readAt",
10792             "description": ""
10793           }
10794         ]
10795       }
10796     },
10797     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10798     "version": "0.0.0",
10799     "filename": "server/api/faxInteraction/index.js",
10800     "groupTitle": "Fax_Interactions"
10801   },
10802   {
10803     "type": "get",
10804     "url": "/api/fax/interactions/{id}/download",
10805     "title": "Get interactions",
10806     "examples": [
10807       {
10808         "title": "Example usage:",
10809         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10810         "type": "json"
10811       }
10812     ],
10813     "name": "download",
10814     "group": "Fax_Interactions",
10815     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
10823     "title": "Gets interaction messages",
10824     "examples": [
10825       {
10826         "title": "Example usage:",
10827         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10828         "type": "json"
10829       }
10830     ],
10831     "name": "getMessages",
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": "put",
10840     "url": "/api/fax/interactions/{id}",
10841     "title": "Update an existing Interaction",
10842     "examples": [
10843       {
10844         "title": "Example usage:",
10845         "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",
10846         "type": "json"
10847       }
10848     ],
10849     "name": "updateInteractions",
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": "get",
10858     "url": "/api/fax/messages/{id}/download",
10859     "title": "Get message",
10860     "examples": [
10861       {
10862         "title": "Example usage:",
10863         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10864         "type": "json"
10865       }
10866     ],
10867     "name": "download",
10868     "group": "Fax_Message",
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/faxMessage/index.js",
10872     "groupTitle": "Fax_Message"
10873   },
10874   {
10875     "type": "delete",
10876     "url": "/api/fax/messages/{id}",
10877     "title": "Deletes a Message",
10878     "examples": [
10879       {
10880         "title": "Example usage:",
10881         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10882         "type": "json"
10883       }
10884     ],
10885     "name": "DeleteMessages",
10886     "group": "Fax_Messages",
10887     "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>",
10888     "version": "0.0.0",
10889     "filename": "server/api/faxMessage/index.js",
10890     "groupTitle": "Fax_Messages"
10891   },
10892   {
10893     "type": "get",
10894     "url": "/api/fax/messages/describe",
10895     "title": "Gets table info about Messages",
10896     "examples": [
10897       {
10898         "title": "Example usage:",
10899         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10900         "type": "json"
10901       }
10902     ],
10903     "name": "DescribeMessages",
10904     "group": "Fax_Messages",
10905     "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>",
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",
10913     "title": "Gets a list of Messages",
10914     "examples": [
10915       {
10916         "title": "Example usage:",
10917         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10918         "type": "json"
10919       }
10920     ],
10921     "name": "GetMessages",
10922     "group": "Fax_Messages",
10923     "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>",
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/{id}",
10931     "title": "Gets a single Message",
10932     "examples": [
10933       {
10934         "title": "Example usage:",
10935         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10936         "type": "json"
10937       }
10938     ],
10939     "name": "ShowMessages",
10940     "group": "Fax_Messages",
10941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10942     "version": "0.0.0",
10943     "filename": "server/api/faxMessage/index.js",
10944     "groupTitle": "Fax_Messages"
10945   },
10946   {
10947     "type": "put",
10948     "url": "/api/fax/messages/{id}/accept",
10949     "title": "Accepts message",
10950     "examples": [
10951       {
10952         "title": "Example usage:",
10953         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10954         "type": "json"
10955       }
10956     ],
10957     "name": "acceptMessage",
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}/reject",
10967     "title": "Rejects message",
10968     "examples": [
10969       {
10970         "title": "Example usage:",
10971         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10972         "type": "json"
10973       }
10974     ],
10975     "name": "rejectMessage",
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": "post",
10984     "url": "/api/fax/messages",
10985     "title": "Create message and send Fax",
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>201</code> upon success.</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": "put",
11002     "url": "/api/fax/messages/{id}",
11003     "title": "Update an existing Message",
11004     "examples": [
11005       {
11006         "title": "Example usage:",
11007         "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",
11008         "type": "json"
11009       }
11010     ],
11011     "name": "updateMessages",
11012     "group": "Fax_Messages",
11013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
11020     "url": "/api/fax/reports/queue",
11021     "title": "Creates a new Fax Queue Report",
11022     "examples": [
11023       {
11024         "title": "Example usage:",
11025         "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",
11026         "type": "json"
11027       }
11028     ],
11029     "name": "CreateFax_Queue_Reports",
11030     "group": "Fax_Queue_Reports",
11031     "parameter": {
11032       "fields": {
11033         "Body": [
11034           {
11035             "group": "Body",
11036             "type": "String",
11037             "optional": false,
11038             "field": "uniqueid",
11039             "description": ""
11040           },
11041           {
11042             "group": "Body",
11043             "type": "String",
11044             "optional": true,
11045             "field": "from",
11046             "description": ""
11047           },
11048           {
11049             "group": "Body",
11050             "type": "String",
11051             "optional": true,
11052             "field": "joinAt",
11053             "description": ""
11054           },
11055           {
11056             "group": "Body",
11057             "type": "String",
11058             "optional": true,
11059             "field": "leaveAt",
11060             "description": ""
11061           },
11062           {
11063             "group": "Body",
11064             "type": "String",
11065             "optional": true,
11066             "field": "acceptAt",
11067             "description": ""
11068           },
11069           {
11070             "group": "Body",
11071             "type": "String",
11072             "optional": true,
11073             "field": "exitAt",
11074             "description": ""
11075           },
11076           {
11077             "group": "Body",
11078             "type": "String",
11079             "optional": true,
11080             "field": "reason",
11081             "description": ""
11082           }
11083         ]
11084       }
11085     },
11086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11087     "version": "0.0.0",
11088     "filename": "server/api/faxQueueReport/index.js",
11089     "groupTitle": "Fax_Queue_Reports"
11090   },
11091   {
11092     "type": "delete",
11093     "url": "/api/fax/reports/queue/{id}",
11094     "title": "Deletes a Fax Queue Report",
11095     "examples": [
11096       {
11097         "title": "Example usage:",
11098         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11099         "type": "json"
11100       }
11101     ],
11102     "name": "DeleteFax_Queue_Reports",
11103     "group": "Fax_Queue_Reports",
11104     "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>",
11105     "version": "0.0.0",
11106     "filename": "server/api/faxQueueReport/index.js",
11107     "groupTitle": "Fax_Queue_Reports"
11108   },
11109   {
11110     "type": "get",
11111     "url": "/api/fax/reports/queue/describe",
11112     "title": "Gets table info about Fax Queue Reports",
11113     "examples": [
11114       {
11115         "title": "Example usage:",
11116         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11117         "type": "json"
11118       }
11119     ],
11120     "name": "DescribeFax_Queue_Reports",
11121     "group": "Fax_Queue_Reports",
11122     "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>",
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",
11130     "title": "Gets a list of Fax Queue Reports",
11131     "examples": [
11132       {
11133         "title": "Example usage:",
11134         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11135         "type": "json"
11136       }
11137     ],
11138     "name": "GetFax_Queue_Reports",
11139     "group": "Fax_Queue_Reports",
11140     "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>",
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/{id}",
11148     "title": "Gets a single Fax Queue Report",
11149     "examples": [
11150       {
11151         "title": "Example usage:",
11152         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11153         "type": "json"
11154       }
11155     ],
11156     "name": "ShowFax_Queue_Reports",
11157     "group": "Fax_Queue_Reports",
11158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11159     "version": "0.0.0",
11160     "filename": "server/api/faxQueueReport/index.js",
11161     "groupTitle": "Fax_Queue_Reports"
11162   },
11163   {
11164     "type": "put",
11165     "url": "/api/fax/reports/queue/{id}",
11166     "title": "Update an existing Fax Queue Report",
11167     "examples": [
11168       {
11169         "title": "Example usage:",
11170         "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",
11171         "type": "json"
11172       }
11173     ],
11174     "name": "updateFax_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": "post",
11183     "url": "/api/fax/queues/{id}/users",
11184     "title": "Add agents to a queue",
11185     "examples": [
11186       {
11187         "title": "Example usage:",
11188         "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",
11189         "type": "json"
11190       }
11191     ],
11192     "name": "AddAgents",
11193     "group": "Fax_Queues",
11194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11195     "version": "0.0.0",
11196     "filename": "server/api/faxQueue/index.js",
11197     "groupTitle": "Fax_Queues"
11198   },
11199   {
11200     "type": "post",
11201     "url": "/api/fax/queues/{id}/teams",
11202     "title": "Add teams to a queue",
11203     "examples": [
11204       {
11205         "title": "Example usage:",
11206         "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",
11207         "type": "json"
11208       }
11209     ],
11210     "name": "AddTeams",
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",
11220     "title": "Creates a new Queue",
11221     "examples": [
11222       {
11223         "title": "Example usage:",
11224         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11225         "type": "json"
11226       }
11227     ],
11228     "name": "CreateQueues",
11229     "group": "Fax_Queues",
11230     "parameter": {
11231       "fields": {
11232         "Body": [
11233           {
11234             "group": "Body",
11235             "type": "String",
11236             "optional": false,
11237             "field": "name",
11238             "description": ""
11239           },
11240           {
11241             "group": "Body",
11242             "type": "String",
11243             "optional": true,
11244             "field": "description",
11245             "description": ""
11246           },
11247           {
11248             "group": "Body",
11249             "type": "Integer",
11250             "optional": false,
11251             "field": "timeout",
11252             "description": ""
11253           },
11254           {
11255             "group": "Body",
11256             "type": "String",
11257             "allowedValues": [
11258               "\"rrmemory\"",
11259               "\"beepall\"",
11260               "\"roundrobin\""
11261             ],
11262             "optional": false,
11263             "field": "strategy",
11264             "description": ""
11265           },
11266           {
11267             "group": "Body",
11268             "type": "Integer",
11269             "optional": true,
11270             "field": "lastAgent",
11271             "description": ""
11272           }
11273         ]
11274       }
11275     },
11276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11277     "version": "0.0.0",
11278     "filename": "server/api/faxQueue/index.js",
11279     "groupTitle": "Fax_Queues"
11280   },
11281   {
11282     "type": "delete",
11283     "url": "/api/fax/queues/{id}",
11284     "title": "Deletes a Queue",
11285     "examples": [
11286       {
11287         "title": "Example usage:",
11288         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11289         "type": "json"
11290       }
11291     ],
11292     "name": "DeleteQueues",
11293     "group": "Fax_Queues",
11294     "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>",
11295     "version": "0.0.0",
11296     "filename": "server/api/faxQueue/index.js",
11297     "groupTitle": "Fax_Queues"
11298   },
11299   {
11300     "type": "get",
11301     "url": "/api/fax/queues/describe",
11302     "title": "Gets table info about Queues",
11303     "examples": [
11304       {
11305         "title": "Example usage:",
11306         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11307         "type": "json"
11308       }
11309     ],
11310     "name": "DescribeQueues",
11311     "group": "Fax_Queues",
11312     "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>",
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/{id}/users",
11320     "title": "Gets queue agents",
11321     "examples": [
11322       {
11323         "title": "Example usage:",
11324         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11325         "type": "json"
11326       }
11327     ],
11328     "name": "GetAgents",
11329     "group": "Fax_Queues",
11330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
11338     "title": "GetMembers",
11339     "examples": [
11340       {
11341         "title": "Example usage:",
11342         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11343         "type": "json"
11344       }
11345     ],
11346     "name": "GetMembers",
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",
11356     "title": "Gets a list of Queues",
11357     "examples": [
11358       {
11359         "title": "Example usage:",
11360         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11361         "type": "json"
11362       }
11363     ],
11364     "name": "GetQueues",
11365     "group": "Fax_Queues",
11366     "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>",
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/{id}/teams",
11374     "title": "Gets queues list",
11375     "examples": [
11376       {
11377         "title": "Example usage:",
11378         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11379         "type": "json"
11380       }
11381     ],
11382     "name": "GetTeams",
11383     "group": "Fax_Queues",
11384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11385     "version": "0.0.0",
11386     "filename": "server/api/faxQueue/index.js",
11387     "groupTitle": "Fax_Queues"
11388   },
11389   {
11390     "type": "delete",
11391     "url": "/api/fax/queues/{id}/users",
11392     "title": "Removes agents from a queue",
11393     "examples": [
11394       {
11395         "title": "Example usage:",
11396         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11397         "type": "json"
11398       }
11399     ],
11400     "name": "RemoveAgents",
11401     "group": "Fax_Queues",
11402     "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>",
11403     "version": "0.0.0",
11404     "filename": "server/api/faxQueue/index.js",
11405     "groupTitle": "Fax_Queues"
11406   },
11407   {
11408     "type": "get",
11409     "url": "/api/fax/queues/{id}",
11410     "title": "Gets a single Queue",
11411     "examples": [
11412       {
11413         "title": "Example usage:",
11414         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11415         "type": "json"
11416       }
11417     ],
11418     "name": "ShowQueues",
11419     "group": "Fax_Queues",
11420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
11427     "url": "/api/fax/queues/{id}",
11428     "title": "Update an existing Queue",
11429     "examples": [
11430       {
11431         "title": "Example usage:",
11432         "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",
11433         "type": "json"
11434       }
11435     ],
11436     "name": "updateQueues",
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": "post",
11445     "url": "/api/fax/reports/transfer",
11446     "title": "Creates a new Fax Transfer Report",
11447     "examples": [
11448       {
11449         "title": "Example usage:",
11450         "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",
11451         "type": "json"
11452       }
11453     ],
11454     "name": "CreateFax_Transfer_Reports",
11455     "group": "Fax_Transfer_Reports",
11456     "parameter": {
11457       "fields": {
11458         "Body": [
11459           {
11460             "group": "Body",
11461             "type": "String",
11462             "optional": false,
11463             "field": "uniqueid",
11464             "description": ""
11465           },
11466           {
11467             "group": "Body",
11468             "type": "String",
11469             "allowedValues": [
11470               "\"account\"",
11471               "\"agent\"",
11472               "\"queue\""
11473             ],
11474             "optional": false,
11475             "field": "type",
11476             "description": ""
11477           },
11478           {
11479             "group": "Body",
11480             "type": "String",
11481             "optional": false,
11482             "field": "transferredAt",
11483             "description": ""
11484           }
11485         ]
11486       }
11487     },
11488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11489     "version": "0.0.0",
11490     "filename": "server/api/faxTransferReport/index.js",
11491     "groupTitle": "Fax_Transfer_Reports"
11492   },
11493   {
11494     "type": "delete",
11495     "url": "/api/fax/reports/transfer/{id}",
11496     "title": "Deletes a Fax Transfer Report",
11497     "examples": [
11498       {
11499         "title": "Example usage:",
11500         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11501         "type": "json"
11502       }
11503     ],
11504     "name": "DeleteFax_Transfer_Reports",
11505     "group": "Fax_Transfer_Reports",
11506     "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>",
11507     "version": "0.0.0",
11508     "filename": "server/api/faxTransferReport/index.js",
11509     "groupTitle": "Fax_Transfer_Reports"
11510   },
11511   {
11512     "type": "get",
11513     "url": "/api/fax/reports/transfer/describe",
11514     "title": "Gets table info about Fax Transfer Reports",
11515     "examples": [
11516       {
11517         "title": "Example usage:",
11518         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11519         "type": "json"
11520       }
11521     ],
11522     "name": "DescribeFax_Transfer_Reports",
11523     "group": "Fax_Transfer_Reports",
11524     "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>",
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",
11532     "title": "Gets a list of Fax Transfer Reports",
11533     "examples": [
11534       {
11535         "title": "Example usage:",
11536         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11537         "type": "json"
11538       }
11539     ],
11540     "name": "GetFax_Transfer_Reports",
11541     "group": "Fax_Transfer_Reports",
11542     "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>",
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/{id}",
11550     "title": "Gets a single Fax Transfer Report",
11551     "examples": [
11552       {
11553         "title": "Example usage:",
11554         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11555         "type": "json"
11556       }
11557     ],
11558     "name": "ShowFax_Transfer_Reports",
11559     "group": "Fax_Transfer_Reports",
11560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11561     "version": "0.0.0",
11562     "filename": "server/api/faxTransferReport/index.js",
11563     "groupTitle": "Fax_Transfer_Reports"
11564   },
11565   {
11566     "type": "put",
11567     "url": "/api/fax/reports/transfer/{id}",
11568     "title": "Update an existing Fax Transfer Report",
11569     "examples": [
11570       {
11571         "title": "Example usage:",
11572         "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",
11573         "type": "json"
11574       }
11575     ],
11576     "name": "updateFax_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": "post",
11585     "url": "/api/integrations/freshdesk/accounts",
11586     "title": "Creates a new Freshdesk Account",
11587     "examples": [
11588       {
11589         "title": "Example usage:",
11590         "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",
11591         "type": "json"
11592       }
11593     ],
11594     "name": "CreateFreshdesk_Accounts",
11595     "group": "Freshdesk_Accounts",
11596     "parameter": {
11597       "fields": {
11598         "Body": [
11599           {
11600             "group": "Body",
11601             "type": "String",
11602             "optional": true,
11603             "field": "name",
11604             "description": ""
11605           },
11606           {
11607             "group": "Body",
11608             "type": "String",
11609             "optional": true,
11610             "field": "description",
11611             "description": ""
11612           },
11613           {
11614             "group": "Body",
11615             "type": "String",
11616             "optional": true,
11617             "field": "username",
11618             "description": ""
11619           },
11620           {
11621             "group": "Body",
11622             "type": "String",
11623             "optional": true,
11624             "field": "apiKey",
11625             "description": ""
11626           },
11627           {
11628             "group": "Body",
11629             "type": "String",
11630             "optional": true,
11631             "field": "remoteUri",
11632             "description": ""
11633           },
11634           {
11635             "group": "Body",
11636             "type": "String",
11637             "optional": false,
11638             "field": "serverUrl",
11639             "description": ""
11640           }
11641         ]
11642       }
11643     },
11644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11645     "version": "0.0.0",
11646     "filename": "server/api/intFreshdeskAccount/index.js",
11647     "groupTitle": "Freshdesk_Accounts"
11648   },
11649   {
11650     "type": "delete",
11651     "url": "/api/integrations/freshdesk/accounts/{id}",
11652     "title": "Deletes a Freshdesk Account",
11653     "examples": [
11654       {
11655         "title": "Example usage:",
11656         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11657         "type": "json"
11658       }
11659     ],
11660     "name": "DeleteFreshdesk_Accounts",
11661     "group": "Freshdesk_Accounts",
11662     "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>",
11663     "version": "0.0.0",
11664     "filename": "server/api/intFreshdeskAccount/index.js",
11665     "groupTitle": "Freshdesk_Accounts"
11666   },
11667   {
11668     "type": "get",
11669     "url": "/api/integrations/freshdesk/accounts",
11670     "title": "Gets a list of Freshdesk Accounts",
11671     "examples": [
11672       {
11673         "title": "Example usage:",
11674         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11675         "type": "json"
11676       }
11677     ],
11678     "name": "GetFreshdesk_Accounts",
11679     "group": "Freshdesk_Accounts",
11680     "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>",
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/{id}",
11688     "title": "Gets a single Freshdesk Account",
11689     "examples": [
11690       {
11691         "title": "Example usage:",
11692         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11693         "type": "json"
11694       }
11695     ],
11696     "name": "ShowFreshdesk_Accounts",
11697     "group": "Freshdesk_Accounts",
11698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11699     "version": "0.0.0",
11700     "filename": "server/api/intFreshdeskAccount/index.js",
11701     "groupTitle": "Freshdesk_Accounts"
11702   },
11703   {
11704     "type": "post",
11705     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11706     "title": "Creates new configuration",
11707     "examples": [
11708       {
11709         "title": "Example usage:",
11710         "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",
11711         "type": "json"
11712       }
11713     ],
11714     "name": "addConfiguration",
11715     "group": "Freshdesk_Accounts",
11716     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
11723     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11724     "title": "Gets account configurations",
11725     "examples": [
11726       {
11727         "title": "Example usage:",
11728         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11729         "type": "json"
11730       }
11731     ],
11732     "name": "getConfigurations",
11733     "group": "Freshdesk_Accounts",
11734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
11742     "title": "Gets account fields",
11743     "examples": [
11744       {
11745         "title": "Example usage:",
11746         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11747         "type": "json"
11748       }
11749     ],
11750     "name": "getFields",
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": "put",
11759     "url": "/api/integrations/freshdesk/accounts/{id}",
11760     "title": "Update an existing Freshdesk Account",
11761     "examples": [
11762       {
11763         "title": "Example usage:",
11764         "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",
11765         "type": "json"
11766       }
11767     ],
11768     "name": "updateFreshdesk_Accounts",
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": "post",
11777     "url": "/api/integrations/freshdesk/configurations",
11778     "title": "Creates a new Freshdesk Configuration",
11779     "examples": [
11780       {
11781         "title": "Example usage:",
11782         "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",
11783         "type": "json"
11784       }
11785     ],
11786     "name": "CreateFreshdesk_Configurations",
11787     "group": "Freshdesk_Configurations",
11788     "parameter": {
11789       "fields": {
11790         "Body": [
11791           {
11792             "group": "Body",
11793             "type": "String",
11794             "optional": true,
11795             "field": "name",
11796             "description": ""
11797           },
11798           {
11799             "group": "Body",
11800             "type": "String",
11801             "optional": true,
11802             "field": "description",
11803             "description": ""
11804           }
11805         ]
11806       }
11807     },
11808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11809     "version": "0.0.0",
11810     "filename": "server/api/intFreshdeskConfiguration/index.js",
11811     "groupTitle": "Freshdesk_Configurations"
11812   },
11813   {
11814     "type": "delete",
11815     "url": "/api/integrations/freshdesk/configurations/{id}",
11816     "title": "Deletes a Freshdesk Configuration",
11817     "examples": [
11818       {
11819         "title": "Example usage:",
11820         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11821         "type": "json"
11822       }
11823     ],
11824     "name": "DeleteFreshdesk_Configurations",
11825     "group": "Freshdesk_Configurations",
11826     "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>",
11827     "version": "0.0.0",
11828     "filename": "server/api/intFreshdeskConfiguration/index.js",
11829     "groupTitle": "Freshdesk_Configurations"
11830   },
11831   {
11832     "type": "get",
11833     "url": "/api/integrations/freshdesk/configurations",
11834     "title": "Gets a list of Freshdesk Configurations",
11835     "examples": [
11836       {
11837         "title": "Example usage:",
11838         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11839         "type": "json"
11840       }
11841     ],
11842     "name": "GetFreshdesk_Configurations",
11843     "group": "Freshdesk_Configurations",
11844     "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>",
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/{id}",
11852     "title": "Gets a single Freshdesk Configuration",
11853     "examples": [
11854       {
11855         "title": "Example usage:",
11856         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11857         "type": "json"
11858       }
11859     ],
11860     "name": "ShowFreshdesk_Configurations",
11861     "group": "Freshdesk_Configurations",
11862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
11870     "title": "Gets configurations descriptions",
11871     "examples": [
11872       {
11873         "title": "Example usage:",
11874         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11875         "type": "json"
11876       }
11877     ],
11878     "name": "getDescriptions",
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}/fields",
11888     "title": "Gets configurations fields",
11889     "examples": [
11890       {
11891         "title": "Example usage:",
11892         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11893         "type": "json"
11894       }
11895     ],
11896     "name": "getFields",
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}/subjects",
11906     "title": "Gets configurations subjects",
11907     "examples": [
11908       {
11909         "title": "Example usage:",
11910         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11911         "type": "json"
11912       }
11913     ],
11914     "name": "getSubjects",
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}/tags",
11924     "title": "Gets configurations tags",
11925     "examples": [
11926       {
11927         "title": "Example usage:",
11928         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11929         "type": "json"
11930       }
11931     ],
11932     "name": "getTags",
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": "post",
11941     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11942     "title": "Sets new tags",
11943     "examples": [
11944       {
11945         "title": "Example usage:",
11946         "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",
11947         "type": "json"
11948       }
11949     ],
11950     "name": "setTags",
11951     "group": "Freshdesk_Configurations",
11952     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
11959     "url": "/api/integrations/freshdesk/configurations/{id}",
11960     "title": "Update an existing Freshdesk Configuration",
11961     "examples": [
11962       {
11963         "title": "Example usage:",
11964         "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",
11965         "type": "json"
11966       }
11967     ],
11968     "name": "updateFreshdesk_Configurations",
11969     "group": "Freshdesk_Configurations",
11970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
11977     "url": "/api/integrations/freshdesk/fields",
11978     "title": "Creates a new Freshdesk Field",
11979     "examples": [
11980       {
11981         "title": "Example usage:",
11982         "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",
11983         "type": "json"
11984       }
11985     ],
11986     "name": "CreateFreshdesk_Fields",
11987     "group": "Freshdesk_Fields",
11988     "parameter": {
11989       "fields": {
11990         "Body": [
11991           {
11992             "group": "Body",
11993             "type": "String",
11994             "allowedValues": [
11995               "\"string\"",
11996               "\"variable\"",
11997               "\"customVariable\"",
11998               "\"keyValue\"",
11999               "\"picklist\""
12000             ],
12001             "optional": true,
12002             "field": "type",
12003             "description": ""
12004           },
12005           {
12006             "group": "Body",
12007             "type": "String",
12008             "optional": true,
12009             "field": "content",
12010             "description": ""
12011           },
12012           {
12013             "group": "Body",
12014             "type": "String",
12015             "optional": true,
12016             "field": "key",
12017             "description": ""
12018           },
12019           {
12020             "group": "Body",
12021             "type": "String",
12022             "allowedValues": [
12023               "\"string\"",
12024               "\"variable\"",
12025               "\"customVariable\""
12026             ],
12027             "optional": true,
12028             "field": "keyType",
12029             "description": ""
12030           },
12031           {
12032             "group": "Body",
12033             "type": "String",
12034             "optional": true,
12035             "field": "keyContent",
12036             "description": ""
12037           },
12038           {
12039             "group": "Body",
12040             "type": "String",
12041             "optional": true,
12042             "field": "idField",
12043             "description": ""
12044           },
12045           {
12046             "group": "Body",
12047             "type": "String",
12048             "optional": true,
12049             "field": "nameField",
12050             "description": ""
12051           },
12052           {
12053             "group": "Body",
12054             "type": "Boolean",
12055             "optional": true,
12056             "field": "customField",
12057             "description": ""
12058           },
12059           {
12060             "group": "Body",
12061             "type": "String",
12062             "optional": true,
12063             "field": "variableName",
12064             "description": ""
12065           }
12066         ]
12067       }
12068     },
12069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12070     "version": "0.0.0",
12071     "filename": "server/api/intFreshdeskField/index.js",
12072     "groupTitle": "Freshdesk_Fields"
12073   },
12074   {
12075     "type": "delete",
12076     "url": "/api/integrations/freshdesk/fields/{id}",
12077     "title": "Deletes a Freshdesk Field",
12078     "examples": [
12079       {
12080         "title": "Example usage:",
12081         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12082         "type": "json"
12083       }
12084     ],
12085     "name": "DeleteFreshdesk_Fields",
12086     "group": "Freshdesk_Fields",
12087     "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>",
12088     "version": "0.0.0",
12089     "filename": "server/api/intFreshdeskField/index.js",
12090     "groupTitle": "Freshdesk_Fields"
12091   },
12092   {
12093     "type": "get",
12094     "url": "/api/integrations/freshdesk/fields",
12095     "title": "Gets a list of Freshdesk Fields",
12096     "examples": [
12097       {
12098         "title": "Example usage:",
12099         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12100         "type": "json"
12101       }
12102     ],
12103     "name": "GetFreshdesk_Fields",
12104     "group": "Freshdesk_Fields",
12105     "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>",
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/{id}",
12113     "title": "Gets a single Freshdesk Field",
12114     "examples": [
12115       {
12116         "title": "Example usage:",
12117         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12118         "type": "json"
12119       }
12120     ],
12121     "name": "ShowFreshdesk_Fields",
12122     "group": "Freshdesk_Fields",
12123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12124     "version": "0.0.0",
12125     "filename": "server/api/intFreshdeskField/index.js",
12126     "groupTitle": "Freshdesk_Fields"
12127   },
12128   {
12129     "type": "put",
12130     "url": "/api/integrations/freshdesk/fields/{id}",
12131     "title": "Update an existing Freshdesk Field",
12132     "examples": [
12133       {
12134         "title": "Example usage:",
12135         "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",
12136         "type": "json"
12137       }
12138     ],
12139     "name": "updateFreshdesk_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": "post",
12148     "url": "/api/integrations/freshsales/accounts",
12149     "title": "Creates a new Freshsales Account",
12150     "examples": [
12151       {
12152         "title": "Example usage:",
12153         "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",
12154         "type": "json"
12155       }
12156     ],
12157     "name": "CreateFreshsales_Accounts",
12158     "group": "Freshsales_Accounts",
12159     "parameter": {
12160       "fields": {
12161         "Body": [
12162           {
12163             "group": "Body",
12164             "type": "String",
12165             "optional": true,
12166             "field": "name",
12167             "description": ""
12168           },
12169           {
12170             "group": "Body",
12171             "type": "String",
12172             "optional": true,
12173             "field": "description",
12174             "description": ""
12175           },
12176           {
12177             "group": "Body",
12178             "type": "String",
12179             "optional": true,
12180             "field": "username",
12181             "description": ""
12182           },
12183           {
12184             "group": "Body",
12185             "type": "String",
12186             "optional": true,
12187             "field": "apiKey",
12188             "description": ""
12189           },
12190           {
12191             "group": "Body",
12192             "type": "String",
12193             "optional": true,
12194             "field": "remoteUri",
12195             "description": ""
12196           },
12197           {
12198             "group": "Body",
12199             "type": "String",
12200             "optional": false,
12201             "field": "serverUrl",
12202             "description": ""
12203           }
12204         ]
12205       }
12206     },
12207     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12208     "version": "0.0.0",
12209     "filename": "server/api/intFreshsalesAccount/index.js",
12210     "groupTitle": "Freshsales_Accounts"
12211   },
12212   {
12213     "type": "delete",
12214     "url": "/api/integrations/freshsales/accounts/{id}",
12215     "title": "Deletes a Freshsales Account",
12216     "examples": [
12217       {
12218         "title": "Example usage:",
12219         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12220         "type": "json"
12221       }
12222     ],
12223     "name": "DeleteFreshsales_Accounts",
12224     "group": "Freshsales_Accounts",
12225     "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>",
12226     "version": "0.0.0",
12227     "filename": "server/api/intFreshsalesAccount/index.js",
12228     "groupTitle": "Freshsales_Accounts"
12229   },
12230   {
12231     "type": "get",
12232     "url": "/api/integrations/freshsales/accounts",
12233     "title": "Gets a list of Freshsales Accounts",
12234     "examples": [
12235       {
12236         "title": "Example usage:",
12237         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12238         "type": "json"
12239       }
12240     ],
12241     "name": "GetFreshsales_Accounts",
12242     "group": "Freshsales_Accounts",
12243     "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>",
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/{id}",
12251     "title": "Gets a single Freshsales Account",
12252     "examples": [
12253       {
12254         "title": "Example usage:",
12255         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12256         "type": "json"
12257       }
12258     ],
12259     "name": "ShowFreshsales_Accounts",
12260     "group": "Freshsales_Accounts",
12261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12262     "version": "0.0.0",
12263     "filename": "server/api/intFreshsalesAccount/index.js",
12264     "groupTitle": "Freshsales_Accounts"
12265   },
12266   {
12267     "type": "post",
12268     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12269     "title": "Creates new configuration",
12270     "examples": [
12271       {
12272         "title": "Example usage:",
12273         "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",
12274         "type": "json"
12275       }
12276     ],
12277     "name": "addConfiguration",
12278     "group": "Freshsales_Accounts",
12279     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
12286     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12287     "title": "Gets account configurations",
12288     "examples": [
12289       {
12290         "title": "Example usage:",
12291         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12292         "type": "json"
12293       }
12294     ],
12295     "name": "getConfigurations",
12296     "group": "Freshsales_Accounts",
12297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
12305     "title": "Gets account fields",
12306     "examples": [
12307       {
12308         "title": "Example usage:",
12309         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12310         "type": "json"
12311       }
12312     ],
12313     "name": "getFields",
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": "put",
12322     "url": "/api/integrations/freshsales/accounts/{id}",
12323     "title": "Update an existing Freshsales Account",
12324     "examples": [
12325       {
12326         "title": "Example usage:",
12327         "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",
12328         "type": "json"
12329       }
12330     ],
12331     "name": "updateFreshsales_Accounts",
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": "post",
12340     "url": "/api/integrations/freshsales/configurations",
12341     "title": "Creates a new Freshsales Configuration",
12342     "examples": [
12343       {
12344         "title": "Example usage:",
12345         "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",
12346         "type": "json"
12347       }
12348     ],
12349     "name": "CreateFreshsales_Configurations",
12350     "group": "Freshsales_Configurations",
12351     "parameter": {
12352       "fields": {
12353         "Body": [
12354           {
12355             "group": "Body",
12356             "type": "String",
12357             "optional": true,
12358             "field": "name",
12359             "description": ""
12360           },
12361           {
12362             "group": "Body",
12363             "type": "String",
12364             "optional": true,
12365             "field": "description",
12366             "description": ""
12367           }
12368         ]
12369       }
12370     },
12371     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12372     "version": "0.0.0",
12373     "filename": "server/api/intFreshsalesConfiguration/index.js",
12374     "groupTitle": "Freshsales_Configurations"
12375   },
12376   {
12377     "type": "delete",
12378     "url": "/api/integrations/freshsales/configurations/{id}",
12379     "title": "Deletes a Freshsales Configuration",
12380     "examples": [
12381       {
12382         "title": "Example usage:",
12383         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12384         "type": "json"
12385       }
12386     ],
12387     "name": "DeleteFreshsales_Configurations",
12388     "group": "Freshsales_Configurations",
12389     "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>",
12390     "version": "0.0.0",
12391     "filename": "server/api/intFreshsalesConfiguration/index.js",
12392     "groupTitle": "Freshsales_Configurations"
12393   },
12394   {
12395     "type": "get",
12396     "url": "/api/integrations/freshsales/configurations",
12397     "title": "Gets a list of Freshsales Configurations",
12398     "examples": [
12399       {
12400         "title": "Example usage:",
12401         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12402         "type": "json"
12403       }
12404     ],
12405     "name": "GetFreshsales_Configurations",
12406     "group": "Freshsales_Configurations",
12407     "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>",
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/{id}",
12415     "title": "Gets a single Freshsales Configuration",
12416     "examples": [
12417       {
12418         "title": "Example usage:",
12419         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12420         "type": "json"
12421       }
12422     ],
12423     "name": "ShowFreshsales_Configurations",
12424     "group": "Freshsales_Configurations",
12425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
12433     "title": "Gets configurations descriptions",
12434     "examples": [
12435       {
12436         "title": "Example usage:",
12437         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12438         "type": "json"
12439       }
12440     ],
12441     "name": "getDescriptions",
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}/fields",
12451     "title": "Gets configurations fields",
12452     "examples": [
12453       {
12454         "title": "Example usage:",
12455         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12456         "type": "json"
12457       }
12458     ],
12459     "name": "getFields",
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}/subjects",
12469     "title": "Gets configurations subjects",
12470     "examples": [
12471       {
12472         "title": "Example usage:",
12473         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12474         "type": "json"
12475       }
12476     ],
12477     "name": "getSubjects",
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": "put",
12486     "url": "/api/integrations/freshsales/configurations/{id}",
12487     "title": "Update an existing Freshsales Configuration",
12488     "examples": [
12489       {
12490         "title": "Example usage:",
12491         "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",
12492         "type": "json"
12493       }
12494     ],
12495     "name": "updateFreshsales_Configurations",
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": "post",
12504     "url": "/api/integrations/freshsales/fields",
12505     "title": "Creates a new Freshsales Field",
12506     "examples": [
12507       {
12508         "title": "Example usage:",
12509         "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",
12510         "type": "json"
12511       }
12512     ],
12513     "name": "CreateFreshsales_Fields",
12514     "group": "Freshsales_Fields",
12515     "parameter": {
12516       "fields": {
12517         "Body": [
12518           {
12519             "group": "Body",
12520             "type": "String",
12521             "allowedValues": [
12522               "\"string\"",
12523               "\"variable\"",
12524               "\"customVariable\"",
12525               "\"keyValue\"",
12526               "\"picklist\""
12527             ],
12528             "optional": true,
12529             "field": "type",
12530             "description": ""
12531           },
12532           {
12533             "group": "Body",
12534             "type": "String",
12535             "optional": true,
12536             "field": "content",
12537             "description": ""
12538           },
12539           {
12540             "group": "Body",
12541             "type": "String",
12542             "optional": true,
12543             "field": "key",
12544             "description": ""
12545           },
12546           {
12547             "group": "Body",
12548             "type": "String",
12549             "allowedValues": [
12550               "\"string\"",
12551               "\"variable\"",
12552               "\"customVariable\""
12553             ],
12554             "optional": true,
12555             "field": "keyType",
12556             "description": ""
12557           },
12558           {
12559             "group": "Body",
12560             "type": "String",
12561             "optional": true,
12562             "field": "keyContent",
12563             "description": ""
12564           },
12565           {
12566             "group": "Body",
12567             "type": "String",
12568             "optional": true,
12569             "field": "idField",
12570             "description": ""
12571           },
12572           {
12573             "group": "Body",
12574             "type": "String",
12575             "optional": true,
12576             "field": "nameField",
12577             "description": ""
12578           },
12579           {
12580             "group": "Body",
12581             "type": "Boolean",
12582             "optional": true,
12583             "field": "customField",
12584             "description": ""
12585           },
12586           {
12587             "group": "Body",
12588             "type": "String",
12589             "optional": true,
12590             "field": "variableName",
12591             "description": ""
12592           }
12593         ]
12594       }
12595     },
12596     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12597     "version": "0.0.0",
12598     "filename": "server/api/intFreshsalesField/index.js",
12599     "groupTitle": "Freshsales_Fields"
12600   },
12601   {
12602     "type": "delete",
12603     "url": "/api/integrations/freshsales/fields/{id}",
12604     "title": "Deletes a Freshsales Field",
12605     "examples": [
12606       {
12607         "title": "Example usage:",
12608         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12609         "type": "json"
12610       }
12611     ],
12612     "name": "DeleteFreshsales_Fields",
12613     "group": "Freshsales_Fields",
12614     "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>",
12615     "version": "0.0.0",
12616     "filename": "server/api/intFreshsalesField/index.js",
12617     "groupTitle": "Freshsales_Fields"
12618   },
12619   {
12620     "type": "get",
12621     "url": "/api/integrations/freshsales/fields",
12622     "title": "Gets a list of Freshsales Fields",
12623     "examples": [
12624       {
12625         "title": "Example usage:",
12626         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12627         "type": "json"
12628       }
12629     ],
12630     "name": "GetFreshsales_Fields",
12631     "group": "Freshsales_Fields",
12632     "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>",
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/{id}",
12640     "title": "Gets a single Freshsales Field",
12641     "examples": [
12642       {
12643         "title": "Example usage:",
12644         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12645         "type": "json"
12646       }
12647     ],
12648     "name": "ShowFreshsales_Fields",
12649     "group": "Freshsales_Fields",
12650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12651     "version": "0.0.0",
12652     "filename": "server/api/intFreshsalesField/index.js",
12653     "groupTitle": "Freshsales_Fields"
12654   },
12655   {
12656     "type": "put",
12657     "url": "/api/integrations/freshsales/fields/{id}",
12658     "title": "Update an existing Freshsales Field",
12659     "examples": [
12660       {
12661         "title": "Example usage:",
12662         "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",
12663         "type": "json"
12664       }
12665     ],
12666     "name": "updateFreshsales_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": "post",
12675     "url": "/api/campaigns/{id}/blacklists",
12676     "title": "Add blacklists to an IVR campaign",
12677     "examples": [
12678       {
12679         "title": "Example usage:",
12680         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12681         "type": "json"
12682       }
12683     ],
12684     "name": "AddBlackLists",
12685     "group": "IVR_Campaigns",
12686     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12687     "version": "0.0.0",
12688     "filename": "server/api/campaign/index.js",
12689     "groupTitle": "IVR_Campaigns"
12690   },
12691   {
12692     "type": "post",
12693     "url": "/api/campaigns/{id}/lists",
12694     "title": "Add lists to an IVR campaign",
12695     "examples": [
12696       {
12697         "title": "Example usage:",
12698         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12699         "type": "json"
12700       }
12701     ],
12702     "name": "AddLists",
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/clone",
12712     "title": "Clone an existing IVR Campaign",
12713     "examples": [
12714       {
12715         "title": "Example usage:",
12716         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12717         "type": "json"
12718       }
12719     ],
12720     "name": "CloneIVR_Campaigns",
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",
12730     "title": "Creates a new IVR Campaign",
12731     "examples": [
12732       {
12733         "title": "Example usage:",
12734         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12735         "type": "json"
12736       }
12737     ],
12738     "name": "CreateIVR_Campaigns",
12739     "group": "IVR_Campaigns",
12740     "parameter": {
12741       "fields": {
12742         "Body": [
12743           {
12744             "group": "Body",
12745             "type": "String",
12746             "optional": false,
12747             "field": "name",
12748             "description": ""
12749           },
12750           {
12751             "group": "Body",
12752             "type": "String",
12753             "allowedValues": [
12754               "\"ivr\""
12755             ],
12756             "optional": false,
12757             "field": "type",
12758             "description": ""
12759           },
12760           {
12761             "group": "Body",
12762             "type": "String",
12763             "optional": true,
12764             "field": "description",
12765             "description": ""
12766           },
12767           {
12768             "group": "Body",
12769             "type": "Boolean",
12770             "optional": true,
12771             "field": "active",
12772             "description": "<p>Active/Disactive Campaign</p>"
12773           },
12774           {
12775             "group": "Body",
12776             "type": "Integer",
12777             "optional": true,
12778             "field": "limitCalls",
12779             "description": "<p>Max 200 calls.</p>"
12780           },
12781           {
12782             "group": "Body",
12783             "type": "String",
12784             "optional": true,
12785             "field": "dialOriginateCallerIdName",
12786             "description": ""
12787           },
12788           {
12789             "group": "Body",
12790             "type": "String",
12791             "optional": true,
12792             "field": "dialOriginateCallerIdNumber",
12793             "description": ""
12794           },
12795           {
12796             "group": "Body",
12797             "type": "Integer",
12798             "optional": true,
12799             "field": "dialOriginateTimeout",
12800             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12801           },
12802           {
12803             "group": "Body",
12804             "type": "Integer",
12805             "optional": true,
12806             "field": "dialCongestionMaxRetry",
12807             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12808           },
12809           {
12810             "group": "Body",
12811             "type": "Integer",
12812             "optional": true,
12813             "field": "dialCongestionRetryFrequency",
12814             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12815           },
12816           {
12817             "group": "Body",
12818             "type": "Integer",
12819             "optional": true,
12820             "field": "dialBusyMaxRetry",
12821             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12822           },
12823           {
12824             "group": "Body",
12825             "type": "Integer",
12826             "optional": true,
12827             "field": "dialBusyRetryFrequency",
12828             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12829           },
12830           {
12831             "group": "Body",
12832             "type": "Integer",
12833             "optional": true,
12834             "field": "dialNoAnswerMaxRetry",
12835             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12836           },
12837           {
12838             "group": "Body",
12839             "type": "Integer",
12840             "optional": true,
12841             "field": "dialNoAnswerRetryFrequency",
12842             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12843           },
12844           {
12845             "group": "Body",
12846             "type": "Integer",
12847             "optional": true,
12848             "field": "dialGlobalMaxRetry",
12849             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12850           },
12851           {
12852             "group": "Body",
12853             "type": "String",
12854             "optional": true,
12855             "field": "dialTimezone",
12856             "description": ""
12857           },
12858           {
12859             "group": "Body",
12860             "type": "String",
12861             "optional": true,
12862             "field": "dialGlobalInterval",
12863             "description": ""
12864           },
12865           {
12866             "group": "Body",
12867             "type": "String",
12868             "allowedValues": [
12869               "\"always\"",
12870               "\"never\"",
12871               "\"onlyIfOpen\""
12872             ],
12873             "optional": true,
12874             "field": "dialCheckDuplicateType",
12875             "description": ""
12876           },
12877           {
12878             "group": "Body",
12879             "type": "Boolean",
12880             "optional": true,
12881             "field": "dialAMDActive",
12882             "description": "<p>Active/Disactive AMD</p>"
12883           },
12884           {
12885             "group": "Body",
12886             "type": "Integer",
12887             "optional": true,
12888             "field": "dialAMDInitialSilence",
12889             "description": "<p>#AMD Initial Silence</p>"
12890           },
12891           {
12892             "group": "Body",
12893             "type": "Integer",
12894             "optional": true,
12895             "field": "dialAMDGreeting",
12896             "description": "<p>#AMD Greeting</p>"
12897           },
12898           {
12899             "group": "Body",
12900             "type": "Integer",
12901             "optional": true,
12902             "field": "dialAMDAfterGreetingSilence",
12903             "description": "<p>#AMD After Greeting Silence</p>"
12904           },
12905           {
12906             "group": "Body",
12907             "type": "Integer",
12908             "optional": true,
12909             "field": "dialAMDTotalAnalysisTime",
12910             "description": "<p>#AMD Total Analysis Time</p>"
12911           },
12912           {
12913             "group": "Body",
12914             "type": "Integer",
12915             "optional": true,
12916             "field": "dialAMDMinWordLength",
12917             "description": "<p>#AMD Min Word Length</p>"
12918           },
12919           {
12920             "group": "Body",
12921             "type": "Integer",
12922             "optional": true,
12923             "field": "dialAMDBetweenWordsSilence",
12924             "description": "<p>#AMD Between Words Silence</p>"
12925           },
12926           {
12927             "group": "Body",
12928             "type": "Integer",
12929             "optional": true,
12930             "field": "dialAMDMaximumNumberOfWords",
12931             "description": "<p>#AMD Maximum Number Of Words</p>"
12932           },
12933           {
12934             "group": "Body",
12935             "type": "Integer",
12936             "optional": true,
12937             "field": "dialAMDSilenceThreshold",
12938             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12939           },
12940           {
12941             "group": "Body",
12942             "type": "Integer",
12943             "optional": true,
12944             "field": "dialAMDMaximumWordLength",
12945             "description": "<p>#AMD Maximum Word Length</p>"
12946           },
12947           {
12948             "group": "Body",
12949             "type": "String",
12950             "allowedValues": [
12951               "\"DESC\"",
12952               "\"ASC\""
12953             ],
12954             "optional": true,
12955             "field": "dialOrderByScheduledAt",
12956             "description": ""
12957           },
12958           {
12959             "group": "Body",
12960             "type": "String",
12961             "optional": true,
12962             "field": "dialPrefix",
12963             "description": ""
12964           },
12965           {
12966             "group": "Body",
12967             "type": "Integer",
12968             "optional": true,
12969             "field": "dialRandomLastDigitCallerIdNumber",
12970             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12971           },
12972           {
12973             "group": "Body",
12974             "type": "Integer",
12975             "optional": true,
12976             "field": "dialCutDigit",
12977             "description": "<p>Cut Digit (min:1, max:15)</p>"
12978           },
12979           {
12980             "group": "Body",
12981             "type": "Integer",
12982             "optional": true,
12983             "field": "dialNoSuchNumberMaxRetry",
12984             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12985           },
12986           {
12987             "group": "Body",
12988             "type": "Integer",
12989             "optional": true,
12990             "field": "dialNoSuchNumberRetryFrequency",
12991             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12992           },
12993           {
12994             "group": "Body",
12995             "type": "Integer",
12996             "optional": true,
12997             "field": "dialDropMaxRetry",
12998             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12999           },
13000           {
13001             "group": "Body",
13002             "type": "Integer",
13003             "optional": true,
13004             "field": "dialDropRetryFrequency",
13005             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13006           },
13007           {
13008             "group": "Body",
13009             "type": "Integer",
13010             "optional": true,
13011             "field": "dialAbandonedMaxRetry",
13012             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13013           },
13014           {
13015             "group": "Body",
13016             "type": "Integer",
13017             "optional": true,
13018             "field": "dialAbandonedRetryFrequency",
13019             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13020           },
13021           {
13022             "group": "Body",
13023             "type": "Integer",
13024             "optional": true,
13025             "field": "dialMachineMaxRetry",
13026             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13027           },
13028           {
13029             "group": "Body",
13030             "type": "Integer",
13031             "optional": true,
13032             "field": "dialMachineRetryFrequency",
13033             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13034           },
13035           {
13036             "group": "Body",
13037             "type": "Integer",
13038             "optional": true,
13039             "field": "dialAgentRejectMaxRetry",
13040             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13041           },
13042           {
13043             "group": "Body",
13044             "type": "Integer",
13045             "optional": true,
13046             "field": "dialAgentRejectRetryFrequency",
13047             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13048           }
13049         ]
13050       }
13051     },
13052     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13053     "version": "0.0.0",
13054     "filename": "server/api/campaign/index.js",
13055     "groupTitle": "IVR_Campaigns"
13056   },
13057   {
13058     "type": "delete",
13059     "url": "/api/campaigns/{id}",
13060     "title": "Deletes a IVR Campaign",
13061     "examples": [
13062       {
13063         "title": "Example usage:",
13064         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13065         "type": "json"
13066       }
13067     ],
13068     "name": "DeleteIVR_Campaigns",
13069     "group": "IVR_Campaigns",
13070     "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>",
13071     "version": "0.0.0",
13072     "filename": "server/api/campaign/index.js",
13073     "groupTitle": "IVR_Campaigns"
13074   },
13075   {
13076     "type": "get",
13077     "url": "/api/campaigns/{id}/blacklists",
13078     "title": "Get IVR campaign blacklists",
13079     "examples": [
13080       {
13081         "title": "Example usage:",
13082         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13083         "type": "json"
13084       }
13085     ],
13086     "name": "GetBlackLists",
13087     "group": "IVR_Campaigns",
13088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/finals",
13096     "title": "Gets IVR campaign hopper finals",
13097     "examples": [
13098       {
13099         "title": "Example usage:",
13100         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13101         "type": "json"
13102       }
13103     ],
13104     "name": "GetHopperFinals",
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}/hopper_histories",
13114     "title": "Gets IVR campaign hopper histories",
13115     "examples": [
13116       {
13117         "title": "Example usage:",
13118         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13119         "type": "json"
13120       }
13121     ],
13122     "name": "GetHopperHistories",
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}/hoppers",
13132     "title": "Gets IVR campaign hoppers",
13133     "examples": [
13134       {
13135         "title": "Example usage:",
13136         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13137         "type": "json"
13138       }
13139     ],
13140     "name": "GetHoppers",
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",
13150     "title": "Gets a list of IVR Campaigns",
13151     "examples": [
13152       {
13153         "title": "Example usage:",
13154         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13155         "type": "json"
13156       }
13157     ],
13158     "name": "GetIVR_Campaigns",
13159     "group": "IVR_Campaigns",
13160     "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>",
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/{id}/lists",
13168     "title": "Get IVR campaign lists",
13169     "examples": [
13170       {
13171         "title": "Example usage:",
13172         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13173         "type": "json"
13174       }
13175     ],
13176     "name": "GetLists",
13177     "group": "IVR_Campaigns",
13178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13179     "version": "0.0.0",
13180     "filename": "server/api/campaign/index.js",
13181     "groupTitle": "IVR_Campaigns"
13182   },
13183   {
13184     "type": "delete",
13185     "url": "/api/campaigns/{id}/blacklists",
13186     "title": "Remove blacklists from an IVR Campaign",
13187     "examples": [
13188       {
13189         "title": "Example usage:",
13190         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13191         "type": "json"
13192       }
13193     ],
13194     "name": "RemoveBlackLists",
13195     "group": "IVR_Campaigns",
13196     "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>",
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}/lists",
13204     "title": "Remove lists from an IVR Campaign",
13205     "examples": [
13206       {
13207         "title": "Example usage:",
13208         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13209         "type": "json"
13210       }
13211     ],
13212     "name": "RemoveLists",
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": "get",
13221     "url": "/api/campaigns/{id}",
13222     "title": "Gets a single IVR Campaign",
13223     "examples": [
13224       {
13225         "title": "Example usage:",
13226         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13227         "type": "json"
13228       }
13229     ],
13230     "name": "ShowIVR_Campaigns",
13231     "group": "IVR_Campaigns",
13232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/blacks",
13240     "title": "Gets IVR campaign hopper blacks",
13241     "examples": [
13242       {
13243         "title": "Example usage:",
13244         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13245         "type": "json"
13246       }
13247     ],
13248     "name": "getHopperBlacks",
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": "put",
13257     "url": "/api/campaigns/{id}",
13258     "title": "Update an existing IVR Campaign",
13259     "examples": [
13260       {
13261         "title": "Example usage:",
13262         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13263         "type": "json"
13264       }
13265     ],
13266     "name": "updateIVR_Campaigns",
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": "post",
13275     "url": "/api/integrations/reports",
13276     "title": "Creates a new Integration Report",
13277     "examples": [
13278       {
13279         "title": "Example usage:",
13280         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13281         "type": "json"
13282       }
13283     ],
13284     "name": "CreateIntegration_Reports",
13285     "group": "Integration_Reports",
13286     "parameter": {
13287       "fields": {
13288         "Body": [
13289           {
13290             "group": "Body",
13291             "type": "String",
13292             "optional": true,
13293             "field": "integration",
13294             "description": ""
13295           },
13296           {
13297             "group": "Body",
13298             "type": "String",
13299             "optional": true,
13300             "field": "eventChannel",
13301             "description": ""
13302           },
13303           {
13304             "group": "Body",
13305             "type": "String",
13306             "optional": true,
13307             "field": "exitStatus",
13308             "description": ""
13309           },
13310           {
13311             "group": "Body",
13312             "type": "String",
13313             "optional": true,
13314             "field": "ticketId",
13315             "description": ""
13316           },
13317           {
13318             "group": "Body",
13319             "type": "Integer",
13320             "optional": true,
13321             "field": "integrationId",
13322             "description": ""
13323           },
13324           {
13325             "group": "Body",
13326             "type": "String",
13327             "optional": true,
13328             "field": "contacts",
13329             "description": ""
13330           },
13331           {
13332             "group": "Body",
13333             "type": "String",
13334             "optional": true,
13335             "field": "uniqueid",
13336             "description": ""
13337           },
13338           {
13339             "group": "Body",
13340             "type": "String",
13341             "optional": true,
13342             "field": "calleridnum",
13343             "description": ""
13344           },
13345           {
13346             "group": "Body",
13347             "type": "String",
13348             "optional": true,
13349             "field": "calleridname",
13350             "description": ""
13351           },
13352           {
13353             "group": "Body",
13354             "type": "String",
13355             "optional": true,
13356             "field": "queue",
13357             "description": ""
13358           },
13359           {
13360             "group": "Body",
13361             "type": "String",
13362             "optional": true,
13363             "field": "interface",
13364             "description": ""
13365           },
13366           {
13367             "group": "Body",
13368             "type": "String",
13369             "optional": true,
13370             "field": "membername",
13371             "description": ""
13372           },
13373           {
13374             "group": "Body",
13375             "type": "String",
13376             "optional": true,
13377             "field": "agentcalledAt",
13378             "description": ""
13379           },
13380           {
13381             "group": "Body",
13382             "type": "String",
13383             "optional": true,
13384             "field": "agentconnectAt",
13385             "description": ""
13386           },
13387           {
13388             "group": "Body",
13389             "type": "Integer",
13390             "optional": true,
13391             "field": "holdtime",
13392             "description": ""
13393           },
13394           {
13395             "group": "Body",
13396             "type": "Boolean",
13397             "optional": true,
13398             "field": "agentcomplete",
13399             "description": ""
13400           },
13401           {
13402             "group": "Body",
13403             "type": "String",
13404             "optional": true,
13405             "field": "agentcompleteAt",
13406             "description": ""
13407           },
13408           {
13409             "group": "Body",
13410             "type": "Integer",
13411             "optional": true,
13412             "field": "talktime",
13413             "description": ""
13414           },
13415           {
13416             "group": "Body",
13417             "type": "Boolean",
13418             "optional": true,
13419             "field": "agentacw",
13420             "description": ""
13421           },
13422           {
13423             "group": "Body",
13424             "type": "Integer",
13425             "optional": true,
13426             "field": "acwtime",
13427             "description": ""
13428           },
13429           {
13430             "group": "Body",
13431             "type": "String",
13432             "optional": true,
13433             "field": "reason",
13434             "description": ""
13435           },
13436           {
13437             "group": "Body",
13438             "type": "Boolean",
13439             "optional": true,
13440             "field": "agentringnoanswer",
13441             "description": ""
13442           },
13443           {
13444             "group": "Body",
13445             "type": "String",
13446             "optional": true,
13447             "field": "agentringnoanswerAt",
13448             "description": ""
13449           },
13450           {
13451             "group": "Body",
13452             "type": "Boolean",
13453             "optional": true,
13454             "field": "agentdump",
13455             "description": ""
13456           },
13457           {
13458             "group": "Body",
13459             "type": "String",
13460             "optional": true,
13461             "field": "agentdumpAt",
13462             "description": ""
13463           },
13464           {
13465             "group": "Body",
13466             "type": "String",
13467             "optional": true,
13468             "field": "lastevent",
13469             "description": ""
13470           },
13471           {
13472             "group": "Body",
13473             "type": "String",
13474             "optional": true,
13475             "field": "channel",
13476             "description": ""
13477           },
13478           {
13479             "group": "Body",
13480             "type": "Integer",
13481             "optional": true,
13482             "field": "channelstate",
13483             "description": ""
13484           },
13485           {
13486             "group": "Body",
13487             "type": "String",
13488             "optional": true,
13489             "field": "channelstatedesc",
13490             "description": ""
13491           },
13492           {
13493             "group": "Body",
13494             "type": "String",
13495             "optional": true,
13496             "field": "connectedlinenum",
13497             "description": ""
13498           },
13499           {
13500             "group": "Body",
13501             "type": "String",
13502             "optional": true,
13503             "field": "connectedlinename",
13504             "description": ""
13505           },
13506           {
13507             "group": "Body",
13508             "type": "String",
13509             "optional": true,
13510             "field": "language",
13511             "description": ""
13512           },
13513           {
13514             "group": "Body",
13515             "type": "String",
13516             "optional": true,
13517             "field": "accountcode",
13518             "description": ""
13519           },
13520           {
13521             "group": "Body",
13522             "type": "String",
13523             "optional": true,
13524             "field": "context",
13525             "description": ""
13526           },
13527           {
13528             "group": "Body",
13529             "type": "String",
13530             "optional": true,
13531             "field": "exten",
13532             "description": ""
13533           },
13534           {
13535             "group": "Body",
13536             "type": "String",
13537             "optional": true,
13538             "field": "priority",
13539             "description": ""
13540           },
13541           {
13542             "group": "Body",
13543             "type": "String",
13544             "optional": true,
13545             "field": "destchannel",
13546             "description": ""
13547           },
13548           {
13549             "group": "Body",
13550             "type": "Integer",
13551             "optional": true,
13552             "field": "destchannelstate",
13553             "description": ""
13554           },
13555           {
13556             "group": "Body",
13557             "type": "String",
13558             "optional": true,
13559             "field": "destchannelstatedesc",
13560             "description": ""
13561           },
13562           {
13563             "group": "Body",
13564             "type": "String",
13565             "optional": true,
13566             "field": "destcalleridnum",
13567             "description": ""
13568           },
13569           {
13570             "group": "Body",
13571             "type": "String",
13572             "optional": true,
13573             "field": "destcalleridname",
13574             "description": ""
13575           },
13576           {
13577             "group": "Body",
13578             "type": "String",
13579             "optional": true,
13580             "field": "destconnectedlinenum",
13581             "description": ""
13582           },
13583           {
13584             "group": "Body",
13585             "type": "String",
13586             "optional": true,
13587             "field": "destconnectedlinename",
13588             "description": ""
13589           },
13590           {
13591             "group": "Body",
13592             "type": "String",
13593             "optional": true,
13594             "field": "destlanguage",
13595             "description": ""
13596           },
13597           {
13598             "group": "Body",
13599             "type": "String",
13600             "optional": true,
13601             "field": "destaccountcode",
13602             "description": ""
13603           },
13604           {
13605             "group": "Body",
13606             "type": "String",
13607             "optional": true,
13608             "field": "destcontext",
13609             "description": ""
13610           },
13611           {
13612             "group": "Body",
13613             "type": "String",
13614             "optional": true,
13615             "field": "destexten",
13616             "description": ""
13617           },
13618           {
13619             "group": "Body",
13620             "type": "String",
13621             "optional": true,
13622             "field": "destpriority",
13623             "description": ""
13624           },
13625           {
13626             "group": "Body",
13627             "type": "String",
13628             "optional": true,
13629             "field": "destuniqueid",
13630             "description": ""
13631           },
13632           {
13633             "group": "Body",
13634             "type": "String",
13635             "optional": true,
13636             "field": "messageId",
13637             "description": ""
13638           },
13639           {
13640             "group": "Body",
13641             "type": "String",
13642             "optional": true,
13643             "field": "inReplyTo",
13644             "description": ""
13645           },
13646           {
13647             "group": "Body",
13648             "type": "String",
13649             "optional": true,
13650             "field": "subject",
13651             "description": ""
13652           },
13653           {
13654             "group": "Body",
13655             "type": "String",
13656             "optional": true,
13657             "field": "from",
13658             "description": ""
13659           },
13660           {
13661             "group": "Body",
13662             "type": "String",
13663             "optional": true,
13664             "field": "to",
13665             "description": ""
13666           },
13667           {
13668             "group": "Body",
13669             "type": "String",
13670             "optional": true,
13671             "field": "cc",
13672             "description": ""
13673           },
13674           {
13675             "group": "Body",
13676             "type": "Text",
13677             "optional": true,
13678             "field": "attachment",
13679             "description": ""
13680           },
13681           {
13682             "group": "Body",
13683             "type": "Text",
13684             "optional": true,
13685             "field": "html",
13686             "description": ""
13687           },
13688           {
13689             "group": "Body",
13690             "type": "Text",
13691             "optional": true,
13692             "field": "text",
13693             "description": ""
13694           },
13695           {
13696             "group": "Body",
13697             "type": "String",
13698             "allowedValues": [
13699               "\"SENT\"",
13700               "\"SENDING\"",
13701               "\"RECEIVED\"",
13702               "\"FAILED\""
13703             ],
13704             "optional": true,
13705             "field": "status",
13706             "description": ""
13707           },
13708           {
13709             "group": "Body",
13710             "type": "String",
13711             "optional": true,
13712             "field": "url",
13713             "description": ""
13714           },
13715           {
13716             "group": "Body",
13717             "type": "String",
13718             "optional": true,
13719             "field": "app",
13720             "description": ""
13721           },
13722           {
13723             "group": "Body",
13724             "type": "String",
13725             "optional": true,
13726             "field": "appdata",
13727             "description": ""
13728           },
13729           {
13730             "group": "Body",
13731             "type": "Integer",
13732             "optional": true,
13733             "field": "projectId",
13734             "description": ""
13735           }
13736         ]
13737       }
13738     },
13739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13740     "version": "0.0.0",
13741     "filename": "server/api/integrationReport/index.js",
13742     "groupTitle": "Integration_Reports"
13743   },
13744   {
13745     "type": "delete",
13746     "url": "/api/integrations/reports/{id}",
13747     "title": "Deletes a Integration Report",
13748     "examples": [
13749       {
13750         "title": "Example usage:",
13751         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13752         "type": "json"
13753       }
13754     ],
13755     "name": "DeleteIntegration_Reports",
13756     "group": "Integration_Reports",
13757     "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>",
13758     "version": "0.0.0",
13759     "filename": "server/api/integrationReport/index.js",
13760     "groupTitle": "Integration_Reports"
13761   },
13762   {
13763     "type": "get",
13764     "url": "/api/integrations/reports/describe",
13765     "title": "Gets table info about Integration Reports",
13766     "examples": [
13767       {
13768         "title": "Example usage:",
13769         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13770         "type": "json"
13771       }
13772     ],
13773     "name": "DescribeIntegration_Reports",
13774     "group": "Integration_Reports",
13775     "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>",
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",
13783     "title": "Gets a list of Integration Reports",
13784     "examples": [
13785       {
13786         "title": "Example usage:",
13787         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13788         "type": "json"
13789       }
13790     ],
13791     "name": "GetIntegration_Reports",
13792     "group": "Integration_Reports",
13793     "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>",
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/{id}",
13801     "title": "Gets a single Integration Report",
13802     "examples": [
13803       {
13804         "title": "Example usage:",
13805         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13806         "type": "json"
13807       }
13808     ],
13809     "name": "ShowIntegration_Reports",
13810     "group": "Integration_Reports",
13811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13812     "version": "0.0.0",
13813     "filename": "server/api/integrationReport/index.js",
13814     "groupTitle": "Integration_Reports"
13815   },
13816   {
13817     "type": "put",
13818     "url": "/api/integrations/reports/{id}",
13819     "title": "Update an existing Integration Report",
13820     "examples": [
13821       {
13822         "title": "Example usage:",
13823         "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",
13824         "type": "json"
13825       }
13826     ],
13827     "name": "updateIntegration_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": "post",
13836     "url": "/api/intervals",
13837     "title": "Creates a new Interval",
13838     "examples": [
13839       {
13840         "title": "Example usage:",
13841         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13842         "type": "json"
13843       }
13844     ],
13845     "name": "CreateIntervals",
13846     "group": "Intervals",
13847     "parameter": {
13848       "fields": {
13849         "Body": [
13850           {
13851             "group": "Body",
13852             "type": "String",
13853             "optional": true,
13854             "field": "name",
13855             "description": ""
13856           },
13857           {
13858             "group": "Body",
13859             "type": "String",
13860             "optional": true,
13861             "field": "description",
13862             "description": ""
13863           },
13864           {
13865             "group": "Body",
13866             "type": "String",
13867             "optional": true,
13868             "field": "interval",
13869             "description": ""
13870           }
13871         ]
13872       }
13873     },
13874     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13875     "version": "0.0.0",
13876     "filename": "server/api/interval/index.js",
13877     "groupTitle": "Intervals"
13878   },
13879   {
13880     "type": "delete",
13881     "url": "/api/intervals/{id}",
13882     "title": "Deletes a Interval",
13883     "examples": [
13884       {
13885         "title": "Example usage:",
13886         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13887         "type": "json"
13888       }
13889     ],
13890     "name": "DeleteIntervals",
13891     "group": "Intervals",
13892     "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>",
13893     "version": "0.0.0",
13894     "filename": "server/api/interval/index.js",
13895     "groupTitle": "Intervals"
13896   },
13897   {
13898     "type": "get",
13899     "url": "/api/intervals",
13900     "title": "Gets a list of Intervals",
13901     "examples": [
13902       {
13903         "title": "Example usage:",
13904         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13905         "type": "json"
13906       }
13907     ],
13908     "name": "GetIntervals",
13909     "group": "Intervals",
13910     "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>",
13911     "version": "0.0.0",
13912     "filename": "server/api/interval/index.js",
13913     "groupTitle": "Intervals"
13914   },
13915   {
13916     "type": "get",
13917     "url": "/api/intervals/{id}",
13918     "title": "Gets a single Interval",
13919     "examples": [
13920       {
13921         "title": "Example usage:",
13922         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13923         "type": "json"
13924       }
13925     ],
13926     "name": "ShowIntervals",
13927     "group": "Intervals",
13928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13929     "version": "0.0.0",
13930     "filename": "server/api/interval/index.js",
13931     "groupTitle": "Intervals"
13932   },
13933   {
13934     "type": "post",
13935     "url": "/api/intervals/{id}/sub_intervals",
13936     "title": "Creates a new sub interval",
13937     "examples": [
13938       {
13939         "title": "Example usage:",
13940         "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",
13941         "type": "json"
13942       }
13943     ],
13944     "name": "addInterval",
13945     "group": "Intervals",
13946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/create_many",
13954     "title": "Create new sub intervals set",
13955     "examples": [
13956       {
13957         "title": "Example usage:",
13958         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13959         "type": "json"
13960       }
13961     ],
13962     "name": "addIntervals",
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": "get",
13971     "url": "/api/intervals/{id}/sub_intervals",
13972     "title": "Get sub intervals set",
13973     "examples": [
13974       {
13975         "title": "Example usage:",
13976         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13977         "type": "json"
13978       }
13979     ],
13980     "name": "getIntervals",
13981     "group": "Intervals",
13982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
13989     "url": "/api/intervals/{id}",
13990     "title": "Update an existing Interval",
13991     "examples": [
13992       {
13993         "title": "Example usage:",
13994         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13995         "type": "json"
13996       }
13997     ],
13998     "name": "updateIntervals",
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": "post",
14007     "url": "/api/jira",
14008     "title": "Creates a new issue",
14009     "examples": [
14010       {
14011         "title": "Example usage:",
14012         "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}",
14013         "type": "json"
14014       }
14015     ],
14016     "name": "Creates_Issue",
14017     "group": "Issue",
14018     "parameter": {
14019       "fields": {
14020         "Body": [
14021           {
14022             "group": "Body",
14023             "type": "String",
14024             "allowedValues": [
14025               "\"Bug\""
14026             ],
14027             "optional": true,
14028             "field": "issuetype",
14029             "description": ""
14030           },
14031           {
14032             "group": "Body",
14033             "type": "String",
14034             "optional": false,
14035             "field": "summary",
14036             "description": ""
14037           },
14038           {
14039             "group": "Body",
14040             "type": "String",
14041             "optional": false,
14042             "field": "description",
14043             "description": ""
14044           }
14045         ]
14046       }
14047     },
14048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14049     "version": "0.0.0",
14050     "filename": "server/api/jira/index.js",
14051     "groupTitle": "Issue"
14052   },
14053   {
14054     "type": "post",
14055     "url": "/api/jscripty/answers/reports",
14056     "title": "Creates a new Report",
14057     "examples": [
14058       {
14059         "title": "Example usage:",
14060         "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",
14061         "type": "json"
14062       }
14063     ],
14064     "name": "CreateReports",
14065     "group": "JscriptyAnswerReport",
14066     "parameter": {
14067       "fields": {
14068         "Body": [
14069           {
14070             "group": "Body",
14071             "type": "Text",
14072             "optional": true,
14073             "field": "question",
14074             "description": ""
14075           },
14076           {
14077             "group": "Body",
14078             "type": "Text",
14079             "optional": true,
14080             "field": "answer",
14081             "description": ""
14082           },
14083           {
14084             "group": "Body",
14085             "type": "String",
14086             "optional": true,
14087             "field": "membername",
14088             "description": ""
14089           },
14090           {
14091             "group": "Body",
14092             "type": "String",
14093             "optional": true,
14094             "field": "projectname",
14095             "description": ""
14096           },
14097           {
14098             "group": "Body",
14099             "type": "String",
14100             "optional": true,
14101             "field": "queue",
14102             "description": ""
14103           },
14104           {
14105             "group": "Body",
14106             "type": "String",
14107             "optional": true,
14108             "field": "uniqueid",
14109             "description": ""
14110           },
14111           {
14112             "group": "Body",
14113             "type": "String",
14114             "optional": true,
14115             "field": "calleridname",
14116             "description": ""
14117           },
14118           {
14119             "group": "Body",
14120             "type": "String",
14121             "optional": true,
14122             "field": "calleridnum",
14123             "description": ""
14124           },
14125           {
14126             "group": "Body",
14127             "type": "String",
14128             "optional": true,
14129             "field": "questionId",
14130             "description": ""
14131           }
14132         ]
14133       }
14134     },
14135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14136     "version": "0.0.0",
14137     "filename": "server/api/jscriptyAnswerReport/index.js",
14138     "groupTitle": "JscriptyAnswerReport"
14139   },
14140   {
14141     "type": "delete",
14142     "url": "/api/jscripty/answers/reports/{id}",
14143     "title": "Deletes a Report",
14144     "examples": [
14145       {
14146         "title": "Example usage:",
14147         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14148         "type": "json"
14149       }
14150     ],
14151     "name": "DeleteReports",
14152     "group": "JscriptyAnswerReport",
14153     "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>",
14154     "version": "0.0.0",
14155     "filename": "server/api/jscriptyAnswerReport/index.js",
14156     "groupTitle": "JscriptyAnswerReport"
14157   },
14158   {
14159     "type": "get",
14160     "url": "/api/jscripty/answers/reports/describe",
14161     "title": "Gets table info about Reports",
14162     "examples": [
14163       {
14164         "title": "Example usage:",
14165         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14166         "type": "json"
14167       }
14168     ],
14169     "name": "DescribeReports",
14170     "group": "JscriptyAnswerReport",
14171     "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>",
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",
14179     "title": "Gets a list of Reports",
14180     "examples": [
14181       {
14182         "title": "Example usage:",
14183         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14184         "type": "json"
14185       }
14186     ],
14187     "name": "GetReports",
14188     "group": "JscriptyAnswerReport",
14189     "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>",
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/{id}",
14197     "title": "Gets a single Report",
14198     "examples": [
14199       {
14200         "title": "Example usage:",
14201         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14202         "type": "json"
14203       }
14204     ],
14205     "name": "ShowReports",
14206     "group": "JscriptyAnswerReport",
14207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14208     "version": "0.0.0",
14209     "filename": "server/api/jscriptyAnswerReport/index.js",
14210     "groupTitle": "JscriptyAnswerReport"
14211   },
14212   {
14213     "type": "put",
14214     "url": "/api/jscripty/answers/reports/{id}",
14215     "title": "Update an existing Report",
14216     "examples": [
14217       {
14218         "title": "Example usage:",
14219         "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",
14220         "type": "json"
14221       }
14222     ],
14223     "name": "updateReports",
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": "post",
14232     "url": "/api/jscripty/questions/reports",
14233     "title": "Creates a new Report",
14234     "examples": [
14235       {
14236         "title": "Example usage:",
14237         "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",
14238         "type": "json"
14239       }
14240     ],
14241     "name": "CreateReports",
14242     "group": "JscriptyQuestionReport",
14243     "parameter": {
14244       "fields": {
14245         "Body": [
14246           {
14247             "group": "Body",
14248             "type": "Text",
14249             "optional": true,
14250             "field": "question",
14251             "description": ""
14252           },
14253           {
14254             "group": "Body",
14255             "type": "Text",
14256             "optional": true,
14257             "field": "answer",
14258             "description": ""
14259           },
14260           {
14261             "group": "Body",
14262             "type": "String",
14263             "optional": true,
14264             "field": "membername",
14265             "description": ""
14266           },
14267           {
14268             "group": "Body",
14269             "type": "String",
14270             "optional": true,
14271             "field": "projectname",
14272             "description": ""
14273           },
14274           {
14275             "group": "Body",
14276             "type": "String",
14277             "optional": true,
14278             "field": "queue",
14279             "description": ""
14280           },
14281           {
14282             "group": "Body",
14283             "type": "String",
14284             "optional": true,
14285             "field": "uniqueid",
14286             "description": ""
14287           },
14288           {
14289             "group": "Body",
14290             "type": "String",
14291             "optional": true,
14292             "field": "calleridname",
14293             "description": ""
14294           },
14295           {
14296             "group": "Body",
14297             "type": "String",
14298             "optional": true,
14299             "field": "calleridnum",
14300             "description": ""
14301           },
14302           {
14303             "group": "Body",
14304             "type": "String",
14305             "optional": true,
14306             "field": "questionId",
14307             "description": ""
14308           }
14309         ]
14310       }
14311     },
14312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14313     "version": "0.0.0",
14314     "filename": "server/api/jscriptyQuestionReport/index.js",
14315     "groupTitle": "JscriptyQuestionReport"
14316   },
14317   {
14318     "type": "delete",
14319     "url": "/api/jscripty/questions/reports/{id}",
14320     "title": "Deletes a Report",
14321     "examples": [
14322       {
14323         "title": "Example usage:",
14324         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14325         "type": "json"
14326       }
14327     ],
14328     "name": "DeleteReports",
14329     "group": "JscriptyQuestionReport",
14330     "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>",
14331     "version": "0.0.0",
14332     "filename": "server/api/jscriptyQuestionReport/index.js",
14333     "groupTitle": "JscriptyQuestionReport"
14334   },
14335   {
14336     "type": "get",
14337     "url": "/api/jscripty/questions/reports/describe",
14338     "title": "Gets table info about Reports",
14339     "examples": [
14340       {
14341         "title": "Example usage:",
14342         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14343         "type": "json"
14344       }
14345     ],
14346     "name": "DescribeReports",
14347     "group": "JscriptyQuestionReport",
14348     "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>",
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",
14356     "title": "Gets a list of Reports",
14357     "examples": [
14358       {
14359         "title": "Example usage:",
14360         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14361         "type": "json"
14362       }
14363     ],
14364     "name": "GetReports",
14365     "group": "JscriptyQuestionReport",
14366     "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>",
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/{id}",
14374     "title": "Gets a single Report",
14375     "examples": [
14376       {
14377         "title": "Example usage:",
14378         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14379         "type": "json"
14380       }
14381     ],
14382     "name": "ShowReports",
14383     "group": "JscriptyQuestionReport",
14384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14385     "version": "0.0.0",
14386     "filename": "server/api/jscriptyQuestionReport/index.js",
14387     "groupTitle": "JscriptyQuestionReport"
14388   },
14389   {
14390     "type": "put",
14391     "url": "/api/jscripty/questions/reports/{id}",
14392     "title": "Update an existing Report",
14393     "examples": [
14394       {
14395         "title": "Example usage:",
14396         "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",
14397         "type": "json"
14398       }
14399     ],
14400     "name": "updateReports",
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": "post",
14409     "url": "/api/jscripty/sessions/reports",
14410     "title": "Creates a new Report",
14411     "examples": [
14412       {
14413         "title": "Example usage:",
14414         "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",
14415         "type": "json"
14416       }
14417     ],
14418     "name": "CreateReports",
14419     "group": "JscriptySessionReport",
14420     "parameter": {
14421       "fields": {
14422         "Body": [
14423           {
14424             "group": "Body",
14425             "type": "String",
14426             "optional": true,
14427             "field": "starttime",
14428             "description": ""
14429           },
14430           {
14431             "group": "Body",
14432             "type": "String",
14433             "optional": true,
14434             "field": "endtime",
14435             "description": ""
14436           },
14437           {
14438             "group": "Body",
14439             "type": "String",
14440             "optional": true,
14441             "field": "membername",
14442             "description": ""
14443           },
14444           {
14445             "group": "Body",
14446             "type": "String",
14447             "optional": true,
14448             "field": "projectname",
14449             "description": ""
14450           },
14451           {
14452             "group": "Body",
14453             "type": "String",
14454             "optional": true,
14455             "field": "queue",
14456             "description": ""
14457           },
14458           {
14459             "group": "Body",
14460             "type": "String",
14461             "optional": true,
14462             "field": "uniqueid",
14463             "description": ""
14464           },
14465           {
14466             "group": "Body",
14467             "type": "String",
14468             "optional": true,
14469             "field": "calleridname",
14470             "description": ""
14471           },
14472           {
14473             "group": "Body",
14474             "type": "String",
14475             "optional": true,
14476             "field": "calleridnum",
14477             "description": ""
14478           },
14479           {
14480             "group": "Body",
14481             "type": "Boolean",
14482             "optional": true,
14483             "field": "completed",
14484             "description": ""
14485           }
14486         ]
14487       }
14488     },
14489     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14490     "version": "0.0.0",
14491     "filename": "server/api/jscriptySessionReport/index.js",
14492     "groupTitle": "JscriptySessionReport"
14493   },
14494   {
14495     "type": "delete",
14496     "url": "/api/jscripty/sessions/reports/{id}",
14497     "title": "Deletes a Report",
14498     "examples": [
14499       {
14500         "title": "Example usage:",
14501         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14502         "type": "json"
14503       }
14504     ],
14505     "name": "DeleteReports",
14506     "group": "JscriptySessionReport",
14507     "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>",
14508     "version": "0.0.0",
14509     "filename": "server/api/jscriptySessionReport/index.js",
14510     "groupTitle": "JscriptySessionReport"
14511   },
14512   {
14513     "type": "get",
14514     "url": "/api/jscripty/sessions/reports/describe",
14515     "title": "Gets table info about Reports",
14516     "examples": [
14517       {
14518         "title": "Example usage:",
14519         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14520         "type": "json"
14521       }
14522     ],
14523     "name": "DescribeReports",
14524     "group": "JscriptySessionReport",
14525     "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>",
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",
14533     "title": "Gets a list of Reports",
14534     "examples": [
14535       {
14536         "title": "Example usage:",
14537         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14538         "type": "json"
14539       }
14540     ],
14541     "name": "GetReports",
14542     "group": "JscriptySessionReport",
14543     "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>",
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/{id}",
14551     "title": "Gets a single Report",
14552     "examples": [
14553       {
14554         "title": "Example usage:",
14555         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14556         "type": "json"
14557       }
14558     ],
14559     "name": "ShowReports",
14560     "group": "JscriptySessionReport",
14561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/questions",
14569     "title": "Gets Jscripty Session questions",
14570     "examples": [
14571       {
14572         "title": "Example usage:",
14573         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14574         "type": "json"
14575       }
14576     ],
14577     "name": "getQuestions",
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": "put",
14586     "url": "/api/jscripty/sessions/reports/{id}",
14587     "title": "Update an existing Report",
14588     "examples": [
14589       {
14590         "title": "Example usage:",
14591         "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",
14592         "type": "json"
14593       }
14594     ],
14595     "name": "updateReports",
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": "post",
14604     "url": "/api/jscripty/projects/clone",
14605     "title": "Clone an existing Project",
14606     "examples": [
14607       {
14608         "title": "Example usage:",
14609         "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",
14610         "type": "json"
14611       }
14612     ],
14613     "name": "CloneProjects",
14614     "group": "Jscripty_Projects",
14615     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14616     "version": "0.0.0",
14617     "filename": "server/api/jscriptyProject/index.js",
14618     "groupTitle": "Jscripty_Projects"
14619   },
14620   {
14621     "type": "post",
14622     "url": "/api/jscripty/projects",
14623     "title": "Creates a new Project",
14624     "examples": [
14625       {
14626         "title": "Example usage:",
14627         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14628         "type": "json"
14629       }
14630     ],
14631     "name": "CreateProjects",
14632     "group": "Jscripty_Projects",
14633     "parameter": {
14634       "fields": {
14635         "Body": [
14636           {
14637             "group": "Body",
14638             "type": "String",
14639             "optional": true,
14640             "field": "name",
14641             "description": ""
14642           },
14643           {
14644             "group": "Body",
14645             "type": "String",
14646             "optional": true,
14647             "field": "description",
14648             "description": ""
14649           },
14650           {
14651             "group": "Body",
14652             "type": "Text",
14653             "optional": true,
14654             "field": "formData",
14655             "description": ""
14656           },
14657           {
14658             "group": "Body",
14659             "type": "Boolean",
14660             "optional": true,
14661             "field": "enableUncompleteSave",
14662             "description": ""
14663           },
14664           {
14665             "group": "Body",
14666             "type": "Boolean",
14667             "optional": true,
14668             "field": "sendUnpauseOnSubmit",
14669             "description": ""
14670           }
14671         ]
14672       }
14673     },
14674     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14675     "version": "0.0.0",
14676     "filename": "server/api/jscriptyProject/index.js",
14677     "groupTitle": "Jscripty_Projects"
14678   },
14679   {
14680     "type": "delete",
14681     "url": "/api/jscripty/projects/{id}",
14682     "title": "Deletes a Project",
14683     "examples": [
14684       {
14685         "title": "Example usage:",
14686         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14687         "type": "json"
14688       }
14689     ],
14690     "name": "DeleteProjects",
14691     "group": "Jscripty_Projects",
14692     "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>",
14693     "version": "0.0.0",
14694     "filename": "server/api/jscriptyProject/index.js",
14695     "groupTitle": "Jscripty_Projects"
14696   },
14697   {
14698     "type": "get",
14699     "url": "/api/jscripty/projects",
14700     "title": "Gets a list of Projects",
14701     "examples": [
14702       {
14703         "title": "Example usage:",
14704         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14705         "type": "json"
14706       }
14707     ],
14708     "name": "GetProjects",
14709     "group": "Jscripty_Projects",
14710     "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>",
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/{id}",
14718     "title": "Gets a single Project",
14719     "examples": [
14720       {
14721         "title": "Example usage:",
14722         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14723         "type": "json"
14724       }
14725     ],
14726     "name": "ShowProjects",
14727     "group": "Jscripty_Projects",
14728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/answers",
14736     "title": "Gets jscripty project answers",
14737     "examples": [
14738       {
14739         "title": "Example usage:",
14740         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14741         "type": "json"
14742       }
14743     ],
14744     "name": "getAnswers",
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}/sessions",
14754     "title": "Gets jscripty project sessions",
14755     "examples": [
14756       {
14757         "title": "Example usage:",
14758         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14759         "type": "json"
14760       }
14761     ],
14762     "name": "getSessions",
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}/summary",
14772     "title": "Gets jscripty project summary",
14773     "examples": [
14774       {
14775         "title": "Example usage:",
14776         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14777         "type": "json"
14778       }
14779     ],
14780     "name": "getSummary",
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": "put",
14789     "url": "/api/jscripty/projects/{id}",
14790     "title": "Update an existing Project",
14791     "examples": [
14792       {
14793         "title": "Example usage:",
14794         "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",
14795         "type": "json"
14796       }
14797     ],
14798     "name": "updateProjects",
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": "get",
14807     "url": "/api/license",
14808     "title": "Gets License Info",
14809     "examples": [
14810       {
14811         "title": "Example usage:",
14812         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14813         "type": "json"
14814       }
14815     ],
14816     "name": "index",
14817     "group": "License",
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/license/index.js",
14821     "groupTitle": "License"
14822   },
14823   {
14824     "type": "put",
14825     "url": "/api/license/{id}",
14826     "title": "Update License Info",
14827     "examples": [
14828       {
14829         "title": "Example usage:",
14830         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14831         "type": "json"
14832       }
14833     ],
14834     "name": "update",
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": "post",
14843     "url": "/api/mail/accounts/{id}/users",
14844     "title": "Add agents to a mail account",
14845     "examples": [
14846       {
14847         "title": "Example usage:",
14848         "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",
14849         "type": "json"
14850       }
14851     ],
14852     "name": "AddAgents",
14853     "group": "Mail_Accounts",
14854     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14855     "version": "0.0.0",
14856     "filename": "server/api/mailAccount/index.js",
14857     "groupTitle": "Mail_Accounts"
14858   },
14859   {
14860     "type": "post",
14861     "url": "/api/mail/accounts/{id}/in_servers",
14862     "title": "Creates a new IMAP server",
14863     "examples": [
14864       {
14865         "title": "Example usage:",
14866         "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",
14867         "type": "json"
14868       }
14869     ],
14870     "name": "AddImap",
14871     "group": "Mail_Accounts",
14872     "parameter": {
14873       "fields": {
14874         "Body": [
14875           {
14876             "group": "Body",
14877             "type": "String",
14878             "optional": true,
14879             "field": "description",
14880             "description": ""
14881           },
14882           {
14883             "group": "Body",
14884             "type": "String",
14885             "optional": true,
14886             "field": "host",
14887             "description": ""
14888           },
14889           {
14890             "group": "Body",
14891             "type": "Boolean",
14892             "optional": true,
14893             "field": "authentication",
14894             "description": ""
14895           },
14896           {
14897             "group": "Body",
14898             "type": "String",
14899             "optional": true,
14900             "field": "user",
14901             "description": ""
14902           },
14903           {
14904             "group": "Body",
14905             "type": "String",
14906             "optional": true,
14907             "field": "password",
14908             "description": ""
14909           },
14910           {
14911             "group": "Body",
14912             "type": "Integer",
14913             "optional": true,
14914             "field": "port",
14915             "description": ""
14916           },
14917           {
14918             "group": "Body",
14919             "type": "Boolean",
14920             "optional": true,
14921             "field": "tls",
14922             "description": ""
14923           },
14924           {
14925             "group": "Body",
14926             "type": "String",
14927             "optional": true,
14928             "field": "mailbox",
14929             "description": ""
14930           },
14931           {
14932             "group": "Body",
14933             "type": "Integer",
14934             "optional": true,
14935             "field": "connTimeout",
14936             "description": ""
14937           },
14938           {
14939             "group": "Body",
14940             "type": "Integer",
14941             "optional": true,
14942             "field": "authTimeout",
14943             "description": ""
14944           },
14945           {
14946             "group": "Body",
14947             "type": "String",
14948             "optional": true,
14949             "field": "service",
14950             "description": ""
14951           }
14952         ]
14953       }
14954     },
14955     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14956     "version": "0.0.0",
14957     "filename": "server/api/mailAccount/index.js",
14958     "groupTitle": "Mail_Accounts"
14959   },
14960   {
14961     "type": "post",
14962     "url": "/api/mail/accounts/{id}/out_servers",
14963     "title": "Creates a new SMTP server",
14964     "examples": [
14965       {
14966         "title": "Example usage:",
14967         "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",
14968         "type": "json"
14969       }
14970     ],
14971     "name": "AddSmtp",
14972     "group": "Mail_Accounts",
14973     "parameter": {
14974       "fields": {
14975         "Body": [
14976           {
14977             "group": "Body",
14978             "type": "String",
14979             "optional": true,
14980             "field": "description",
14981             "description": ""
14982           },
14983           {
14984             "group": "Body",
14985             "type": "String",
14986             "optional": true,
14987             "field": "host",
14988             "description": ""
14989           },
14990           {
14991             "group": "Body",
14992             "type": "String",
14993             "optional": true,
14994             "field": "user",
14995             "description": ""
14996           },
14997           {
14998             "group": "Body",
14999             "type": "String",
15000             "optional": true,
15001             "field": "pass",
15002             "description": ""
15003           },
15004           {
15005             "group": "Body",
15006             "type": "Integer",
15007             "optional": true,
15008             "field": "port",
15009             "description": ""
15010           },
15011           {
15012             "group": "Body",
15013             "type": "Boolean",
15014             "optional": true,
15015             "field": "secure",
15016             "description": ""
15017           },
15018           {
15019             "group": "Body",
15020             "type": "String",
15021             "optional": true,
15022             "field": "service",
15023             "description": ""
15024           },
15025           {
15026             "group": "Body",
15027             "type": "Boolean",
15028             "optional": true,
15029             "field": "authentication",
15030             "description": ""
15031           }
15032         ]
15033       }
15034     },
15035     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15036     "version": "0.0.0",
15037     "filename": "server/api/mailAccount/index.js",
15038     "groupTitle": "Mail_Accounts"
15039   },
15040   {
15041     "type": "delete",
15042     "url": "/api/mail/accounts/{id}",
15043     "title": "Deletes a mail account",
15044     "examples": [
15045       {
15046         "title": "Example usage:",
15047         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15048         "type": "json"
15049       }
15050     ],
15051     "name": "DeleteMailAccounts",
15052     "group": "Mail_Accounts",
15053     "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>",
15054     "version": "0.0.0",
15055     "filename": "server/api/mailAccount/index.js",
15056     "groupTitle": "Mail_Accounts"
15057   },
15058   {
15059     "type": "get",
15060     "url": "/api/mail/accounts/describe",
15061     "title": "Gets table info about Accounts",
15062     "examples": [
15063       {
15064         "title": "Example usage:",
15065         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15066         "type": "json"
15067       }
15068     ],
15069     "name": "DescribeAccounts",
15070     "group": "Mail_Accounts",
15071     "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>",
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",
15079     "title": "Gets a list of Accounts",
15080     "examples": [
15081       {
15082         "title": "Example usage:",
15083         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15084         "type": "json"
15085       }
15086     ],
15087     "name": "GetAccounts",
15088     "group": "Mail_Accounts",
15089     "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>",
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/{id}/users",
15097     "title": "Gets agents from mail account",
15098     "examples": [
15099       {
15100         "title": "Example usage:",
15101         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15102         "type": "json"
15103       }
15104     ],
15105     "name": "GetAgents",
15106     "group": "Mail_Accounts",
15107     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/in_servers",
15115     "title": "Gets account IMAP server",
15116     "examples": [
15117       {
15118         "title": "Example usage:",
15119         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15120         "type": "json"
15121       }
15122     ],
15123     "name": "GetImap",
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}/out_servers",
15133     "title": "Gets account SMTP server",
15134     "examples": [
15135       {
15136         "title": "Example usage:",
15137         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15138         "type": "json"
15139       }
15140     ],
15141     "name": "GetSmtp",
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": "delete",
15150     "url": "/api/mail/accounts/{id}/users",
15151     "title": "Removes agents from a mail account",
15152     "examples": [
15153       {
15154         "title": "Example usage:",
15155         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15156         "type": "json"
15157       }
15158     ],
15159     "name": "RemoveAgents",
15160     "group": "Mail_Accounts",
15161     "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>",
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}/canned_answers",
15169     "title": "Removes canned answers from account",
15170     "examples": [
15171       {
15172         "title": "Example usage:",
15173         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15174         "type": "json"
15175       }
15176     ],
15177     "name": "RemoveAnswers",
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}/dispositions",
15187     "title": "Removes dispositions from account",
15188     "examples": [
15189       {
15190         "title": "Example usage:",
15191         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15192         "type": "json"
15193       }
15194     ],
15195     "name": "RemoveDispositions",
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}/in_servers",
15205     "title": "Removes IMAP server from an account",
15206     "examples": [
15207       {
15208         "title": "Example usage:",
15209         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15210         "type": "json"
15211       }
15212     ],
15213     "name": "RemoveImmap",
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}/out_servers",
15223     "title": "Removes SMTP server from an account",
15224     "examples": [
15225       {
15226         "title": "Example usage:",
15227         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15228         "type": "json"
15229       }
15230     ],
15231     "name": "RemoveSmtp",
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": "get",
15240     "url": "/api/mail/accounts/{id}",
15241     "title": "Gets a single Account",
15242     "examples": [
15243       {
15244         "title": "Example usage:",
15245         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15246         "type": "json"
15247       }
15248     ],
15249     "name": "ShowAccounts",
15250     "group": "Mail_Accounts",
15251     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
15258     "url": "/api/mail/accounts/{id}/canned_answers",
15259     "title": "Creates new canned answer",
15260     "examples": [
15261       {
15262         "title": "Example usage:",
15263         "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",
15264         "type": "json"
15265       }
15266     ],
15267     "name": "addAnswer",
15268     "group": "Mail_Accounts",
15269     "parameter": {
15270       "fields": {
15271         "Body": [
15272           {
15273             "group": "Body",
15274             "type": "String",
15275             "optional": false,
15276             "field": "key",
15277             "description": ""
15278           },
15279           {
15280             "group": "Body",
15281             "type": "Text",
15282             "optional": false,
15283             "field": "value",
15284             "description": ""
15285           },
15286           {
15287             "group": "Body",
15288             "type": "String",
15289             "optional": true,
15290             "field": "description",
15291             "description": ""
15292           },
15293           {
15294             "group": "Body",
15295             "type": "Virtual",
15296             "optional": true,
15297             "field": "name",
15298             "description": ""
15299           }
15300         ]
15301       }
15302     },
15303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15304     "version": "0.0.0",
15305     "filename": "server/api/mailAccount/index.js",
15306     "groupTitle": "Mail_Accounts"
15307   },
15308   {
15309     "type": "post",
15310     "url": "/api/mail/accounts/{id}/applications",
15311     "title": "Creates new applications",
15312     "examples": [
15313       {
15314         "title": "Example usage:",
15315         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15316         "type": "json"
15317       }
15318     ],
15319     "name": "addApplications",
15320     "group": "Mail_Accounts",
15321     "parameter": {
15322       "fields": {
15323         "Body": [
15324           {
15325             "group": "Body",
15326             "type": "Integer",
15327             "optional": false,
15328             "field": "priority",
15329             "description": ""
15330           },
15331           {
15332             "group": "Body",
15333             "type": "String",
15334             "optional": false,
15335             "field": "app",
15336             "description": ""
15337           },
15338           {
15339             "group": "Body",
15340             "type": "Text",
15341             "optional": true,
15342             "field": "appdata",
15343             "description": ""
15344           },
15345           {
15346             "group": "Body",
15347             "type": "String",
15348             "optional": true,
15349             "field": "description",
15350             "description": ""
15351           },
15352           {
15353             "group": "Body",
15354             "type": "String",
15355             "optional": true,
15356             "field": "interval",
15357             "description": ""
15358           }
15359         ]
15360       }
15361     },
15362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15363     "version": "0.0.0",
15364     "filename": "server/api/mailAccount/index.js",
15365     "groupTitle": "Mail_Accounts"
15366   },
15367   {
15368     "type": "post",
15369     "url": "/api/mail/accounts/{id}/dispositions",
15370     "title": "Creates new disposition",
15371     "examples": [
15372       {
15373         "title": "Example usage:",
15374         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15375         "type": "json"
15376       }
15377     ],
15378     "name": "addDisposition",
15379     "group": "Mail_Accounts",
15380     "parameter": {
15381       "fields": {
15382         "Body": [
15383           {
15384             "group": "Body",
15385             "type": "String",
15386             "optional": false,
15387             "field": "name",
15388             "description": ""
15389           },
15390           {
15391             "group": "Body",
15392             "type": "String",
15393             "allowedValues": [
15394               "\"first\"",
15395               "\"second\"",
15396               "\"third\""
15397             ],
15398             "optional": false,
15399             "field": "level",
15400             "description": ""
15401           },
15402           {
15403             "group": "Body",
15404             "type": "String",
15405             "optional": true,
15406             "field": "description",
15407             "description": ""
15408           }
15409         ]
15410       }
15411     },
15412     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15413     "version": "0.0.0",
15414     "filename": "server/api/mailAccount/index.js",
15415     "groupTitle": "Mail_Accounts"
15416   },
15417   {
15418     "type": "post",
15419     "url": "/api/mail/accounts/{id}/interactions",
15420     "title": "Creates new interactions",
15421     "examples": [
15422       {
15423         "title": "Example usage:",
15424         "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",
15425         "type": "json"
15426       }
15427     ],
15428     "name": "addInteraction",
15429     "group": "Mail_Accounts",
15430     "parameter": {
15431       "fields": {
15432         "Body": [
15433           {
15434             "group": "Body",
15435             "type": "Boolean",
15436             "optional": true,
15437             "field": "closed",
15438             "description": ""
15439           },
15440           {
15441             "group": "Body",
15442             "type": "String",
15443             "optional": true,
15444             "field": "closedAt",
15445             "description": ""
15446           },
15447           {
15448             "group": "Body",
15449             "type": "String",
15450             "optional": true,
15451             "field": "disposition",
15452             "description": ""
15453           },
15454           {
15455             "group": "Body",
15456             "type": "String",
15457             "optional": true,
15458             "field": "secondDisposition",
15459             "description": ""
15460           },
15461           {
15462             "group": "Body",
15463             "type": "String",
15464             "optional": true,
15465             "field": "thirdDisposition",
15466             "description": ""
15467           },
15468           {
15469             "group": "Body",
15470             "type": "String",
15471             "optional": true,
15472             "field": "note",
15473             "description": ""
15474           },
15475           {
15476             "group": "Body",
15477             "type": "String",
15478             "optional": true,
15479             "field": "inReplyTo",
15480             "description": ""
15481           },
15482           {
15483             "group": "Body",
15484             "type": "String",
15485             "optional": true,
15486             "field": "to",
15487             "description": ""
15488           },
15489           {
15490             "group": "Body",
15491             "type": "Text",
15492             "optional": true,
15493             "field": "cc",
15494             "description": ""
15495           },
15496           {
15497             "group": "Body",
15498             "type": "Text",
15499             "optional": true,
15500             "field": "subject",
15501             "description": ""
15502           },
15503           {
15504             "group": "Body",
15505             "type": "Boolean",
15506             "optional": true,
15507             "field": "attach",
15508             "description": ""
15509           },
15510           {
15511             "group": "Body",
15512             "type": "String",
15513             "optional": true,
15514             "field": "read1stAt",
15515             "description": ""
15516           },
15517           {
15518             "group": "Body",
15519             "type": "String",
15520             "optional": true,
15521             "field": "substatus",
15522             "description": ""
15523           },
15524           {
15525             "group": "Body",
15526             "type": "String",
15527             "optional": true,
15528             "field": "substatusAt",
15529             "description": ""
15530           },
15531           {
15532             "group": "Body",
15533             "type": "String",
15534             "allowedValues": [
15535               "\"in\"",
15536               "\"out\""
15537             ],
15538             "optional": false,
15539             "field": "firstMsgDirection",
15540             "description": ""
15541           },
15542           {
15543             "group": "Body",
15544             "type": "String",
15545             "optional": true,
15546             "field": "lastMsgAt",
15547             "description": ""
15548           },
15549           {
15550             "group": "Body",
15551             "type": "String",
15552             "allowedValues": [
15553               "\"in\"",
15554               "\"out\""
15555             ],
15556             "optional": false,
15557             "field": "lastMsgDirection",
15558             "description": ""
15559           },
15560           {
15561             "group": "Body",
15562             "type": "Boolean",
15563             "optional": true,
15564             "field": "autoreplyExecuted",
15565             "description": ""
15566           }
15567         ]
15568       }
15569     },
15570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15571     "version": "0.0.0",
15572     "filename": "server/api/mailAccount/index.js",
15573     "groupTitle": "Mail_Accounts"
15574   },
15575   {
15576     "type": "post",
15577     "url": "/api/mail/accounts",
15578     "title": "Create a mail account",
15579     "examples": [
15580       {
15581         "title": "Example usage:",
15582         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15583         "type": "json"
15584       }
15585     ],
15586     "name": "create",
15587     "group": "Mail_Accounts",
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": "get",
15595     "url": "/api/mail/accounts/{id}/canned_answers",
15596     "title": "Gets account canned answers",
15597     "examples": [
15598       {
15599         "title": "Example usage:",
15600         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15601         "type": "json"
15602       }
15603     ],
15604     "name": "getAnswers",
15605     "group": "Mail_Accounts",
15606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
15614     "title": "Gets account applications",
15615     "examples": [
15616       {
15617         "title": "Example usage:",
15618         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15619         "type": "json"
15620       }
15621     ],
15622     "name": "getApplications",
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}/dispositions",
15632     "title": "Gets account dispositions",
15633     "examples": [
15634       {
15635         "title": "Example usage:",
15636         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15637         "type": "json"
15638       }
15639     ],
15640     "name": "getDispositions",
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}/interactions",
15650     "title": "Gets account interactions",
15651     "examples": [
15652       {
15653         "title": "Example usage:",
15654         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15655         "type": "json"
15656       }
15657     ],
15658     "name": "getInteraction",
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}/messages",
15668     "title": "Gets account messages",
15669     "examples": [
15670       {
15671         "title": "Example usage:",
15672         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15673         "type": "json"
15674       }
15675     ],
15676     "name": "getMessages",
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": "post",
15685     "url": "/api/mail/accounts/{id}/send",
15686     "title": "Send new mail",
15687     "examples": [
15688       {
15689         "title": "Example usage:",
15690         "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",
15691         "type": "json"
15692       }
15693     ],
15694     "name": "sendMail",
15695     "group": "Mail_Accounts",
15696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
15703     "url": "/api/mail/accounts/{id}",
15704     "title": "Update an existing Account",
15705     "examples": [
15706       {
15707         "title": "Example usage:",
15708         "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",
15709         "type": "json"
15710       }
15711     ],
15712     "name": "updateAccounts",
15713     "group": "Mail_Accounts",
15714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
15721     "url": "/api/mail/accounts/{id}/verify",
15722     "title": "Verify mail account",
15723     "examples": [
15724       {
15725         "title": "Example usage:",
15726         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15727         "type": "json"
15728       }
15729     ],
15730     "name": "verifySmtp",
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": "delete",
15739     "url": "/api/mail/applications/{id}",
15740     "title": "Deletes a Application",
15741     "examples": [
15742       {
15743         "title": "Example usage:",
15744         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15745         "type": "json"
15746       }
15747     ],
15748     "name": "DeleteApplications",
15749     "group": "Mail_Applications",
15750     "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>",
15751     "version": "0.0.0",
15752     "filename": "server/api/mailApplication/index.js",
15753     "groupTitle": "Mail_Applications"
15754   },
15755   {
15756     "type": "get",
15757     "url": "/api/mail/applications/{id}",
15758     "title": "Gets a single Application",
15759     "examples": [
15760       {
15761         "title": "Example usage:",
15762         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15763         "type": "json"
15764       }
15765     ],
15766     "name": "ShowApplications",
15767     "group": "Mail_Applications",
15768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
15775     "url": "/api/mail/applications/{id}",
15776     "title": "Update an existing Application",
15777     "examples": [
15778       {
15779         "title": "Example usage:",
15780         "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",
15781         "type": "json"
15782       }
15783     ],
15784     "name": "updateApplications",
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": "post",
15793     "url": "/api/mail/interactions/{id}/tags",
15794     "title": "Add tags to the interaction",
15795     "examples": [
15796       {
15797         "title": "Example usage:",
15798         "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",
15799         "type": "json"
15800       }
15801     ],
15802     "name": "AddTags",
15803     "group": "Mail_Interactions",
15804     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15805     "version": "0.0.0",
15806     "filename": "server/api/mailInteraction/index.js",
15807     "groupTitle": "Mail_Interactions"
15808   },
15809   {
15810     "type": "post",
15811     "url": "/api/mail/interactions",
15812     "title": "Creates a new Interaction",
15813     "examples": [
15814       {
15815         "title": "Example usage:",
15816         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15817         "type": "json"
15818       }
15819     ],
15820     "name": "CreateInteractions",
15821     "group": "Mail_Interactions",
15822     "parameter": {
15823       "fields": {
15824         "Body": [
15825           {
15826             "group": "Body",
15827             "type": "Boolean",
15828             "optional": true,
15829             "field": "closed",
15830             "description": ""
15831           },
15832           {
15833             "group": "Body",
15834             "type": "String",
15835             "optional": true,
15836             "field": "closedAt",
15837             "description": ""
15838           },
15839           {
15840             "group": "Body",
15841             "type": "String",
15842             "optional": true,
15843             "field": "disposition",
15844             "description": ""
15845           },
15846           {
15847             "group": "Body",
15848             "type": "String",
15849             "optional": true,
15850             "field": "secondDisposition",
15851             "description": ""
15852           },
15853           {
15854             "group": "Body",
15855             "type": "String",
15856             "optional": true,
15857             "field": "thirdDisposition",
15858             "description": ""
15859           },
15860           {
15861             "group": "Body",
15862             "type": "String",
15863             "optional": true,
15864             "field": "note",
15865             "description": ""
15866           },
15867           {
15868             "group": "Body",
15869             "type": "String",
15870             "optional": true,
15871             "field": "inReplyTo",
15872             "description": ""
15873           },
15874           {
15875             "group": "Body",
15876             "type": "String",
15877             "optional": true,
15878             "field": "to",
15879             "description": ""
15880           },
15881           {
15882             "group": "Body",
15883             "type": "Text",
15884             "optional": true,
15885             "field": "cc",
15886             "description": ""
15887           },
15888           {
15889             "group": "Body",
15890             "type": "Text",
15891             "optional": true,
15892             "field": "subject",
15893             "description": ""
15894           },
15895           {
15896             "group": "Body",
15897             "type": "Boolean",
15898             "optional": true,
15899             "field": "attach",
15900             "description": ""
15901           },
15902           {
15903             "group": "Body",
15904             "type": "String",
15905             "optional": true,
15906             "field": "read1stAt",
15907             "description": ""
15908           },
15909           {
15910             "group": "Body",
15911             "type": "String",
15912             "optional": true,
15913             "field": "substatus",
15914             "description": ""
15915           },
15916           {
15917             "group": "Body",
15918             "type": "String",
15919             "optional": true,
15920             "field": "substatusAt",
15921             "description": ""
15922           },
15923           {
15924             "group": "Body",
15925             "type": "String",
15926             "allowedValues": [
15927               "\"in\"",
15928               "\"out\""
15929             ],
15930             "optional": false,
15931             "field": "firstMsgDirection",
15932             "description": ""
15933           },
15934           {
15935             "group": "Body",
15936             "type": "String",
15937             "optional": true,
15938             "field": "lastMsgAt",
15939             "description": ""
15940           },
15941           {
15942             "group": "Body",
15943             "type": "String",
15944             "allowedValues": [
15945               "\"in\"",
15946               "\"out\""
15947             ],
15948             "optional": false,
15949             "field": "lastMsgDirection",
15950             "description": ""
15951           },
15952           {
15953             "group": "Body",
15954             "type": "Boolean",
15955             "optional": true,
15956             "field": "autoreplyExecuted",
15957             "description": ""
15958           }
15959         ]
15960       }
15961     },
15962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15963     "version": "0.0.0",
15964     "filename": "server/api/mailInteraction/index.js",
15965     "groupTitle": "Mail_Interactions"
15966   },
15967   {
15968     "type": "delete",
15969     "url": "/api/mail/interactions/{id}",
15970     "title": "Deletes a Interaction",
15971     "examples": [
15972       {
15973         "title": "Example usage:",
15974         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15975         "type": "json"
15976       }
15977     ],
15978     "name": "DeleteInteractions",
15979     "group": "Mail_Interactions",
15980     "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>",
15981     "version": "0.0.0",
15982     "filename": "server/api/mailInteraction/index.js",
15983     "groupTitle": "Mail_Interactions"
15984   },
15985   {
15986     "type": "get",
15987     "url": "/api/mail/interactions/describe",
15988     "title": "Gets table info about Interactions",
15989     "examples": [
15990       {
15991         "title": "Example usage:",
15992         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15993         "type": "json"
15994       }
15995     ],
15996     "name": "DescribeInteractions",
15997     "group": "Mail_Interactions",
15998     "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>",
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",
16006     "title": "Gets a list of Interactions",
16007     "examples": [
16008       {
16009         "title": "Example usage:",
16010         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16011         "type": "json"
16012       }
16013     ],
16014     "name": "GetInteractions",
16015     "group": "Mail_Interactions",
16016     "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>",
16017     "version": "0.0.0",
16018     "filename": "server/api/mailInteraction/index.js",
16019     "groupTitle": "Mail_Interactions"
16020   },
16021   {
16022     "type": "delete",
16023     "url": "/api/mail/interactions/{id}/tags",
16024     "title": "Removes tags from interaction",
16025     "examples": [
16026       {
16027         "title": "Example usage:",
16028         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16029         "type": "json"
16030       }
16031     ],
16032     "name": "RemoveTags",
16033     "group": "Mail_Interactions",
16034     "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>",
16035     "version": "0.0.0",
16036     "filename": "server/api/mailInteraction/index.js",
16037     "groupTitle": "Mail_Interactions"
16038   },
16039   {
16040     "type": "get",
16041     "url": "/api/mail/interactions/{id}",
16042     "title": "Gets a single Interaction",
16043     "examples": [
16044       {
16045         "title": "Example usage:",
16046         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16047         "type": "json"
16048       }
16049     ],
16050     "name": "ShowInteractions",
16051     "group": "Mail_Interactions",
16052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
16059     "url": "/api/mail/interactions/{id}/messages",
16060     "title": "Creates new message",
16061     "examples": [
16062       {
16063         "title": "Example usage:",
16064         "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",
16065         "type": "json"
16066       }
16067     ],
16068     "name": "addMessage",
16069     "group": "Mail_Interactions",
16070     "parameter": {
16071       "fields": {
16072         "Body": [
16073           {
16074             "group": "Body",
16075             "type": "Text",
16076             "optional": false,
16077             "field": "body",
16078             "description": ""
16079           },
16080           {
16081             "group": "Body",
16082             "type": "Text",
16083             "optional": true,
16084             "field": "plainBody",
16085             "description": ""
16086           },
16087           {
16088             "group": "Body",
16089             "type": "Boolean",
16090             "optional": true,
16091             "field": "read",
16092             "description": ""
16093           },
16094           {
16095             "group": "Body",
16096             "type": "String",
16097             "allowedValues": [
16098               "\"in\"",
16099               "\"out\""
16100             ],
16101             "optional": false,
16102             "field": "direction",
16103             "description": ""
16104           },
16105           {
16106             "group": "Body",
16107             "type": "String",
16108             "optional": true,
16109             "field": "messageId",
16110             "description": ""
16111           },
16112           {
16113             "group": "Body",
16114             "type": "String",
16115             "optional": true,
16116             "field": "from",
16117             "description": ""
16118           },
16119           {
16120             "group": "Body",
16121             "type": "Text",
16122             "optional": true,
16123             "field": "to",
16124             "description": ""
16125           },
16126           {
16127             "group": "Body",
16128             "type": "Text",
16129             "optional": true,
16130             "field": "cc",
16131             "description": ""
16132           },
16133           {
16134             "group": "Body",
16135             "type": "Text",
16136             "optional": true,
16137             "field": "bcc",
16138             "description": ""
16139           },
16140           {
16141             "group": "Body",
16142             "type": "Text",
16143             "optional": true,
16144             "field": "subject",
16145             "description": ""
16146           },
16147           {
16148             "group": "Body",
16149             "type": "String",
16150             "optional": true,
16151             "field": "sentAt",
16152             "description": ""
16153           },
16154           {
16155             "group": "Body",
16156             "type": "Integer",
16157             "optional": true,
16158             "field": "attach",
16159             "description": ""
16160           },
16161           {
16162             "group": "Body",
16163             "type": "Boolean",
16164             "optional": true,
16165             "field": "secret",
16166             "description": ""
16167           },
16168           {
16169             "group": "Body",
16170             "type": "String",
16171             "optional": true,
16172             "field": "readAt",
16173             "description": ""
16174           },
16175           {
16176             "group": "Body",
16177             "type": "Text",
16178             "optional": true,
16179             "field": "originTo",
16180             "description": ""
16181           },
16182           {
16183             "group": "Body",
16184             "type": "Text",
16185             "optional": true,
16186             "field": "originCc",
16187             "description": ""
16188           },
16189           {
16190             "group": "Body",
16191             "type": "String",
16192             "allowedValues": [
16193               "\"Email\"",
16194               "\"Chat\""
16195             ],
16196             "optional": false,
16197             "field": "originChannel",
16198             "description": ""
16199           }
16200         ]
16201       }
16202     },
16203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16204     "version": "0.0.0",
16205     "filename": "server/api/mailInteraction/index.js",
16206     "groupTitle": "Mail_Interactions"
16207   },
16208   {
16209     "type": "get",
16210     "url": "/api/mail/interactions/{id}/download",
16211     "title": "Gets interaction",
16212     "examples": [
16213       {
16214         "title": "Example usage:",
16215         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16216         "type": "json"
16217       }
16218     ],
16219     "name": "download",
16220     "group": "Mail_Interactions",
16221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
16229     "title": "Gets interaction messages",
16230     "examples": [
16231       {
16232         "title": "Example usage:",
16233         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16234         "type": "json"
16235       }
16236     ],
16237     "name": "getMessages",
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": "put",
16246     "url": "/api/mail/interactions/{id}",
16247     "title": "Update an existing Interaction",
16248     "examples": [
16249       {
16250         "title": "Example usage:",
16251         "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",
16252         "type": "json"
16253       }
16254     ],
16255     "name": "updateInteractions",
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": "delete",
16264     "url": "/api/mail/messages/{id}",
16265     "title": "Deletes a Message",
16266     "examples": [
16267       {
16268         "title": "Example usage:",
16269         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16270         "type": "json"
16271       }
16272     ],
16273     "name": "DeleteMessages",
16274     "group": "Mail_Messages",
16275     "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>",
16276     "version": "0.0.0",
16277     "filename": "server/api/mailMessage/index.js",
16278     "groupTitle": "Mail_Messages"
16279   },
16280   {
16281     "type": "get",
16282     "url": "/api/mail/messages/describe",
16283     "title": "Gets table info about Messages",
16284     "examples": [
16285       {
16286         "title": "Example usage:",
16287         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16288         "type": "json"
16289       }
16290     ],
16291     "name": "DescribeMessages",
16292     "group": "Mail_Messages",
16293     "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>",
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",
16301     "title": "Gets a list of Messages",
16302     "examples": [
16303       {
16304         "title": "Example usage:",
16305         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16306         "type": "json"
16307       }
16308     ],
16309     "name": "GetMessages",
16310     "group": "Mail_Messages",
16311     "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>",
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/{id}",
16319     "title": "Gets a single Message",
16320     "examples": [
16321       {
16322         "title": "Example usage:",
16323         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16324         "type": "json"
16325       }
16326     ],
16327     "name": "ShowMessages",
16328     "group": "Mail_Messages",
16329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16330     "version": "0.0.0",
16331     "filename": "server/api/mailMessage/index.js",
16332     "groupTitle": "Mail_Messages"
16333   },
16334   {
16335     "type": "put",
16336     "url": "/api/mail/messages/{id}/accept",
16337     "title": "Accepts message",
16338     "examples": [
16339       {
16340         "title": "Example usage:",
16341         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16342         "type": "json"
16343       }
16344     ],
16345     "name": "acceptMessage",
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": "post",
16354     "url": "/api/mail/messages",
16355     "title": "Create a message",
16356     "examples": [
16357       {
16358         "title": "Example usage:",
16359         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16360         "type": "json"
16361       }
16362     ],
16363     "name": "createMessage",
16364     "group": "Mail_Messages",
16365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
16372     "url": "/api/mail/messages/{id}/download",
16373     "title": "Gets message",
16374     "examples": [
16375       {
16376         "title": "Example usage:",
16377         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16378         "type": "json"
16379       }
16380     ],
16381     "name": "download",
16382     "group": "Mail_Messages",
16383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
16390     "url": "/api/mail/messages/{id}/reject",
16391     "title": "Rejects message",
16392     "examples": [
16393       {
16394         "title": "Example usage:",
16395         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16396         "type": "json"
16397       }
16398     ],
16399     "name": "rejectMessage",
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}",
16409     "title": "Update an existing Message",
16410     "examples": [
16411       {
16412         "title": "Example usage:",
16413         "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",
16414         "type": "json"
16415       }
16416     ],
16417     "name": "updateMessages",
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": "post",
16426     "url": "/api/mail/reports/queue",
16427     "title": "Creates a new Mail Queue Report",
16428     "examples": [
16429       {
16430         "title": "Example usage:",
16431         "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",
16432         "type": "json"
16433       }
16434     ],
16435     "name": "CreateMail_Queue_Reports",
16436     "group": "Mail_Queue_Reports",
16437     "parameter": {
16438       "fields": {
16439         "Body": [
16440           {
16441             "group": "Body",
16442             "type": "String",
16443             "optional": false,
16444             "field": "uniqueid",
16445             "description": ""
16446           },
16447           {
16448             "group": "Body",
16449             "type": "String",
16450             "optional": true,
16451             "field": "from",
16452             "description": ""
16453           },
16454           {
16455             "group": "Body",
16456             "type": "String",
16457             "optional": true,
16458             "field": "joinAt",
16459             "description": ""
16460           },
16461           {
16462             "group": "Body",
16463             "type": "String",
16464             "optional": true,
16465             "field": "leaveAt",
16466             "description": ""
16467           },
16468           {
16469             "group": "Body",
16470             "type": "String",
16471             "optional": true,
16472             "field": "acceptAt",
16473             "description": ""
16474           },
16475           {
16476             "group": "Body",
16477             "type": "String",
16478             "optional": true,
16479             "field": "exitAt",
16480             "description": ""
16481           },
16482           {
16483             "group": "Body",
16484             "type": "String",
16485             "optional": true,
16486             "field": "reason",
16487             "description": ""
16488           }
16489         ]
16490       }
16491     },
16492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16493     "version": "0.0.0",
16494     "filename": "server/api/mailQueueReport/index.js",
16495     "groupTitle": "Mail_Queue_Reports"
16496   },
16497   {
16498     "type": "delete",
16499     "url": "/api/mail/reports/queue/{id}",
16500     "title": "Deletes a Mail Queue Report",
16501     "examples": [
16502       {
16503         "title": "Example usage:",
16504         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16505         "type": "json"
16506       }
16507     ],
16508     "name": "DeleteMail_Queue_Reports",
16509     "group": "Mail_Queue_Reports",
16510     "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>",
16511     "version": "0.0.0",
16512     "filename": "server/api/mailQueueReport/index.js",
16513     "groupTitle": "Mail_Queue_Reports"
16514   },
16515   {
16516     "type": "get",
16517     "url": "/api/mail/reports/queue/describe",
16518     "title": "Gets table info about Mail Queue Reports",
16519     "examples": [
16520       {
16521         "title": "Example usage:",
16522         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16523         "type": "json"
16524       }
16525     ],
16526     "name": "DescribeMail_Queue_Reports",
16527     "group": "Mail_Queue_Reports",
16528     "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>",
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",
16536     "title": "Gets a list of Mail Queue Reports",
16537     "examples": [
16538       {
16539         "title": "Example usage:",
16540         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16541         "type": "json"
16542       }
16543     ],
16544     "name": "GetMail_Queue_Reports",
16545     "group": "Mail_Queue_Reports",
16546     "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>",
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/{id}",
16554     "title": "Gets a single Mail Queue Report",
16555     "examples": [
16556       {
16557         "title": "Example usage:",
16558         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16559         "type": "json"
16560       }
16561     ],
16562     "name": "ShowMail_Queue_Reports",
16563     "group": "Mail_Queue_Reports",
16564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16565     "version": "0.0.0",
16566     "filename": "server/api/mailQueueReport/index.js",
16567     "groupTitle": "Mail_Queue_Reports"
16568   },
16569   {
16570     "type": "put",
16571     "url": "/api/mail/reports/queue/{id}",
16572     "title": "Update an existing Mail Queue Report",
16573     "examples": [
16574       {
16575         "title": "Example usage:",
16576         "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",
16577         "type": "json"
16578       }
16579     ],
16580     "name": "updateMail_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": "post",
16589     "url": "/api/mail/queues/{id}/users",
16590     "title": "Add agents to a queue",
16591     "examples": [
16592       {
16593         "title": "Example usage:",
16594         "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",
16595         "type": "json"
16596       }
16597     ],
16598     "name": "AddAgents",
16599     "group": "Mail_Queues",
16600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16601     "version": "0.0.0",
16602     "filename": "server/api/mailQueue/index.js",
16603     "groupTitle": "Mail_Queues"
16604   },
16605   {
16606     "type": "post",
16607     "url": "/api/mail/queues/{id}/teams",
16608     "title": "Add teams to a queue",
16609     "examples": [
16610       {
16611         "title": "Example usage:",
16612         "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",
16613         "type": "json"
16614       }
16615     ],
16616     "name": "AddTeams",
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",
16626     "title": "Creates a new Queue",
16627     "examples": [
16628       {
16629         "title": "Example usage:",
16630         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16631         "type": "json"
16632       }
16633     ],
16634     "name": "CreateQueues",
16635     "group": "Mail_Queues",
16636     "parameter": {
16637       "fields": {
16638         "Body": [
16639           {
16640             "group": "Body",
16641             "type": "String",
16642             "optional": true,
16643             "field": "name",
16644             "description": ""
16645           },
16646           {
16647             "group": "Body",
16648             "type": "String",
16649             "optional": true,
16650             "field": "description",
16651             "description": ""
16652           },
16653           {
16654             "group": "Body",
16655             "type": "Integer",
16656             "optional": true,
16657             "field": "timeout",
16658             "description": ""
16659           },
16660           {
16661             "group": "Body",
16662             "type": "String",
16663             "allowedValues": [
16664               "\"rrmemory\"",
16665               "\"beepall\"",
16666               "\"roundrobin\""
16667             ],
16668             "optional": true,
16669             "field": "strategy",
16670             "description": ""
16671           }
16672         ]
16673       }
16674     },
16675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16676     "version": "0.0.0",
16677     "filename": "server/api/mailQueue/index.js",
16678     "groupTitle": "Mail_Queues"
16679   },
16680   {
16681     "type": "delete",
16682     "url": "/api/mail/queues/{id}",
16683     "title": "Deletes a Queue",
16684     "examples": [
16685       {
16686         "title": "Example usage:",
16687         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16688         "type": "json"
16689       }
16690     ],
16691     "name": "DeleteQueues",
16692     "group": "Mail_Queues",
16693     "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>",
16694     "version": "0.0.0",
16695     "filename": "server/api/mailQueue/index.js",
16696     "groupTitle": "Mail_Queues"
16697   },
16698   {
16699     "type": "get",
16700     "url": "/api/mail/queues/describe",
16701     "title": "Gets table info about Queues",
16702     "examples": [
16703       {
16704         "title": "Example usage:",
16705         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16706         "type": "json"
16707       }
16708     ],
16709     "name": "DescribeQueues",
16710     "group": "Mail_Queues",
16711     "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>",
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/{id}/users",
16719     "title": "Gets queue agents",
16720     "examples": [
16721       {
16722         "title": "Example usage:",
16723         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16724         "type": "json"
16725       }
16726     ],
16727     "name": "GetAgents",
16728     "group": "Mail_Queues",
16729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
16737     "title": "GetMembers",
16738     "examples": [
16739       {
16740         "title": "Example usage:",
16741         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16742         "type": "json"
16743       }
16744     ],
16745     "name": "GetMembers",
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",
16755     "title": "Gets a list of Queues",
16756     "examples": [
16757       {
16758         "title": "Example usage:",
16759         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16760         "type": "json"
16761       }
16762     ],
16763     "name": "GetQueues",
16764     "group": "Mail_Queues",
16765     "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>",
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/{id}/teams",
16773     "title": "Gets queues list",
16774     "examples": [
16775       {
16776         "title": "Example usage:",
16777         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16778         "type": "json"
16779       }
16780     ],
16781     "name": "GetTeams",
16782     "group": "Mail_Queues",
16783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16784     "version": "0.0.0",
16785     "filename": "server/api/mailQueue/index.js",
16786     "groupTitle": "Mail_Queues"
16787   },
16788   {
16789     "type": "delete",
16790     "url": "/api/mail/queues/{id}/users",
16791     "title": "Removes agents from a queue",
16792     "examples": [
16793       {
16794         "title": "Example usage:",
16795         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16796         "type": "json"
16797       }
16798     ],
16799     "name": "RemoveAgents",
16800     "group": "Mail_Queues",
16801     "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>",
16802     "version": "0.0.0",
16803     "filename": "server/api/mailQueue/index.js",
16804     "groupTitle": "Mail_Queues"
16805   },
16806   {
16807     "type": "get",
16808     "url": "/api/mail/queues/{id}",
16809     "title": "Gets a single Queue",
16810     "examples": [
16811       {
16812         "title": "Example usage:",
16813         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16814         "type": "json"
16815       }
16816     ],
16817     "name": "ShowQueues",
16818     "group": "Mail_Queues",
16819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
16826     "url": "/api/mail/queues/{id}",
16827     "title": "Update an existing Queue",
16828     "examples": [
16829       {
16830         "title": "Example usage:",
16831         "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",
16832         "type": "json"
16833       }
16834     ],
16835     "name": "updateQueues",
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": "post",
16844     "url": "/api/mail/out_servers",
16845     "title": "Creates a new SMTP",
16846     "examples": [
16847       {
16848         "title": "Example usage:",
16849         "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",
16850         "type": "json"
16851       }
16852     ],
16853     "name": "CreateSMTPs",
16854     "group": "Mail_SMTP",
16855     "parameter": {
16856       "fields": {
16857         "Body": [
16858           {
16859             "group": "Body",
16860             "type": "String",
16861             "optional": true,
16862             "field": "description",
16863             "description": ""
16864           },
16865           {
16866             "group": "Body",
16867             "type": "String",
16868             "optional": true,
16869             "field": "host",
16870             "description": ""
16871           },
16872           {
16873             "group": "Body",
16874             "type": "String",
16875             "optional": true,
16876             "field": "user",
16877             "description": ""
16878           },
16879           {
16880             "group": "Body",
16881             "type": "String",
16882             "optional": true,
16883             "field": "pass",
16884             "description": ""
16885           },
16886           {
16887             "group": "Body",
16888             "type": "Integer",
16889             "optional": true,
16890             "field": "port",
16891             "description": ""
16892           },
16893           {
16894             "group": "Body",
16895             "type": "Boolean",
16896             "optional": true,
16897             "field": "secure",
16898             "description": ""
16899           },
16900           {
16901             "group": "Body",
16902             "type": "String",
16903             "optional": true,
16904             "field": "service",
16905             "description": ""
16906           },
16907           {
16908             "group": "Body",
16909             "type": "Boolean",
16910             "optional": true,
16911             "field": "authentication",
16912             "description": ""
16913           }
16914         ]
16915       }
16916     },
16917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16918     "version": "0.0.0",
16919     "filename": "server/api/mailServerOut/index.js",
16920     "groupTitle": "Mail_SMTP"
16921   },
16922   {
16923     "type": "delete",
16924     "url": "/api/mail/out_servers/{id}",
16925     "title": "Deletes a SMTP",
16926     "examples": [
16927       {
16928         "title": "Example usage:",
16929         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16930         "type": "json"
16931       }
16932     ],
16933     "name": "DeleteSMTPs",
16934     "group": "Mail_SMTP",
16935     "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>",
16936     "version": "0.0.0",
16937     "filename": "server/api/mailServerOut/index.js",
16938     "groupTitle": "Mail_SMTP"
16939   },
16940   {
16941     "type": "get",
16942     "url": "/api/mail/out_servers",
16943     "title": "Gets a list of SMTPs",
16944     "examples": [
16945       {
16946         "title": "Example usage:",
16947         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16948         "type": "json"
16949       }
16950     ],
16951     "name": "GetSMTPs",
16952     "group": "Mail_SMTP",
16953     "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>",
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/{id}",
16961     "title": "Gets a single SMTP",
16962     "examples": [
16963       {
16964         "title": "Example usage:",
16965         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16966         "type": "json"
16967       }
16968     ],
16969     "name": "ShowSMTPs",
16970     "group": "Mail_SMTP",
16971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16972     "version": "0.0.0",
16973     "filename": "server/api/mailServerOut/index.js",
16974     "groupTitle": "Mail_SMTP"
16975   },
16976   {
16977     "type": "put",
16978     "url": "/api/mail/out_servers/{id}",
16979     "title": "Update an existing SMTP",
16980     "examples": [
16981       {
16982         "title": "Example usage:",
16983         "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",
16984         "type": "json"
16985       }
16986     ],
16987     "name": "updateSMTPs",
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": "post",
16996     "url": "/api/mail/substatuses",
16997     "title": "Creates a new Queue",
16998     "examples": [
16999       {
17000         "title": "Example usage:",
17001         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17002         "type": "json"
17003       }
17004     ],
17005     "name": "CreateSubstatuses",
17006     "group": "Mail_Substatuses",
17007     "parameter": {
17008       "fields": {
17009         "Body": [
17010           {
17011             "group": "Body",
17012             "type": "String",
17013             "optional": false,
17014             "field": "name",
17015             "description": ""
17016           },
17017           {
17018             "group": "Body",
17019             "type": "String",
17020             "optional": true,
17021             "field": "description",
17022             "description": ""
17023           }
17024         ]
17025       }
17026     },
17027     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17028     "version": "0.0.0",
17029     "filename": "server/api/mailSubstatus/index.js",
17030     "groupTitle": "Mail_Substatuses"
17031   },
17032   {
17033     "type": "delete",
17034     "url": "/api/mail/substatuses/{id}",
17035     "title": "Deletes a Queue",
17036     "examples": [
17037       {
17038         "title": "Example usage:",
17039         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17040         "type": "json"
17041       }
17042     ],
17043     "name": "DeleteSubstatuses",
17044     "group": "Mail_Substatuses",
17045     "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>",
17046     "version": "0.0.0",
17047     "filename": "server/api/mailSubstatus/index.js",
17048     "groupTitle": "Mail_Substatuses"
17049   },
17050   {
17051     "type": "get",
17052     "url": "/api/mail/substatuses/describe",
17053     "title": "Gets table info about Substatuses",
17054     "examples": [
17055       {
17056         "title": "Example usage:",
17057         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17058         "type": "json"
17059       }
17060     ],
17061     "name": "DescribeSubstatuses",
17062     "group": "Mail_Substatuses",
17063     "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>",
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",
17071     "title": "Gets a list of Substatuses",
17072     "examples": [
17073       {
17074         "title": "Example usage:",
17075         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17076         "type": "json"
17077       }
17078     ],
17079     "name": "GetSubstatuses",
17080     "group": "Mail_Substatuses",
17081     "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>",
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/{id}",
17089     "title": "Gets a single Queue",
17090     "examples": [
17091       {
17092         "title": "Example usage:",
17093         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17094         "type": "json"
17095       }
17096     ],
17097     "name": "ShowSubstatuses",
17098     "group": "Mail_Substatuses",
17099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17100     "version": "0.0.0",
17101     "filename": "server/api/mailSubstatus/index.js",
17102     "groupTitle": "Mail_Substatuses"
17103   },
17104   {
17105     "type": "put",
17106     "url": "/api/mail/substatuses/{id}",
17107     "title": "Update an existing Queue",
17108     "examples": [
17109       {
17110         "title": "Example usage:",
17111         "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",
17112         "type": "json"
17113       }
17114     ],
17115     "name": "updateSubstatuses",
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": "post",
17124     "url": "/api/mail/reports/transfer",
17125     "title": "Creates a new Mail Transfer Report",
17126     "examples": [
17127       {
17128         "title": "Example usage:",
17129         "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",
17130         "type": "json"
17131       }
17132     ],
17133     "name": "CreateMail_Transfer_Reports",
17134     "group": "Mail_Transfer_Reports",
17135     "parameter": {
17136       "fields": {
17137         "Body": [
17138           {
17139             "group": "Body",
17140             "type": "String",
17141             "optional": false,
17142             "field": "uniqueid",
17143             "description": ""
17144           },
17145           {
17146             "group": "Body",
17147             "type": "String",
17148             "allowedValues": [
17149               "\"account\"",
17150               "\"agent\"",
17151               "\"queue\""
17152             ],
17153             "optional": false,
17154             "field": "type",
17155             "description": ""
17156           },
17157           {
17158             "group": "Body",
17159             "type": "String",
17160             "optional": false,
17161             "field": "transferredAt",
17162             "description": ""
17163           }
17164         ]
17165       }
17166     },
17167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17168     "version": "0.0.0",
17169     "filename": "server/api/mailTransferReport/index.js",
17170     "groupTitle": "Mail_Transfer_Reports"
17171   },
17172   {
17173     "type": "delete",
17174     "url": "/api/mail/reports/transfer/{id}",
17175     "title": "Deletes a Mail Transfer Report",
17176     "examples": [
17177       {
17178         "title": "Example usage:",
17179         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17180         "type": "json"
17181       }
17182     ],
17183     "name": "DeleteMail_Transfer_Reports",
17184     "group": "Mail_Transfer_Reports",
17185     "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>",
17186     "version": "0.0.0",
17187     "filename": "server/api/mailTransferReport/index.js",
17188     "groupTitle": "Mail_Transfer_Reports"
17189   },
17190   {
17191     "type": "get",
17192     "url": "/api/mail/reports/transfer/describe",
17193     "title": "Gets table info about Mail Transfer Reports",
17194     "examples": [
17195       {
17196         "title": "Example usage:",
17197         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17198         "type": "json"
17199       }
17200     ],
17201     "name": "DescribeMail_Transfer_Reports",
17202     "group": "Mail_Transfer_Reports",
17203     "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>",
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",
17211     "title": "Gets a list of Mail Transfer Reports",
17212     "examples": [
17213       {
17214         "title": "Example usage:",
17215         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17216         "type": "json"
17217       }
17218     ],
17219     "name": "GetMail_Transfer_Reports",
17220     "group": "Mail_Transfer_Reports",
17221     "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>",
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/{id}",
17229     "title": "Gets a single Mail Transfer Report",
17230     "examples": [
17231       {
17232         "title": "Example usage:",
17233         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17234         "type": "json"
17235       }
17236     ],
17237     "name": "ShowMail_Transfer_Reports",
17238     "group": "Mail_Transfer_Reports",
17239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17240     "version": "0.0.0",
17241     "filename": "server/api/mailTransferReport/index.js",
17242     "groupTitle": "Mail_Transfer_Reports"
17243   },
17244   {
17245     "type": "put",
17246     "url": "/api/mail/reports/transfer/{id}",
17247     "title": "Update an existing Mail Transfer Report",
17248     "examples": [
17249       {
17250         "title": "Example usage:",
17251         "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",
17252         "type": "json"
17253       }
17254     ],
17255     "name": "updateMail_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": "get",
17264     "url": "/api/members/reports/describe",
17265     "title": "Gets table info about Member Reports",
17266     "examples": [
17267       {
17268         "title": "Example usage:",
17269         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17270         "type": "json"
17271       }
17272     ],
17273     "name": "DescribeMember_Reports",
17274     "group": "Member_Reports",
17275     "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>",
17276     "version": "0.0.0",
17277     "filename": "server/api/memberReport/index.js",
17278     "groupTitle": "Member_Reports"
17279   },
17280   {
17281     "type": "get",
17282     "url": "/api/members/reports",
17283     "title": "Gets a list of Member Reports",
17284     "examples": [
17285       {
17286         "title": "Example usage:",
17287         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17288         "type": "json"
17289       }
17290     ],
17291     "name": "GetMember_Reports",
17292     "group": "Member_Reports",
17293     "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>",
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/{id}",
17301     "title": "Gets a single Member Report",
17302     "examples": [
17303       {
17304         "title": "Example usage:",
17305         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17306         "type": "json"
17307       }
17308     ],
17309     "name": "ShowMember_Reports",
17310     "group": "Member_Reports",
17311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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/migrations",
17319     "title": "Gets a list of Migrations",
17320     "examples": [
17321       {
17322         "title": "Example usage:",
17323         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17324         "type": "json"
17325       }
17326     ],
17327     "name": "GetMigrations",
17328     "group": "Migrations",
17329     "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>",
17330     "version": "0.0.0",
17331     "filename": "server/api/migration/index.js",
17332     "groupTitle": "Migrations"
17333   },
17334   {
17335     "type": "post",
17336     "url": "/api/voice/networks",
17337     "title": "Create a new network",
17338     "examples": [
17339       {
17340         "title": "Example usage:",
17341         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17342         "type": "json"
17343       }
17344     ],
17345     "name": "Create",
17346     "group": "Networks",
17347     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17348     "version": "0.0.0",
17349     "filename": "server/api/network/index.js",
17350     "groupTitle": "Networks"
17351   },
17352   {
17353     "type": "delete",
17354     "url": "/api/voice/networks/{id}",
17355     "title": "Deletes a network",
17356     "examples": [
17357       {
17358         "title": "Example usage:",
17359         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17360         "type": "json"
17361       }
17362     ],
17363     "name": "Delete",
17364     "group": "Networks",
17365     "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>",
17366     "version": "0.0.0",
17367     "filename": "server/api/network/index.js",
17368     "groupTitle": "Networks"
17369   },
17370   {
17371     "type": "get",
17372     "url": "/api/networks",
17373     "title": "Gets a list of Networks",
17374     "examples": [
17375       {
17376         "title": "Example usage:",
17377         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17378         "type": "json"
17379       }
17380     ],
17381     "name": "GetNetworks",
17382     "group": "Networks",
17383     "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>",
17384     "version": "0.0.0",
17385     "filename": "server/api/network/index.js",
17386     "groupTitle": "Networks"
17387   },
17388   {
17389     "type": "get",
17390     "url": "/api/networks/{id}",
17391     "title": "Gets a single Network",
17392     "examples": [
17393       {
17394         "title": "Example usage:",
17395         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17396         "type": "json"
17397       }
17398     ],
17399     "name": "ShowNetworks",
17400     "group": "Networks",
17401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17402     "version": "0.0.0",
17403     "filename": "server/api/network/index.js",
17404     "groupTitle": "Networks"
17405   },
17406   {
17407     "type": "put",
17408     "url": "/api/voice/networks/{id}",
17409     "title": "Update an existing network",
17410     "examples": [
17411       {
17412         "title": "Example usage:",
17413         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17414         "type": "json"
17415       }
17416     ],
17417     "name": "Update",
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": "post",
17426     "url": "/api/openchannel/accounts/{id}/users",
17427     "title": "Add agents to a openchannel account",
17428     "examples": [
17429       {
17430         "title": "Example usage:",
17431         "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",
17432         "type": "json"
17433       }
17434     ],
17435     "name": "AddAgents",
17436     "group": "Openchannel_Accounts",
17437     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17438     "version": "0.0.0",
17439     "filename": "server/api/openchannelAccount/index.js",
17440     "groupTitle": "Openchannel_Accounts"
17441   },
17442   {
17443     "type": "post",
17444     "url": "/api/openchannel/accounts",
17445     "title": "Creates a new Account",
17446     "examples": [
17447       {
17448         "title": "Example usage:",
17449         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17450         "type": "json"
17451       }
17452     ],
17453     "name": "CreateAccounts",
17454     "group": "Openchannel_Accounts",
17455     "parameter": {
17456       "fields": {
17457         "Body": [
17458           {
17459             "group": "Body",
17460             "type": "String",
17461             "optional": false,
17462             "field": "name",
17463             "description": ""
17464           },
17465           {
17466             "group": "Body",
17467             "type": "String",
17468             "optional": true,
17469             "field": "description",
17470             "description": ""
17471           },
17472           {
17473             "group": "Body",
17474             "type": "String",
17475             "optional": true,
17476             "field": "token",
17477             "description": ""
17478           },
17479           {
17480             "group": "Body",
17481             "type": "String",
17482             "optional": true,
17483             "field": "replyUri",
17484             "description": ""
17485           },
17486           {
17487             "group": "Body",
17488             "type": "String",
17489             "optional": false,
17490             "field": "key",
17491             "description": ""
17492           },
17493           {
17494             "group": "Body",
17495             "type": "Text",
17496             "optional": true,
17497             "field": "notificationTemplate",
17498             "description": ""
17499           },
17500           {
17501             "group": "Body",
17502             "type": "Boolean",
17503             "optional": true,
17504             "field": "notificationSound",
17505             "description": ""
17506           },
17507           {
17508             "group": "Body",
17509             "type": "Boolean",
17510             "optional": true,
17511             "field": "notificationShake",
17512             "description": ""
17513           },
17514           {
17515             "group": "Body",
17516             "type": "Integer",
17517             "optional": true,
17518             "field": "waitForTheAssignedAgent",
17519             "description": ""
17520           },
17521           {
17522             "group": "Body",
17523             "type": "String",
17524             "optional": true,
17525             "field": "mapKey",
17526             "description": ""
17527           },
17528           {
17529             "group": "Body",
17530             "type": "Boolean",
17531             "optional": true,
17532             "field": "queueTransfer",
17533             "description": ""
17534           },
17535           {
17536             "group": "Body",
17537             "type": "Integer",
17538             "optional": true,
17539             "field": "queueTransferTimeout",
17540             "description": ""
17541           },
17542           {
17543             "group": "Body",
17544             "type": "Boolean",
17545             "optional": true,
17546             "field": "agentTransfer",
17547             "description": ""
17548           },
17549           {
17550             "group": "Body",
17551             "type": "Integer",
17552             "optional": true,
17553             "field": "agentTransferTimeout",
17554             "description": ""
17555           },
17556           {
17557             "group": "Body",
17558             "type": "Integer",
17559             "optional": true,
17560             "field": "mandatoryDispositionPauseId",
17561             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17562           },
17563           {
17564             "group": "Body",
17565             "type": "Boolean",
17566             "optional": true,
17567             "field": "mandatoryDisposition",
17568             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17569           }
17570         ]
17571       }
17572     },
17573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17574     "version": "0.0.0",
17575     "filename": "server/api/openchannelAccount/index.js",
17576     "groupTitle": "Openchannel_Accounts"
17577   },
17578   {
17579     "type": "delete",
17580     "url": "/api/openchannel/accounts/{id}",
17581     "title": "Deletes a Account",
17582     "examples": [
17583       {
17584         "title": "Example usage:",
17585         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17586         "type": "json"
17587       }
17588     ],
17589     "name": "DeleteAccounts",
17590     "group": "Openchannel_Accounts",
17591     "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>",
17592     "version": "0.0.0",
17593     "filename": "server/api/openchannelAccount/index.js",
17594     "groupTitle": "Openchannel_Accounts"
17595   },
17596   {
17597     "type": "get",
17598     "url": "/api/openchannel/accounts/describe",
17599     "title": "Gets table info about Accounts",
17600     "examples": [
17601       {
17602         "title": "Example usage:",
17603         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17604         "type": "json"
17605       }
17606     ],
17607     "name": "DescribeAccounts",
17608     "group": "Openchannel_Accounts",
17609     "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>",
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",
17617     "title": "Gets a list of Accounts",
17618     "examples": [
17619       {
17620         "title": "Example usage:",
17621         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17622         "type": "json"
17623       }
17624     ],
17625     "name": "GetAccounts",
17626     "group": "Openchannel_Accounts",
17627     "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>",
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/{id}/users",
17635     "title": "Gets agents from openchannel account",
17636     "examples": [
17637       {
17638         "title": "Example usage:",
17639         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17640         "type": "json"
17641       }
17642     ],
17643     "name": "GetAgents",
17644     "group": "Openchannel_Accounts",
17645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17646     "version": "0.0.0",
17647     "filename": "server/api/openchannelAccount/index.js",
17648     "groupTitle": "Openchannel_Accounts"
17649   },
17650   {
17651     "type": "delete",
17652     "url": "/api/openchannel/accounts/{id}/users",
17653     "title": "Removes agents from a openchannel account",
17654     "examples": [
17655       {
17656         "title": "Example usage:",
17657         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17658         "type": "json"
17659       }
17660     ],
17661     "name": "RemoveAgents",
17662     "group": "Openchannel_Accounts",
17663     "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>",
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}/canned_answers",
17671     "title": "Removes canned answers from account",
17672     "examples": [
17673       {
17674         "title": "Example usage:",
17675         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17676         "type": "json"
17677       }
17678     ],
17679     "name": "RemoveAnswers",
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}/dispositions",
17689     "title": "Removes dispositions from account",
17690     "examples": [
17691       {
17692         "title": "Example usage:",
17693         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17694         "type": "json"
17695       }
17696     ],
17697     "name": "RemoveDispositions",
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": "get",
17706     "url": "/api/openchannel/accounts/{id}",
17707     "title": "Gets a single Account",
17708     "examples": [
17709       {
17710         "title": "Example usage:",
17711         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17712         "type": "json"
17713       }
17714     ],
17715     "name": "ShowAccounts",
17716     "group": "Openchannel_Accounts",
17717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
17724     "url": "/api/openchannel/accounts/{id}/canned_answers",
17725     "title": "Creates new canned answer",
17726     "examples": [
17727       {
17728         "title": "Example usage:",
17729         "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",
17730         "type": "json"
17731       }
17732     ],
17733     "name": "addAnswer",
17734     "group": "Openchannel_Accounts",
17735     "parameter": {
17736       "fields": {
17737         "Body": [
17738           {
17739             "group": "Body",
17740             "type": "String",
17741             "optional": false,
17742             "field": "key",
17743             "description": ""
17744           },
17745           {
17746             "group": "Body",
17747             "type": "Text",
17748             "optional": false,
17749             "field": "value",
17750             "description": ""
17751           },
17752           {
17753             "group": "Body",
17754             "type": "String",
17755             "optional": true,
17756             "field": "description",
17757             "description": ""
17758           },
17759           {
17760             "group": "Body",
17761             "type": "Virtual",
17762             "optional": true,
17763             "field": "name",
17764             "description": ""
17765           }
17766         ]
17767       }
17768     },
17769     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17770     "version": "0.0.0",
17771     "filename": "server/api/openchannelAccount/index.js",
17772     "groupTitle": "Openchannel_Accounts"
17773   },
17774   {
17775     "type": "post",
17776     "url": "/api/openchannel/accounts/{id}/applications",
17777     "title": "Creates new applications",
17778     "examples": [
17779       {
17780         "title": "Example usage:",
17781         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17782         "type": "json"
17783       }
17784     ],
17785     "name": "addApplications",
17786     "group": "Openchannel_Accounts",
17787     "parameter": {
17788       "fields": {
17789         "Body": [
17790           {
17791             "group": "Body",
17792             "type": "Integer",
17793             "optional": false,
17794             "field": "priority",
17795             "description": ""
17796           },
17797           {
17798             "group": "Body",
17799             "type": "String",
17800             "optional": false,
17801             "field": "app",
17802             "description": ""
17803           },
17804           {
17805             "group": "Body",
17806             "type": "Text",
17807             "optional": true,
17808             "field": "appdata",
17809             "description": ""
17810           },
17811           {
17812             "group": "Body",
17813             "type": "String",
17814             "optional": true,
17815             "field": "description",
17816             "description": ""
17817           },
17818           {
17819             "group": "Body",
17820             "type": "String",
17821             "optional": true,
17822             "field": "interval",
17823             "description": ""
17824           }
17825         ]
17826       }
17827     },
17828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17829     "version": "0.0.0",
17830     "filename": "server/api/openchannelAccount/index.js",
17831     "groupTitle": "Openchannel_Accounts"
17832   },
17833   {
17834     "type": "post",
17835     "url": "/api/openchannel/accounts/{id}/dispositions",
17836     "title": "Creates new disposition",
17837     "examples": [
17838       {
17839         "title": "Example usage:",
17840         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17841         "type": "json"
17842       }
17843     ],
17844     "name": "addDisposition",
17845     "group": "Openchannel_Accounts",
17846     "parameter": {
17847       "fields": {
17848         "Body": [
17849           {
17850             "group": "Body",
17851             "type": "String",
17852             "optional": false,
17853             "field": "name",
17854             "description": ""
17855           },
17856           {
17857             "group": "Body",
17858             "type": "String",
17859             "allowedValues": [
17860               "\"first\"",
17861               "\"second\"",
17862               "\"third\""
17863             ],
17864             "optional": false,
17865             "field": "level",
17866             "description": ""
17867           },
17868           {
17869             "group": "Body",
17870             "type": "String",
17871             "optional": true,
17872             "field": "description",
17873             "description": ""
17874           }
17875         ]
17876       }
17877     },
17878     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17879     "version": "0.0.0",
17880     "filename": "server/api/openchannelAccount/index.js",
17881     "groupTitle": "Openchannel_Accounts"
17882   },
17883   {
17884     "type": "get",
17885     "url": "/api/openchannel/accounts/{id}/canned_answers",
17886     "title": "Gets account canned answers",
17887     "examples": [
17888       {
17889         "title": "Example usage:",
17890         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17891         "type": "json"
17892       }
17893     ],
17894     "name": "getAnswers",
17895     "group": "Openchannel_Accounts",
17896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
17904     "title": "Gets account applications",
17905     "examples": [
17906       {
17907         "title": "Example usage:",
17908         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17909         "type": "json"
17910       }
17911     ],
17912     "name": "getApplications",
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}/dispositions",
17922     "title": "Gets account dispositions",
17923     "examples": [
17924       {
17925         "title": "Example usage:",
17926         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17927         "type": "json"
17928       }
17929     ],
17930     "name": "getDispositions",
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}/interactions",
17940     "title": "Gets Openchannel Account Interactions",
17941     "examples": [
17942       {
17943         "title": "Example usage:",
17944         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17945         "type": "json"
17946       }
17947     ],
17948     "name": "getInteractions",
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": "post",
17957     "url": "/api/openchannel/accounts/{id}/notify",
17958     "title": "Notify new message",
17959     "examples": [
17960       {
17961         "title": "Example usage:",
17962         "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",
17963         "type": "json"
17964       }
17965     ],
17966     "name": "notify",
17967     "group": "Openchannel_Accounts",
17968     "description": "<p>Motion 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>",
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}/send",
17976     "title": "Send new openchannel message",
17977     "examples": [
17978       {
17979         "title": "Example usage:",
17980         "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",
17981         "type": "json"
17982       }
17983     ],
17984     "name": "sendOpenchannel",
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>",
17987     "version": "0.0.0",
17988     "filename": "server/api/openchannelAccount/index.js",
17989     "groupTitle": "Openchannel_Accounts"
17990   },
17991   {
17992     "type": "put",
17993     "url": "/api/openchannel/accounts/{id}",
17994     "title": "Update an existing Account",
17995     "examples": [
17996       {
17997         "title": "Example usage:",
17998         "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",
17999         "type": "json"
18000       }
18001     ],
18002     "name": "updateAccounts",
18003     "group": "Openchannel_Accounts",
18004     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
18011     "url": "/api/openchannel/applications",
18012     "title": "Creates a new Application",
18013     "examples": [
18014       {
18015         "title": "Example usage:",
18016         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18017         "type": "json"
18018       }
18019     ],
18020     "name": "CreateApplications",
18021     "group": "Openchannel_Applications",
18022     "parameter": {
18023       "fields": {
18024         "Body": [
18025           {
18026             "group": "Body",
18027             "type": "Integer",
18028             "optional": false,
18029             "field": "priority",
18030             "description": ""
18031           },
18032           {
18033             "group": "Body",
18034             "type": "String",
18035             "optional": false,
18036             "field": "app",
18037             "description": ""
18038           },
18039           {
18040             "group": "Body",
18041             "type": "Text",
18042             "optional": true,
18043             "field": "appdata",
18044             "description": ""
18045           },
18046           {
18047             "group": "Body",
18048             "type": "String",
18049             "optional": true,
18050             "field": "description",
18051             "description": ""
18052           },
18053           {
18054             "group": "Body",
18055             "type": "String",
18056             "optional": true,
18057             "field": "interval",
18058             "description": ""
18059           }
18060         ]
18061       }
18062     },
18063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18064     "version": "0.0.0",
18065     "filename": "server/api/openchannelApplication/index.js",
18066     "groupTitle": "Openchannel_Applications"
18067   },
18068   {
18069     "type": "delete",
18070     "url": "/api/openchannel/applications/{id}",
18071     "title": "Deletes a Application",
18072     "examples": [
18073       {
18074         "title": "Example usage:",
18075         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18076         "type": "json"
18077       }
18078     ],
18079     "name": "DeleteApplications",
18080     "group": "Openchannel_Applications",
18081     "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>",
18082     "version": "0.0.0",
18083     "filename": "server/api/openchannelApplication/index.js",
18084     "groupTitle": "Openchannel_Applications"
18085   },
18086   {
18087     "type": "get",
18088     "url": "/api/openchannel/applications",
18089     "title": "Gets a list of Applications",
18090     "examples": [
18091       {
18092         "title": "Example usage:",
18093         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18094         "type": "json"
18095       }
18096     ],
18097     "name": "GetApplications",
18098     "group": "Openchannel_Applications",
18099     "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>",
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/{id}",
18107     "title": "Gets a single Application",
18108     "examples": [
18109       {
18110         "title": "Example usage:",
18111         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18112         "type": "json"
18113       }
18114     ],
18115     "name": "ShowApplications",
18116     "group": "Openchannel_Applications",
18117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18118     "version": "0.0.0",
18119     "filename": "server/api/openchannelApplication/index.js",
18120     "groupTitle": "Openchannel_Applications"
18121   },
18122   {
18123     "type": "put",
18124     "url": "/api/openchannel/applications/{id}",
18125     "title": "Update an existing Application",
18126     "examples": [
18127       {
18128         "title": "Example usage:",
18129         "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",
18130         "type": "json"
18131       }
18132     ],
18133     "name": "updateApplications",
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": "post",
18142     "url": "/api/openchannel/interactions/{id}/tags",
18143     "title": "Add tags to the interaction",
18144     "examples": [
18145       {
18146         "title": "Example usage:",
18147         "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",
18148         "type": "json"
18149       }
18150     ],
18151     "name": "AddTags",
18152     "group": "Openchannel_Interactions",
18153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18154     "version": "0.0.0",
18155     "filename": "server/api/openchannelInteraction/index.js",
18156     "groupTitle": "Openchannel_Interactions"
18157   },
18158   {
18159     "type": "post",
18160     "url": "/api/openchannel/interactions",
18161     "title": "Creates a new Interaction",
18162     "examples": [
18163       {
18164         "title": "Example usage:",
18165         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18166         "type": "json"
18167       }
18168     ],
18169     "name": "CreateInteractions",
18170     "group": "Openchannel_Interactions",
18171     "parameter": {
18172       "fields": {
18173         "Body": [
18174           {
18175             "group": "Body",
18176             "type": "Boolean",
18177             "optional": true,
18178             "field": "closed",
18179             "description": ""
18180           },
18181           {
18182             "group": "Body",
18183             "type": "String",
18184             "optional": true,
18185             "field": "closedAt",
18186             "description": ""
18187           },
18188           {
18189             "group": "Body",
18190             "type": "String",
18191             "optional": true,
18192             "field": "disposition",
18193             "description": ""
18194           },
18195           {
18196             "group": "Body",
18197             "type": "String",
18198             "optional": true,
18199             "field": "secondDisposition",
18200             "description": ""
18201           },
18202           {
18203             "group": "Body",
18204             "type": "String",
18205             "optional": true,
18206             "field": "thirdDisposition",
18207             "description": ""
18208           },
18209           {
18210             "group": "Body",
18211             "type": "String",
18212             "optional": true,
18213             "field": "note",
18214             "description": ""
18215           },
18216           {
18217             "group": "Body",
18218             "type": "String",
18219             "optional": true,
18220             "field": "read1stAt",
18221             "description": ""
18222           },
18223           {
18224             "group": "Body",
18225             "type": "String",
18226             "optional": true,
18227             "field": "threadId",
18228             "description": ""
18229           },
18230           {
18231             "group": "Body",
18232             "type": "String",
18233             "optional": true,
18234             "field": "externalUrl",
18235             "description": ""
18236           },
18237           {
18238             "group": "Body",
18239             "type": "String",
18240             "optional": true,
18241             "field": "lastMsgAt",
18242             "description": ""
18243           },
18244           {
18245             "group": "Body",
18246             "type": "String",
18247             "allowedValues": [
18248               "\"in\"",
18249               "\"out\""
18250             ],
18251             "optional": false,
18252             "field": "lastMsgDirection",
18253             "description": ""
18254           },
18255           {
18256             "group": "Body",
18257             "type": "String",
18258             "optional": true,
18259             "field": "from",
18260             "description": ""
18261           },
18262           {
18263             "group": "Body",
18264             "type": "Boolean",
18265             "optional": true,
18266             "field": "autoreplyExecuted",
18267             "description": ""
18268           }
18269         ]
18270       }
18271     },
18272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18273     "version": "0.0.0",
18274     "filename": "server/api/openchannelInteraction/index.js",
18275     "groupTitle": "Openchannel_Interactions"
18276   },
18277   {
18278     "type": "delete",
18279     "url": "/api/openchannel/interactions/{id}",
18280     "title": "Deletes a Interaction",
18281     "examples": [
18282       {
18283         "title": "Example usage:",
18284         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18285         "type": "json"
18286       }
18287     ],
18288     "name": "DeleteInteractions",
18289     "group": "Openchannel_Interactions",
18290     "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>",
18291     "version": "0.0.0",
18292     "filename": "server/api/openchannelInteraction/index.js",
18293     "groupTitle": "Openchannel_Interactions"
18294   },
18295   {
18296     "type": "get",
18297     "url": "/api/openchannel/interactions/describe",
18298     "title": "Gets table info about Interactions",
18299     "examples": [
18300       {
18301         "title": "Example usage:",
18302         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18303         "type": "json"
18304       }
18305     ],
18306     "name": "DescribeInteractions",
18307     "group": "Openchannel_Interactions",
18308     "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>",
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",
18316     "title": "Gets a list of Interactions",
18317     "examples": [
18318       {
18319         "title": "Example usage:",
18320         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18321         "type": "json"
18322       }
18323     ],
18324     "name": "GetInteractions",
18325     "group": "Openchannel_Interactions",
18326     "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>",
18327     "version": "0.0.0",
18328     "filename": "server/api/openchannelInteraction/index.js",
18329     "groupTitle": "Openchannel_Interactions"
18330   },
18331   {
18332     "type": "delete",
18333     "url": "/api/openchannel/interactions/{id}/tags",
18334     "title": "Removes tags from interaction",
18335     "examples": [
18336       {
18337         "title": "Example usage:",
18338         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18339         "type": "json"
18340       }
18341     ],
18342     "name": "RemoveTags",
18343     "group": "Openchannel_Interactions",
18344     "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>",
18345     "version": "0.0.0",
18346     "filename": "server/api/openchannelInteraction/index.js",
18347     "groupTitle": "Openchannel_Interactions"
18348   },
18349   {
18350     "type": "get",
18351     "url": "/api/openchannel/interactions/{id}",
18352     "title": "Gets a single Interaction",
18353     "examples": [
18354       {
18355         "title": "Example usage:",
18356         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18357         "type": "json"
18358       }
18359     ],
18360     "name": "ShowInteractions",
18361     "group": "Openchannel_Interactions",
18362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
18369     "url": "/api/openchannel/interactions/{id}/messages",
18370     "title": "Creates new messages",
18371     "examples": [
18372       {
18373         "title": "Example usage:",
18374         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18375         "type": "json"
18376       }
18377     ],
18378     "name": "addMessage",
18379     "group": "Openchannel_Interactions",
18380     "parameter": {
18381       "fields": {
18382         "Body": [
18383           {
18384             "group": "Body",
18385             "type": "Text",
18386             "optional": false,
18387             "field": "body",
18388             "description": ""
18389           },
18390           {
18391             "group": "Body",
18392             "type": "Boolean",
18393             "optional": true,
18394             "field": "read",
18395             "description": ""
18396           },
18397           {
18398             "group": "Body",
18399             "type": "Boolean",
18400             "optional": true,
18401             "field": "secret",
18402             "description": ""
18403           },
18404           {
18405             "group": "Body",
18406             "type": "String",
18407             "allowedValues": [
18408               "\"in\"",
18409               "\"out\""
18410             ],
18411             "optional": false,
18412             "field": "direction",
18413             "description": ""
18414           },
18415           {
18416             "group": "Body",
18417             "type": "String",
18418             "optional": true,
18419             "field": "readAt",
18420             "description": ""
18421           },
18422           {
18423             "group": "Body",
18424             "type": "String",
18425             "optional": true,
18426             "field": "providerName",
18427             "description": ""
18428           },
18429           {
18430             "group": "Body",
18431             "type": "Text",
18432             "optional": true,
18433             "field": "providerResponse",
18434             "description": ""
18435           }
18436         ]
18437       }
18438     },
18439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18440     "version": "0.0.0",
18441     "filename": "server/api/openchannelInteraction/index.js",
18442     "groupTitle": "Openchannel_Interactions"
18443   },
18444   {
18445     "type": "get",
18446     "url": "/api/openchannel/interactions/{id}/download",
18447     "title": "Gets interaction",
18448     "examples": [
18449       {
18450         "title": "Example usage:",
18451         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18452         "type": "json"
18453       }
18454     ],
18455     "name": "download",
18456     "group": "Openchannel_Interactions",
18457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
18465     "title": "Gets interaction messages",
18466     "examples": [
18467       {
18468         "title": "Example usage:",
18469         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18470         "type": "json"
18471       }
18472     ],
18473     "name": "getMessages",
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": "put",
18482     "url": "/api/openchannel/interactions/{id}",
18483     "title": "Update an existing Interaction",
18484     "examples": [
18485       {
18486         "title": "Example usage:",
18487         "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",
18488         "type": "json"
18489       }
18490     ],
18491     "name": "updateInteractions",
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": "post",
18500     "url": "/api/openchannel/messages",
18501     "title": "Creates a new Message",
18502     "examples": [
18503       {
18504         "title": "Example usage:",
18505         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18506         "type": "json"
18507       }
18508     ],
18509     "name": "CreateMessages",
18510     "group": "Openchannel_Messages",
18511     "parameter": {
18512       "fields": {
18513         "Body": [
18514           {
18515             "group": "Body",
18516             "type": "Text",
18517             "optional": false,
18518             "field": "body",
18519             "description": ""
18520           },
18521           {
18522             "group": "Body",
18523             "type": "Boolean",
18524             "optional": true,
18525             "field": "read",
18526             "description": ""
18527           },
18528           {
18529             "group": "Body",
18530             "type": "Boolean",
18531             "optional": true,
18532             "field": "secret",
18533             "description": ""
18534           },
18535           {
18536             "group": "Body",
18537             "type": "String",
18538             "allowedValues": [
18539               "\"in\"",
18540               "\"out\""
18541             ],
18542             "optional": false,
18543             "field": "direction",
18544             "description": ""
18545           },
18546           {
18547             "group": "Body",
18548             "type": "String",
18549             "optional": true,
18550             "field": "readAt",
18551             "description": ""
18552           },
18553           {
18554             "group": "Body",
18555             "type": "String",
18556             "optional": true,
18557             "field": "providerName",
18558             "description": ""
18559           },
18560           {
18561             "group": "Body",
18562             "type": "Text",
18563             "optional": true,
18564             "field": "providerResponse",
18565             "description": ""
18566           }
18567         ]
18568       }
18569     },
18570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18571     "version": "0.0.0",
18572     "filename": "server/api/openchannelMessage/index.js",
18573     "groupTitle": "Openchannel_Messages"
18574   },
18575   {
18576     "type": "delete",
18577     "url": "/api/openchannel/messages/{id}",
18578     "title": "Deletes a Message",
18579     "examples": [
18580       {
18581         "title": "Example usage:",
18582         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18583         "type": "json"
18584       }
18585     ],
18586     "name": "DeleteMessages",
18587     "group": "Openchannel_Messages",
18588     "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>",
18589     "version": "0.0.0",
18590     "filename": "server/api/openchannelMessage/index.js",
18591     "groupTitle": "Openchannel_Messages"
18592   },
18593   {
18594     "type": "get",
18595     "url": "/api/openchannel/messages/describe",
18596     "title": "Gets table info about Messages",
18597     "examples": [
18598       {
18599         "title": "Example usage:",
18600         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18601         "type": "json"
18602       }
18603     ],
18604     "name": "DescribeMessages",
18605     "group": "Openchannel_Messages",
18606     "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>",
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",
18614     "title": "Gets a list of Messages",
18615     "examples": [
18616       {
18617         "title": "Example usage:",
18618         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18619         "type": "json"
18620       }
18621     ],
18622     "name": "GetMessages",
18623     "group": "Openchannel_Messages",
18624     "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>",
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/{id}",
18632     "title": "Gets a single Message",
18633     "examples": [
18634       {
18635         "title": "Example usage:",
18636         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18637         "type": "json"
18638       }
18639     ],
18640     "name": "ShowMessages",
18641     "group": "Openchannel_Messages",
18642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18643     "version": "0.0.0",
18644     "filename": "server/api/openchannelMessage/index.js",
18645     "groupTitle": "Openchannel_Messages"
18646   },
18647   {
18648     "type": "put",
18649     "url": "/api/openchannel/messages/{id}/accept",
18650     "title": "Accepts message",
18651     "examples": [
18652       {
18653         "title": "Example usage:",
18654         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18655         "type": "json"
18656       }
18657     ],
18658     "name": "acceptMessage",
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}/reject",
18668     "title": "Rejects message",
18669     "examples": [
18670       {
18671         "title": "Example usage:",
18672         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18673         "type": "json"
18674       }
18675     ],
18676     "name": "rejectMessage",
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}",
18686     "title": "Update an existing Message",
18687     "examples": [
18688       {
18689         "title": "Example usage:",
18690         "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",
18691         "type": "json"
18692       }
18693     ],
18694     "name": "updateMessages",
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": "post",
18703     "url": "/api/openchannel/reports/queue",
18704     "title": "Creates a new Openchannel Queue Report",
18705     "examples": [
18706       {
18707         "title": "Example usage:",
18708         "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",
18709         "type": "json"
18710       }
18711     ],
18712     "name": "CreateOpenchannel_Queue_Reports",
18713     "group": "Openchannel_Queue_Reports",
18714     "parameter": {
18715       "fields": {
18716         "Body": [
18717           {
18718             "group": "Body",
18719             "type": "String",
18720             "optional": false,
18721             "field": "uniqueid",
18722             "description": ""
18723           },
18724           {
18725             "group": "Body",
18726             "type": "String",
18727             "optional": true,
18728             "field": "from",
18729             "description": ""
18730           },
18731           {
18732             "group": "Body",
18733             "type": "String",
18734             "optional": true,
18735             "field": "joinAt",
18736             "description": ""
18737           },
18738           {
18739             "group": "Body",
18740             "type": "String",
18741             "optional": true,
18742             "field": "leaveAt",
18743             "description": ""
18744           },
18745           {
18746             "group": "Body",
18747             "type": "String",
18748             "optional": true,
18749             "field": "acceptAt",
18750             "description": ""
18751           },
18752           {
18753             "group": "Body",
18754             "type": "String",
18755             "optional": true,
18756             "field": "exitAt",
18757             "description": ""
18758           },
18759           {
18760             "group": "Body",
18761             "type": "String",
18762             "optional": true,
18763             "field": "reason",
18764             "description": ""
18765           }
18766         ]
18767       }
18768     },
18769     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18770     "version": "0.0.0",
18771     "filename": "server/api/openchannelQueueReport/index.js",
18772     "groupTitle": "Openchannel_Queue_Reports"
18773   },
18774   {
18775     "type": "delete",
18776     "url": "/api/openchannel/reports/queue/{id}",
18777     "title": "Deletes a Openchannel Queue Report",
18778     "examples": [
18779       {
18780         "title": "Example usage:",
18781         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18782         "type": "json"
18783       }
18784     ],
18785     "name": "DeleteOpenchannel_Queue_Reports",
18786     "group": "Openchannel_Queue_Reports",
18787     "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>",
18788     "version": "0.0.0",
18789     "filename": "server/api/openchannelQueueReport/index.js",
18790     "groupTitle": "Openchannel_Queue_Reports"
18791   },
18792   {
18793     "type": "get",
18794     "url": "/api/openchannel/reports/queue/describe",
18795     "title": "Gets table info about Openchannel Queue Reports",
18796     "examples": [
18797       {
18798         "title": "Example usage:",
18799         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18800         "type": "json"
18801       }
18802     ],
18803     "name": "DescribeOpenchannel_Queue_Reports",
18804     "group": "Openchannel_Queue_Reports",
18805     "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>",
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",
18813     "title": "Gets a list of Openchannel Queue Reports",
18814     "examples": [
18815       {
18816         "title": "Example usage:",
18817         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18818         "type": "json"
18819       }
18820     ],
18821     "name": "GetOpenchannel_Queue_Reports",
18822     "group": "Openchannel_Queue_Reports",
18823     "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>",
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/{id}",
18831     "title": "Gets a single Openchannel Queue Report",
18832     "examples": [
18833       {
18834         "title": "Example usage:",
18835         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18836         "type": "json"
18837       }
18838     ],
18839     "name": "ShowOpenchannel_Queue_Reports",
18840     "group": "Openchannel_Queue_Reports",
18841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18842     "version": "0.0.0",
18843     "filename": "server/api/openchannelQueueReport/index.js",
18844     "groupTitle": "Openchannel_Queue_Reports"
18845   },
18846   {
18847     "type": "put",
18848     "url": "/api/openchannel/reports/queue/{id}",
18849     "title": "Update an existing Openchannel Queue Report",
18850     "examples": [
18851       {
18852         "title": "Example usage:",
18853         "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",
18854         "type": "json"
18855       }
18856     ],
18857     "name": "updateOpenchannel_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": "post",
18866     "url": "/api/openchannel/queues/{id}/users",
18867     "title": "Add agents to a queue",
18868     "examples": [
18869       {
18870         "title": "Example usage:",
18871         "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",
18872         "type": "json"
18873       }
18874     ],
18875     "name": "AddAgents",
18876     "group": "Openchannel_Queues",
18877     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18878     "version": "0.0.0",
18879     "filename": "server/api/openchannelQueue/index.js",
18880     "groupTitle": "Openchannel_Queues"
18881   },
18882   {
18883     "type": "post",
18884     "url": "/api/openchannel/queues/{id}/teams",
18885     "title": "Add teams to a queue",
18886     "examples": [
18887       {
18888         "title": "Example usage:",
18889         "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",
18890         "type": "json"
18891       }
18892     ],
18893     "name": "AddTeams",
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",
18903     "title": "Creates a new Queue",
18904     "examples": [
18905       {
18906         "title": "Example usage:",
18907         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18908         "type": "json"
18909       }
18910     ],
18911     "name": "CreateQueues",
18912     "group": "Openchannel_Queues",
18913     "parameter": {
18914       "fields": {
18915         "Body": [
18916           {
18917             "group": "Body",
18918             "type": "String",
18919             "optional": true,
18920             "field": "name",
18921             "description": ""
18922           },
18923           {
18924             "group": "Body",
18925             "type": "String",
18926             "optional": true,
18927             "field": "description",
18928             "description": ""
18929           },
18930           {
18931             "group": "Body",
18932             "type": "Integer",
18933             "optional": true,
18934             "field": "timeout",
18935             "description": ""
18936           },
18937           {
18938             "group": "Body",
18939             "type": "String",
18940             "allowedValues": [
18941               "\"rrmemory\"",
18942               "\"beepall\"",
18943               "\"roundrobin\""
18944             ],
18945             "optional": true,
18946             "field": "strategy",
18947             "description": ""
18948           }
18949         ]
18950       }
18951     },
18952     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18953     "version": "0.0.0",
18954     "filename": "server/api/openchannelQueue/index.js",
18955     "groupTitle": "Openchannel_Queues"
18956   },
18957   {
18958     "type": "delete",
18959     "url": "/api/openchannel/queues/{id}",
18960     "title": "Deletes a Queue",
18961     "examples": [
18962       {
18963         "title": "Example usage:",
18964         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18965         "type": "json"
18966       }
18967     ],
18968     "name": "DeleteQueues",
18969     "group": "Openchannel_Queues",
18970     "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>",
18971     "version": "0.0.0",
18972     "filename": "server/api/openchannelQueue/index.js",
18973     "groupTitle": "Openchannel_Queues"
18974   },
18975   {
18976     "type": "get",
18977     "url": "/api/openchannel/queues/describe",
18978     "title": "Gets table info about Queues",
18979     "examples": [
18980       {
18981         "title": "Example usage:",
18982         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18983         "type": "json"
18984       }
18985     ],
18986     "name": "DescribeQueues",
18987     "group": "Openchannel_Queues",
18988     "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>",
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/{id}/users",
18996     "title": "Gets queue agents",
18997     "examples": [
18998       {
18999         "title": "Example usage:",
19000         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19001         "type": "json"
19002       }
19003     ],
19004     "name": "GetAgents",
19005     "group": "Openchannel_Queues",
19006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
19014     "title": "GetMembers",
19015     "examples": [
19016       {
19017         "title": "Example usage:",
19018         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19019         "type": "json"
19020       }
19021     ],
19022     "name": "GetMembers",
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",
19032     "title": "Gets a list of Queues",
19033     "examples": [
19034       {
19035         "title": "Example usage:",
19036         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19037         "type": "json"
19038       }
19039     ],
19040     "name": "GetQueues",
19041     "group": "Openchannel_Queues",
19042     "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>",
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/{id}/teams",
19050     "title": "Gets queues list",
19051     "examples": [
19052       {
19053         "title": "Example usage:",
19054         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19055         "type": "json"
19056       }
19057     ],
19058     "name": "GetTeams",
19059     "group": "Openchannel_Queues",
19060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19061     "version": "0.0.0",
19062     "filename": "server/api/openchannelQueue/index.js",
19063     "groupTitle": "Openchannel_Queues"
19064   },
19065   {
19066     "type": "delete",
19067     "url": "/api/openchannel/queues/{id}/users",
19068     "title": "Removes agents from a queue",
19069     "examples": [
19070       {
19071         "title": "Example usage:",
19072         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19073         "type": "json"
19074       }
19075     ],
19076     "name": "RemoveAgents",
19077     "group": "Openchannel_Queues",
19078     "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>",
19079     "version": "0.0.0",
19080     "filename": "server/api/openchannelQueue/index.js",
19081     "groupTitle": "Openchannel_Queues"
19082   },
19083   {
19084     "type": "get",
19085     "url": "/api/openchannel/queues/{id}",
19086     "title": "Gets a single Queue",
19087     "examples": [
19088       {
19089         "title": "Example usage:",
19090         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19091         "type": "json"
19092       }
19093     ],
19094     "name": "ShowQueues",
19095     "group": "Openchannel_Queues",
19096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
19103     "url": "/api/openchannel/queues/{id}",
19104     "title": "Update an existing Queue",
19105     "examples": [
19106       {
19107         "title": "Example usage:",
19108         "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",
19109         "type": "json"
19110       }
19111     ],
19112     "name": "updateQueues",
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": "post",
19121     "url": "/api/openchannel/reports/transfer",
19122     "title": "Creates a new Openchannel Transfer Report",
19123     "examples": [
19124       {
19125         "title": "Example usage:",
19126         "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",
19127         "type": "json"
19128       }
19129     ],
19130     "name": "CreateOpenchannel_Transfer_Reports",
19131     "group": "Openchannel_Transfer_Reports",
19132     "parameter": {
19133       "fields": {
19134         "Body": [
19135           {
19136             "group": "Body",
19137             "type": "String",
19138             "optional": false,
19139             "field": "uniqueid",
19140             "description": ""
19141           },
19142           {
19143             "group": "Body",
19144             "type": "String",
19145             "allowedValues": [
19146               "\"account\"",
19147               "\"agent\"",
19148               "\"queue\""
19149             ],
19150             "optional": false,
19151             "field": "type",
19152             "description": ""
19153           },
19154           {
19155             "group": "Body",
19156             "type": "String",
19157             "optional": false,
19158             "field": "transferredAt",
19159             "description": ""
19160           }
19161         ]
19162       }
19163     },
19164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19165     "version": "0.0.0",
19166     "filename": "server/api/openchannelTransferReport/index.js",
19167     "groupTitle": "Openchannel_Transfer_Reports"
19168   },
19169   {
19170     "type": "delete",
19171     "url": "/api/openchannel/reports/transfer/{id}",
19172     "title": "Deletes a Openchannel Transfer Report",
19173     "examples": [
19174       {
19175         "title": "Example usage:",
19176         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19177         "type": "json"
19178       }
19179     ],
19180     "name": "DeleteOpenchannel_Transfer_Reports",
19181     "group": "Openchannel_Transfer_Reports",
19182     "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>",
19183     "version": "0.0.0",
19184     "filename": "server/api/openchannelTransferReport/index.js",
19185     "groupTitle": "Openchannel_Transfer_Reports"
19186   },
19187   {
19188     "type": "get",
19189     "url": "/api/openchannel/reports/transfer/describe",
19190     "title": "Gets table info about Openchannel Transfer Reports",
19191     "examples": [
19192       {
19193         "title": "Example usage:",
19194         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19195         "type": "json"
19196       }
19197     ],
19198     "name": "DescribeOpenchannel_Transfer_Reports",
19199     "group": "Openchannel_Transfer_Reports",
19200     "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>",
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",
19208     "title": "Gets a list of Openchannel Transfer Reports",
19209     "examples": [
19210       {
19211         "title": "Example usage:",
19212         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19213         "type": "json"
19214       }
19215     ],
19216     "name": "GetOpenchannel_Transfer_Reports",
19217     "group": "Openchannel_Transfer_Reports",
19218     "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>",
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/{id}",
19226     "title": "Gets a single Openchannel Transfer Report",
19227     "examples": [
19228       {
19229         "title": "Example usage:",
19230         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19231         "type": "json"
19232       }
19233     ],
19234     "name": "ShowOpenchannel_Transfer_Reports",
19235     "group": "Openchannel_Transfer_Reports",
19236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19237     "version": "0.0.0",
19238     "filename": "server/api/openchannelTransferReport/index.js",
19239     "groupTitle": "Openchannel_Transfer_Reports"
19240   },
19241   {
19242     "type": "put",
19243     "url": "/api/openchannel/reports/transfer/{id}",
19244     "title": "Update an existing Openchannel Transfer Report",
19245     "examples": [
19246       {
19247         "title": "Example usage:",
19248         "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",
19249         "type": "json"
19250       }
19251     ],
19252     "name": "updateOpenchannel_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": "post",
19261     "url": "/api/pauses",
19262     "title": "Creates a new Pause",
19263     "examples": [
19264       {
19265         "title": "Example usage:",
19266         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19267         "type": "json"
19268       }
19269     ],
19270     "name": "CreatePauses",
19271     "group": "Pauses",
19272     "parameter": {
19273       "fields": {
19274         "Body": [
19275           {
19276             "group": "Body",
19277             "type": "String",
19278             "optional": false,
19279             "field": "name",
19280             "description": ""
19281           },
19282           {
19283             "group": "Body",
19284             "type": "String",
19285             "optional": true,
19286             "field": "description",
19287             "description": ""
19288           }
19289         ]
19290       }
19291     },
19292     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19293     "version": "0.0.0",
19294     "filename": "server/api/pause/index.js",
19295     "groupTitle": "Pauses"
19296   },
19297   {
19298     "type": "delete",
19299     "url": "/api/pauses/{id}",
19300     "title": "Deletes a Pause",
19301     "examples": [
19302       {
19303         "title": "Example usage:",
19304         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19305         "type": "json"
19306       }
19307     ],
19308     "name": "DeletePauses",
19309     "group": "Pauses",
19310     "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>",
19311     "version": "0.0.0",
19312     "filename": "server/api/pause/index.js",
19313     "groupTitle": "Pauses"
19314   },
19315   {
19316     "type": "get",
19317     "url": "/api/pauses",
19318     "title": "Gets a list of Pauses",
19319     "examples": [
19320       {
19321         "title": "Example usage:",
19322         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19323         "type": "json"
19324       }
19325     ],
19326     "name": "GetPauses",
19327     "group": "Pauses",
19328     "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>",
19329     "version": "0.0.0",
19330     "filename": "server/api/pause/index.js",
19331     "groupTitle": "Pauses"
19332   },
19333   {
19334     "type": "get",
19335     "url": "/api/pauses/{id}",
19336     "title": "Gets a single Pause",
19337     "examples": [
19338       {
19339         "title": "Example usage:",
19340         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19341         "type": "json"
19342       }
19343     ],
19344     "name": "ShowPauses",
19345     "group": "Pauses",
19346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19347     "version": "0.0.0",
19348     "filename": "server/api/pause/index.js",
19349     "groupTitle": "Pauses"
19350   },
19351   {
19352     "type": "put",
19353     "url": "/api/pauses/{id}",
19354     "title": "Update an existing Pause",
19355     "examples": [
19356       {
19357         "title": "Example usage:",
19358         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19359         "type": "json"
19360       }
19361     ],
19362     "name": "updatePauses",
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": "get",
19371     "url": "/api/plugins",
19372     "title": "Gets a list of Plugins",
19373     "examples": [
19374       {
19375         "title": "Example usage:",
19376         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19377         "type": "json"
19378       }
19379     ],
19380     "name": "GetPlugins",
19381     "group": "Plugins",
19382     "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>",
19383     "version": "0.0.0",
19384     "filename": "server/api/plugin/index.js",
19385     "groupTitle": "Plugins"
19386   },
19387   {
19388     "type": "get",
19389     "url": "/api/plugins/{id}",
19390     "title": "Gets a single Plugin",
19391     "examples": [
19392       {
19393         "title": "Example usage:",
19394         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19395         "type": "json"
19396       }
19397     ],
19398     "name": "ShowPlugins",
19399     "group": "Plugins",
19400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19401     "version": "0.0.0",
19402     "filename": "server/api/plugin/index.js",
19403     "groupTitle": "Plugins"
19404   },
19405   {
19406     "type": "delete",
19407     "url": "/api/plugins/{id}",
19408     "title": "Delete a plugin",
19409     "examples": [
19410       {
19411         "title": "Example usage:",
19412         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19413         "type": "json"
19414       }
19415     ],
19416     "name": "destroyPlugin",
19417     "group": "Plugins",
19418     "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>",
19419     "version": "0.0.0",
19420     "filename": "server/api/plugin/index.js",
19421     "groupTitle": "Plugins"
19422   },
19423   {
19424     "type": "get",
19425     "url": "/api/plugins/{id}/download",
19426     "title": "Download plugin source code",
19427     "examples": [
19428       {
19429         "title": "Example usage:",
19430         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19431         "type": "json"
19432       }
19433     ],
19434     "name": "download",
19435     "group": "Plugins",
19436     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
19443     "url": "/api/plugins/{id}",
19444     "title": "Update an existing plugin",
19445     "examples": [
19446       {
19447         "title": "Example usage:",
19448         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19449         "type": "json"
19450       }
19451     ],
19452     "name": "updatePlugin",
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": "post",
19461     "url": "/api/plugins",
19462     "title": "Upload new plugin",
19463     "examples": [
19464       {
19465         "title": "Example usage:",
19466         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19467         "type": "json"
19468       }
19469     ],
19470     "name": "uploadPlugin",
19471     "group": "Plugins",
19472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
19479     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19480     "title": "Redirect a plugin request to the specified path",
19481     "examples": [
19482       {
19483         "title": "Example usage:",
19484         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19485         "type": "json"
19486       }
19487     ],
19488     "name": "webhookPlugin",
19489     "group": "Plugins",
19490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "delete",
19515     "url": "/api/pm2/{id}",
19516     "title": "Deletes an existing process",
19517     "examples": [
19518       {
19519         "title": "Example usage:",
19520         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19521         "type": "json"
19522       }
19523     ],
19524     "name": "DeletePm2Process",
19525     "group": "Pm2",
19526     "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>",
19527     "version": "0.0.0",
19528     "filename": "server/api/pm2/index.js",
19529     "groupTitle": "Pm2"
19530   },
19531   {
19532     "type": "get",
19533     "url": "/api/pm2/{id}",
19534     "title": "Gets a single pm2 process",
19535     "examples": [
19536       {
19537         "title": "Example usage:",
19538         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19539         "type": "json"
19540       }
19541     ],
19542     "name": "GetPm2Process",
19543     "group": "Pm2",
19544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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",
19552     "title": "Gets pm2 processes",
19553     "examples": [
19554       {
19555         "title": "Example usage:",
19556         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19557         "type": "json"
19558       }
19559     ],
19560     "name": "GetPm2Processes",
19561     "group": "Pm2",
19562     "description": "<p>Motion returns the pm2 processes list.</p>",
19563     "version": "0.0.0",
19564     "filename": "server/api/pm2/index.js",
19565     "groupTitle": "Pm2"
19566   },
19567   {
19568     "type": "post",
19569     "url": "/api/pm2",
19570     "title": "Start a single pm2 process",
19571     "examples": [
19572       {
19573         "title": "Example usage:",
19574         "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",
19575         "type": "json"
19576       }
19577     ],
19578     "name": "StartPm2Process",
19579     "group": "Pm2",
19580     "parameter": {
19581       "fields": {
19582         "Body": [
19583           {
19584             "group": "Body",
19585             "type": "String",
19586             "optional": false,
19587             "field": "name",
19588             "description": ""
19589           },
19590           {
19591             "group": "Body",
19592             "type": "String",
19593             "optional": false,
19594             "field": "script",
19595             "description": ""
19596           }
19597         ]
19598       }
19599     },
19600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19601     "version": "0.0.0",
19602     "filename": "server/api/pm2/index.js",
19603     "groupTitle": "Pm2"
19604   },
19605   {
19606     "type": "put",
19607     "url": "/api/pm2/{id}",
19608     "title": "Update an existing process",
19609     "examples": [
19610       {
19611         "title": "Example usage:",
19612         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19613         "type": "json"
19614       }
19615     ],
19616     "name": "UpdatePm2Process",
19617     "group": "Pm2",
19618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
19625     "url": "/api/rpc/campaigns/",
19626     "title": "Gets a list of campaigns",
19627     "examples": [
19628       {
19629         "title": "Example usage:",
19630         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19631         "type": "json"
19632       }
19633     ],
19634     "name": "Campaigns",
19635     "group": "RPC_Realtime",
19636     "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>",
19637     "version": "0.0.0",
19638     "filename": "server/api/rpc/index.js",
19639     "groupTitle": "RPC_Realtime"
19640   },
19641   {
19642     "type": "get",
19643     "url": "/api/rpc/fax/accounts",
19644     "title": "Gets a list of FaxAccounts",
19645     "examples": [
19646       {
19647         "title": "Example usage:",
19648         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19649         "type": "json"
19650       }
19651     ],
19652     "name": "FaxAccounts",
19653     "group": "RPC_Realtime",
19654     "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>",
19655     "version": "0.0.0",
19656     "filename": "server/api/rpc/index.js",
19657     "groupTitle": "RPC_Realtime"
19658   },
19659   {
19660     "type": "put",
19661     "url": "/api/rpc/agents/:id/capacity",
19662     "title": "Sets agent capacity",
19663     "examples": [
19664       {
19665         "title": "Example usage:",
19666         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19667         "type": "json"
19668       }
19669     ],
19670     "name": "RTAgentCapacity",
19671     "group": "RPC_Realtime",
19672     "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>",
19673     "version": "0.0.0",
19674     "filename": "server/api/rpc/index.js",
19675     "groupTitle": "RPC_Realtime"
19676   },
19677   {
19678     "type": "get",
19679     "url": "/api/rpc/agents",
19680     "title": "Gets a list of RTAgents",
19681     "examples": [
19682       {
19683         "title": "Example usage:",
19684         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19685         "type": "json"
19686       }
19687     ],
19688     "name": "RTAgents",
19689     "group": "RPC_Realtime",
19690     "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>",
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/chat/queues",
19698     "title": "Gets a list of RTChatQueues",
19699     "examples": [
19700       {
19701         "title": "Example usage:",
19702         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19703         "type": "json"
19704       }
19705     ],
19706     "name": "RTChatQueues",
19707     "group": "RPC_Realtime",
19708     "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>",
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/fax/queues",
19716     "title": "Gets a list of RTFaxQueues",
19717     "examples": [
19718       {
19719         "title": "Example usage:",
19720         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19721         "type": "json"
19722       }
19723     ],
19724     "name": "RTFaxQueues",
19725     "group": "RPC_Realtime",
19726     "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>",
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/mail/accounts",
19734     "title": "Gets a list of RTMailAccounts",
19735     "examples": [
19736       {
19737         "title": "Example usage:",
19738         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19739         "type": "json"
19740       }
19741     ],
19742     "name": "RTMailAccounts",
19743     "group": "RPC_Realtime",
19744     "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>",
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/queues",
19752     "title": "Gets a list of RTMailQueues",
19753     "examples": [
19754       {
19755         "title": "Example usage:",
19756         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19757         "type": "json"
19758       }
19759     ],
19760     "name": "RTMailQueues",
19761     "group": "RPC_Realtime",
19762     "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>",
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/openchannel/queues",
19770     "title": "Gets a list of RTOpenchannelQueues",
19771     "examples": [
19772       {
19773         "title": "Example usage:",
19774         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19775         "type": "json"
19776       }
19777     ],
19778     "name": "RTOpenchannelQueues",
19779     "group": "RPC_Realtime",
19780     "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>",
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/outbound/channels",
19788     "title": "Gets a list of RTOutboundChannels",
19789     "examples": [
19790       {
19791         "title": "Example usage:",
19792         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19793         "type": "json"
19794       }
19795     ],
19796     "name": "RTOutboundChannels",
19797     "group": "RPC_Realtime",
19798     "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>",
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/sms/queues",
19806     "title": "Gets a list of RTSmsQueues",
19807     "examples": [
19808       {
19809         "title": "Example usage:",
19810         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19811         "type": "json"
19812       }
19813     ],
19814     "name": "RTSmsQueues",
19815     "group": "RPC_Realtime",
19816     "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>",
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/telephones",
19824     "title": "Gets a list of RTTelephones",
19825     "examples": [
19826       {
19827         "title": "Example usage:",
19828         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19829         "type": "json"
19830       }
19831     ],
19832     "name": "RTTelephones",
19833     "group": "RPC_Realtime",
19834     "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>",
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/trunks",
19842     "title": "Gets a list of RTTrunks",
19843     "examples": [
19844       {
19845         "title": "Example usage:",
19846         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19847         "type": "json"
19848       }
19849     ],
19850     "name": "RTTrunks",
19851     "group": "RPC_Realtime",
19852     "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>",
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/voice/channels",
19860     "title": "Gets a list of RTVoiceChannelMixMonitor",
19861     "examples": [
19862       {
19863         "title": "Example usage:",
19864         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19865         "type": "json"
19866       }
19867     ],
19868     "name": "RTVoiceChannelMixMonitor",
19869     "group": "RPC_Realtime",
19870     "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>",
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 RTVoiceChannelStopMixMonitor",
19879     "examples": [
19880       {
19881         "title": "Example usage:",
19882         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19883         "type": "json"
19884       }
19885     ],
19886     "name": "RTVoiceChannelStopMixMonitor",
19887     "group": "RPC_Realtime",
19888     "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>",
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 RTVoiceChannels",
19897     "examples": [
19898       {
19899         "title": "Example usage:",
19900         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19901         "type": "json"
19902       }
19903     ],
19904     "name": "RTVoiceChannels",
19905     "group": "RPC_Realtime",
19906     "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>",
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/queues/channels/{uniqueid}",
19914     "title": "Gets a single RTVoiceQueueChannel",
19915     "examples": [
19916       {
19917         "title": "Example usage:",
19918         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19919         "type": "json"
19920       }
19921     ],
19922     "name": "RTVoiceQueueChannel",
19923     "group": "RPC_Realtime",
19924     "description": "<p>Motion will return a specific realtime voice queue channel.</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}/hangup",
19932     "title": "Hangup a single RTVoiceQueueChannel",
19933     "examples": [
19934       {
19935         "title": "Example usage:",
19936         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19937         "type": "json"
19938       }
19939     ],
19940     "name": "RTVoiceQueueChannelHangup",
19941     "group": "RPC_Realtime",
19942     "description": "<p>Motion will hangup 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}/redirect/{exten}",
19950     "title": "Hangup a single RTVoiceQueueChannel",
19951     "examples": [
19952       {
19953         "title": "Example usage:",
19954         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19955         "type": "json"
19956       }
19957     ],
19958     "name": "RTVoiceQueueChannelRedirect",
19959     "group": "RPC_Realtime",
19960     "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>",
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/preview/{id}",
19968     "title": "Gets a single preview contact",
19969     "examples": [
19970       {
19971         "title": "Example usage:",
19972         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19973         "type": "json"
19974       }
19975     ],
19976     "name": "RTVoiceQueuePreview",
19977     "group": "RPC_Realtime",
19978     "description": "<p>Motion will return a specific preview contact.</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",
19986     "title": "Gets a list of RTVoiceQueues",
19987     "examples": [
19988       {
19989         "title": "Example usage:",
19990         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19991         "type": "json"
19992       }
19993     ],
19994     "name": "RTVoiceQueues",
19995     "group": "RPC_Realtime",
19996     "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>",
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/channels",
20022     "title": "Gets a list of RTVoiceQueuesChannels",
20023     "examples": [
20024       {
20025         "title": "Example usage:",
20026         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20027         "type": "json"
20028       }
20029     ],
20030     "name": "RTVoiceQueuesChannels",
20031     "group": "RPC_Realtime",
20032     "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>",
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/chat/queues/{id}",
20040     "title": "Gets a single RTChatQueue",
20041     "examples": [
20042       {
20043         "title": "Example usage:",
20044         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20045         "type": "json"
20046       }
20047     ],
20048     "name": "ShowRTChatQueues",
20049     "group": "RPC_Realtime",
20050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/fax/queues/{id}",
20058     "title": "Gets a single RTFaxQueue",
20059     "examples": [
20060       {
20061         "title": "Example usage:",
20062         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20063         "type": "json"
20064       }
20065     ],
20066     "name": "ShowRTFaxQueues",
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/mail/queues/{id}",
20076     "title": "Gets a single RTMailQueue",
20077     "examples": [
20078       {
20079         "title": "Example usage:",
20080         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20081         "type": "json"
20082       }
20083     ],
20084     "name": "ShowRTMailQueues",
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/openchannel/queues/{id}",
20094     "title": "Gets a single RTOpenchannelQueue",
20095     "examples": [
20096       {
20097         "title": "Example usage:",
20098         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20099         "type": "json"
20100       }
20101     ],
20102     "name": "ShowRTOpenchannelQueues",
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/sms/queues/{id}",
20112     "title": "Gets a single RTSmsQueue",
20113     "examples": [
20114       {
20115         "title": "Example usage:",
20116         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20117         "type": "json"
20118       }
20119     ],
20120     "name": "ShowRTSmsQueues",
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/voice/queues/{id}",
20130     "title": "Gets a single RTVoiceQueue",
20131     "examples": [
20132       {
20133         "title": "Example usage:",
20134         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20135         "type": "json"
20136       }
20137     ],
20138     "name": "ShowRTVoiceQueues",
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": "put",
20147     "url": "/api/rpc/voice/{id}/queues",
20148     "title": "Updates a single VoiceQueue",
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": "UpdateVoiceQueues",
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": "post",
20165     "url": "/api/rpc/agents/:id/notify",
20166     "title": "Notify message to a specific agent",
20167     "examples": [
20168       {
20169         "title": "Example usage:",
20170         "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",
20171         "type": "json"
20172       }
20173     ],
20174     "name": "agentNotify",
20175     "group": "RPC_Realtime",
20176     "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>",
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/chat/queues/:id/notify",
20184     "title": "Notify message to a specific queue",
20185     "examples": [
20186       {
20187         "title": "Example usage:",
20188         "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",
20189         "type": "json"
20190       }
20191     ],
20192     "name": "chatQueueNotify",
20193     "group": "RPC_Realtime",
20194     "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>",
20195     "version": "0.0.0",
20196     "filename": "server/api/rpc/index.js",
20197     "groupTitle": "RPC_Realtime"
20198   },
20199   {
20200     "type": "get",
20201     "url": "/api/rpc/chat/queues/waitinginteractions",
20202     "title": "Gets a list of chatQueuesWaitingInteractions",
20203     "examples": [
20204       {
20205         "title": "Example usage:",
20206         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20207         "type": "json"
20208       }
20209     ],
20210     "name": "chatQueuesWaitingInteractions",
20211     "group": "RPC_Realtime",
20212     "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>",
20213     "version": "0.0.0",
20214     "filename": "server/api/rpc/index.js",
20215     "groupTitle": "RPC_Realtime"
20216   },
20217   {
20218     "type": "post",
20219     "url": "/api/rpc/fax/queues/:id/notify",
20220     "title": "Notify message to a specific queue",
20221     "examples": [
20222       {
20223         "title": "Example usage:",
20224         "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",
20225         "type": "json"
20226       }
20227     ],
20228     "name": "faxQueueNotify",
20229     "group": "RPC_Realtime",
20230     "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>",
20231     "version": "0.0.0",
20232     "filename": "server/api/rpc/index.js",
20233     "groupTitle": "RPC_Realtime"
20234   },
20235   {
20236     "type": "get",
20237     "url": "/api/rpc/fax/queues/waitinginteractions",
20238     "title": "Gets a list of faxQueuesWaitingInteractions",
20239     "examples": [
20240       {
20241         "title": "Example usage:",
20242         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20243         "type": "json"
20244       }
20245     ],
20246     "name": "faxQueuesWaitingInteractions",
20247     "group": "RPC_Realtime",
20248     "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>",
20249     "version": "0.0.0",
20250     "filename": "server/api/rpc/index.js",
20251     "groupTitle": "RPC_Realtime"
20252   },
20253   {
20254     "type": "post",
20255     "url": "/api/rpc/mail/queues/:id/notify",
20256     "title": "Notify message to a specific queue",
20257     "examples": [
20258       {
20259         "title": "Example usage:",
20260         "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",
20261         "type": "json"
20262       }
20263     ],
20264     "name": "mailQueueNotify",
20265     "group": "RPC_Realtime",
20266     "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>",
20267     "version": "0.0.0",
20268     "filename": "server/api/rpc/index.js",
20269     "groupTitle": "RPC_Realtime"
20270   },
20271   {
20272     "type": "get",
20273     "url": "/api/rpc/mail/queues/waitinginteractions",
20274     "title": "Gets a list of mailQueuesWaitingInteractions",
20275     "examples": [
20276       {
20277         "title": "Example usage:",
20278         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20279         "type": "json"
20280       }
20281     ],
20282     "name": "mailQueuesWaitingInteractions",
20283     "group": "RPC_Realtime",
20284     "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>",
20285     "version": "0.0.0",
20286     "filename": "server/api/rpc/index.js",
20287     "groupTitle": "RPC_Realtime"
20288   },
20289   {
20290     "type": "post",
20291     "url": "/api/rpc/openchannel/queues/:id/notify",
20292     "title": "Notify message to a specific queue",
20293     "examples": [
20294       {
20295         "title": "Example usage:",
20296         "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",
20297         "type": "json"
20298       }
20299     ],
20300     "name": "openchannelQueueNotify",
20301     "group": "RPC_Realtime",
20302     "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>",
20303     "version": "0.0.0",
20304     "filename": "server/api/rpc/index.js",
20305     "groupTitle": "RPC_Realtime"
20306   },
20307   {
20308     "type": "get",
20309     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20310     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20311     "examples": [
20312       {
20313         "title": "Example usage:",
20314         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20315         "type": "json"
20316       }
20317     ],
20318     "name": "openchannelQueuesIdWaitingInteractions",
20319     "group": "RPC_Realtime",
20320     "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>",
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/waitinginteractions",
20328     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20329     "examples": [
20330       {
20331         "title": "Example usage:",
20332         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20333         "type": "json"
20334       }
20335     ],
20336     "name": "openchannelQueuesWaitingInteractions",
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": "post",
20345     "url": "/api/rpc/sms/queues/:id/notify",
20346     "title": "Notify message to a specific queue",
20347     "examples": [
20348       {
20349         "title": "Example usage:",
20350         "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",
20351         "type": "json"
20352       }
20353     ],
20354     "name": "smsQueueNotify",
20355     "group": "RPC_Realtime",
20356     "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>",
20357     "version": "0.0.0",
20358     "filename": "server/api/rpc/index.js",
20359     "groupTitle": "RPC_Realtime"
20360   },
20361   {
20362     "type": "get",
20363     "url": "/api/rpc/sms/queues/waitinginteractions",
20364     "title": "Gets a list of smsQueuesWaitingInteractions",
20365     "examples": [
20366       {
20367         "title": "Example usage:",
20368         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20369         "type": "json"
20370       }
20371     ],
20372     "name": "smsQueuesWaitingInteractions",
20373     "group": "RPC_Realtime",
20374     "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>",
20375     "version": "0.0.0",
20376     "filename": "server/api/rpc/index.js",
20377     "groupTitle": "RPC_Realtime"
20378   },
20379   {
20380     "type": "get",
20381     "url": "/api/realtime/agents",
20382     "title": "Gets realtime agents info",
20383     "examples": [
20384       {
20385         "title": "Example usage:",
20386         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
20387         "type": "json"
20388       }
20389     ],
20390     "name": "getAgents",
20391     "group": "Realtime",
20392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20393     "version": "0.0.0",
20394     "filename": "server/api/realtime/index.js",
20395     "groupTitle": "Realtime"
20396   },
20397   {
20398     "type": "get",
20399     "url": "/api/realtime/queues",
20400     "title": "Gets realtime queues info",
20401     "examples": [
20402       {
20403         "title": "Example usage:",
20404         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
20405         "type": "json"
20406       }
20407     ],
20408     "name": "getQueues",
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": "post",
20417     "url": "/api/integrations/salesforce/accounts",
20418     "title": "Creates a new Salesforce Account",
20419     "examples": [
20420       {
20421         "title": "Example usage:",
20422         "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",
20423         "type": "json"
20424       }
20425     ],
20426     "name": "CreateSalesforce_Accounts",
20427     "group": "Salesforce_Accounts",
20428     "parameter": {
20429       "fields": {
20430         "Body": [
20431           {
20432             "group": "Body",
20433             "type": "String",
20434             "optional": true,
20435             "field": "name",
20436             "description": ""
20437           },
20438           {
20439             "group": "Body",
20440             "type": "String",
20441             "optional": true,
20442             "field": "description",
20443             "description": ""
20444           },
20445           {
20446             "group": "Body",
20447             "type": "String",
20448             "optional": true,
20449             "field": "username",
20450             "description": ""
20451           },
20452           {
20453             "group": "Body",
20454             "type": "String",
20455             "optional": true,
20456             "field": "remoteUri",
20457             "description": ""
20458           },
20459           {
20460             "group": "Body",
20461             "type": "String",
20462             "optional": true,
20463             "field": "password",
20464             "description": ""
20465           },
20466           {
20467             "group": "Body",
20468             "type": "String",
20469             "optional": true,
20470             "field": "clientId",
20471             "description": ""
20472           },
20473           {
20474             "group": "Body",
20475             "type": "String",
20476             "optional": true,
20477             "field": "clientSecret",
20478             "description": ""
20479           },
20480           {
20481             "group": "Body",
20482             "type": "String",
20483             "optional": true,
20484             "field": "securityToken",
20485             "description": ""
20486           },
20487           {
20488             "group": "Body",
20489             "type": "String",
20490             "optional": false,
20491             "field": "serverUrl",
20492             "description": ""
20493           },
20494           {
20495             "group": "Body",
20496             "type": "String",
20497             "allowedValues": [
20498               "\"integrationTab\"",
20499               "\"newTab\""
20500             ],
20501             "optional": true,
20502             "field": "type",
20503             "description": ""
20504           }
20505         ]
20506       }
20507     },
20508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20509     "version": "0.0.0",
20510     "filename": "server/api/intSalesforceAccount/index.js",
20511     "groupTitle": "Salesforce_Accounts"
20512   },
20513   {
20514     "type": "delete",
20515     "url": "/api/integrations/salesforce/accounts/{id}",
20516     "title": "Deletes a Salesforce Account",
20517     "examples": [
20518       {
20519         "title": "Example usage:",
20520         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20521         "type": "json"
20522       }
20523     ],
20524     "name": "DeleteSalesforce_Accounts",
20525     "group": "Salesforce_Accounts",
20526     "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>",
20527     "version": "0.0.0",
20528     "filename": "server/api/intSalesforceAccount/index.js",
20529     "groupTitle": "Salesforce_Accounts"
20530   },
20531   {
20532     "type": "get",
20533     "url": "/api/integrations/salesforce/accounts",
20534     "title": "Gets a list of Salesforce Accounts",
20535     "examples": [
20536       {
20537         "title": "Example usage:",
20538         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20539         "type": "json"
20540       }
20541     ],
20542     "name": "GetSalesforce_Accounts",
20543     "group": "Salesforce_Accounts",
20544     "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>",
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/{id}",
20552     "title": "Gets a single Salesforce Account",
20553     "examples": [
20554       {
20555         "title": "Example usage:",
20556         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20557         "type": "json"
20558       }
20559     ],
20560     "name": "ShowSalesforce_Accounts",
20561     "group": "Salesforce_Accounts",
20562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20563     "version": "0.0.0",
20564     "filename": "server/api/intSalesforceAccount/index.js",
20565     "groupTitle": "Salesforce_Accounts"
20566   },
20567   {
20568     "type": "post",
20569     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20570     "title": "Creates new configuration",
20571     "examples": [
20572       {
20573         "title": "Example usage:",
20574         "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",
20575         "type": "json"
20576       }
20577     ],
20578     "name": "addConfiguration",
20579     "group": "Salesforce_Accounts",
20580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
20587     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20588     "title": "Gets account configurations",
20589     "examples": [
20590       {
20591         "title": "Example usage:",
20592         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20593         "type": "json"
20594       }
20595     ],
20596     "name": "getConfigurations",
20597     "group": "Salesforce_Accounts",
20598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
20606     "title": "Gets account fields",
20607     "examples": [
20608       {
20609         "title": "Example usage:",
20610         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20611         "type": "json"
20612       }
20613     ],
20614     "name": "getFields",
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": "put",
20623     "url": "/api/integrations/salesforce/accounts/{id}",
20624     "title": "Update an existing Salesforce Account",
20625     "examples": [
20626       {
20627         "title": "Example usage:",
20628         "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",
20629         "type": "json"
20630       }
20631     ],
20632     "name": "updateSalesforce_Accounts",
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": "post",
20641     "url": "/api/integrations/salesforce/configurations",
20642     "title": "Creates a new Salesforce Configuration",
20643     "examples": [
20644       {
20645         "title": "Example usage:",
20646         "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",
20647         "type": "json"
20648       }
20649     ],
20650     "name": "CreateSalesforce_Configurations",
20651     "group": "Salesforce_Configurations",
20652     "parameter": {
20653       "fields": {
20654         "Body": [
20655           {
20656             "group": "Body",
20657             "type": "String",
20658             "optional": true,
20659             "field": "name",
20660             "description": ""
20661           },
20662           {
20663             "group": "Body",
20664             "type": "String",
20665             "optional": true,
20666             "field": "description",
20667             "description": ""
20668           },
20669           {
20670             "group": "Body",
20671             "type": "String",
20672             "allowedValues": [
20673               "\"Task\"",
20674               "\"Case\""
20675             ],
20676             "optional": true,
20677             "field": "ticketType",
20678             "description": ""
20679           },
20680           {
20681             "group": "Body",
20682             "type": "String",
20683             "allowedValues": [
20684               "\"contact_lead\"",
20685               "\"contact\"",
20686               "\"lead\"",
20687               "\"account_contact_lead\"",
20688               "\"account\""
20689             ],
20690             "optional": true,
20691             "field": "moduleSearch",
20692             "description": ""
20693           },
20694           {
20695             "group": "Body",
20696             "type": "String",
20697             "allowedValues": [
20698               "\"nothing\"",
20699               "\"contact\"",
20700               "\"lead\"",
20701               "\"account\""
20702             ],
20703             "optional": true,
20704             "field": "moduleCreate",
20705             "description": ""
20706           },
20707           {
20708             "group": "Body",
20709             "type": "String",
20710             "optional": true,
20711             "field": "leadId",
20712             "description": ""
20713           },
20714           {
20715             "group": "Body",
20716             "type": "String",
20717             "optional": true,
20718             "field": "additionalSearchAccount",
20719             "description": ""
20720           },
20721           {
20722             "group": "Body",
20723             "type": "String",
20724             "optional": true,
20725             "field": "additionalSearchContact",
20726             "description": ""
20727           },
20728           {
20729             "group": "Body",
20730             "type": "String",
20731             "optional": true,
20732             "field": "additionalSearchLead",
20733             "description": ""
20734           }
20735         ]
20736       }
20737     },
20738     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20739     "version": "0.0.0",
20740     "filename": "server/api/intSalesforceConfiguration/index.js",
20741     "groupTitle": "Salesforce_Configurations"
20742   },
20743   {
20744     "type": "delete",
20745     "url": "/api/integrations/salesforce/configurations/{id}",
20746     "title": "Deletes a Salesforce Configuration",
20747     "examples": [
20748       {
20749         "title": "Example usage:",
20750         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20751         "type": "json"
20752       }
20753     ],
20754     "name": "DeleteSalesforce_Configurations",
20755     "group": "Salesforce_Configurations",
20756     "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>",
20757     "version": "0.0.0",
20758     "filename": "server/api/intSalesforceConfiguration/index.js",
20759     "groupTitle": "Salesforce_Configurations"
20760   },
20761   {
20762     "type": "get",
20763     "url": "/api/integrations/salesforce/configurations",
20764     "title": "Gets a list of Salesforce Configurations",
20765     "examples": [
20766       {
20767         "title": "Example usage:",
20768         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20769         "type": "json"
20770       }
20771     ],
20772     "name": "GetSalesforce_Configurations",
20773     "group": "Salesforce_Configurations",
20774     "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>",
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/{id}",
20782     "title": "Gets a single Salesforce Configuration",
20783     "examples": [
20784       {
20785         "title": "Example usage:",
20786         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20787         "type": "json"
20788       }
20789     ],
20790     "name": "ShowSalesforce_Configurations",
20791     "group": "Salesforce_Configurations",
20792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
20800     "title": "Gets configurations descriptions",
20801     "examples": [
20802       {
20803         "title": "Example usage:",
20804         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20805         "type": "json"
20806       }
20807     ],
20808     "name": "getDescriptions",
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}/fields",
20818     "title": "Gets configurations fields",
20819     "examples": [
20820       {
20821         "title": "Example usage:",
20822         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20823         "type": "json"
20824       }
20825     ],
20826     "name": "getFields",
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}/subjects",
20836     "title": "Gets configurations subjects",
20837     "examples": [
20838       {
20839         "title": "Example usage:",
20840         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20841         "type": "json"
20842       }
20843     ],
20844     "name": "getSubjects",
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": "put",
20853     "url": "/api/integrations/salesforce/configurations/{id}",
20854     "title": "Update an existing Salesforce Configuration",
20855     "examples": [
20856       {
20857         "title": "Example usage:",
20858         "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",
20859         "type": "json"
20860       }
20861     ],
20862     "name": "updateSalesforce_Configurations",
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": "post",
20871     "url": "/api/integrations/salesforce/fields",
20872     "title": "Creates a new Salesforce Field",
20873     "examples": [
20874       {
20875         "title": "Example usage:",
20876         "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",
20877         "type": "json"
20878       }
20879     ],
20880     "name": "CreateSalesforce_Fields",
20881     "group": "Salesforce_Fields",
20882     "parameter": {
20883       "fields": {
20884         "Body": [
20885           {
20886             "group": "Body",
20887             "type": "String",
20888             "allowedValues": [
20889               "\"string\"",
20890               "\"variable\"",
20891               "\"customVariable\"",
20892               "\"keyValue\"",
20893               "\"picklist\""
20894             ],
20895             "optional": true,
20896             "field": "type",
20897             "description": ""
20898           },
20899           {
20900             "group": "Body",
20901             "type": "String",
20902             "optional": true,
20903             "field": "content",
20904             "description": ""
20905           },
20906           {
20907             "group": "Body",
20908             "type": "String",
20909             "optional": true,
20910             "field": "key",
20911             "description": ""
20912           },
20913           {
20914             "group": "Body",
20915             "type": "String",
20916             "allowedValues": [
20917               "\"string\"",
20918               "\"variable\"",
20919               "\"customVariable\""
20920             ],
20921             "optional": true,
20922             "field": "keyType",
20923             "description": ""
20924           },
20925           {
20926             "group": "Body",
20927             "type": "String",
20928             "optional": true,
20929             "field": "keyContent",
20930             "description": ""
20931           },
20932           {
20933             "group": "Body",
20934             "type": "String",
20935             "optional": true,
20936             "field": "idField",
20937             "description": ""
20938           },
20939           {
20940             "group": "Body",
20941             "type": "String",
20942             "optional": true,
20943             "field": "variableName",
20944             "description": ""
20945           }
20946         ]
20947       }
20948     },
20949     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20950     "version": "0.0.0",
20951     "filename": "server/api/intSalesforceField/index.js",
20952     "groupTitle": "Salesforce_Fields"
20953   },
20954   {
20955     "type": "delete",
20956     "url": "/api/integrations/salesforce/fields/{id}",
20957     "title": "Deletes a Salesforce Field",
20958     "examples": [
20959       {
20960         "title": "Example usage:",
20961         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20962         "type": "json"
20963       }
20964     ],
20965     "name": "DeleteSalesforce_Fields",
20966     "group": "Salesforce_Fields",
20967     "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>",
20968     "version": "0.0.0",
20969     "filename": "server/api/intSalesforceField/index.js",
20970     "groupTitle": "Salesforce_Fields"
20971   },
20972   {
20973     "type": "get",
20974     "url": "/api/integrations/salesforce/fields",
20975     "title": "Gets a list of Salesforce Fields",
20976     "examples": [
20977       {
20978         "title": "Example usage:",
20979         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20980         "type": "json"
20981       }
20982     ],
20983     "name": "GetSalesforce_Fields",
20984     "group": "Salesforce_Fields",
20985     "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>",
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/{id}",
20993     "title": "Gets a single Salesforce Field",
20994     "examples": [
20995       {
20996         "title": "Example usage:",
20997         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20998         "type": "json"
20999       }
21000     ],
21001     "name": "ShowSalesforce_Fields",
21002     "group": "Salesforce_Fields",
21003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21004     "version": "0.0.0",
21005     "filename": "server/api/intSalesforceField/index.js",
21006     "groupTitle": "Salesforce_Fields"
21007   },
21008   {
21009     "type": "put",
21010     "url": "/api/integrations/salesforce/fields/{id}",
21011     "title": "Update an existing Salesforce Field",
21012     "examples": [
21013       {
21014         "title": "Example usage:",
21015         "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",
21016         "type": "json"
21017       }
21018     ],
21019     "name": "updateSalesforce_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": "post",
21028     "url": "/api/schedules",
21029     "title": "Creates a new Schedule",
21030     "examples": [
21031       {
21032         "title": "Example usage:",
21033         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21034         "type": "json"
21035       }
21036     ],
21037     "name": "CreateSchedules",
21038     "group": "Schedules",
21039     "parameter": {
21040       "fields": {
21041         "Body": [
21042           {
21043             "group": "Body",
21044             "type": "String",
21045             "optional": false,
21046             "field": "name",
21047             "description": ""
21048           },
21049           {
21050             "group": "Body",
21051             "type": "String",
21052             "optional": true,
21053             "field": "description",
21054             "description": ""
21055           },
21056           {
21057             "group": "Body",
21058             "type": "Boolean",
21059             "optional": false,
21060             "field": "active",
21061             "description": ""
21062           },
21063           {
21064             "group": "Body",
21065             "type": "String",
21066             "optional": false,
21067             "field": "cron",
21068             "description": ""
21069           },
21070           {
21071             "group": "Body",
21072             "type": "String",
21073             "optional": false,
21074             "field": "startAt",
21075             "description": ""
21076           },
21077           {
21078             "group": "Body",
21079             "type": "String",
21080             "optional": false,
21081             "field": "endAt",
21082             "description": ""
21083           },
21084           {
21085             "group": "Body",
21086             "type": "Integer",
21087             "optional": false,
21088             "field": "subtractNumber",
21089             "description": ""
21090           },
21091           {
21092             "group": "Body",
21093             "type": "String",
21094             "allowedValues": [
21095               "\"years\"",
21096               "\"quarters\"",
21097               "\"months\"",
21098               "\"weeks\"",
21099               "\"days\"",
21100               "\"hours\"",
21101               "\"minutes\""
21102             ],
21103             "optional": false,
21104             "field": "subtractUnit",
21105             "description": ""
21106           },
21107           {
21108             "group": "Body",
21109             "type": "String",
21110             "allowedValues": [
21111               "\"csv\"",
21112               "\"pdf\"",
21113               "\"xlsx\""
21114             ],
21115             "optional": false,
21116             "field": "output",
21117             "description": ""
21118           },
21119           {
21120             "group": "Body",
21121             "type": "String",
21122             "allowedValues": [
21123               "\"custom\"",
21124               "\"default\""
21125             ],
21126             "optional": false,
21127             "field": "type",
21128             "description": ""
21129           },
21130           {
21131             "group": "Body",
21132             "type": "Boolean",
21133             "optional": true,
21134             "field": "sendMail",
21135             "description": ""
21136           },
21137           {
21138             "group": "Body",
21139             "type": "String",
21140             "optional": true,
21141             "field": "email",
21142             "description": ""
21143           },
21144           {
21145             "group": "Body",
21146             "type": "Text",
21147             "optional": true,
21148             "field": "cc",
21149             "description": ""
21150           },
21151           {
21152             "group": "Body",
21153             "type": "Text",
21154             "optional": true,
21155             "field": "bcc",
21156             "description": ""
21157           },
21158           {
21159             "group": "Body",
21160             "type": "Boolean",
21161             "optional": true,
21162             "field": "sendIfEmpty",
21163             "description": ""
21164           }
21165         ]
21166       }
21167     },
21168     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21169     "version": "0.0.0",
21170     "filename": "server/api/schedule/index.js",
21171     "groupTitle": "Schedules"
21172   },
21173   {
21174     "type": "delete",
21175     "url": "/api/schedules/{id}",
21176     "title": "Deletes a Schedule",
21177     "examples": [
21178       {
21179         "title": "Example usage:",
21180         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21181         "type": "json"
21182       }
21183     ],
21184     "name": "DeleteSchedules",
21185     "group": "Schedules",
21186     "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>",
21187     "version": "0.0.0",
21188     "filename": "server/api/schedule/index.js",
21189     "groupTitle": "Schedules"
21190   },
21191   {
21192     "type": "get",
21193     "url": "/api/schedules",
21194     "title": "Gets a list of Schedules",
21195     "examples": [
21196       {
21197         "title": "Example usage:",
21198         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21199         "type": "json"
21200       }
21201     ],
21202     "name": "GetSchedules",
21203     "group": "Schedules",
21204     "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>",
21205     "version": "0.0.0",
21206     "filename": "server/api/schedule/index.js",
21207     "groupTitle": "Schedules"
21208   },
21209   {
21210     "type": "get",
21211     "url": "/api/schedules/{id}",
21212     "title": "Gets a single Schedule",
21213     "examples": [
21214       {
21215         "title": "Example usage:",
21216         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21217         "type": "json"
21218       }
21219     ],
21220     "name": "ShowSchedules",
21221     "group": "Schedules",
21222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/run",
21230     "title": "Run Scheduler",
21231     "examples": [
21232       {
21233         "title": "Example usage:",
21234         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21235         "type": "json"
21236       }
21237     ],
21238     "name": "run",
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": "put",
21247     "url": "/api/schedules/{id}",
21248     "title": "Update an existing Schedule",
21249     "examples": [
21250       {
21251         "title": "Example usage:",
21252         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21253         "type": "json"
21254       }
21255     ],
21256     "name": "updateSchedules",
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": "post",
21265     "url": "/api/screen/recordings",
21266     "title": "Creates a new Recording",
21267     "examples": [
21268       {
21269         "title": "Example usage:",
21270         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21271         "type": "json"
21272       }
21273     ],
21274     "name": "CreateRecordings",
21275     "group": "Screen_Recordings",
21276     "parameter": {
21277       "fields": {
21278         "Body": [
21279           {
21280             "group": "Body",
21281             "type": "Virtual",
21282             "optional": true,
21283             "field": "format",
21284             "description": ""
21285           },
21286           {
21287             "group": "Body",
21288             "type": "String",
21289             "optional": true,
21290             "field": "interactionid",
21291             "description": ""
21292           },
21293           {
21294             "group": "Body",
21295             "type": "String",
21296             "optional": true,
21297             "field": "channel",
21298             "description": ""
21299           },
21300           {
21301             "group": "Body",
21302             "type": "String",
21303             "optional": true,
21304             "field": "value",
21305             "description": ""
21306           },
21307           {
21308             "group": "Body",
21309             "type": "Integer",
21310             "optional": true,
21311             "field": "rating",
21312             "description": ""
21313           },
21314           {
21315             "group": "Body",
21316             "type": "Integer",
21317             "optional": true,
21318             "field": "duration",
21319             "description": ""
21320           },
21321           {
21322             "group": "Body",
21323             "type": "String",
21324             "optional": true,
21325             "field": "startedAt",
21326             "description": ""
21327           },
21328           {
21329             "group": "Body",
21330             "type": "String",
21331             "optional": true,
21332             "field": "closedAt",
21333             "description": ""
21334           },
21335           {
21336             "group": "Body",
21337             "type": "String",
21338             "optional": true,
21339             "field": "createdAt",
21340             "description": ""
21341           },
21342           {
21343             "group": "Body",
21344             "type": "String",
21345             "optional": true,
21346             "field": "updatedAt",
21347             "description": ""
21348           }
21349         ]
21350       }
21351     },
21352     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21353     "version": "0.0.0",
21354     "filename": "server/api/screenRecording/index.js",
21355     "groupTitle": "Screen_Recordings"
21356   },
21357   {
21358     "type": "get",
21359     "url": "/api/screen/recordings/describe",
21360     "title": "Gets table info about Recordings",
21361     "examples": [
21362       {
21363         "title": "Example usage:",
21364         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21365         "type": "json"
21366       }
21367     ],
21368     "name": "DescribeRecordings",
21369     "group": "Screen_Recordings",
21370     "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>",
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",
21378     "title": "Gets a list of Recordings",
21379     "examples": [
21380       {
21381         "title": "Example usage:",
21382         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21383         "type": "json"
21384       }
21385     ],
21386     "name": "GetRecordings",
21387     "group": "Screen_Recordings",
21388     "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>",
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/{id}",
21396     "title": "Gets a single Recording",
21397     "examples": [
21398       {
21399         "title": "Example usage:",
21400         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21401         "type": "json"
21402       }
21403     ],
21404     "name": "ShowRecordings",
21405     "group": "Screen_Recordings",
21406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21407     "version": "0.0.0",
21408     "filename": "server/api/screenRecording/index.js",
21409     "groupTitle": "Screen_Recordings"
21410   },
21411   {
21412     "type": "delete",
21413     "url": "/api/screen/recordings/{id}",
21414     "title": "Delete screen recording",
21415     "examples": [
21416       {
21417         "title": "Example usage:",
21418         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21419         "type": "json"
21420       }
21421     ],
21422     "name": "destroy",
21423     "group": "Screen_Recordings",
21424     "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>",
21425     "version": "0.0.0",
21426     "filename": "server/api/screenRecording/index.js",
21427     "groupTitle": "Screen_Recordings"
21428   },
21429   {
21430     "type": "get",
21431     "url": "/api/screen/recordings/{id}/download",
21432     "title": "Download Recording",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "download",
21441     "group": "Screen_Recordings",
21442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
21449     "url": "/api/screen/recordings/{id}",
21450     "title": "Update an existing Recording",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "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",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "updateRecordings",
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": "post",
21467     "url": "/api/integrations/servicenow/accounts",
21468     "title": "Creates a new Servicenow Account",
21469     "examples": [
21470       {
21471         "title": "Example usage:",
21472         "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",
21473         "type": "json"
21474       }
21475     ],
21476     "name": "CreateServicenow_Accounts",
21477     "group": "Servicenow_Accounts",
21478     "parameter": {
21479       "fields": {
21480         "Body": [
21481           {
21482             "group": "Body",
21483             "type": "String",
21484             "optional": true,
21485             "field": "name",
21486             "description": ""
21487           },
21488           {
21489             "group": "Body",
21490             "type": "String",
21491             "optional": true,
21492             "field": "description",
21493             "description": ""
21494           },
21495           {
21496             "group": "Body",
21497             "type": "String",
21498             "optional": true,
21499             "field": "username",
21500             "description": ""
21501           },
21502           {
21503             "group": "Body",
21504             "type": "String",
21505             "optional": true,
21506             "field": "password",
21507             "description": ""
21508           },
21509           {
21510             "group": "Body",
21511             "type": "String",
21512             "optional": true,
21513             "field": "email",
21514             "description": ""
21515           },
21516           {
21517             "group": "Body",
21518             "type": "String",
21519             "optional": true,
21520             "field": "remoteUri",
21521             "description": ""
21522           },
21523           {
21524             "group": "Body",
21525             "type": "String",
21526             "optional": false,
21527             "field": "serverUrl",
21528             "description": ""
21529           }
21530         ]
21531       }
21532     },
21533     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21534     "version": "0.0.0",
21535     "filename": "server/api/intServicenowAccount/index.js",
21536     "groupTitle": "Servicenow_Accounts"
21537   },
21538   {
21539     "type": "delete",
21540     "url": "/api/integrations/servicenow/accounts/{id}",
21541     "title": "Deletes a Servicenow Account",
21542     "examples": [
21543       {
21544         "title": "Example usage:",
21545         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21546         "type": "json"
21547       }
21548     ],
21549     "name": "DeleteServicenow_Accounts",
21550     "group": "Servicenow_Accounts",
21551     "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>",
21552     "version": "0.0.0",
21553     "filename": "server/api/intServicenowAccount/index.js",
21554     "groupTitle": "Servicenow_Accounts"
21555   },
21556   {
21557     "type": "get",
21558     "url": "/api/integrations/servicenow/accounts",
21559     "title": "Gets a list of Servicenow Accounts",
21560     "examples": [
21561       {
21562         "title": "Example usage:",
21563         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21564         "type": "json"
21565       }
21566     ],
21567     "name": "GetServicenow_Accounts",
21568     "group": "Servicenow_Accounts",
21569     "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>",
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/{id}",
21577     "title": "Gets a single Servicenow Account",
21578     "examples": [
21579       {
21580         "title": "Example usage:",
21581         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21582         "type": "json"
21583       }
21584     ],
21585     "name": "ShowServicenow_Accounts",
21586     "group": "Servicenow_Accounts",
21587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21588     "version": "0.0.0",
21589     "filename": "server/api/intServicenowAccount/index.js",
21590     "groupTitle": "Servicenow_Accounts"
21591   },
21592   {
21593     "type": "post",
21594     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21595     "title": "Creates new configuration",
21596     "examples": [
21597       {
21598         "title": "Example usage:",
21599         "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",
21600         "type": "json"
21601       }
21602     ],
21603     "name": "addConfiguration",
21604     "group": "Servicenow_Accounts",
21605     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
21612     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21613     "title": "Gets account configurations",
21614     "examples": [
21615       {
21616         "title": "Example usage:",
21617         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21618         "type": "json"
21619       }
21620     ],
21621     "name": "getConfigurations",
21622     "group": "Servicenow_Accounts",
21623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
21631     "title": "Gets account fields",
21632     "examples": [
21633       {
21634         "title": "Example usage:",
21635         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21636         "type": "json"
21637       }
21638     ],
21639     "name": "getFields",
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": "put",
21648     "url": "/api/integrations/servicenow/accounts/{id}",
21649     "title": "Update an existing Servicenow Account",
21650     "examples": [
21651       {
21652         "title": "Example usage:",
21653         "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",
21654         "type": "json"
21655       }
21656     ],
21657     "name": "updateServicenow_Accounts",
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": "post",
21666     "url": "/api/integrations/servicenow/configurations",
21667     "title": "Creates a new Servicenow Configuration",
21668     "examples": [
21669       {
21670         "title": "Example usage:",
21671         "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",
21672         "type": "json"
21673       }
21674     ],
21675     "name": "CreateServicenow_Configurations",
21676     "group": "Servicenow_Configurations",
21677     "parameter": {
21678       "fields": {
21679         "Body": [
21680           {
21681             "group": "Body",
21682             "type": "String",
21683             "optional": true,
21684             "field": "name",
21685             "description": ""
21686           },
21687           {
21688             "group": "Body",
21689             "type": "String",
21690             "optional": true,
21691             "field": "description",
21692             "description": ""
21693           }
21694         ]
21695       }
21696     },
21697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21698     "version": "0.0.0",
21699     "filename": "server/api/intServicenowConfiguration/index.js",
21700     "groupTitle": "Servicenow_Configurations"
21701   },
21702   {
21703     "type": "delete",
21704     "url": "/api/integrations/servicenow/configurations/{id}",
21705     "title": "Deletes a Servicenow Configuration",
21706     "examples": [
21707       {
21708         "title": "Example usage:",
21709         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21710         "type": "json"
21711       }
21712     ],
21713     "name": "DeleteServicenow_Configurations",
21714     "group": "Servicenow_Configurations",
21715     "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>",
21716     "version": "0.0.0",
21717     "filename": "server/api/intServicenowConfiguration/index.js",
21718     "groupTitle": "Servicenow_Configurations"
21719   },
21720   {
21721     "type": "get",
21722     "url": "/api/integrations/servicenow/configurations",
21723     "title": "Gets a list of Servicenow Configurations",
21724     "examples": [
21725       {
21726         "title": "Example usage:",
21727         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21728         "type": "json"
21729       }
21730     ],
21731     "name": "GetServicenow_Configurations",
21732     "group": "Servicenow_Configurations",
21733     "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>",
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/{id}",
21741     "title": "Gets a single Servicenow Configuration",
21742     "examples": [
21743       {
21744         "title": "Example usage:",
21745         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21746         "type": "json"
21747       }
21748     ],
21749     "name": "ShowServicenow_Configurations",
21750     "group": "Servicenow_Configurations",
21751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
21759     "title": "Gets configurations descriptions",
21760     "examples": [
21761       {
21762         "title": "Example usage:",
21763         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21764         "type": "json"
21765       }
21766     ],
21767     "name": "getDescriptions",
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}/fields",
21777     "title": "Gets configurations fields",
21778     "examples": [
21779       {
21780         "title": "Example usage:",
21781         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21782         "type": "json"
21783       }
21784     ],
21785     "name": "getFields",
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}/subjects",
21795     "title": "Gets configurations subjects",
21796     "examples": [
21797       {
21798         "title": "Example usage:",
21799         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21800         "type": "json"
21801       }
21802     ],
21803     "name": "getSubjects",
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": "put",
21812     "url": "/api/integrations/servicenow/configurations/{id}",
21813     "title": "Update an existing Servicenow Configuration",
21814     "examples": [
21815       {
21816         "title": "Example usage:",
21817         "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",
21818         "type": "json"
21819       }
21820     ],
21821     "name": "updateServicenow_Configurations",
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": "post",
21830     "url": "/api/integrations/servicenow/fields",
21831     "title": "Creates a new Servicenow Field",
21832     "examples": [
21833       {
21834         "title": "Example usage:",
21835         "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",
21836         "type": "json"
21837       }
21838     ],
21839     "name": "CreateServicenow_Fields",
21840     "group": "Servicenow_Fields",
21841     "parameter": {
21842       "fields": {
21843         "Body": [
21844           {
21845             "group": "Body",
21846             "type": "String",
21847             "allowedValues": [
21848               "\"string\"",
21849               "\"variable\"",
21850               "\"customVariable\"",
21851               "\"keyValue\"",
21852               "\"picklist\""
21853             ],
21854             "optional": true,
21855             "field": "type",
21856             "description": ""
21857           },
21858           {
21859             "group": "Body",
21860             "type": "String",
21861             "optional": true,
21862             "field": "content",
21863             "description": ""
21864           },
21865           {
21866             "group": "Body",
21867             "type": "String",
21868             "optional": true,
21869             "field": "key",
21870             "description": ""
21871           },
21872           {
21873             "group": "Body",
21874             "type": "String",
21875             "allowedValues": [
21876               "\"string\"",
21877               "\"variable\"",
21878               "\"customVariable\""
21879             ],
21880             "optional": true,
21881             "field": "keyType",
21882             "description": ""
21883           },
21884           {
21885             "group": "Body",
21886             "type": "String",
21887             "optional": true,
21888             "field": "keyContent",
21889             "description": ""
21890           },
21891           {
21892             "group": "Body",
21893             "type": "String",
21894             "optional": true,
21895             "field": "idField",
21896             "description": ""
21897           },
21898           {
21899             "group": "Body",
21900             "type": "String",
21901             "optional": true,
21902             "field": "nameField",
21903             "description": ""
21904           },
21905           {
21906             "group": "Body",
21907             "type": "Boolean",
21908             "optional": true,
21909             "field": "customField",
21910             "description": ""
21911           },
21912           {
21913             "group": "Body",
21914             "type": "String",
21915             "optional": true,
21916             "field": "variableName",
21917             "description": ""
21918           }
21919         ]
21920       }
21921     },
21922     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21923     "version": "0.0.0",
21924     "filename": "server/api/intServicenowField/index.js",
21925     "groupTitle": "Servicenow_Fields"
21926   },
21927   {
21928     "type": "delete",
21929     "url": "/api/integrations/servicenow/fields/{id}",
21930     "title": "Deletes a Servicenow Field",
21931     "examples": [
21932       {
21933         "title": "Example usage:",
21934         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21935         "type": "json"
21936       }
21937     ],
21938     "name": "DeleteServicenow_Fields",
21939     "group": "Servicenow_Fields",
21940     "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>",
21941     "version": "0.0.0",
21942     "filename": "server/api/intServicenowField/index.js",
21943     "groupTitle": "Servicenow_Fields"
21944   },
21945   {
21946     "type": "get",
21947     "url": "/api/integrations/servicenow/fields",
21948     "title": "Gets a list of Servicenow Fields",
21949     "examples": [
21950       {
21951         "title": "Example usage:",
21952         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21953         "type": "json"
21954       }
21955     ],
21956     "name": "GetServicenow_Fields",
21957     "group": "Servicenow_Fields",
21958     "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>",
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/{id}",
21966     "title": "Gets a single Servicenow Field",
21967     "examples": [
21968       {
21969         "title": "Example usage:",
21970         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21971         "type": "json"
21972       }
21973     ],
21974     "name": "ShowServicenow_Fields",
21975     "group": "Servicenow_Fields",
21976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21977     "version": "0.0.0",
21978     "filename": "server/api/intServicenowField/index.js",
21979     "groupTitle": "Servicenow_Fields"
21980   },
21981   {
21982     "type": "put",
21983     "url": "/api/integrations/servicenow/fields/{id}",
21984     "title": "Update an existing Servicenow Field",
21985     "examples": [
21986       {
21987         "title": "Example usage:",
21988         "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",
21989         "type": "json"
21990       }
21991     ],
21992     "name": "updateServicenow_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": "get",
22001     "url": "/api/settings",
22002     "title": "Gets a list of Settings",
22003     "examples": [
22004       {
22005         "title": "Example usage:",
22006         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22007         "type": "json"
22008       }
22009     ],
22010     "name": "GetSettings",
22011     "group": "Settings",
22012     "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>",
22013     "version": "0.0.0",
22014     "filename": "server/api/setting/index.js",
22015     "groupTitle": "Settings"
22016   },
22017   {
22018     "type": "get",
22019     "url": "/api/settings/{id}",
22020     "title": "Gets a single Setting",
22021     "examples": [
22022       {
22023         "title": "Example usage:",
22024         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22025         "type": "json"
22026       }
22027     ],
22028     "name": "ShowSettings",
22029     "group": "Settings",
22030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22031     "version": "0.0.0",
22032     "filename": "server/api/setting/index.js",
22033     "groupTitle": "Settings"
22034   },
22035   {
22036     "type": "post",
22037     "url": "/api/settings/{id}/favicon",
22038     "title": "Add Favicon",
22039     "examples": [
22040       {
22041         "title": "Example usage:",
22042         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22043         "type": "json"
22044       }
22045     ],
22046     "name": "addFavicon",
22047     "group": "Settings",
22048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/logo",
22056     "title": "Add logo",
22057     "examples": [
22058       {
22059         "title": "Example usage:",
22060         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22061         "type": "json"
22062       }
22063     ],
22064     "name": "addLogo",
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_login",
22074     "title": "Add logo login",
22075     "examples": [
22076       {
22077         "title": "Example usage:",
22078         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22079         "type": "json"
22080       }
22081     ],
22082     "name": "addLogoLogin",
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}/preferred",
22092     "title": "Add Preferred",
22093     "examples": [
22094       {
22095         "title": "Example usage:",
22096         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22097         "type": "json"
22098       }
22099     ],
22100     "name": "addPreferred",
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": "get",
22109     "url": "/api/settings/now",
22110     "title": "Get Server Current Date",
22111     "examples": [
22112       {
22113         "title": "Example usage:",
22114         "content": "curl https://{domain}/api/settings/now -v -X GET",
22115         "type": "json"
22116       }
22117     ],
22118     "name": "getDate",
22119     "group": "Settings",
22120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}/favicon",
22128     "title": "Get Favicon",
22129     "examples": [
22130       {
22131         "title": "Example usage:",
22132         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22133         "type": "json"
22134       }
22135     ],
22136     "name": "getFavicon",
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}/gdpr",
22146     "title": "Get gdpr settings",
22147     "examples": [
22148       {
22149         "title": "Example usage:",
22150         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22151         "type": "json"
22152       }
22153     ],
22154     "name": "getGdpr",
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}/logo",
22164     "title": "Get logo",
22165     "examples": [
22166       {
22167         "title": "Example usage:",
22168         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22169         "type": "json"
22170       }
22171     ],
22172     "name": "getLogo",
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_login",
22182     "title": "Get logo login",
22183     "examples": [
22184       {
22185         "title": "Example usage:",
22186         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22187         "type": "json"
22188       }
22189     ],
22190     "name": "getLogoLogin",
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}/preferred",
22200     "title": "Get Preferred",
22201     "examples": [
22202       {
22203         "title": "Example usage:",
22204         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22205         "type": "json"
22206       }
22207     ],
22208     "name": "getPreferred",
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": "put",
22217     "url": "/api/settings/{id}",
22218     "title": "Update an existing Setting",
22219     "examples": [
22220       {
22221         "title": "Example usage:",
22222         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22223         "type": "json"
22224       }
22225     ],
22226     "name": "updateSettings",
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": "post",
22235     "url": "/api/sms/accounts/{id}/users",
22236     "title": "Add agents to a sms account",
22237     "examples": [
22238       {
22239         "title": "Example usage:",
22240         "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",
22241         "type": "json"
22242       }
22243     ],
22244     "name": "AddAgents",
22245     "group": "Sms_Accounts",
22246     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22247     "version": "0.0.0",
22248     "filename": "server/api/smsAccount/index.js",
22249     "groupTitle": "Sms_Accounts"
22250   },
22251   {
22252     "type": "post",
22253     "url": "/api/sms/accounts",
22254     "title": "Creates a new Account",
22255     "examples": [
22256       {
22257         "title": "Example usage:",
22258         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22259         "type": "json"
22260       }
22261     ],
22262     "name": "CreateAccounts",
22263     "group": "Sms_Accounts",
22264     "parameter": {
22265       "fields": {
22266         "Body": [
22267           {
22268             "group": "Body",
22269             "type": "String",
22270             "optional": false,
22271             "field": "name",
22272             "description": ""
22273           },
22274           {
22275             "group": "Body",
22276             "type": "String",
22277             "optional": false,
22278             "field": "key",
22279             "description": ""
22280           },
22281           {
22282             "group": "Body",
22283             "type": "String",
22284             "optional": false,
22285             "field": "remote",
22286             "description": ""
22287           },
22288           {
22289             "group": "Body",
22290             "type": "String",
22291             "optional": true,
22292             "field": "token",
22293             "description": ""
22294           },
22295           {
22296             "group": "Body",
22297             "type": "String",
22298             "optional": true,
22299             "field": "phone",
22300             "description": ""
22301           },
22302           {
22303             "group": "Body",
22304             "type": "String",
22305             "allowedValues": [
22306               "\"twilio\"",
22307               "\"skebby\"",
22308               "\"connectel\"",
22309               "\"clicksend\"",
22310               "\"plivo\"",
22311               "\"clickatell\"",
22312               "\"bandwidth\"",
22313               "\"csc\"",
22314               "\"infobip\"",
22315               "\"intelepeer\""
22316             ],
22317             "optional": true,
22318             "field": "type",
22319             "description": ""
22320           },
22321           {
22322             "group": "Body",
22323             "type": "String",
22324             "optional": true,
22325             "field": "accountSid",
22326             "description": ""
22327           },
22328           {
22329             "group": "Body",
22330             "type": "String",
22331             "optional": true,
22332             "field": "authId",
22333             "description": ""
22334           },
22335           {
22336             "group": "Body",
22337             "type": "String",
22338             "optional": true,
22339             "field": "authToken",
22340             "description": ""
22341           },
22342           {
22343             "group": "Body",
22344             "type": "String",
22345             "allowedValues": [
22346               "\"SI\"",
22347               "\"TI\"",
22348               "\"GP\""
22349             ],
22350             "optional": true,
22351             "field": "smsMethod",
22352             "description": ""
22353           },
22354           {
22355             "group": "Body",
22356             "type": "String",
22357             "optional": true,
22358             "field": "username",
22359             "description": ""
22360           },
22361           {
22362             "group": "Body",
22363             "type": "String",
22364             "optional": true,
22365             "field": "password",
22366             "description": ""
22367           },
22368           {
22369             "group": "Body",
22370             "type": "String",
22371             "optional": true,
22372             "field": "apiKey",
22373             "description": ""
22374           },
22375           {
22376             "group": "Body",
22377             "type": "String",
22378             "optional": true,
22379             "field": "applicationId",
22380             "description": ""
22381           },
22382           {
22383             "group": "Body",
22384             "type": "String",
22385             "optional": true,
22386             "field": "accountId",
22387             "description": ""
22388           },
22389           {
22390             "group": "Body",
22391             "type": "String",
22392             "optional": true,
22393             "field": "senderString",
22394             "description": ""
22395           },
22396           {
22397             "group": "Body",
22398             "type": "Boolean",
22399             "optional": true,
22400             "field": "deliveryReport",
22401             "description": ""
22402           },
22403           {
22404             "group": "Body",
22405             "type": "String",
22406             "optional": true,
22407             "field": "description",
22408             "description": ""
22409           },
22410           {
22411             "group": "Body",
22412             "type": "Text",
22413             "optional": true,
22414             "field": "notificationTemplate",
22415             "description": ""
22416           },
22417           {
22418             "group": "Body",
22419             "type": "Boolean",
22420             "optional": true,
22421             "field": "notificationSound",
22422             "description": ""
22423           },
22424           {
22425             "group": "Body",
22426             "type": "Boolean",
22427             "optional": true,
22428             "field": "notificationShake",
22429             "description": ""
22430           },
22431           {
22432             "group": "Body",
22433             "type": "Integer",
22434             "optional": true,
22435             "field": "waitForTheAssignedAgent",
22436             "description": ""
22437           },
22438           {
22439             "group": "Body",
22440             "type": "Boolean",
22441             "optional": true,
22442             "field": "queueTransfer",
22443             "description": ""
22444           },
22445           {
22446             "group": "Body",
22447             "type": "Integer",
22448             "optional": true,
22449             "field": "queueTransferTimeout",
22450             "description": ""
22451           },
22452           {
22453             "group": "Body",
22454             "type": "Boolean",
22455             "optional": true,
22456             "field": "agentTransfer",
22457             "description": ""
22458           },
22459           {
22460             "group": "Body",
22461             "type": "Integer",
22462             "optional": true,
22463             "field": "agentTransferTimeout",
22464             "description": ""
22465           },
22466           {
22467             "group": "Body",
22468             "type": "String",
22469             "optional": true,
22470             "field": "baseUrl",
22471             "description": ""
22472           },
22473           {
22474             "group": "Body",
22475             "type": "Integer",
22476             "optional": true,
22477             "field": "mandatoryDispositionPauseId",
22478             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22479           },
22480           {
22481             "group": "Body",
22482             "type": "Boolean",
22483             "optional": true,
22484             "field": "mandatoryDisposition",
22485             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22486           }
22487         ]
22488       }
22489     },
22490     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22491     "version": "0.0.0",
22492     "filename": "server/api/smsAccount/index.js",
22493     "groupTitle": "Sms_Accounts"
22494   },
22495   {
22496     "type": "delete",
22497     "url": "/api/sms/accounts/{id}",
22498     "title": "Deletes a Account",
22499     "examples": [
22500       {
22501         "title": "Example usage:",
22502         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22503         "type": "json"
22504       }
22505     ],
22506     "name": "DeleteAccounts",
22507     "group": "Sms_Accounts",
22508     "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>",
22509     "version": "0.0.0",
22510     "filename": "server/api/smsAccount/index.js",
22511     "groupTitle": "Sms_Accounts"
22512   },
22513   {
22514     "type": "get",
22515     "url": "/api/sms/accounts/describe",
22516     "title": "Gets table info about Accounts",
22517     "examples": [
22518       {
22519         "title": "Example usage:",
22520         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22521         "type": "json"
22522       }
22523     ],
22524     "name": "DescribeAccounts",
22525     "group": "Sms_Accounts",
22526     "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>",
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",
22534     "title": "Gets a list of Accounts",
22535     "examples": [
22536       {
22537         "title": "Example usage:",
22538         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22539         "type": "json"
22540       }
22541     ],
22542     "name": "GetAccounts",
22543     "group": "Sms_Accounts",
22544     "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>",
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/{id}/users",
22552     "title": "Gets agents from sms account",
22553     "examples": [
22554       {
22555         "title": "Example usage:",
22556         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22557         "type": "json"
22558       }
22559     ],
22560     "name": "GetAgents",
22561     "group": "Sms_Accounts",
22562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22563     "version": "0.0.0",
22564     "filename": "server/api/smsAccount/index.js",
22565     "groupTitle": "Sms_Accounts"
22566   },
22567   {
22568     "type": "delete",
22569     "url": "/api/sms/accounts/{id}/users",
22570     "title": "Removes agents from a sms account",
22571     "examples": [
22572       {
22573         "title": "Example usage:",
22574         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22575         "type": "json"
22576       }
22577     ],
22578     "name": "RemoveAgents",
22579     "group": "Sms_Accounts",
22580     "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>",
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}/canned_answers",
22588     "title": "Removes canned answers from account",
22589     "examples": [
22590       {
22591         "title": "Example usage:",
22592         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22593         "type": "json"
22594       }
22595     ],
22596     "name": "RemoveAnswers",
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}/dispositions",
22606     "title": "Removes dispositions from account",
22607     "examples": [
22608       {
22609         "title": "Example usage:",
22610         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22611         "type": "json"
22612       }
22613     ],
22614     "name": "RemoveDispositions",
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": "get",
22623     "url": "/api/sms/accounts/{id}",
22624     "title": "Gets a single Account",
22625     "examples": [
22626       {
22627         "title": "Example usage:",
22628         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22629         "type": "json"
22630       }
22631     ],
22632     "name": "ShowAccounts",
22633     "group": "Sms_Accounts",
22634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
22641     "url": "/api/sms/messages/{id}/accept",
22642     "title": "Accepts message",
22643     "examples": [
22644       {
22645         "title": "Example usage:",
22646         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22647         "type": "json"
22648       }
22649     ],
22650     "name": "acceptMessage",
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/smsMessage/index.js",
22655     "groupTitle": "Sms_Accounts"
22656   },
22657   {
22658     "type": "post",
22659     "url": "/api/sms/accounts/{id}/canned_answers",
22660     "title": "Creates new canned answer",
22661     "examples": [
22662       {
22663         "title": "Example usage:",
22664         "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",
22665         "type": "json"
22666       }
22667     ],
22668     "name": "addAnswer",
22669     "group": "Sms_Accounts",
22670     "parameter": {
22671       "fields": {
22672         "Body": [
22673           {
22674             "group": "Body",
22675             "type": "String",
22676             "optional": false,
22677             "field": "key",
22678             "description": ""
22679           },
22680           {
22681             "group": "Body",
22682             "type": "Text",
22683             "optional": false,
22684             "field": "value",
22685             "description": ""
22686           },
22687           {
22688             "group": "Body",
22689             "type": "String",
22690             "optional": true,
22691             "field": "description",
22692             "description": ""
22693           },
22694           {
22695             "group": "Body",
22696             "type": "Virtual",
22697             "optional": true,
22698             "field": "name",
22699             "description": ""
22700           }
22701         ]
22702       }
22703     },
22704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22705     "version": "0.0.0",
22706     "filename": "server/api/smsAccount/index.js",
22707     "groupTitle": "Sms_Accounts"
22708   },
22709   {
22710     "type": "post",
22711     "url": "/api/sms/accounts/{id}/applications",
22712     "title": "Creates new applications",
22713     "examples": [
22714       {
22715         "title": "Example usage:",
22716         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22717         "type": "json"
22718       }
22719     ],
22720     "name": "addApplications",
22721     "group": "Sms_Accounts",
22722     "parameter": {
22723       "fields": {
22724         "Body": [
22725           {
22726             "group": "Body",
22727             "type": "Integer",
22728             "optional": false,
22729             "field": "priority",
22730             "description": ""
22731           },
22732           {
22733             "group": "Body",
22734             "type": "String",
22735             "optional": false,
22736             "field": "app",
22737             "description": ""
22738           },
22739           {
22740             "group": "Body",
22741             "type": "Text",
22742             "optional": true,
22743             "field": "appdata",
22744             "description": ""
22745           },
22746           {
22747             "group": "Body",
22748             "type": "String",
22749             "optional": true,
22750             "field": "description",
22751             "description": ""
22752           },
22753           {
22754             "group": "Body",
22755             "type": "String",
22756             "optional": true,
22757             "field": "interval",
22758             "description": ""
22759           }
22760         ]
22761       }
22762     },
22763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22764     "version": "0.0.0",
22765     "filename": "server/api/smsAccount/index.js",
22766     "groupTitle": "Sms_Accounts"
22767   },
22768   {
22769     "type": "post",
22770     "url": "/api/sms/accounts/{id}/dispositions",
22771     "title": "Creates new disposition",
22772     "examples": [
22773       {
22774         "title": "Example usage:",
22775         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22776         "type": "json"
22777       }
22778     ],
22779     "name": "addDisposition",
22780     "group": "Sms_Accounts",
22781     "parameter": {
22782       "fields": {
22783         "Body": [
22784           {
22785             "group": "Body",
22786             "type": "String",
22787             "optional": false,
22788             "field": "name",
22789             "description": ""
22790           },
22791           {
22792             "group": "Body",
22793             "type": "String",
22794             "allowedValues": [
22795               "\"first\"",
22796               "\"second\"",
22797               "\"third\""
22798             ],
22799             "optional": false,
22800             "field": "level",
22801             "description": ""
22802           },
22803           {
22804             "group": "Body",
22805             "type": "String",
22806             "optional": true,
22807             "field": "description",
22808             "description": ""
22809           }
22810         ]
22811       }
22812     },
22813     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22814     "version": "0.0.0",
22815     "filename": "server/api/smsAccount/index.js",
22816     "groupTitle": "Sms_Accounts"
22817   },
22818   {
22819     "type": "get",
22820     "url": "/api/sms/accounts/{id}/canned_answers",
22821     "title": "Gets account canned answers",
22822     "examples": [
22823       {
22824         "title": "Example usage:",
22825         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22826         "type": "json"
22827       }
22828     ],
22829     "name": "getAnswers",
22830     "group": "Sms_Accounts",
22831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
22839     "title": "Gets account applications",
22840     "examples": [
22841       {
22842         "title": "Example usage:",
22843         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22844         "type": "json"
22845       }
22846     ],
22847     "name": "getApplications",
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}/dispositions",
22857     "title": "Gets account dispositions",
22858     "examples": [
22859       {
22860         "title": "Example usage:",
22861         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22862         "type": "json"
22863       }
22864     ],
22865     "name": "getDispositions",
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}/interactions",
22875     "title": "Gets Sms Account interactions",
22876     "examples": [
22877       {
22878         "title": "Example usage:",
22879         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22880         "type": "json"
22881       }
22882     ],
22883     "name": "getInteractions",
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": "post",
22892     "url": "/api/sms/accounts/{id}/notify",
22893     "title": "Notify new message",
22894     "examples": [
22895       {
22896         "title": "Example usage:",
22897         "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",
22898         "type": "json"
22899       }
22900     ],
22901     "name": "notify",
22902     "group": "Sms_Accounts",
22903     "description": "<p>Motion 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>",
22904     "version": "0.0.0",
22905     "filename": "server/api/smsAccount/index.js",
22906     "groupTitle": "Sms_Accounts"
22907   },
22908   {
22909     "type": "put",
22910     "url": "/api/sms/messages/{id}/reject",
22911     "title": "Rejects message",
22912     "examples": [
22913       {
22914         "title": "Example usage:",
22915         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22916         "type": "json"
22917       }
22918     ],
22919     "name": "rejectMessage",
22920     "group": "Sms_Accounts",
22921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22922     "version": "0.0.0",
22923     "filename": "server/api/smsMessage/index.js",
22924     "groupTitle": "Sms_Accounts"
22925   },
22926   {
22927     "type": "post",
22928     "url": "/api/sms/accounts/{id}/send",
22929     "title": "Send new sms message",
22930     "examples": [
22931       {
22932         "title": "Example usage:",
22933         "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",
22934         "type": "json"
22935       }
22936     ],
22937     "name": "sendSms",
22938     "group": "Sms_Accounts",
22939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22940     "version": "0.0.0",
22941     "filename": "server/api/smsAccount/index.js",
22942     "groupTitle": "Sms_Accounts"
22943   },
22944   {
22945     "type": "post",
22946     "url": "/api/sms/messages/{id}/status",
22947     "title": "Receive message status",
22948     "examples": [
22949       {
22950         "title": "Example usage:",
22951         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22952         "type": "json"
22953       }
22954     ],
22955     "name": "statusMessage",
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/smsMessage/index.js",
22960     "groupTitle": "Sms_Accounts"
22961   },
22962   {
22963     "type": "post",
22964     "url": "/api/sms/accounts/{id}/status",
22965     "title": "Receive message status",
22966     "examples": [
22967       {
22968         "title": "Example usage:",
22969         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22970         "type": "json"
22971       }
22972     ],
22973     "name": "statusMessage",
22974     "group": "Sms_Accounts",
22975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
22982     "url": "/api/sms/accounts/{id}/status",
22983     "title": "Receive message status as get request",
22984     "examples": [
22985       {
22986         "title": "Example usage:",
22987         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22988         "type": "json"
22989       }
22990     ],
22991     "name": "statusMessage",
22992     "group": "Sms_Accounts",
22993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22994     "version": "0.0.0",
22995     "filename": "server/api/smsAccount/index.js",
22996     "groupTitle": "Sms_Accounts"
22997   },
22998   {
22999     "type": "put",
23000     "url": "/api/sms/accounts/{id}",
23001     "title": "Update an existing Account",
23002     "examples": [
23003       {
23004         "title": "Example usage:",
23005         "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",
23006         "type": "json"
23007       }
23008     ],
23009     "name": "updateAccounts",
23010     "group": "Sms_Accounts",
23011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
23018     "url": "/api/sms/applications",
23019     "title": "Creates a new Application",
23020     "examples": [
23021       {
23022         "title": "Example usage:",
23023         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23024         "type": "json"
23025       }
23026     ],
23027     "name": "CreateApplications",
23028     "group": "Sms_Applications",
23029     "parameter": {
23030       "fields": {
23031         "Body": [
23032           {
23033             "group": "Body",
23034             "type": "Integer",
23035             "optional": false,
23036             "field": "priority",
23037             "description": ""
23038           },
23039           {
23040             "group": "Body",
23041             "type": "String",
23042             "optional": false,
23043             "field": "app",
23044             "description": ""
23045           },
23046           {
23047             "group": "Body",
23048             "type": "Text",
23049             "optional": true,
23050             "field": "appdata",
23051             "description": ""
23052           },
23053           {
23054             "group": "Body",
23055             "type": "String",
23056             "optional": true,
23057             "field": "description",
23058             "description": ""
23059           },
23060           {
23061             "group": "Body",
23062             "type": "String",
23063             "optional": true,
23064             "field": "interval",
23065             "description": ""
23066           }
23067         ]
23068       }
23069     },
23070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23071     "version": "0.0.0",
23072     "filename": "server/api/smsApplication/index.js",
23073     "groupTitle": "Sms_Applications"
23074   },
23075   {
23076     "type": "delete",
23077     "url": "/api/sms/applications/{id}",
23078     "title": "Deletes a Application",
23079     "examples": [
23080       {
23081         "title": "Example usage:",
23082         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23083         "type": "json"
23084       }
23085     ],
23086     "name": "DeleteApplications",
23087     "group": "Sms_Applications",
23088     "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>",
23089     "version": "0.0.0",
23090     "filename": "server/api/smsApplication/index.js",
23091     "groupTitle": "Sms_Applications"
23092   },
23093   {
23094     "type": "get",
23095     "url": "/api/sms/applications",
23096     "title": "Gets a list of Applications",
23097     "examples": [
23098       {
23099         "title": "Example usage:",
23100         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23101         "type": "json"
23102       }
23103     ],
23104     "name": "GetApplications",
23105     "group": "Sms_Applications",
23106     "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>",
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/{id}",
23114     "title": "Gets a single Application",
23115     "examples": [
23116       {
23117         "title": "Example usage:",
23118         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23119         "type": "json"
23120       }
23121     ],
23122     "name": "ShowApplications",
23123     "group": "Sms_Applications",
23124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23125     "version": "0.0.0",
23126     "filename": "server/api/smsApplication/index.js",
23127     "groupTitle": "Sms_Applications"
23128   },
23129   {
23130     "type": "put",
23131     "url": "/api/sms/applications/{id}",
23132     "title": "Update an existing Application",
23133     "examples": [
23134       {
23135         "title": "Example usage:",
23136         "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",
23137         "type": "json"
23138       }
23139     ],
23140     "name": "updateApplications",
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": "post",
23149     "url": "/api/sms/interactions/{id}/tags",
23150     "title": "Add tags to the interaction",
23151     "examples": [
23152       {
23153         "title": "Example usage:",
23154         "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",
23155         "type": "json"
23156       }
23157     ],
23158     "name": "AddTags",
23159     "group": "Sms_Interactions",
23160     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161     "version": "0.0.0",
23162     "filename": "server/api/smsInteraction/index.js",
23163     "groupTitle": "Sms_Interactions"
23164   },
23165   {
23166     "type": "post",
23167     "url": "/api/sms/interactions",
23168     "title": "Creates a new Interaction",
23169     "examples": [
23170       {
23171         "title": "Example usage:",
23172         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23173         "type": "json"
23174       }
23175     ],
23176     "name": "CreateInteractions",
23177     "group": "Sms_Interactions",
23178     "parameter": {
23179       "fields": {
23180         "Body": [
23181           {
23182             "group": "Body",
23183             "type": "Boolean",
23184             "optional": true,
23185             "field": "closed",
23186             "description": ""
23187           },
23188           {
23189             "group": "Body",
23190             "type": "String",
23191             "optional": true,
23192             "field": "closedAt",
23193             "description": ""
23194           },
23195           {
23196             "group": "Body",
23197             "type": "String",
23198             "optional": true,
23199             "field": "disposition",
23200             "description": ""
23201           },
23202           {
23203             "group": "Body",
23204             "type": "String",
23205             "optional": true,
23206             "field": "secondDisposition",
23207             "description": ""
23208           },
23209           {
23210             "group": "Body",
23211             "type": "String",
23212             "optional": true,
23213             "field": "thirdDisposition",
23214             "description": ""
23215           },
23216           {
23217             "group": "Body",
23218             "type": "String",
23219             "optional": true,
23220             "field": "note",
23221             "description": ""
23222           },
23223           {
23224             "group": "Body",
23225             "type": "String",
23226             "optional": true,
23227             "field": "phone",
23228             "description": ""
23229           },
23230           {
23231             "group": "Body",
23232             "type": "String",
23233             "optional": true,
23234             "field": "read1stAt",
23235             "description": ""
23236           },
23237           {
23238             "group": "Body",
23239             "type": "String",
23240             "allowedValues": [
23241               "\"in\"",
23242               "\"out\""
23243             ],
23244             "optional": false,
23245             "field": "firstMsgDirection",
23246             "description": ""
23247           },
23248           {
23249             "group": "Body",
23250             "type": "String",
23251             "optional": true,
23252             "field": "lastMsgAt",
23253             "description": ""
23254           },
23255           {
23256             "group": "Body",
23257             "type": "String",
23258             "allowedValues": [
23259               "\"in\"",
23260               "\"out\""
23261             ],
23262             "optional": false,
23263             "field": "lastMsgDirection",
23264             "description": ""
23265           },
23266           {
23267             "group": "Body",
23268             "type": "Boolean",
23269             "optional": true,
23270             "field": "autoreplyExecuted",
23271             "description": ""
23272           }
23273         ]
23274       }
23275     },
23276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23277     "version": "0.0.0",
23278     "filename": "server/api/smsInteraction/index.js",
23279     "groupTitle": "Sms_Interactions"
23280   },
23281   {
23282     "type": "delete",
23283     "url": "/api/sms/interactions/{id}",
23284     "title": "Deletes a Interaction",
23285     "examples": [
23286       {
23287         "title": "Example usage:",
23288         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23289         "type": "json"
23290       }
23291     ],
23292     "name": "DeleteInteractions",
23293     "group": "Sms_Interactions",
23294     "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>",
23295     "version": "0.0.0",
23296     "filename": "server/api/smsInteraction/index.js",
23297     "groupTitle": "Sms_Interactions"
23298   },
23299   {
23300     "type": "get",
23301     "url": "/api/sms/interactions/describe",
23302     "title": "Gets table info about Interactions",
23303     "examples": [
23304       {
23305         "title": "Example usage:",
23306         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23307         "type": "json"
23308       }
23309     ],
23310     "name": "DescribeInteractions",
23311     "group": "Sms_Interactions",
23312     "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>",
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",
23320     "title": "Gets a list of Interactions",
23321     "examples": [
23322       {
23323         "title": "Example usage:",
23324         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23325         "type": "json"
23326       }
23327     ],
23328     "name": "GetInteractions",
23329     "group": "Sms_Interactions",
23330     "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>",
23331     "version": "0.0.0",
23332     "filename": "server/api/smsInteraction/index.js",
23333     "groupTitle": "Sms_Interactions"
23334   },
23335   {
23336     "type": "delete",
23337     "url": "/api/sms/interactions/{id}/tags",
23338     "title": "Removes tags from interaction",
23339     "examples": [
23340       {
23341         "title": "Example usage:",
23342         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23343         "type": "json"
23344       }
23345     ],
23346     "name": "RemoveTags",
23347     "group": "Sms_Interactions",
23348     "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>",
23349     "version": "0.0.0",
23350     "filename": "server/api/smsInteraction/index.js",
23351     "groupTitle": "Sms_Interactions"
23352   },
23353   {
23354     "type": "get",
23355     "url": "/api/sms/interactions/{id}",
23356     "title": "Gets a single Interaction",
23357     "examples": [
23358       {
23359         "title": "Example usage:",
23360         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23361         "type": "json"
23362       }
23363     ],
23364     "name": "ShowInteractions",
23365     "group": "Sms_Interactions",
23366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
23373     "url": "/api/sms/interactions/{id}/messages",
23374     "title": "Creates new messages",
23375     "examples": [
23376       {
23377         "title": "Example usage:",
23378         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23379         "type": "json"
23380       }
23381     ],
23382     "name": "addMessage",
23383     "group": "Sms_Interactions",
23384     "parameter": {
23385       "fields": {
23386         "Body": [
23387           {
23388             "group": "Body",
23389             "type": "Text",
23390             "optional": false,
23391             "field": "body",
23392             "description": ""
23393           },
23394           {
23395             "group": "Body",
23396             "type": "Boolean",
23397             "optional": true,
23398             "field": "read",
23399             "description": ""
23400           },
23401           {
23402             "group": "Body",
23403             "type": "String",
23404             "allowedValues": [
23405               "\"in\"",
23406               "\"out\""
23407             ],
23408             "optional": false,
23409             "field": "direction",
23410             "description": ""
23411           },
23412           {
23413             "group": "Body",
23414             "type": "String",
23415             "optional": true,
23416             "field": "messageId",
23417             "description": ""
23418           },
23419           {
23420             "group": "Body",
23421             "type": "String",
23422             "optional": true,
23423             "field": "phone",
23424             "description": ""
23425           },
23426           {
23427             "group": "Body",
23428             "type": "String",
23429             "optional": true,
23430             "field": "readAt",
23431             "description": ""
23432           },
23433           {
23434             "group": "Body",
23435             "type": "Boolean",
23436             "optional": true,
23437             "field": "secret",
23438             "description": ""
23439           },
23440           {
23441             "group": "Body",
23442             "type": "String",
23443             "optional": true,
23444             "field": "providerName",
23445             "description": ""
23446           },
23447           {
23448             "group": "Body",
23449             "type": "Text",
23450             "optional": true,
23451             "field": "providerResponse",
23452             "description": ""
23453           }
23454         ]
23455       }
23456     },
23457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23458     "version": "0.0.0",
23459     "filename": "server/api/smsInteraction/index.js",
23460     "groupTitle": "Sms_Interactions"
23461   },
23462   {
23463     "type": "get",
23464     "url": "/api/sms/interactions/{id}/download",
23465     "title": "Gets interaction",
23466     "examples": [
23467       {
23468         "title": "Example usage:",
23469         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23470         "type": "json"
23471       }
23472     ],
23473     "name": "download",
23474     "group": "Sms_Interactions",
23475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
23483     "title": "Gets interaction messages",
23484     "examples": [
23485       {
23486         "title": "Example usage:",
23487         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23488         "type": "json"
23489       }
23490     ],
23491     "name": "getMessages",
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": "put",
23500     "url": "/api/sms/interactions/{id}",
23501     "title": "Update an existing Interaction",
23502     "examples": [
23503       {
23504         "title": "Example usage:",
23505         "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",
23506         "type": "json"
23507       }
23508     ],
23509     "name": "updateInteractions",
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": "post",
23518     "url": "/api/sms/messages",
23519     "title": "Creates a new Message",
23520     "examples": [
23521       {
23522         "title": "Example usage:",
23523         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23524         "type": "json"
23525       }
23526     ],
23527     "name": "CreateMessages",
23528     "group": "Sms_Messages",
23529     "parameter": {
23530       "fields": {
23531         "Body": [
23532           {
23533             "group": "Body",
23534             "type": "Text",
23535             "optional": false,
23536             "field": "body",
23537             "description": ""
23538           },
23539           {
23540             "group": "Body",
23541             "type": "Boolean",
23542             "optional": true,
23543             "field": "read",
23544             "description": ""
23545           },
23546           {
23547             "group": "Body",
23548             "type": "String",
23549             "allowedValues": [
23550               "\"in\"",
23551               "\"out\""
23552             ],
23553             "optional": false,
23554             "field": "direction",
23555             "description": ""
23556           },
23557           {
23558             "group": "Body",
23559             "type": "String",
23560             "optional": true,
23561             "field": "messageId",
23562             "description": ""
23563           },
23564           {
23565             "group": "Body",
23566             "type": "String",
23567             "optional": true,
23568             "field": "phone",
23569             "description": ""
23570           },
23571           {
23572             "group": "Body",
23573             "type": "String",
23574             "optional": true,
23575             "field": "readAt",
23576             "description": ""
23577           },
23578           {
23579             "group": "Body",
23580             "type": "Boolean",
23581             "optional": true,
23582             "field": "secret",
23583             "description": ""
23584           },
23585           {
23586             "group": "Body",
23587             "type": "String",
23588             "optional": true,
23589             "field": "providerName",
23590             "description": ""
23591           },
23592           {
23593             "group": "Body",
23594             "type": "Text",
23595             "optional": true,
23596             "field": "providerResponse",
23597             "description": ""
23598           }
23599         ]
23600       }
23601     },
23602     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23603     "version": "0.0.0",
23604     "filename": "server/api/smsMessage/index.js",
23605     "groupTitle": "Sms_Messages"
23606   },
23607   {
23608     "type": "delete",
23609     "url": "/api/sms/messages/{id}",
23610     "title": "Deletes a Message",
23611     "examples": [
23612       {
23613         "title": "Example usage:",
23614         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23615         "type": "json"
23616       }
23617     ],
23618     "name": "DeleteMessages",
23619     "group": "Sms_Messages",
23620     "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>",
23621     "version": "0.0.0",
23622     "filename": "server/api/smsMessage/index.js",
23623     "groupTitle": "Sms_Messages"
23624   },
23625   {
23626     "type": "get",
23627     "url": "/api/sms/messages/describe",
23628     "title": "Gets table info about Messages",
23629     "examples": [
23630       {
23631         "title": "Example usage:",
23632         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23633         "type": "json"
23634       }
23635     ],
23636     "name": "DescribeMessages",
23637     "group": "Sms_Messages",
23638     "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>",
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",
23646     "title": "Gets a list of Messages",
23647     "examples": [
23648       {
23649         "title": "Example usage:",
23650         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23651         "type": "json"
23652       }
23653     ],
23654     "name": "GetMessages",
23655     "group": "Sms_Messages",
23656     "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>",
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/{id}",
23664     "title": "Gets a single Message",
23665     "examples": [
23666       {
23667         "title": "Example usage:",
23668         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23669         "type": "json"
23670       }
23671     ],
23672     "name": "ShowMessages",
23673     "group": "Sms_Messages",
23674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23675     "version": "0.0.0",
23676     "filename": "server/api/smsMessage/index.js",
23677     "groupTitle": "Sms_Messages"
23678   },
23679   {
23680     "type": "put",
23681     "url": "/api/sms/messages/{id}",
23682     "title": "Update an existing Message",
23683     "examples": [
23684       {
23685         "title": "Example usage:",
23686         "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",
23687         "type": "json"
23688       }
23689     ],
23690     "name": "updateMessages",
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": "post",
23699     "url": "/api/sms/reports/queue",
23700     "title": "Creates a new Sms Queue Report",
23701     "examples": [
23702       {
23703         "title": "Example usage:",
23704         "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",
23705         "type": "json"
23706       }
23707     ],
23708     "name": "CreateSms_Queue_Reports",
23709     "group": "Sms_Queue_Reports",
23710     "parameter": {
23711       "fields": {
23712         "Body": [
23713           {
23714             "group": "Body",
23715             "type": "String",
23716             "optional": false,
23717             "field": "uniqueid",
23718             "description": ""
23719           },
23720           {
23721             "group": "Body",
23722             "type": "String",
23723             "optional": true,
23724             "field": "from",
23725             "description": ""
23726           },
23727           {
23728             "group": "Body",
23729             "type": "String",
23730             "optional": true,
23731             "field": "joinAt",
23732             "description": ""
23733           },
23734           {
23735             "group": "Body",
23736             "type": "String",
23737             "optional": true,
23738             "field": "leaveAt",
23739             "description": ""
23740           },
23741           {
23742             "group": "Body",
23743             "type": "String",
23744             "optional": true,
23745             "field": "acceptAt",
23746             "description": ""
23747           },
23748           {
23749             "group": "Body",
23750             "type": "String",
23751             "optional": true,
23752             "field": "exitAt",
23753             "description": ""
23754           },
23755           {
23756             "group": "Body",
23757             "type": "String",
23758             "optional": true,
23759             "field": "reason",
23760             "description": ""
23761           }
23762         ]
23763       }
23764     },
23765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23766     "version": "0.0.0",
23767     "filename": "server/api/smsQueueReport/index.js",
23768     "groupTitle": "Sms_Queue_Reports"
23769   },
23770   {
23771     "type": "delete",
23772     "url": "/api/sms/reports/queue/{id}",
23773     "title": "Deletes a Sms Queue Report",
23774     "examples": [
23775       {
23776         "title": "Example usage:",
23777         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23778         "type": "json"
23779       }
23780     ],
23781     "name": "DeleteSms_Queue_Reports",
23782     "group": "Sms_Queue_Reports",
23783     "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>",
23784     "version": "0.0.0",
23785     "filename": "server/api/smsQueueReport/index.js",
23786     "groupTitle": "Sms_Queue_Reports"
23787   },
23788   {
23789     "type": "get",
23790     "url": "/api/sms/reports/queue/describe",
23791     "title": "Gets table info about Sms Queue Reports",
23792     "examples": [
23793       {
23794         "title": "Example usage:",
23795         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23796         "type": "json"
23797       }
23798     ],
23799     "name": "DescribeSms_Queue_Reports",
23800     "group": "Sms_Queue_Reports",
23801     "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>",
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",
23809     "title": "Gets a list of Sms Queue Reports",
23810     "examples": [
23811       {
23812         "title": "Example usage:",
23813         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23814         "type": "json"
23815       }
23816     ],
23817     "name": "GetSms_Queue_Reports",
23818     "group": "Sms_Queue_Reports",
23819     "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>",
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/{id}",
23827     "title": "Gets a single Sms Queue Report",
23828     "examples": [
23829       {
23830         "title": "Example usage:",
23831         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23832         "type": "json"
23833       }
23834     ],
23835     "name": "ShowSms_Queue_Reports",
23836     "group": "Sms_Queue_Reports",
23837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23838     "version": "0.0.0",
23839     "filename": "server/api/smsQueueReport/index.js",
23840     "groupTitle": "Sms_Queue_Reports"
23841   },
23842   {
23843     "type": "put",
23844     "url": "/api/sms/reports/queue/{id}",
23845     "title": "Update an existing Sms Queue Report",
23846     "examples": [
23847       {
23848         "title": "Example usage:",
23849         "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",
23850         "type": "json"
23851       }
23852     ],
23853     "name": "updateSms_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": "post",
23862     "url": "/api/sms/queues/{id}/users",
23863     "title": "Add agents to a queue",
23864     "examples": [
23865       {
23866         "title": "Example usage:",
23867         "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",
23868         "type": "json"
23869       }
23870     ],
23871     "name": "AddAgents",
23872     "group": "Sms_Queues",
23873     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23874     "version": "0.0.0",
23875     "filename": "server/api/smsQueue/index.js",
23876     "groupTitle": "Sms_Queues"
23877   },
23878   {
23879     "type": "post",
23880     "url": "/api/sms/queues/{id}/teams",
23881     "title": "Add teams to a queue",
23882     "examples": [
23883       {
23884         "title": "Example usage:",
23885         "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",
23886         "type": "json"
23887       }
23888     ],
23889     "name": "AddTeams",
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",
23899     "title": "Creates a new Queue",
23900     "examples": [
23901       {
23902         "title": "Example usage:",
23903         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23904         "type": "json"
23905       }
23906     ],
23907     "name": "CreateQueues",
23908     "group": "Sms_Queues",
23909     "parameter": {
23910       "fields": {
23911         "Body": [
23912           {
23913             "group": "Body",
23914             "type": "String",
23915             "optional": true,
23916             "field": "name",
23917             "description": ""
23918           },
23919           {
23920             "group": "Body",
23921             "type": "String",
23922             "optional": true,
23923             "field": "description",
23924             "description": ""
23925           },
23926           {
23927             "group": "Body",
23928             "type": "Integer",
23929             "optional": true,
23930             "field": "timeout",
23931             "description": ""
23932           },
23933           {
23934             "group": "Body",
23935             "type": "String",
23936             "allowedValues": [
23937               "\"rrmemory\"",
23938               "\"beepall\"",
23939               "\"roundrobin\""
23940             ],
23941             "optional": true,
23942             "field": "strategy",
23943             "description": ""
23944           }
23945         ]
23946       }
23947     },
23948     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23949     "version": "0.0.0",
23950     "filename": "server/api/smsQueue/index.js",
23951     "groupTitle": "Sms_Queues"
23952   },
23953   {
23954     "type": "delete",
23955     "url": "/api/sms/queues/{id}",
23956     "title": "Deletes a Queue",
23957     "examples": [
23958       {
23959         "title": "Example usage:",
23960         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23961         "type": "json"
23962       }
23963     ],
23964     "name": "DeleteQueues",
23965     "group": "Sms_Queues",
23966     "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>",
23967     "version": "0.0.0",
23968     "filename": "server/api/smsQueue/index.js",
23969     "groupTitle": "Sms_Queues"
23970   },
23971   {
23972     "type": "get",
23973     "url": "/api/sms/queues/describe",
23974     "title": "Gets table info about Queues",
23975     "examples": [
23976       {
23977         "title": "Example usage:",
23978         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23979         "type": "json"
23980       }
23981     ],
23982     "name": "DescribeQueues",
23983     "group": "Sms_Queues",
23984     "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>",
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/{id}/users",
23992     "title": "Gets queue agents",
23993     "examples": [
23994       {
23995         "title": "Example usage:",
23996         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23997         "type": "json"
23998       }
23999     ],
24000     "name": "GetAgents",
24001     "group": "Sms_Queues",
24002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
24010     "title": "GetMembers",
24011     "examples": [
24012       {
24013         "title": "Example usage:",
24014         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24015         "type": "json"
24016       }
24017     ],
24018     "name": "GetMembers",
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",
24028     "title": "Gets a list of Queues",
24029     "examples": [
24030       {
24031         "title": "Example usage:",
24032         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24033         "type": "json"
24034       }
24035     ],
24036     "name": "GetQueues",
24037     "group": "Sms_Queues",
24038     "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>",
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/{id}/teams",
24046     "title": "Gets queues list",
24047     "examples": [
24048       {
24049         "title": "Example usage:",
24050         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24051         "type": "json"
24052       }
24053     ],
24054     "name": "GetTeams",
24055     "group": "Sms_Queues",
24056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24057     "version": "0.0.0",
24058     "filename": "server/api/smsQueue/index.js",
24059     "groupTitle": "Sms_Queues"
24060   },
24061   {
24062     "type": "delete",
24063     "url": "/api/sms/queues/{id}/users",
24064     "title": "Removes agents from a queue",
24065     "examples": [
24066       {
24067         "title": "Example usage:",
24068         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24069         "type": "json"
24070       }
24071     ],
24072     "name": "RemoveAgents",
24073     "group": "Sms_Queues",
24074     "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>",
24075     "version": "0.0.0",
24076     "filename": "server/api/smsQueue/index.js",
24077     "groupTitle": "Sms_Queues"
24078   },
24079   {
24080     "type": "get",
24081     "url": "/api/sms/queues/{id}",
24082     "title": "Gets a single Queue",
24083     "examples": [
24084       {
24085         "title": "Example usage:",
24086         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24087         "type": "json"
24088       }
24089     ],
24090     "name": "ShowQueues",
24091     "group": "Sms_Queues",
24092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
24099     "url": "/api/sms/queues/{id}",
24100     "title": "Update an existing Queue",
24101     "examples": [
24102       {
24103         "title": "Example usage:",
24104         "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",
24105         "type": "json"
24106       }
24107     ],
24108     "name": "updateQueues",
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": "post",
24117     "url": "/api/sms/reports/transfer",
24118     "title": "Creates a new Sms Transfer Report",
24119     "examples": [
24120       {
24121         "title": "Example usage:",
24122         "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",
24123         "type": "json"
24124       }
24125     ],
24126     "name": "CreateSms_Transfer_Reports",
24127     "group": "Sms_Transfer_Reports",
24128     "parameter": {
24129       "fields": {
24130         "Body": [
24131           {
24132             "group": "Body",
24133             "type": "String",
24134             "optional": false,
24135             "field": "uniqueid",
24136             "description": ""
24137           },
24138           {
24139             "group": "Body",
24140             "type": "String",
24141             "allowedValues": [
24142               "\"account\"",
24143               "\"agent\"",
24144               "\"queue\""
24145             ],
24146             "optional": false,
24147             "field": "type",
24148             "description": ""
24149           },
24150           {
24151             "group": "Body",
24152             "type": "String",
24153             "optional": false,
24154             "field": "transferredAt",
24155             "description": ""
24156           }
24157         ]
24158       }
24159     },
24160     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24161     "version": "0.0.0",
24162     "filename": "server/api/smsTransferReport/index.js",
24163     "groupTitle": "Sms_Transfer_Reports"
24164   },
24165   {
24166     "type": "delete",
24167     "url": "/api/sms/reports/transfer/{id}",
24168     "title": "Deletes a Sms Transfer Report",
24169     "examples": [
24170       {
24171         "title": "Example usage:",
24172         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24173         "type": "json"
24174       }
24175     ],
24176     "name": "DeleteSms_Transfer_Reports",
24177     "group": "Sms_Transfer_Reports",
24178     "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>",
24179     "version": "0.0.0",
24180     "filename": "server/api/smsTransferReport/index.js",
24181     "groupTitle": "Sms_Transfer_Reports"
24182   },
24183   {
24184     "type": "get",
24185     "url": "/api/sms/reports/transfer/describe",
24186     "title": "Gets table info about Sms Transfer Reports",
24187     "examples": [
24188       {
24189         "title": "Example usage:",
24190         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24191         "type": "json"
24192       }
24193     ],
24194     "name": "DescribeSms_Transfer_Reports",
24195     "group": "Sms_Transfer_Reports",
24196     "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>",
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",
24204     "title": "Gets a list of Sms Transfer Reports",
24205     "examples": [
24206       {
24207         "title": "Example usage:",
24208         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24209         "type": "json"
24210       }
24211     ],
24212     "name": "GetSms_Transfer_Reports",
24213     "group": "Sms_Transfer_Reports",
24214     "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>",
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/{id}",
24222     "title": "Gets a single Sms Transfer Report",
24223     "examples": [
24224       {
24225         "title": "Example usage:",
24226         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24227         "type": "json"
24228       }
24229     ],
24230     "name": "ShowSms_Transfer_Reports",
24231     "group": "Sms_Transfer_Reports",
24232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24233     "version": "0.0.0",
24234     "filename": "server/api/smsTransferReport/index.js",
24235     "groupTitle": "Sms_Transfer_Reports"
24236   },
24237   {
24238     "type": "put",
24239     "url": "/api/sms/reports/transfer/{id}",
24240     "title": "Update an existing Sms Transfer Report",
24241     "examples": [
24242       {
24243         "title": "Example usage:",
24244         "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",
24245         "type": "json"
24246       }
24247     ],
24248     "name": "updateSms_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": "get",
24257     "url": "/api/sounds",
24258     "title": "Gets a list of Sounds",
24259     "examples": [
24260       {
24261         "title": "Example usage:",
24262         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24263         "type": "json"
24264       }
24265     ],
24266     "name": "GetSounds",
24267     "group": "Sounds",
24268     "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>",
24269     "version": "0.0.0",
24270     "filename": "server/api/sound/index.js",
24271     "groupTitle": "Sounds"
24272   },
24273   {
24274     "type": "get",
24275     "url": "/api/sounds/{id}",
24276     "title": "Gets a single Sound",
24277     "examples": [
24278       {
24279         "title": "Example usage:",
24280         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24281         "type": "json"
24282       }
24283     ],
24284     "name": "ShowSounds",
24285     "group": "Sounds",
24286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24287     "version": "0.0.0",
24288     "filename": "server/api/sound/index.js",
24289     "groupTitle": "Sounds"
24290   },
24291   {
24292     "type": "post",
24293     "url": "/api/sounds",
24294     "title": "Create a new sound",
24295     "examples": [
24296       {
24297         "title": "Example usage:",
24298         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24299         "type": "json"
24300       }
24301     ],
24302     "name": "addSound",
24303     "group": "Sounds",
24304     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "delete",
24311     "url": "/api/sounds/{id}",
24312     "title": "Deletes a sound",
24313     "examples": [
24314       {
24315         "title": "Example usage:",
24316         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24317         "type": "json"
24318       }
24319     ],
24320     "name": "destroySound",
24321     "group": "Sounds",
24322     "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>",
24323     "version": "0.0.0",
24324     "filename": "server/api/sound/index.js",
24325     "groupTitle": "Sounds"
24326   },
24327   {
24328     "type": "get",
24329     "url": "/api/sounds/{id}/download",
24330     "title": "Download Sound",
24331     "examples": [
24332       {
24333         "title": "Example usage:",
24334         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24335         "type": "json"
24336       }
24337     ],
24338     "name": "download",
24339     "group": "Sounds",
24340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
24347     "url": "/api/sounds",
24348     "title": "Update an existing new sound",
24349     "examples": [
24350       {
24351         "title": "Example usage:",
24352         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24353         "type": "json"
24354       }
24355     ],
24356     "name": "updateSound",
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": "post",
24365     "url": "/api/square/details/reports",
24366     "title": "Creates a new Square Detail Report",
24367     "examples": [
24368       {
24369         "title": "Example usage:",
24370         "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",
24371         "type": "json"
24372       }
24373     ],
24374     "name": "CreateSquare_Detail_Reports",
24375     "group": "Square_Details_Reports",
24376     "parameter": {
24377       "fields": {
24378         "Body": [
24379           {
24380             "group": "Body",
24381             "type": "String",
24382             "optional": true,
24383             "field": "uniqueid",
24384             "description": ""
24385           },
24386           {
24387             "group": "Body",
24388             "type": "String",
24389             "optional": true,
24390             "field": "node",
24391             "description": ""
24392           },
24393           {
24394             "group": "Body",
24395             "type": "String",
24396             "optional": true,
24397             "field": "application",
24398             "description": ""
24399           },
24400           {
24401             "group": "Body",
24402             "type": "Text",
24403             "optional": true,
24404             "field": "data",
24405             "description": ""
24406           },
24407           {
24408             "group": "Body",
24409             "type": "String",
24410             "optional": true,
24411             "field": "project_name",
24412             "description": ""
24413           },
24414           {
24415             "group": "Body",
24416             "type": "String",
24417             "optional": true,
24418             "field": "callerid",
24419             "description": ""
24420           }
24421         ]
24422       }
24423     },
24424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24425     "version": "0.0.0",
24426     "filename": "server/api/squareReportDetail/index.js",
24427     "groupTitle": "Square_Details_Reports"
24428   },
24429   {
24430     "type": "delete",
24431     "url": "/api/square/details/reports/{id}",
24432     "title": "Deletes a Square Detail Report",
24433     "examples": [
24434       {
24435         "title": "Example usage:",
24436         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24437         "type": "json"
24438       }
24439     ],
24440     "name": "DeleteSquare_Detail_Reports",
24441     "group": "Square_Details_Reports",
24442     "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>",
24443     "version": "0.0.0",
24444     "filename": "server/api/squareReportDetail/index.js",
24445     "groupTitle": "Square_Details_Reports"
24446   },
24447   {
24448     "type": "get",
24449     "url": "/api/square/details/reports/describe",
24450     "title": "Gets table info about Square Detail Reports",
24451     "examples": [
24452       {
24453         "title": "Example usage:",
24454         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24455         "type": "json"
24456       }
24457     ],
24458     "name": "DescribeSquare_Detail_Reports",
24459     "group": "Square_Details_Reports",
24460     "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>",
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",
24468     "title": "Gets a list of Square Detail Reports",
24469     "examples": [
24470       {
24471         "title": "Example usage:",
24472         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24473         "type": "json"
24474       }
24475     ],
24476     "name": "GetSquare_Detail_Reports",
24477     "group": "Square_Details_Reports",
24478     "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>",
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/{id}",
24486     "title": "Gets a single Square Detail Report",
24487     "examples": [
24488       {
24489         "title": "Example usage:",
24490         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24491         "type": "json"
24492       }
24493     ],
24494     "name": "ShowSquare_Detail_Reports",
24495     "group": "Square_Details_Reports",
24496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24497     "version": "0.0.0",
24498     "filename": "server/api/squareReportDetail/index.js",
24499     "groupTitle": "Square_Details_Reports"
24500   },
24501   {
24502     "type": "put",
24503     "url": "/api/square/details/reports/{id}",
24504     "title": "Update an existing Square Detail Report",
24505     "examples": [
24506       {
24507         "title": "Example usage:",
24508         "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",
24509         "type": "json"
24510       }
24511     ],
24512     "name": "updateSquare_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": "post",
24521     "url": "/api/square/messages",
24522     "title": "Creates a new Message",
24523     "examples": [
24524       {
24525         "title": "Example usage:",
24526         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24527         "type": "json"
24528       }
24529     ],
24530     "name": "CreateMessages",
24531     "group": "Square_Messages",
24532     "parameter": {
24533       "fields": {
24534         "Body": [
24535           {
24536             "group": "Body",
24537             "type": "String",
24538             "optional": true,
24539             "field": "uniqueid",
24540             "description": ""
24541           },
24542           {
24543             "group": "Body",
24544             "type": "Text",
24545             "optional": false,
24546             "field": "body",
24547             "description": ""
24548           },
24549           {
24550             "group": "Body",
24551             "type": "String",
24552             "allowedValues": [
24553               "\"in\"",
24554               "\"out\""
24555             ],
24556             "optional": false,
24557             "field": "direction",
24558             "description": ""
24559           },
24560           {
24561             "group": "Body",
24562             "type": "String",
24563             "optional": true,
24564             "field": "providerName",
24565             "description": ""
24566           },
24567           {
24568             "group": "Body",
24569             "type": "Text",
24570             "optional": true,
24571             "field": "providerResponse",
24572             "description": ""
24573           }
24574         ]
24575       }
24576     },
24577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24578     "version": "0.0.0",
24579     "filename": "server/api/squareMessage/index.js",
24580     "groupTitle": "Square_Messages"
24581   },
24582   {
24583     "type": "delete",
24584     "url": "/api/square/messages/{id}",
24585     "title": "Deletes a Message",
24586     "examples": [
24587       {
24588         "title": "Example usage:",
24589         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24590         "type": "json"
24591       }
24592     ],
24593     "name": "DeleteMessages",
24594     "group": "Square_Messages",
24595     "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>",
24596     "version": "0.0.0",
24597     "filename": "server/api/squareMessage/index.js",
24598     "groupTitle": "Square_Messages"
24599   },
24600   {
24601     "type": "get",
24602     "url": "/api/square/messages",
24603     "title": "Gets a list of Messages",
24604     "examples": [
24605       {
24606         "title": "Example usage:",
24607         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24608         "type": "json"
24609       }
24610     ],
24611     "name": "GetMessages",
24612     "group": "Square_Messages",
24613     "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>",
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/{id}",
24621     "title": "Gets a single Message",
24622     "examples": [
24623       {
24624         "title": "Example usage:",
24625         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24626         "type": "json"
24627       }
24628     ],
24629     "name": "ShowMessages",
24630     "group": "Square_Messages",
24631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24632     "version": "0.0.0",
24633     "filename": "server/api/squareMessage/index.js",
24634     "groupTitle": "Square_Messages"
24635   },
24636   {
24637     "type": "put",
24638     "url": "/api/square/messages/{id}",
24639     "title": "Update an existing Message",
24640     "examples": [
24641       {
24642         "title": "Example usage:",
24643         "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",
24644         "type": "json"
24645       }
24646     ],
24647     "name": "updateMessages",
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": "post",
24656     "url": "/api/square/odbc",
24657     "title": "Creates a new ODBC",
24658     "examples": [
24659       {
24660         "title": "Example usage:",
24661         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24662         "type": "json"
24663       }
24664     ],
24665     "name": "CreateODBCs",
24666     "group": "Square_ODBC",
24667     "parameter": {
24668       "fields": {
24669         "Body": [
24670           {
24671             "group": "Body",
24672             "type": "String",
24673             "optional": false,
24674             "field": "name",
24675             "description": ""
24676           },
24677           {
24678             "group": "Body",
24679             "type": "String",
24680             "optional": true,
24681             "field": "dsn",
24682             "description": ""
24683           },
24684           {
24685             "group": "Body",
24686             "type": "String",
24687             "optional": true,
24688             "field": "description",
24689             "description": ""
24690           }
24691         ]
24692       }
24693     },
24694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24695     "version": "0.0.0",
24696     "filename": "server/api/squareOdbc/index.js",
24697     "groupTitle": "Square_ODBC"
24698   },
24699   {
24700     "type": "delete",
24701     "url": "/api/square/odbc/{id}",
24702     "title": "Deletes a ODBC",
24703     "examples": [
24704       {
24705         "title": "Example usage:",
24706         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24707         "type": "json"
24708       }
24709     ],
24710     "name": "DeleteODBCs",
24711     "group": "Square_ODBC",
24712     "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>",
24713     "version": "0.0.0",
24714     "filename": "server/api/squareOdbc/index.js",
24715     "groupTitle": "Square_ODBC"
24716   },
24717   {
24718     "type": "get",
24719     "url": "/api/square/odbc",
24720     "title": "Gets a list of ODBCs",
24721     "examples": [
24722       {
24723         "title": "Example usage:",
24724         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24725         "type": "json"
24726       }
24727     ],
24728     "name": "GetODBCs",
24729     "group": "Square_ODBC",
24730     "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>",
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/{id}",
24738     "title": "Gets a single ODBC",
24739     "examples": [
24740       {
24741         "title": "Example usage:",
24742         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24743         "type": "json"
24744       }
24745     ],
24746     "name": "ShowODBCs",
24747     "group": "Square_ODBC",
24748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/test",
24756     "title": "Test Odbc",
24757     "examples": [
24758       {
24759         "title": "Example usage:",
24760         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24761         "type": "json"
24762       }
24763     ],
24764     "name": "test",
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": "put",
24773     "url": "/api/square/odbc/{id}",
24774     "title": "Update an existing ODBC",
24775     "examples": [
24776       {
24777         "title": "Example usage:",
24778         "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",
24779         "type": "json"
24780       }
24781     ],
24782     "name": "updateODBCs",
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": "post",
24791     "url": "/api/square/projects",
24792     "title": "Creates a new Project",
24793     "examples": [
24794       {
24795         "title": "Example usage:",
24796         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24797         "type": "json"
24798       }
24799     ],
24800     "name": "CreateProjects",
24801     "group": "Square_Projects",
24802     "parameter": {
24803       "fields": {
24804         "Body": [
24805           {
24806             "group": "Body",
24807             "type": "String",
24808             "optional": false,
24809             "field": "name",
24810             "description": ""
24811           },
24812           {
24813             "group": "Body",
24814             "type": "String",
24815             "optional": true,
24816             "field": "description",
24817             "description": ""
24818           },
24819           {
24820             "group": "Body",
24821             "type": "Text",
24822             "optional": true,
24823             "field": "notes",
24824             "description": ""
24825           },
24826           {
24827             "group": "Body",
24828             "type": "Blob",
24829             "optional": true,
24830             "field": "preproduction",
24831             "description": ""
24832           },
24833           {
24834             "group": "Body",
24835             "type": "Blob",
24836             "optional": true,
24837             "field": "production",
24838             "description": ""
24839           },
24840           {
24841             "group": "Body",
24842             "type": "String",
24843             "optional": true,
24844             "field": "savedAt",
24845             "description": ""
24846           },
24847           {
24848             "group": "Body",
24849             "type": "String",
24850             "optional": true,
24851             "field": "publishedAt",
24852             "description": ""
24853           }
24854         ]
24855       }
24856     },
24857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24858     "version": "0.0.0",
24859     "filename": "server/api/squareProject/index.js",
24860     "groupTitle": "Square_Projects"
24861   },
24862   {
24863     "type": "delete",
24864     "url": "/api/square/projects/{id}",
24865     "title": "Deletes a Project",
24866     "examples": [
24867       {
24868         "title": "Example usage:",
24869         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24870         "type": "json"
24871       }
24872     ],
24873     "name": "DeleteProjects",
24874     "group": "Square_Projects",
24875     "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>",
24876     "version": "0.0.0",
24877     "filename": "server/api/squareProject/index.js",
24878     "groupTitle": "Square_Projects"
24879   },
24880   {
24881     "type": "get",
24882     "url": "/api/square/projects",
24883     "title": "Gets a list of Projects",
24884     "examples": [
24885       {
24886         "title": "Example usage:",
24887         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24888         "type": "json"
24889       }
24890     ],
24891     "name": "GetProjects",
24892     "group": "Square_Projects",
24893     "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>",
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/{id}",
24901     "title": "Gets a single Project",
24902     "examples": [
24903       {
24904         "title": "Example usage:",
24905         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24906         "type": "json"
24907       }
24908     ],
24909     "name": "ShowProjects",
24910     "group": "Square_Projects",
24911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24912     "version": "0.0.0",
24913     "filename": "server/api/squareProject/index.js",
24914     "groupTitle": "Square_Projects"
24915   },
24916   {
24917     "type": "post",
24918     "url": "/api/square/projects/{id}/users",
24919     "title": "Adds user permissions to a Project",
24920     "examples": [
24921       {
24922         "title": "Example usage:",
24923         "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",
24924         "type": "json"
24925       }
24926     ],
24927     "name": "addUsers",
24928     "group": "Square_Projects",
24929     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
24936     "url": "/api/square/projects/{id}/users",
24937     "title": "Gets users permissions from Project",
24938     "examples": [
24939       {
24940         "title": "Example usage:",
24941         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24942         "type": "json"
24943       }
24944     ],
24945     "name": "getUsers",
24946     "group": "Square_Projects",
24947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "delete",
24954     "url": "/api/square/projects/{id}/users",
24955     "title": "Removes user permissions from a Project",
24956     "examples": [
24957       {
24958         "title": "Example usage:",
24959         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24960         "type": "json"
24961       }
24962     ],
24963     "name": "removeUsers",
24964     "group": "Square_Projects",
24965     "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>",
24966     "version": "0.0.0",
24967     "filename": "server/api/squareProject/index.js",
24968     "groupTitle": "Square_Projects"
24969   },
24970   {
24971     "type": "put",
24972     "url": "/api/square/projects/{id}",
24973     "title": "Update an existing Project",
24974     "examples": [
24975       {
24976         "title": "Example usage:",
24977         "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",
24978         "type": "json"
24979       }
24980     ],
24981     "name": "updateProjects",
24982     "group": "Square_Projects",
24983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
24990     "url": "/api/square/recordings",
24991     "title": "Creates a new Recording",
24992     "examples": [
24993       {
24994         "title": "Example usage:",
24995         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24996         "type": "json"
24997       }
24998     ],
24999     "name": "CreateRecordings",
25000     "group": "Square_Recordings",
25001     "parameter": {
25002       "fields": {
25003         "Body": [
25004           {
25005             "group": "Body",
25006             "type": "String",
25007             "optional": true,
25008             "field": "uniqueid",
25009             "description": ""
25010           },
25011           {
25012             "group": "Body",
25013             "type": "String",
25014             "optional": true,
25015             "field": "callerid",
25016             "description": ""
25017           },
25018           {
25019             "group": "Body",
25020             "type": "String",
25021             "optional": true,
25022             "field": "calleridname",
25023             "description": ""
25024           },
25025           {
25026             "group": "Body",
25027             "type": "String",
25028             "optional": true,
25029             "field": "context",
25030             "description": ""
25031           },
25032           {
25033             "group": "Body",
25034             "type": "String",
25035             "optional": true,
25036             "field": "extension",
25037             "description": ""
25038           },
25039           {
25040             "group": "Body",
25041             "type": "String",
25042             "optional": true,
25043             "field": "priority",
25044             "description": ""
25045           },
25046           {
25047             "group": "Body",
25048             "type": "String",
25049             "optional": true,
25050             "field": "accountcode",
25051             "description": ""
25052           },
25053           {
25054             "group": "Body",
25055             "type": "String",
25056             "optional": true,
25057             "field": "dnid",
25058             "description": ""
25059           },
25060           {
25061             "group": "Body",
25062             "type": "String",
25063             "optional": true,
25064             "field": "projectName",
25065             "description": ""
25066           },
25067           {
25068             "group": "Body",
25069             "type": "String",
25070             "optional": true,
25071             "field": "saveName",
25072             "description": ""
25073           },
25074           {
25075             "group": "Body",
25076             "type": "String",
25077             "optional": true,
25078             "field": "filename",
25079             "description": ""
25080           },
25081           {
25082             "group": "Body",
25083             "type": "String",
25084             "optional": true,
25085             "field": "savePath",
25086             "description": ""
25087           },
25088           {
25089             "group": "Body",
25090             "type": "Virtual",
25091             "optional": true,
25092             "field": "format",
25093             "description": ""
25094           }
25095         ]
25096       }
25097     },
25098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25099     "version": "0.0.0",
25100     "filename": "server/api/squareRecording/index.js",
25101     "groupTitle": "Square_Recordings"
25102   },
25103   {
25104     "type": "get",
25105     "url": "/api/square/recordings",
25106     "title": "Gets a list of Recordings",
25107     "examples": [
25108       {
25109         "title": "Example usage:",
25110         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25111         "type": "json"
25112       }
25113     ],
25114     "name": "GetRecordings",
25115     "group": "Square_Recordings",
25116     "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>",
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/{id}",
25124     "title": "Gets a single Recording",
25125     "examples": [
25126       {
25127         "title": "Example usage:",
25128         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25129         "type": "json"
25130       }
25131     ],
25132     "name": "ShowRecordings",
25133     "group": "Square_Recordings",
25134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25135     "version": "0.0.0",
25136     "filename": "server/api/squareRecording/index.js",
25137     "groupTitle": "Square_Recordings"
25138   },
25139   {
25140     "type": "delete",
25141     "url": "/api/square/recordings/{id}",
25142     "title": "Delete recording",
25143     "examples": [
25144       {
25145         "title": "Example usage:",
25146         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25147         "type": "json"
25148       }
25149     ],
25150     "name": "destroy",
25151     "group": "Square_Recordings",
25152     "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>",
25153     "version": "0.0.0",
25154     "filename": "server/api/squareRecording/index.js",
25155     "groupTitle": "Square_Recordings"
25156   },
25157   {
25158     "type": "get",
25159     "url": "/api/square/recordings/{id}/download",
25160     "title": "Download Recording",
25161     "examples": [
25162       {
25163         "title": "Example usage:",
25164         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25165         "type": "json"
25166       }
25167     ],
25168     "name": "download",
25169     "group": "Square_Recordings",
25170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
25177     "url": "/api/square/recordings/{id}",
25178     "title": "Update an existing Recording",
25179     "examples": [
25180       {
25181         "title": "Example usage:",
25182         "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",
25183         "type": "json"
25184       }
25185     ],
25186     "name": "updateRecordings",
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": "post",
25195     "url": "/api/square/reports",
25196     "title": "Creates a new Square Report",
25197     "examples": [
25198       {
25199         "title": "Example usage:",
25200         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25201         "type": "json"
25202       }
25203     ],
25204     "name": "CreateSquare_Reports",
25205     "group": "Square_Reports",
25206     "parameter": {
25207       "fields": {
25208         "Body": [
25209           {
25210             "group": "Body",
25211             "type": "String",
25212             "optional": true,
25213             "field": "network",
25214             "description": ""
25215           },
25216           {
25217             "group": "Body",
25218             "type": "String",
25219             "optional": true,
25220             "field": "network_script",
25221             "description": ""
25222           },
25223           {
25224             "group": "Body",
25225             "type": "String",
25226             "optional": true,
25227             "field": "request",
25228             "description": ""
25229           },
25230           {
25231             "group": "Body",
25232             "type": "String",
25233             "optional": true,
25234             "field": "channel",
25235             "description": ""
25236           },
25237           {
25238             "group": "Body",
25239             "type": "String",
25240             "optional": true,
25241             "field": "language",
25242             "description": ""
25243           },
25244           {
25245             "group": "Body",
25246             "type": "String",
25247             "optional": true,
25248             "field": "type",
25249             "description": ""
25250           },
25251           {
25252             "group": "Body",
25253             "type": "String",
25254             "optional": true,
25255             "field": "uniqueid",
25256             "description": ""
25257           },
25258           {
25259             "group": "Body",
25260             "type": "String",
25261             "optional": true,
25262             "field": "version",
25263             "description": ""
25264           },
25265           {
25266             "group": "Body",
25267             "type": "String",
25268             "optional": true,
25269             "field": "callerid",
25270             "description": ""
25271           },
25272           {
25273             "group": "Body",
25274             "type": "String",
25275             "optional": true,
25276             "field": "calleridname",
25277             "description": ""
25278           },
25279           {
25280             "group": "Body",
25281             "type": "String",
25282             "optional": true,
25283             "field": "callingpres",
25284             "description": ""
25285           },
25286           {
25287             "group": "Body",
25288             "type": "String",
25289             "optional": true,
25290             "field": "callingani2",
25291             "description": ""
25292           },
25293           {
25294             "group": "Body",
25295             "type": "String",
25296             "optional": true,
25297             "field": "callington",
25298             "description": ""
25299           },
25300           {
25301             "group": "Body",
25302             "type": "String",
25303             "optional": true,
25304             "field": "callingtns",
25305             "description": ""
25306           },
25307           {
25308             "group": "Body",
25309             "type": "String",
25310             "optional": true,
25311             "field": "dnid",
25312             "description": ""
25313           },
25314           {
25315             "group": "Body",
25316             "type": "String",
25317             "optional": true,
25318             "field": "rdnis",
25319             "description": ""
25320           },
25321           {
25322             "group": "Body",
25323             "type": "String",
25324             "optional": true,
25325             "field": "context",
25326             "description": ""
25327           },
25328           {
25329             "group": "Body",
25330             "type": "String",
25331             "optional": true,
25332             "field": "extension",
25333             "description": ""
25334           },
25335           {
25336             "group": "Body",
25337             "type": "String",
25338             "optional": true,
25339             "field": "priority",
25340             "description": ""
25341           },
25342           {
25343             "group": "Body",
25344             "type": "String",
25345             "optional": true,
25346             "field": "enhanced",
25347             "description": ""
25348           },
25349           {
25350             "group": "Body",
25351             "type": "String",
25352             "optional": true,
25353             "field": "accountcode",
25354             "description": ""
25355           },
25356           {
25357             "group": "Body",
25358             "type": "String",
25359             "optional": true,
25360             "field": "threadid",
25361             "description": ""
25362           },
25363           {
25364             "group": "Body",
25365             "type": "String",
25366             "optional": true,
25367             "field": "project_name",
25368             "description": ""
25369           },
25370           {
25371             "group": "Body",
25372             "type": "String",
25373             "optional": true,
25374             "field": "joinAt",
25375             "description": ""
25376           },
25377           {
25378             "group": "Body",
25379             "type": "String",
25380             "optional": true,
25381             "field": "leaveAt",
25382             "description": ""
25383           },
25384           {
25385             "group": "Body",
25386             "type": "Boolean",
25387             "optional": true,
25388             "field": "bot",
25389             "description": ""
25390           }
25391         ]
25392       }
25393     },
25394     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25395     "version": "0.0.0",
25396     "filename": "server/api/squareReport/index.js",
25397     "groupTitle": "Square_Reports"
25398   },
25399   {
25400     "type": "delete",
25401     "url": "/api/square/reports/{id}",
25402     "title": "Deletes a Square Report",
25403     "examples": [
25404       {
25405         "title": "Example usage:",
25406         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25407         "type": "json"
25408       }
25409     ],
25410     "name": "DeleteSquare_Reports",
25411     "group": "Square_Reports",
25412     "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>",
25413     "version": "0.0.0",
25414     "filename": "server/api/squareReport/index.js",
25415     "groupTitle": "Square_Reports"
25416   },
25417   {
25418     "type": "get",
25419     "url": "/api/square/reports/describe",
25420     "title": "Gets table info about Square Reports",
25421     "examples": [
25422       {
25423         "title": "Example usage:",
25424         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25425         "type": "json"
25426       }
25427     ],
25428     "name": "DescribeSquare_Reports",
25429     "group": "Square_Reports",
25430     "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>",
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",
25438     "title": "Gets a list of Square Reports",
25439     "examples": [
25440       {
25441         "title": "Example usage:",
25442         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25443         "type": "json"
25444       }
25445     ],
25446     "name": "GetSquare_Reports",
25447     "group": "Square_Reports",
25448     "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>",
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/{id}",
25456     "title": "Gets a single Square Report",
25457     "examples": [
25458       {
25459         "title": "Example usage:",
25460         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25461         "type": "json"
25462       }
25463     ],
25464     "name": "ShowSquare_Reports",
25465     "group": "Square_Reports",
25466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25467     "version": "0.0.0",
25468     "filename": "server/api/squareReport/index.js",
25469     "groupTitle": "Square_Reports"
25470   },
25471   {
25472     "type": "put",
25473     "url": "/api/square/reports/{id}",
25474     "title": "Update an existing Square Report",
25475     "examples": [
25476       {
25477         "title": "Example usage:",
25478         "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",
25479         "type": "json"
25480       }
25481     ],
25482     "name": "updateSquare_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": "post",
25491     "url": "/api/integrations/sugarcrm/configurations",
25492     "title": "Creates a new SugarCRM Configuration",
25493     "examples": [
25494       {
25495         "title": "Example usage:",
25496         "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",
25497         "type": "json"
25498       }
25499     ],
25500     "name": "CreateSugarCRM_Configurations",
25501     "group": "SugarCRM_Configurations",
25502     "parameter": {
25503       "fields": {
25504         "Body": [
25505           {
25506             "group": "Body",
25507             "type": "String",
25508             "optional": true,
25509             "field": "name",
25510             "description": ""
25511           },
25512           {
25513             "group": "Body",
25514             "type": "String",
25515             "optional": true,
25516             "field": "description",
25517             "description": ""
25518           }
25519         ]
25520       }
25521     },
25522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25523     "version": "0.0.0",
25524     "filename": "server/api/intSugarcrmConfiguration/index.js",
25525     "groupTitle": "SugarCRM_Configurations"
25526   },
25527   {
25528     "type": "delete",
25529     "url": "/api/integrations/sugarcrm/configurations/{id}",
25530     "title": "Deletes a SugarCRM Configuration",
25531     "examples": [
25532       {
25533         "title": "Example usage:",
25534         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25535         "type": "json"
25536       }
25537     ],
25538     "name": "DeleteSugarCRM_Configurations",
25539     "group": "SugarCRM_Configurations",
25540     "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>",
25541     "version": "0.0.0",
25542     "filename": "server/api/intSugarcrmConfiguration/index.js",
25543     "groupTitle": "SugarCRM_Configurations"
25544   },
25545   {
25546     "type": "get",
25547     "url": "/api/integrations/sugarcrm/configurations",
25548     "title": "Gets a list of SugarCRM Configurations",
25549     "examples": [
25550       {
25551         "title": "Example usage:",
25552         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25553         "type": "json"
25554       }
25555     ],
25556     "name": "GetSugarCRM_Configurations",
25557     "group": "SugarCRM_Configurations",
25558     "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>",
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/{id}",
25566     "title": "Gets a single SugarCRM Configuration",
25567     "examples": [
25568       {
25569         "title": "Example usage:",
25570         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25571         "type": "json"
25572       }
25573     ],
25574     "name": "ShowSugarCRM_Configurations",
25575     "group": "SugarCRM_Configurations",
25576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25577     "version": "0.0.0",
25578     "filename": "server/api/intSugarcrmConfiguration/index.js",
25579     "groupTitle": "SugarCRM_Configurations"
25580   },
25581   {
25582     "type": "put",
25583     "url": "/api/integrations/sugarcrm/configurations/{id}",
25584     "title": "Update an existing SugarCRM Configuration",
25585     "examples": [
25586       {
25587         "title": "Example usage:",
25588         "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",
25589         "type": "json"
25590       }
25591     ],
25592     "name": "updateSugarCRM_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": "post",
25601     "url": "/api/integrations/sugarcrm/accounts",
25602     "title": "Creates a new Sugarcrm Account",
25603     "examples": [
25604       {
25605         "title": "Example usage:",
25606         "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",
25607         "type": "json"
25608       }
25609     ],
25610     "name": "CreateSugarcrm_Accounts",
25611     "group": "Sugarcrm_Accounts",
25612     "parameter": {
25613       "fields": {
25614         "Body": [
25615           {
25616             "group": "Body",
25617             "type": "String",
25618             "optional": true,
25619             "field": "name",
25620             "description": ""
25621           },
25622           {
25623             "group": "Body",
25624             "type": "String",
25625             "optional": true,
25626             "field": "description",
25627             "description": ""
25628           },
25629           {
25630             "group": "Body",
25631             "type": "String",
25632             "optional": true,
25633             "field": "username",
25634             "description": ""
25635           },
25636           {
25637             "group": "Body",
25638             "type": "String",
25639             "optional": true,
25640             "field": "password",
25641             "description": ""
25642           },
25643           {
25644             "group": "Body",
25645             "type": "String",
25646             "optional": true,
25647             "field": "remoteUri",
25648             "description": ""
25649           },
25650           {
25651             "group": "Body",
25652             "type": "String",
25653             "optional": false,
25654             "field": "serverUrl",
25655             "description": ""
25656           }
25657         ]
25658       }
25659     },
25660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25661     "version": "0.0.0",
25662     "filename": "server/api/intSugarcrmAccount/index.js",
25663     "groupTitle": "Sugarcrm_Accounts"
25664   },
25665   {
25666     "type": "delete",
25667     "url": "/api/integrations/sugarcrm/accounts/{id}",
25668     "title": "Deletes a Sugarcrm Account",
25669     "examples": [
25670       {
25671         "title": "Example usage:",
25672         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25673         "type": "json"
25674       }
25675     ],
25676     "name": "DeleteSugarcrm_Accounts",
25677     "group": "Sugarcrm_Accounts",
25678     "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>",
25679     "version": "0.0.0",
25680     "filename": "server/api/intSugarcrmAccount/index.js",
25681     "groupTitle": "Sugarcrm_Accounts"
25682   },
25683   {
25684     "type": "get",
25685     "url": "/api/integrations/sugarcrm/accounts",
25686     "title": "Gets a list of Sugarcrm Accounts",
25687     "examples": [
25688       {
25689         "title": "Example usage:",
25690         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25691         "type": "json"
25692       }
25693     ],
25694     "name": "GetSugarcrm_Accounts",
25695     "group": "Sugarcrm_Accounts",
25696     "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>",
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/{id}",
25704     "title": "Gets a single Sugarcrm Account",
25705     "examples": [
25706       {
25707         "title": "Example usage:",
25708         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25709         "type": "json"
25710       }
25711     ],
25712     "name": "ShowSugarcrm_Accounts",
25713     "group": "Sugarcrm_Accounts",
25714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25715     "version": "0.0.0",
25716     "filename": "server/api/intSugarcrmAccount/index.js",
25717     "groupTitle": "Sugarcrm_Accounts"
25718   },
25719   {
25720     "type": "post",
25721     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25722     "title": "Creates new configuration",
25723     "examples": [
25724       {
25725         "title": "Example usage:",
25726         "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",
25727         "type": "json"
25728       }
25729     ],
25730     "name": "addConfiguration",
25731     "group": "Sugarcrm_Accounts",
25732     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
25739     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25740     "title": "Gets account configurations",
25741     "examples": [
25742       {
25743         "title": "Example usage:",
25744         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25745         "type": "json"
25746       }
25747     ],
25748     "name": "getConfigurations",
25749     "group": "Sugarcrm_Accounts",
25750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
25758     "title": "Gets account fields",
25759     "examples": [
25760       {
25761         "title": "Example usage:",
25762         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25763         "type": "json"
25764       }
25765     ],
25766     "name": "getFields",
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": "put",
25775     "url": "/api/integrations/sugarcrm/accounts/{id}",
25776     "title": "Update an existing Sugarcrm Account",
25777     "examples": [
25778       {
25779         "title": "Example usage:",
25780         "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",
25781         "type": "json"
25782       }
25783     ],
25784     "name": "updateSugarcrm_Accounts",
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": "get",
25793     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25794     "title": "Gets configurations descriptions",
25795     "examples": [
25796       {
25797         "title": "Example usage:",
25798         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25799         "type": "json"
25800       }
25801     ],
25802     "name": "getDescriptions",
25803     "group": "Sugarcrm_Configurations",
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/intSugarcrmConfiguration/index.js",
25807     "groupTitle": "Sugarcrm_Configurations"
25808   },
25809   {
25810     "type": "get",
25811     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25812     "title": "Gets configurations fields",
25813     "examples": [
25814       {
25815         "title": "Example usage:",
25816         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25817         "type": "json"
25818       }
25819     ],
25820     "name": "getFields",
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}/subjects",
25830     "title": "Gets configurations subjects",
25831     "examples": [
25832       {
25833         "title": "Example usage:",
25834         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25835         "type": "json"
25836       }
25837     ],
25838     "name": "getSubjects",
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": "post",
25847     "url": "/api/integrations/sugarcrm/fields",
25848     "title": "Creates a new Sugarcrm Field",
25849     "examples": [
25850       {
25851         "title": "Example usage:",
25852         "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",
25853         "type": "json"
25854       }
25855     ],
25856     "name": "CreateSugarcrm_Fields",
25857     "group": "Sugarcrm_Fields",
25858     "parameter": {
25859       "fields": {
25860         "Body": [
25861           {
25862             "group": "Body",
25863             "type": "String",
25864             "allowedValues": [
25865               "\"string\"",
25866               "\"variable\"",
25867               "\"customVariable\"",
25868               "\"keyValue\"",
25869               "\"picklist\""
25870             ],
25871             "optional": true,
25872             "field": "type",
25873             "description": ""
25874           },
25875           {
25876             "group": "Body",
25877             "type": "String",
25878             "optional": true,
25879             "field": "content",
25880             "description": ""
25881           },
25882           {
25883             "group": "Body",
25884             "type": "String",
25885             "optional": true,
25886             "field": "key",
25887             "description": ""
25888           },
25889           {
25890             "group": "Body",
25891             "type": "String",
25892             "allowedValues": [
25893               "\"string\"",
25894               "\"variable\"",
25895               "\"customVariable\""
25896             ],
25897             "optional": true,
25898             "field": "keyType",
25899             "description": ""
25900           },
25901           {
25902             "group": "Body",
25903             "type": "String",
25904             "optional": true,
25905             "field": "keyContent",
25906             "description": ""
25907           },
25908           {
25909             "group": "Body",
25910             "type": "String",
25911             "optional": true,
25912             "field": "idField",
25913             "description": ""
25914           },
25915           {
25916             "group": "Body",
25917             "type": "String",
25918             "optional": true,
25919             "field": "nameField",
25920             "description": ""
25921           },
25922           {
25923             "group": "Body",
25924             "type": "Boolean",
25925             "optional": true,
25926             "field": "customField",
25927             "description": ""
25928           },
25929           {
25930             "group": "Body",
25931             "type": "String",
25932             "optional": true,
25933             "field": "variableName",
25934             "description": ""
25935           }
25936         ]
25937       }
25938     },
25939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25940     "version": "0.0.0",
25941     "filename": "server/api/intSugarcrmField/index.js",
25942     "groupTitle": "Sugarcrm_Fields"
25943   },
25944   {
25945     "type": "delete",
25946     "url": "/api/integrations/sugarcrm/fields/{id}",
25947     "title": "Deletes a Sugarcrm Field",
25948     "examples": [
25949       {
25950         "title": "Example usage:",
25951         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25952         "type": "json"
25953       }
25954     ],
25955     "name": "DeleteSugarcrm_Fields",
25956     "group": "Sugarcrm_Fields",
25957     "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>",
25958     "version": "0.0.0",
25959     "filename": "server/api/intSugarcrmField/index.js",
25960     "groupTitle": "Sugarcrm_Fields"
25961   },
25962   {
25963     "type": "get",
25964     "url": "/api/integrations/sugarcrm/fields",
25965     "title": "Gets a list of Sugarcrm Fields",
25966     "examples": [
25967       {
25968         "title": "Example usage:",
25969         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25970         "type": "json"
25971       }
25972     ],
25973     "name": "GetSugarcrm_Fields",
25974     "group": "Sugarcrm_Fields",
25975     "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>",
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/{id}",
25983     "title": "Gets a single Sugarcrm Field",
25984     "examples": [
25985       {
25986         "title": "Example usage:",
25987         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25988         "type": "json"
25989       }
25990     ],
25991     "name": "ShowSugarcrm_Fields",
25992     "group": "Sugarcrm_Fields",
25993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25994     "version": "0.0.0",
25995     "filename": "server/api/intSugarcrmField/index.js",
25996     "groupTitle": "Sugarcrm_Fields"
25997   },
25998   {
25999     "type": "put",
26000     "url": "/api/integrations/sugarcrm/fields/{id}",
26001     "title": "Update an existing Sugarcrm Field",
26002     "examples": [
26003       {
26004         "title": "Example usage:",
26005         "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",
26006         "type": "json"
26007       }
26008     ],
26009     "name": "updateSugarcrm_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": "get",
26018     "url": "/api/system",
26019     "title": "Gets system information",
26020     "examples": [
26021       {
26022         "title": "Example usage:",
26023         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26024         "type": "json"
26025       }
26026     ],
26027     "name": "GetSystemInformation",
26028     "group": "System_Information",
26029     "description": "<p>Motion returns the system information.</p>",
26030     "version": "0.0.0",
26031     "filename": "server/api/system/index.js",
26032     "groupTitle": "System_Information"
26033   },
26034   {
26035     "type": "get",
26036     "url": "/api/system/process",
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": "post",
26054     "url": "/api/tags",
26055     "title": "Creates a new Tag",
26056     "examples": [
26057       {
26058         "title": "Example usage:",
26059         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26060         "type": "json"
26061       }
26062     ],
26063     "name": "CreateTags",
26064     "group": "Tags",
26065     "parameter": {
26066       "fields": {
26067         "Body": [
26068           {
26069             "group": "Body",
26070             "type": "String",
26071             "optional": false,
26072             "field": "name",
26073             "description": ""
26074           },
26075           {
26076             "group": "Body",
26077             "type": "String",
26078             "optional": true,
26079             "field": "color",
26080             "description": ""
26081           },
26082           {
26083             "group": "Body",
26084             "type": "String",
26085             "optional": true,
26086             "field": "description",
26087             "description": ""
26088           }
26089         ]
26090       }
26091     },
26092     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26093     "version": "0.0.0",
26094     "filename": "server/api/tag/index.js",
26095     "groupTitle": "Tags"
26096   },
26097   {
26098     "type": "delete",
26099     "url": "/api/tags/{id}",
26100     "title": "Deletes a Tag",
26101     "examples": [
26102       {
26103         "title": "Example usage:",
26104         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26105         "type": "json"
26106       }
26107     ],
26108     "name": "DeleteTags",
26109     "group": "Tags",
26110     "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>",
26111     "version": "0.0.0",
26112     "filename": "server/api/tag/index.js",
26113     "groupTitle": "Tags"
26114   },
26115   {
26116     "type": "get",
26117     "url": "/api/tags",
26118     "title": "Gets a list of Tags",
26119     "examples": [
26120       {
26121         "title": "Example usage:",
26122         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26123         "type": "json"
26124       }
26125     ],
26126     "name": "GetTags",
26127     "group": "Tags",
26128     "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>",
26129     "version": "0.0.0",
26130     "filename": "server/api/tag/index.js",
26131     "groupTitle": "Tags"
26132   },
26133   {
26134     "type": "get",
26135     "url": "/api/tags/{id}",
26136     "title": "Gets a single Tag",
26137     "examples": [
26138       {
26139         "title": "Example usage:",
26140         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26141         "type": "json"
26142       }
26143     ],
26144     "name": "ShowTags",
26145     "group": "Tags",
26146     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26147     "version": "0.0.0",
26148     "filename": "server/api/tag/index.js",
26149     "groupTitle": "Tags"
26150   },
26151   {
26152     "type": "put",
26153     "url": "/api/tags/{id}",
26154     "title": "Update an existing Tag",
26155     "examples": [
26156       {
26157         "title": "Example usage:",
26158         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26159         "type": "json"
26160       }
26161     ],
26162     "name": "updateTags",
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": "post",
26171     "url": "/api/teams/{id}/queues",
26172     "title": "Add queues to a team",
26173     "examples": [
26174       {
26175         "title": "Example usage:",
26176         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26177         "type": "json"
26178       }
26179     ],
26180     "name": "AddQueues",
26181     "group": "Teams",
26182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183     "version": "0.0.0",
26184     "filename": "server/api/team/index.js",
26185     "groupTitle": "Teams"
26186   },
26187   {
26188     "type": "post",
26189     "url": "/api/teams",
26190     "title": "Creates a new Team",
26191     "examples": [
26192       {
26193         "title": "Example usage:",
26194         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26195         "type": "json"
26196       }
26197     ],
26198     "name": "CreateTeams",
26199     "group": "Teams",
26200     "parameter": {
26201       "fields": {
26202         "Body": [
26203           {
26204             "group": "Body",
26205             "type": "String",
26206             "optional": false,
26207             "field": "name",
26208             "description": ""
26209           },
26210           {
26211             "group": "Body",
26212             "type": "String",
26213             "optional": true,
26214             "field": "description",
26215             "description": ""
26216           }
26217         ]
26218       }
26219     },
26220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26221     "version": "0.0.0",
26222     "filename": "server/api/team/index.js",
26223     "groupTitle": "Teams"
26224   },
26225   {
26226     "type": "delete",
26227     "url": "/api/teams/{id}",
26228     "title": "Deletes a Team",
26229     "examples": [
26230       {
26231         "title": "Example usage:",
26232         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26233         "type": "json"
26234       }
26235     ],
26236     "name": "DeleteTeams",
26237     "group": "Teams",
26238     "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>",
26239     "version": "0.0.0",
26240     "filename": "server/api/team/index.js",
26241     "groupTitle": "Teams"
26242   },
26243   {
26244     "type": "get",
26245     "url": "/api/teams/{id}/users",
26246     "title": "Gets agents from team",
26247     "examples": [
26248       {
26249         "title": "Example usage:",
26250         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26251         "type": "json"
26252       }
26253     ],
26254     "name": "GetAgents",
26255     "group": "Teams",
26256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/queues?channel={channel}",
26264     "title": "Gets Queues list",
26265     "examples": [
26266       {
26267         "title": "Example usage:",
26268         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26269         "type": "json"
26270       }
26271     ],
26272     "name": "GetQueues",
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",
26282     "title": "Gets a list of Teams",
26283     "examples": [
26284       {
26285         "title": "Example usage:",
26286         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26287         "type": "json"
26288       }
26289     ],
26290     "name": "GetTeams",
26291     "group": "Teams",
26292     "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>",
26293     "version": "0.0.0",
26294     "filename": "server/api/team/index.js",
26295     "groupTitle": "Teams"
26296   },
26297   {
26298     "type": "delete",
26299     "url": "/api/teams/{id}/users",
26300     "title": "Removes agents from a team",
26301     "examples": [
26302       {
26303         "title": "Example usage:",
26304         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26305         "type": "json"
26306       }
26307     ],
26308     "name": "RemoveAgents",
26309     "group": "Teams",
26310     "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>",
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}/queues",
26318     "title": "Remove queues to a team",
26319     "examples": [
26320       {
26321         "title": "Example usage:",
26322         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26323         "type": "json"
26324       }
26325     ],
26326     "name": "RemoveQueues",
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/voice/Prefixes/{id}/teams",
26336     "title": "Remove teams from a voice prefix",
26337     "examples": [
26338       {
26339         "title": "Example usage:",
26340         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26341         "type": "json"
26342       }
26343     ],
26344     "name": "RemoveTeams",
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/voicePrefix/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/fax/queues/{id}/teams",
26372     "title": "Remove teams from a queue",
26373     "examples": [
26374       {
26375         "title": "Example usage:",
26376         "content": "curl https://{domain}/api/fax/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/faxQueue/index.js",
26385     "groupTitle": "Teams"
26386   },
26387   {
26388     "type": "delete",
26389     "url": "/api/mail/queues/{id}/teams",
26390     "title": "Remove teams from a queue",
26391     "examples": [
26392       {
26393         "title": "Example usage:",
26394         "content": "curl https://{domain}/api/mail/queues/{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/mailQueue/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/chat/queues/{id}/teams",
26444     "title": "Remove teams from a queue",
26445     "examples": [
26446       {
26447         "title": "Example usage:",
26448         "content": "curl https://{domain}/api/chat/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/chatQueue/index.js",
26457     "groupTitle": "Teams"
26458   },
26459   {
26460     "type": "delete",
26461     "url": "/api/voice/queues/{id}/teams",
26462     "title": "Remove teams from a queue",
26463     "examples": [
26464       {
26465         "title": "Example usage:",
26466         "content": "curl https://{domain}/api/voice/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/voiceQueue/index.js",
26475     "groupTitle": "Teams"
26476   },
26477   {
26478     "type": "get",
26479     "url": "/api/teams/{id}",
26480     "title": "Gets a single Team",
26481     "examples": [
26482       {
26483         "title": "Example usage:",
26484         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26485         "type": "json"
26486       }
26487     ],
26488     "name": "ShowTeams",
26489     "group": "Teams",
26490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/team/index.js",
26493     "groupTitle": "Teams"
26494   },
26495   {
26496     "type": "post",
26497     "url": "/api/teams/{id}/users",
26498     "title": "Adds agents to a team",
26499     "examples": [
26500       {
26501         "title": "Example usage:",
26502         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26503         "type": "json"
26504       }
26505     ],
26506     "name": "addAgents",
26507     "group": "Teams",
26508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
26515     "url": "/api/teams/{id}",
26516     "title": "Update an existing Team",
26517     "examples": [
26518       {
26519         "title": "Example usage:",
26520         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26521         "type": "json"
26522       }
26523     ],
26524     "name": "updateTeams",
26525     "group": "Teams",
26526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
26533     "url": "/api/templates",
26534     "title": "Creates a new Template",
26535     "examples": [
26536       {
26537         "title": "Example usage:",
26538         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26539         "type": "json"
26540       }
26541     ],
26542     "name": "CreateTemplates",
26543     "group": "Templates",
26544     "parameter": {
26545       "fields": {
26546         "Body": [
26547           {
26548             "group": "Body",
26549             "type": "String",
26550             "optional": true,
26551             "field": "name",
26552             "description": ""
26553           },
26554           {
26555             "group": "Body",
26556             "type": "String",
26557             "optional": true,
26558             "field": "description",
26559             "description": ""
26560           },
26561           {
26562             "group": "Body",
26563             "type": "Text",
26564             "optional": true,
26565             "field": "html",
26566             "description": ""
26567           }
26568         ]
26569       }
26570     },
26571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26572     "version": "0.0.0",
26573     "filename": "server/api/template/index.js",
26574     "groupTitle": "Templates"
26575   },
26576   {
26577     "type": "delete",
26578     "url": "/api/templates/{id}",
26579     "title": "Deletes a Template",
26580     "examples": [
26581       {
26582         "title": "Example usage:",
26583         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26584         "type": "json"
26585       }
26586     ],
26587     "name": "DeleteTemplates",
26588     "group": "Templates",
26589     "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>",
26590     "version": "0.0.0",
26591     "filename": "server/api/template/index.js",
26592     "groupTitle": "Templates"
26593   },
26594   {
26595     "type": "get",
26596     "url": "/api/templates",
26597     "title": "Gets a list of Templates",
26598     "examples": [
26599       {
26600         "title": "Example usage:",
26601         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26602         "type": "json"
26603       }
26604     ],
26605     "name": "GetTemplates",
26606     "group": "Templates",
26607     "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>",
26608     "version": "0.0.0",
26609     "filename": "server/api/template/index.js",
26610     "groupTitle": "Templates"
26611   },
26612   {
26613     "type": "get",
26614     "url": "/api/templates/{id}",
26615     "title": "Gets a single Template",
26616     "examples": [
26617       {
26618         "title": "Example usage:",
26619         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26620         "type": "json"
26621       }
26622     ],
26623     "name": "ShowTemplates",
26624     "group": "Templates",
26625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26626     "version": "0.0.0",
26627     "filename": "server/api/template/index.js",
26628     "groupTitle": "Templates"
26629   },
26630   {
26631     "type": "put",
26632     "url": "/api/templates/{id}",
26633     "title": "Update an existing Template",
26634     "examples": [
26635       {
26636         "title": "Example usage:",
26637         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26638         "type": "json"
26639       }
26640     ],
26641     "name": "updateTemplates",
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": "post",
26650     "url": "/api/triggers",
26651     "title": "Creates a new Trigger",
26652     "examples": [
26653       {
26654         "title": "Example usage:",
26655         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26656         "type": "json"
26657       }
26658     ],
26659     "name": "CreateTriggers",
26660     "group": "Triggers",
26661     "parameter": {
26662       "fields": {
26663         "Body": [
26664           {
26665             "group": "Body",
26666             "type": "String",
26667             "optional": true,
26668             "field": "name",
26669             "description": ""
26670           },
26671           {
26672             "group": "Body",
26673             "type": "String",
26674             "optional": true,
26675             "field": "channel",
26676             "description": ""
26677           },
26678           {
26679             "group": "Body",
26680             "type": "String",
26681             "optional": true,
26682             "field": "description",
26683             "description": ""
26684           },
26685           {
26686             "group": "Body",
26687             "type": "Boolean",
26688             "optional": true,
26689             "field": "status",
26690             "description": ""
26691           }
26692         ]
26693       }
26694     },
26695     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26696     "version": "0.0.0",
26697     "filename": "server/api/trigger/index.js",
26698     "groupTitle": "Triggers"
26699   },
26700   {
26701     "type": "delete",
26702     "url": "/api/triggers/{id}",
26703     "title": "Deletes a Trigger",
26704     "examples": [
26705       {
26706         "title": "Example usage:",
26707         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26708         "type": "json"
26709       }
26710     ],
26711     "name": "DeleteTriggers",
26712     "group": "Triggers",
26713     "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>",
26714     "version": "0.0.0",
26715     "filename": "server/api/trigger/index.js",
26716     "groupTitle": "Triggers"
26717   },
26718   {
26719     "type": "get",
26720     "url": "/api/triggers",
26721     "title": "Gets a list of Triggers",
26722     "examples": [
26723       {
26724         "title": "Example usage:",
26725         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26726         "type": "json"
26727       }
26728     ],
26729     "name": "GetTriggers",
26730     "group": "Triggers",
26731     "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>",
26732     "version": "0.0.0",
26733     "filename": "server/api/trigger/index.js",
26734     "groupTitle": "Triggers"
26735   },
26736   {
26737     "type": "get",
26738     "url": "/api/triggers/{id}",
26739     "title": "Gets a single Trigger",
26740     "examples": [
26741       {
26742         "title": "Example usage:",
26743         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26744         "type": "json"
26745       }
26746     ],
26747     "name": "ShowTriggers",
26748     "group": "Triggers",
26749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26750     "version": "0.0.0",
26751     "filename": "server/api/trigger/index.js",
26752     "groupTitle": "Triggers"
26753   },
26754   {
26755     "type": "post",
26756     "url": "/api/triggers/{id}/actions",
26757     "title": "Creates new actions",
26758     "examples": [
26759       {
26760         "title": "Example usage:",
26761         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26762         "type": "json"
26763       }
26764     ],
26765     "name": "addAction",
26766     "group": "Triggers",
26767     "parameter": {
26768       "fields": {
26769         "Body": [
26770           {
26771             "group": "Body",
26772             "type": "Virtual",
26773             "optional": true,
26774             "field": "name",
26775             "description": ""
26776           },
26777           {
26778             "group": "Body",
26779             "type": "String",
26780             "optional": false,
26781             "field": "action",
26782             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26783           },
26784           {
26785             "group": "Body",
26786             "type": "String",
26787             "optional": true,
26788             "field": "data1",
26789             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26790           },
26791           {
26792             "group": "Body",
26793             "type": "String",
26794             "optional": true,
26795             "field": "data2",
26796             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26797           },
26798           {
26799             "group": "Body",
26800             "type": "String",
26801             "optional": true,
26802             "field": "data3",
26803             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26804           },
26805           {
26806             "group": "Body",
26807             "type": "String",
26808             "optional": true,
26809             "field": "data4",
26810             "description": ""
26811           },
26812           {
26813             "group": "Body",
26814             "type": "String",
26815             "optional": true,
26816             "field": "data5",
26817             "description": ""
26818           },
26819           {
26820             "group": "Body",
26821             "type": "String",
26822             "optional": true,
26823             "field": "data6",
26824             "description": ""
26825           },
26826           {
26827             "group": "Body",
26828             "type": "Text",
26829             "optional": true,
26830             "field": "data7",
26831             "description": ""
26832           }
26833         ]
26834       }
26835     },
26836     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26837     "version": "0.0.0",
26838     "filename": "server/api/trigger/index.js",
26839     "groupTitle": "Triggers"
26840   },
26841   {
26842     "type": "post",
26843     "url": "/api/triggers/{id}/all_conditions",
26844     "title": "Creates a new \"AND\"condition",
26845     "examples": [
26846       {
26847         "title": "Example usage:",
26848         "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",
26849         "type": "json"
26850       }
26851     ],
26852     "name": "addAllCondition",
26853     "group": "Triggers",
26854     "parameter": {
26855       "fields": {
26856         "Body": [
26857           {
26858             "group": "Body",
26859             "type": "Virtual",
26860             "optional": true,
26861             "field": "name",
26862             "description": ""
26863           },
26864           {
26865             "group": "Body",
26866             "type": "String",
26867             "optional": false,
26868             "field": "field",
26869             "description": ""
26870           },
26871           {
26872             "group": "Body",
26873             "type": "String",
26874             "optional": false,
26875             "field": "operator",
26876             "description": ""
26877           },
26878           {
26879             "group": "Body",
26880             "type": "String",
26881             "optional": false,
26882             "field": "value",
26883             "description": ""
26884           }
26885         ]
26886       }
26887     },
26888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26889     "version": "0.0.0",
26890     "filename": "server/api/trigger/index.js",
26891     "groupTitle": "Triggers"
26892   },
26893   {
26894     "type": "post",
26895     "url": "/api/triggers/{id}/any_conditions",
26896     "title": "Creates a new \"OR\"condition",
26897     "examples": [
26898       {
26899         "title": "Example usage:",
26900         "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",
26901         "type": "json"
26902       }
26903     ],
26904     "name": "addAnyCondition",
26905     "group": "Triggers",
26906     "parameter": {
26907       "fields": {
26908         "Body": [
26909           {
26910             "group": "Body",
26911             "type": "Virtual",
26912             "optional": true,
26913             "field": "name",
26914             "description": ""
26915           },
26916           {
26917             "group": "Body",
26918             "type": "String",
26919             "optional": false,
26920             "field": "field",
26921             "description": ""
26922           },
26923           {
26924             "group": "Body",
26925             "type": "String",
26926             "optional": false,
26927             "field": "operator",
26928             "description": ""
26929           },
26930           {
26931             "group": "Body",
26932             "type": "String",
26933             "optional": false,
26934             "field": "value",
26935             "description": ""
26936           }
26937         ]
26938       }
26939     },
26940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26941     "version": "0.0.0",
26942     "filename": "server/api/trigger/index.js",
26943     "groupTitle": "Triggers"
26944   },
26945   {
26946     "type": "get",
26947     "url": "/api/triggers/{id}/actions",
26948     "title": "Gets Trigger Actions",
26949     "examples": [
26950       {
26951         "title": "Example usage:",
26952         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26953         "type": "json"
26954       }
26955     ],
26956     "name": "getActions",
26957     "group": "Triggers",
26958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/all_conditions",
26966     "title": "Gets \"AND\" Trigger Conditions",
26967     "examples": [
26968       {
26969         "title": "Example usage:",
26970         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26971         "type": "json"
26972       }
26973     ],
26974     "name": "getAllConditions",
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}/any_conditions",
26984     "title": "Gets \"OR\" Trigger Conditions",
26985     "examples": [
26986       {
26987         "title": "Example usage:",
26988         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26989         "type": "json"
26990       }
26991     ],
26992     "name": "getAnyConditions",
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": "put",
27001     "url": "/api/triggers/{id}",
27002     "title": "Update an existing Trigger",
27003     "examples": [
27004       {
27005         "title": "Example usage:",
27006         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27007         "type": "json"
27008       }
27009     ],
27010     "name": "updateTriggers",
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": "post",
27019     "url": "/api/trunks/clone",
27020     "title": "Clone an existing Trunk",
27021     "examples": [
27022       {
27023         "title": "Example usage:",
27024         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27025         "type": "json"
27026       }
27027     ],
27028     "name": "CloneTrunks",
27029     "group": "Trunks",
27030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27031     "version": "0.0.0",
27032     "filename": "server/api/trunk/index.js",
27033     "groupTitle": "Trunks"
27034   },
27035   {
27036     "type": "post",
27037     "url": "/api/trunks",
27038     "title": "Create a new trunk",
27039     "examples": [
27040       {
27041         "title": "Example usage:",
27042         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27043         "type": "json"
27044       }
27045     ],
27046     "name": "Create",
27047     "group": "Trunks",
27048     "parameter": {
27049       "fields": {
27050         "Body": [
27051           {
27052             "group": "Body",
27053             "type": "String",
27054             "optional": false,
27055             "field": "name",
27056             "description": ""
27057           },
27058           {
27059             "group": "Body",
27060             "type": "String",
27061             "allowedValues": [
27062               "\"friend\"",
27063               "\"user\"",
27064               "\"peer\""
27065             ],
27066             "optional": false,
27067             "field": "type",
27068             "description": ""
27069           },
27070           {
27071             "group": "Body",
27072             "type": "String",
27073             "optional": false,
27074             "field": "context",
27075             "description": ""
27076           },
27077           {
27078             "group": "Body",
27079             "type": "String",
27080             "allowedValues": [
27081               "\"ALLOWED_NOT_SCREENED\"",
27082               "\"ALLOWED_PASSED_SCREEN\"",
27083               "\"ALLOWED_FAILED_SCREEN\"",
27084               "\"ALLOWED\"",
27085               "\"PROHIB_NOT_SCREENED\"",
27086               "\"PROHIB_PASSED_SCREEN\"",
27087               "\"PROHIB_FAILED_SCREEN\"",
27088               "\"PROHIB\""
27089             ],
27090             "optional": true,
27091             "field": "callingpres",
27092             "description": ""
27093           },
27094           {
27095             "group": "Body",
27096             "type": "String",
27097             "optional": true,
27098             "field": "deny",
27099             "description": ""
27100           },
27101           {
27102             "group": "Body",
27103             "type": "String",
27104             "optional": true,
27105             "field": "permit",
27106             "description": ""
27107           },
27108           {
27109             "group": "Body",
27110             "type": "String",
27111             "optional": true,
27112             "field": "secret",
27113             "description": ""
27114           },
27115           {
27116             "group": "Body",
27117             "type": "String",
27118             "optional": true,
27119             "field": "md5secret",
27120             "description": ""
27121           },
27122           {
27123             "group": "Body",
27124             "type": "String",
27125             "optional": true,
27126             "field": "remotesecret",
27127             "description": ""
27128           },
27129           {
27130             "group": "Body",
27131             "type": "String",
27132             "optional": true,
27133             "field": "transport",
27134             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27135           },
27136           {
27137             "group": "Body",
27138             "type": "String",
27139             "allowedValues": [
27140               "\"rfc2833\"",
27141               "\"info\"",
27142               "\"shortinfo\"",
27143               "\"inband\"",
27144               "\"auto\""
27145             ],
27146             "optional": true,
27147             "field": "dtmfmode",
27148             "description": ""
27149           },
27150           {
27151             "group": "Body",
27152             "type": "String",
27153             "allowedValues": [
27154               "\"yes\"",
27155               "\"no\"",
27156               "\"nonat\"",
27157               "\"update\"",
27158               "\"outgoing\""
27159             ],
27160             "optional": true,
27161             "field": "directmedia",
27162             "description": ""
27163           },
27164           {
27165             "group": "Body",
27166             "type": "String",
27167             "allowedValues": [
27168               "\"yes\"",
27169               "\"no\""
27170             ],
27171             "optional": true,
27172             "field": "directrtpsetup",
27173             "description": ""
27174           },
27175           {
27176             "group": "Body",
27177             "type": "String",
27178             "optional": true,
27179             "field": "directmediapermit",
27180             "description": ""
27181           },
27182           {
27183             "group": "Body",
27184             "type": "String",
27185             "optional": true,
27186             "field": "directmediadeny",
27187             "description": ""
27188           },
27189           {
27190             "group": "Body",
27191             "type": "String",
27192             "optional": true,
27193             "field": "nat",
27194             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27195           },
27196           {
27197             "group": "Body",
27198             "type": "String",
27199             "optional": true,
27200             "field": "callgroup",
27201             "description": ""
27202           },
27203           {
27204             "group": "Body",
27205             "type": "String",
27206             "optional": true,
27207             "field": "namedcallgroup",
27208             "description": ""
27209           },
27210           {
27211             "group": "Body",
27212             "type": "String",
27213             "optional": true,
27214             "field": "pickupgroup",
27215             "description": ""
27216           },
27217           {
27218             "group": "Body",
27219             "type": "String",
27220             "optional": true,
27221             "field": "namedpickupgroup",
27222             "description": ""
27223           },
27224           {
27225             "group": "Body",
27226             "type": "String",
27227             "optional": true,
27228             "field": "language",
27229             "description": ""
27230           },
27231           {
27232             "group": "Body",
27233             "type": "String",
27234             "optional": true,
27235             "field": "tonezone",
27236             "description": ""
27237           },
27238           {
27239             "group": "Body",
27240             "type": "String",
27241             "optional": true,
27242             "field": "disallow",
27243             "description": ""
27244           },
27245           {
27246             "group": "Body",
27247             "type": "String",
27248             "optional": false,
27249             "field": "allow",
27250             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27251           },
27252           {
27253             "group": "Body",
27254             "type": "String",
27255             "allowedValues": [
27256               "\"yes\"",
27257               "\"no\""
27258             ],
27259             "optional": true,
27260             "field": "autoframing",
27261             "description": ""
27262           },
27263           {
27264             "group": "Body",
27265             "type": "String",
27266             "optional": true,
27267             "field": "insecure",
27268             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27269           },
27270           {
27271             "group": "Body",
27272             "type": "String",
27273             "allowedValues": [
27274               "\"yes\"",
27275               "\"no\""
27276             ],
27277             "optional": true,
27278             "field": "trustrpid",
27279             "description": ""
27280           },
27281           {
27282             "group": "Body",
27283             "type": "String",
27284             "allowedValues": [
27285               "\"yes\"",
27286               "\"no\""
27287             ],
27288             "optional": true,
27289             "field": "trust_id_outbound",
27290             "description": ""
27291           },
27292           {
27293             "group": "Body",
27294             "type": "String",
27295             "allowedValues": [
27296               "\"yes\"",
27297               "\"no\"",
27298               "\"never\""
27299             ],
27300             "optional": true,
27301             "field": "progressinband",
27302             "description": ""
27303           },
27304           {
27305             "group": "Body",
27306             "type": "String",
27307             "allowedValues": [
27308               "\"yes\"",
27309               "\"no\""
27310             ],
27311             "optional": true,
27312             "field": "promiscredir",
27313             "description": ""
27314           },
27315           {
27316             "group": "Body",
27317             "type": "String",
27318             "allowedValues": [
27319               "\"yes\"",
27320               "\"no\""
27321             ],
27322             "optional": true,
27323             "field": "useclientcode",
27324             "description": ""
27325           },
27326           {
27327             "group": "Body",
27328             "type": "Integer",
27329             "optional": true,
27330             "field": "accountcode",
27331             "description": ""
27332           },
27333           {
27334             "group": "Body",
27335             "type": "String",
27336             "optional": true,
27337             "field": "setvar",
27338             "description": ""
27339           },
27340           {
27341             "group": "Body",
27342             "type": "String",
27343             "optional": true,
27344             "field": "callerid",
27345             "description": ""
27346           },
27347           {
27348             "group": "Body",
27349             "type": "String",
27350             "optional": true,
27351             "field": "amaflags",
27352             "description": ""
27353           },
27354           {
27355             "group": "Body",
27356             "type": "String",
27357             "allowedValues": [
27358               "\"yes\"",
27359               "\"no\""
27360             ],
27361             "optional": true,
27362             "field": "callcounter",
27363             "description": ""
27364           },
27365           {
27366             "group": "Body",
27367             "type": "Integer",
27368             "optional": true,
27369             "field": "busylevel",
27370             "description": ""
27371           },
27372           {
27373             "group": "Body",
27374             "type": "String",
27375             "allowedValues": [
27376               "\"yes\"",
27377               "\"no\""
27378             ],
27379             "optional": true,
27380             "field": "allowoverlap",
27381             "description": ""
27382           },
27383           {
27384             "group": "Body",
27385             "type": "String",
27386             "allowedValues": [
27387               "\"yes\"",
27388               "\"no\""
27389             ],
27390             "optional": true,
27391             "field": "allowsubscribe",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "String",
27397             "allowedValues": [
27398               "\"yes\"",
27399               "\"no\""
27400             ],
27401             "optional": true,
27402             "field": "allowtransfer",
27403             "description": ""
27404           },
27405           {
27406             "group": "Body",
27407             "type": "String",
27408             "allowedValues": [
27409               "\"yes\"",
27410               "\"no\""
27411             ],
27412             "optional": true,
27413             "field": "ignoresdpversion",
27414             "description": ""
27415           },
27416           {
27417             "group": "Body",
27418             "type": "String",
27419             "optional": true,
27420             "field": "subscribecontext",
27421             "description": ""
27422           },
27423           {
27424             "group": "Body",
27425             "type": "String",
27426             "optional": true,
27427             "field": "template",
27428             "description": ""
27429           },
27430           {
27431             "group": "Body",
27432             "type": "String",
27433             "allowedValues": [
27434               "\"yes\"",
27435               "\"no\"",
27436               "\"always\""
27437             ],
27438             "optional": true,
27439             "field": "videosupport",
27440             "description": ""
27441           },
27442           {
27443             "group": "Body",
27444             "type": "Integer",
27445             "optional": true,
27446             "field": "maxcallbitrate",
27447             "description": ""
27448           },
27449           {
27450             "group": "Body",
27451             "type": "String",
27452             "allowedValues": [
27453               "\"yes\"",
27454               "\"no\""
27455             ],
27456             "optional": true,
27457             "field": "rfc2833compensate",
27458             "description": ""
27459           },
27460           {
27461             "group": "Body",
27462             "type": "String",
27463             "optional": true,
27464             "field": "mailbox",
27465             "description": ""
27466           },
27467           {
27468             "group": "Body",
27469             "type": "String",
27470             "allowedValues": [
27471               "\"accept\"",
27472               "\"refuse\"",
27473               "\"originate\""
27474             ],
27475             "optional": true,
27476             "field": "session_timers",
27477             "description": ""
27478           },
27479           {
27480             "group": "Body",
27481             "type": "Integer",
27482             "optional": true,
27483             "field": "session_expires",
27484             "description": ""
27485           },
27486           {
27487             "group": "Body",
27488             "type": "Integer",
27489             "optional": true,
27490             "field": "session_minse",
27491             "description": ""
27492           },
27493           {
27494             "group": "Body",
27495             "type": "String",
27496             "allowedValues": [
27497               "\"uac\"",
27498               "\"uas\""
27499             ],
27500             "optional": true,
27501             "field": "session_refresher",
27502             "description": ""
27503           },
27504           {
27505             "group": "Body",
27506             "type": "String",
27507             "optional": true,
27508             "field": "t38pt_usertpsource",
27509             "description": ""
27510           },
27511           {
27512             "group": "Body",
27513             "type": "String",
27514             "optional": true,
27515             "field": "regexten",
27516             "description": ""
27517           },
27518           {
27519             "group": "Body",
27520             "type": "String",
27521             "optional": true,
27522             "field": "fromdomain",
27523             "description": ""
27524           },
27525           {
27526             "group": "Body",
27527             "type": "String",
27528             "optional": true,
27529             "field": "fromuser",
27530             "description": ""
27531           },
27532           {
27533             "group": "Body",
27534             "type": "Integer",
27535             "optional": true,
27536             "field": "port",
27537             "description": ""
27538           },
27539           {
27540             "group": "Body",
27541             "type": "String",
27542             "allowedValues": [
27543               "\"yes\"",
27544               "\"no\""
27545             ],
27546             "optional": true,
27547             "field": "qualify",
27548             "description": ""
27549           },
27550           {
27551             "group": "Body",
27552             "type": "Integer",
27553             "optional": true,
27554             "field": "keepalive",
27555             "description": ""
27556           },
27557           {
27558             "group": "Body",
27559             "type": "String",
27560             "optional": true,
27561             "field": "defaultip",
27562             "description": ""
27563           },
27564           {
27565             "group": "Body",
27566             "type": "String",
27567             "optional": true,
27568             "field": "defaultuser",
27569             "description": ""
27570           },
27571           {
27572             "group": "Body",
27573             "type": "Integer",
27574             "optional": true,
27575             "field": "rtptimeout",
27576             "description": ""
27577           },
27578           {
27579             "group": "Body",
27580             "type": "Integer",
27581             "optional": true,
27582             "field": "rtpholdtimeout",
27583             "description": ""
27584           },
27585           {
27586             "group": "Body",
27587             "type": "Integer",
27588             "optional": true,
27589             "field": "rtpkeepalive",
27590             "description": ""
27591           },
27592           {
27593             "group": "Body",
27594             "type": "String",
27595             "allowedValues": [
27596               "\"yes\"",
27597               "\"no\"",
27598               "\"pai\""
27599             ],
27600             "optional": true,
27601             "field": "sendrpid",
27602             "description": ""
27603           },
27604           {
27605             "group": "Body",
27606             "type": "String",
27607             "optional": true,
27608             "field": "outboundproxy",
27609             "description": ""
27610           },
27611           {
27612             "group": "Body",
27613             "type": "String",
27614             "optional": true,
27615             "field": "callbackextension",
27616             "description": ""
27617           },
27618           {
27619             "group": "Body",
27620             "type": "Integer",
27621             "optional": true,
27622             "field": "timert1",
27623             "description": ""
27624           },
27625           {
27626             "group": "Body",
27627             "type": "Integer",
27628             "optional": true,
27629             "field": "timerb",
27630             "description": ""
27631           },
27632           {
27633             "group": "Body",
27634             "type": "Integer",
27635             "optional": true,
27636             "field": "qualifyfreq",
27637             "description": ""
27638           },
27639           {
27640             "group": "Body",
27641             "type": "String",
27642             "optional": true,
27643             "field": "contactpermit",
27644             "description": ""
27645           },
27646           {
27647             "group": "Body",
27648             "type": "String",
27649             "optional": true,
27650             "field": "contactdeny",
27651             "description": ""
27652           },
27653           {
27654             "group": "Body",
27655             "type": "String",
27656             "optional": true,
27657             "field": "contactacl",
27658             "description": ""
27659           },
27660           {
27661             "group": "Body",
27662             "type": "String",
27663             "optional": true,
27664             "field": "unsolicited_mailbox",
27665             "description": ""
27666           },
27667           {
27668             "group": "Body",
27669             "type": "String",
27670             "optional": true,
27671             "field": "use_q850_reason",
27672             "description": ""
27673           },
27674           {
27675             "group": "Body",
27676             "type": "Integer",
27677             "optional": true,
27678             "field": "maxforwards",
27679             "description": ""
27680           },
27681           {
27682             "group": "Body",
27683             "type": "String",
27684             "allowedValues": [
27685               "\"yes\"",
27686               "\"no\""
27687             ],
27688             "optional": true,
27689             "field": "encryption",
27690             "description": ""
27691           },
27692           {
27693             "group": "Body",
27694             "type": "String",
27695             "allowedValues": [
27696               "\"yes\"",
27697               "\"no\""
27698             ],
27699             "optional": true,
27700             "field": "avpf",
27701             "description": ""
27702           },
27703           {
27704             "group": "Body",
27705             "type": "String",
27706             "allowedValues": [
27707               "\"yes\"",
27708               "\"no\""
27709             ],
27710             "optional": true,
27711             "field": "force_avp",
27712             "description": ""
27713           },
27714           {
27715             "group": "Body",
27716             "type": "String",
27717             "allowedValues": [
27718               "\"yes\"",
27719               "\"no\""
27720             ],
27721             "optional": true,
27722             "field": "icesupport",
27723             "description": ""
27724           },
27725           {
27726             "group": "Body",
27727             "type": "String",
27728             "allowedValues": [
27729               "\"yes\"",
27730               "\"no\""
27731             ],
27732             "optional": true,
27733             "field": "dtlsenable",
27734             "description": ""
27735           },
27736           {
27737             "group": "Body",
27738             "type": "String",
27739             "allowedValues": [
27740               "\"yes\"",
27741               "\"no\"",
27742               "\"fingerprint\"",
27743               "\"certificate\""
27744             ],
27745             "optional": true,
27746             "field": "dtlsverify",
27747             "description": ""
27748           },
27749           {
27750             "group": "Body",
27751             "type": "Integer",
27752             "optional": true,
27753             "field": "dtlsrekey",
27754             "description": ""
27755           },
27756           {
27757             "group": "Body",
27758             "type": "String",
27759             "optional": true,
27760             "field": "dtlscertfile",
27761             "description": ""
27762           },
27763           {
27764             "group": "Body",
27765             "type": "String",
27766             "optional": true,
27767             "field": "dtlsprivatekey",
27768             "description": ""
27769           },
27770           {
27771             "group": "Body",
27772             "type": "String",
27773             "optional": true,
27774             "field": "dtlscipher",
27775             "description": ""
27776           },
27777           {
27778             "group": "Body",
27779             "type": "String",
27780             "optional": true,
27781             "field": "dtlscafile",
27782             "description": ""
27783           },
27784           {
27785             "group": "Body",
27786             "type": "String",
27787             "optional": true,
27788             "field": "dtlscapath",
27789             "description": ""
27790           },
27791           {
27792             "group": "Body",
27793             "type": "String",
27794             "allowedValues": [
27795               "\"active\"",
27796               "\"passive\"",
27797               "\"actpass\""
27798             ],
27799             "optional": true,
27800             "field": "dtlssetup",
27801             "description": ""
27802           },
27803           {
27804             "group": "Body",
27805             "type": "String",
27806             "optional": true,
27807             "field": "dtlsfingerprint",
27808             "description": ""
27809           },
27810           {
27811             "group": "Body",
27812             "type": "String",
27813             "allowedValues": [
27814               "\"yes\"",
27815               "\"no\""
27816             ],
27817             "optional": true,
27818             "field": "usereqphone",
27819             "description": ""
27820           },
27821           {
27822             "group": "Body",
27823             "type": "String",
27824             "optional": true,
27825             "field": "recordonfeature",
27826             "description": ""
27827           },
27828           {
27829             "group": "Body",
27830             "type": "String",
27831             "optional": true,
27832             "field": "recordofffeature",
27833             "description": ""
27834           },
27835           {
27836             "group": "Body",
27837             "type": "Integer",
27838             "optional": true,
27839             "field": "call_limit",
27840             "description": ""
27841           },
27842           {
27843             "group": "Body",
27844             "type": "String",
27845             "allowedValues": [
27846               "\"yes\"",
27847               "\"no\""
27848             ],
27849             "optional": true,
27850             "field": "registertrying",
27851             "description": ""
27852           },
27853           {
27854             "group": "Body",
27855             "type": "String",
27856             "allowedValues": [
27857               "\"yes\"",
27858               "\"no\""
27859             ],
27860             "optional": true,
27861             "field": "subscribemwi",
27862             "description": ""
27863           },
27864           {
27865             "group": "Body",
27866             "type": "String",
27867             "optional": true,
27868             "field": "vmexten",
27869             "description": ""
27870           },
27871           {
27872             "group": "Body",
27873             "type": "String",
27874             "optional": true,
27875             "field": "mohinterpret",
27876             "description": ""
27877           },
27878           {
27879             "group": "Body",
27880             "type": "String",
27881             "optional": true,
27882             "field": "mohsuggest",
27883             "description": ""
27884           },
27885           {
27886             "group": "Body",
27887             "type": "String",
27888             "optional": true,
27889             "field": "parkinglot",
27890             "description": ""
27891           },
27892           {
27893             "group": "Body",
27894             "type": "String",
27895             "optional": true,
27896             "field": "description",
27897             "description": ""
27898           },
27899           {
27900             "group": "Body",
27901             "type": "String",
27902             "optional": true,
27903             "field": "host",
27904             "description": ""
27905           },
27906           {
27907             "group": "Body",
27908             "type": "String",
27909             "allowedValues": [
27910               "\"yes\"",
27911               "\"no\"",
27912               "\"nonat\"",
27913               "\"update\"",
27914               "\"update,nonat\""
27915             ],
27916             "optional": true,
27917             "field": "canreinvite",
27918             "description": ""
27919           },
27920           {
27921             "group": "Body",
27922             "type": "String",
27923             "optional": true,
27924             "field": "registry",
27925             "description": ""
27926           },
27927           {
27928             "group": "Body",
27929             "type": "String",
27930             "optional": true,
27931             "field": "otherFields",
27932             "description": ""
27933           },
27934           {
27935             "group": "Body",
27936             "type": "Boolean",
27937             "optional": false,
27938             "field": "active",
27939             "description": ""
27940           },
27941           {
27942             "group": "Body",
27943             "type": "String",
27944             "optional": true,
27945             "field": "t38pt_udptl",
27946             "description": ""
27947           }
27948         ]
27949       }
27950     },
27951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27952     "version": "0.0.0",
27953     "filename": "server/api/trunk/index.js",
27954     "groupTitle": "Trunks"
27955   },
27956   {
27957     "type": "delete",
27958     "url": "/api/trunks/{id}",
27959     "title": "Deletes a trunk",
27960     "examples": [
27961       {
27962         "title": "Example usage:",
27963         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27964         "type": "json"
27965       }
27966     ],
27967     "name": "Delete",
27968     "group": "Trunks",
27969     "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>",
27970     "version": "0.0.0",
27971     "filename": "server/api/trunk/index.js",
27972     "groupTitle": "Trunks"
27973   },
27974   {
27975     "type": "get",
27976     "url": "/api/trunks",
27977     "title": "Gets a list of Trunks",
27978     "examples": [
27979       {
27980         "title": "Example usage:",
27981         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27982         "type": "json"
27983       }
27984     ],
27985     "name": "GetTrunks",
27986     "group": "Trunks",
27987     "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>",
27988     "version": "0.0.0",
27989     "filename": "server/api/trunk/index.js",
27990     "groupTitle": "Trunks"
27991   },
27992   {
27993     "type": "get",
27994     "url": "/api/trunks/{id}",
27995     "title": "Gets a single Trunk",
27996     "examples": [
27997       {
27998         "title": "Example usage:",
27999         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28000         "type": "json"
28001       }
28002     ],
28003     "name": "ShowTrunks",
28004     "group": "Trunks",
28005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28006     "version": "0.0.0",
28007     "filename": "server/api/trunk/index.js",
28008     "groupTitle": "Trunks"
28009   },
28010   {
28011     "type": "put",
28012     "url": "/api/trunks/{id}",
28013     "title": "Update an existing trunk",
28014     "examples": [
28015       {
28016         "title": "Example usage:",
28017         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28018         "type": "json"
28019       }
28020     ],
28021     "name": "Update",
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": "post",
28030     "url": "/api/userNotifications",
28031     "title": "Send notification to user",
28032     "examples": [
28033       {
28034         "title": "Example usage:",
28035         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28036         "type": "json"
28037       }
28038     ],
28039     "name": "Send",
28040     "group": "UserNotifications",
28041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28042     "version": "0.0.0",
28043     "filename": "server/api/userNotification/index.js",
28044     "groupTitle": "UserNotifications"
28045   },
28046   {
28047     "type": "post",
28048     "url": "/api/userProfile/resources",
28049     "title": "Creates a new User Profile Resource",
28050     "examples": [
28051       {
28052         "title": "Example usage:",
28053         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28054         "type": "json"
28055       }
28056     ],
28057     "name": "CreateUser_Profile_Resources",
28058     "group": "User_Profile_Resources",
28059     "parameter": {
28060       "fields": {
28061         "Body": [
28062           {
28063             "group": "Body",
28064             "type": "String",
28065             "optional": false,
28066             "field": "name",
28067             "description": ""
28068           },
28069           {
28070             "group": "Body",
28071             "type": "Integer",
28072             "optional": false,
28073             "field": "resourceId",
28074             "description": ""
28075           },
28076           {
28077             "group": "Body",
28078             "type": "String",
28079             "optional": false,
28080             "field": "type",
28081             "description": ""
28082           }
28083         ]
28084       }
28085     },
28086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28087     "version": "0.0.0",
28088     "filename": "server/api/userProfileResource/index.js",
28089     "groupTitle": "User_Profile_Resources"
28090   },
28091   {
28092     "type": "delete",
28093     "url": "/api/userProfile/resources/{id}",
28094     "title": "Deletes a User Profile Resource",
28095     "examples": [
28096       {
28097         "title": "Example usage:",
28098         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28099         "type": "json"
28100       }
28101     ],
28102     "name": "DeleteUser_Profile_Resources",
28103     "group": "User_Profile_Resources",
28104     "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>",
28105     "version": "0.0.0",
28106     "filename": "server/api/userProfileResource/index.js",
28107     "groupTitle": "User_Profile_Resources"
28108   },
28109   {
28110     "type": "get",
28111     "url": "/api/userProfile/resources/describe",
28112     "title": "Gets table info about User Profile Resources",
28113     "examples": [
28114       {
28115         "title": "Example usage:",
28116         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28117         "type": "json"
28118       }
28119     ],
28120     "name": "DescribeUser_Profile_Resources",
28121     "group": "User_Profile_Resources",
28122     "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>",
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",
28130     "title": "Gets a list of User Profile Resources",
28131     "examples": [
28132       {
28133         "title": "Example usage:",
28134         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28135         "type": "json"
28136       }
28137     ],
28138     "name": "GetUser_Profile_Resources",
28139     "group": "User_Profile_Resources",
28140     "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>",
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/{id}",
28148     "title": "Gets a single User Profile Resource",
28149     "examples": [
28150       {
28151         "title": "Example usage:",
28152         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28153         "type": "json"
28154       }
28155     ],
28156     "name": "ShowUser_Profile_Resources",
28157     "group": "User_Profile_Resources",
28158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28159     "version": "0.0.0",
28160     "filename": "server/api/userProfileResource/index.js",
28161     "groupTitle": "User_Profile_Resources"
28162   },
28163   {
28164     "type": "put",
28165     "url": "/api/userProfile/resources/{id}",
28166     "title": "Update an existing User Profile Resource",
28167     "examples": [
28168       {
28169         "title": "Example usage:",
28170         "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",
28171         "type": "json"
28172       }
28173     ],
28174     "name": "updateUser_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": "post",
28183     "url": "/api/userProfile/sections",
28184     "title": "Creates a new User Profile Section",
28185     "examples": [
28186       {
28187         "title": "Example usage:",
28188         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28189         "type": "json"
28190       }
28191     ],
28192     "name": "CreateUser_Profile_Sections",
28193     "group": "User_Profile_Sections",
28194     "parameter": {
28195       "fields": {
28196         "Body": [
28197           {
28198             "group": "Body",
28199             "type": "String",
28200             "optional": false,
28201             "field": "name",
28202             "description": ""
28203           },
28204           {
28205             "group": "Body",
28206             "type": "String",
28207             "optional": false,
28208             "field": "category",
28209             "description": ""
28210           },
28211           {
28212             "group": "Body",
28213             "type": "Integer",
28214             "optional": false,
28215             "field": "sectionId",
28216             "description": ""
28217           },
28218           {
28219             "group": "Body",
28220             "type": "Boolean",
28221             "optional": true,
28222             "field": "enabled",
28223             "description": ""
28224           },
28225           {
28226             "group": "Body",
28227             "type": "Boolean",
28228             "optional": true,
28229             "field": "autoAssociation",
28230             "description": ""
28231           },
28232           {
28233             "group": "Body",
28234             "type": "String",
28235             "optional": true,
28236             "field": "crudPermissions",
28237             "description": ""
28238           }
28239         ]
28240       }
28241     },
28242     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28243     "version": "0.0.0",
28244     "filename": "server/api/userProfileSection/index.js",
28245     "groupTitle": "User_Profile_Sections"
28246   },
28247   {
28248     "type": "delete",
28249     "url": "/api/userProfile/sections/{id}",
28250     "title": "Deletes a User Profile Section",
28251     "examples": [
28252       {
28253         "title": "Example usage:",
28254         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28255         "type": "json"
28256       }
28257     ],
28258     "name": "DeleteUser_Profile_Sections",
28259     "group": "User_Profile_Sections",
28260     "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>",
28261     "version": "0.0.0",
28262     "filename": "server/api/userProfileSection/index.js",
28263     "groupTitle": "User_Profile_Sections"
28264   },
28265   {
28266     "type": "get",
28267     "url": "/api/userProfile/sections/describe",
28268     "title": "Gets table info about User Profile Sections",
28269     "examples": [
28270       {
28271         "title": "Example usage:",
28272         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28273         "type": "json"
28274       }
28275     ],
28276     "name": "DescribeUser_Profile_Sections",
28277     "group": "User_Profile_Sections",
28278     "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>",
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",
28286     "title": "Gets a list of User Profile Sections",
28287     "examples": [
28288       {
28289         "title": "Example usage:",
28290         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28291         "type": "json"
28292       }
28293     ],
28294     "name": "GetUser_Profile_Sections",
28295     "group": "User_Profile_Sections",
28296     "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>",
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/{id}",
28304     "title": "Gets a single User Profile Section",
28305     "examples": [
28306       {
28307         "title": "Example usage:",
28308         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28309         "type": "json"
28310       }
28311     ],
28312     "name": "ShowUser_Profile_Sections",
28313     "group": "User_Profile_Sections",
28314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28315     "version": "0.0.0",
28316     "filename": "server/api/userProfileSection/index.js",
28317     "groupTitle": "User_Profile_Sections"
28318   },
28319   {
28320     "type": "put",
28321     "url": "/api/userProfile/sections/{id}",
28322     "title": "Update an existing User Profile Section",
28323     "examples": [
28324       {
28325         "title": "Example usage:",
28326         "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",
28327         "type": "json"
28328       }
28329     ],
28330     "name": "updateUser_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": "post",
28339     "url": "/api/userProfiles/{id}/resources",
28340     "title": "Add resources' permissions to User Profile",
28341     "examples": [
28342       {
28343         "title": "Example usage:",
28344         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28345         "type": "json"
28346       }
28347     ],
28348     "name": "AddResources",
28349     "group": "User_Profiles",
28350     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28351     "version": "0.0.0",
28352     "filename": "server/api/userProfile/index.js",
28353     "groupTitle": "User_Profiles"
28354   },
28355   {
28356     "type": "post",
28357     "url": "/api/userProfiles/{id}/sections",
28358     "title": "Add sections' permissions to User Profile",
28359     "examples": [
28360       {
28361         "title": "Example usage:",
28362         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28363         "type": "json"
28364       }
28365     ],
28366     "name": "AddSections",
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/clone",
28376     "title": "Clone an existing User Profile",
28377     "examples": [
28378       {
28379         "title": "Example usage:",
28380         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28381         "type": "json"
28382       }
28383     ],
28384     "name": "CloneUser_Profiles",
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",
28394     "title": "Creates a new User Profile",
28395     "examples": [
28396       {
28397         "title": "Example usage:",
28398         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28399         "type": "json"
28400       }
28401     ],
28402     "name": "CreateUser_Profiles",
28403     "group": "User_Profiles",
28404     "parameter": {
28405       "fields": {
28406         "Body": [
28407           {
28408             "group": "Body",
28409             "type": "String",
28410             "optional": false,
28411             "field": "name",
28412             "description": ""
28413           },
28414           {
28415             "group": "Body",
28416             "type": "String",
28417             "optional": false,
28418             "field": "crudPermissions",
28419             "description": ""
28420           },
28421           {
28422             "group": "Body",
28423             "type": "String",
28424             "optional": true,
28425             "field": "description",
28426             "description": ""
28427           },
28428           {
28429             "group": "Body",
28430             "type": "Boolean",
28431             "optional": true,
28432             "field": "privacyEnabled",
28433             "description": ""
28434           },
28435           {
28436             "group": "Body",
28437             "type": "Boolean",
28438             "optional": true,
28439             "field": "downloadAttachments",
28440             "description": ""
28441           },
28442           {
28443             "group": "Body",
28444             "type": "Boolean",
28445             "optional": true,
28446             "field": "downloadCallySquareRecordings",
28447             "description": ""
28448           },
28449           {
28450             "group": "Body",
28451             "type": "Boolean",
28452             "optional": true,
28453             "field": "downloadContactManagerLists",
28454             "description": ""
28455           },
28456           {
28457             "group": "Body",
28458             "type": "Boolean",
28459             "optional": true,
28460             "field": "downloadJscriptySessions",
28461             "description": ""
28462           },
28463           {
28464             "group": "Body",
28465             "type": "Boolean",
28466             "optional": true,
28467             "field": "downloadOmnichannelInteractions",
28468             "description": ""
28469           },
28470           {
28471             "group": "Body",
28472             "type": "Boolean",
28473             "optional": true,
28474             "field": "downloadScreenRecordings",
28475             "description": ""
28476           },
28477           {
28478             "group": "Body",
28479             "type": "Boolean",
28480             "optional": true,
28481             "field": "downloadVoiceRecordings",
28482             "description": ""
28483           }
28484         ]
28485       }
28486     },
28487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28488     "version": "0.0.0",
28489     "filename": "server/api/userProfile/index.js",
28490     "groupTitle": "User_Profiles"
28491   },
28492   {
28493     "type": "delete",
28494     "url": "/api/userProfiles/{id}",
28495     "title": "Deletes a User Profile",
28496     "examples": [
28497       {
28498         "title": "Example usage:",
28499         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28500         "type": "json"
28501       }
28502     ],
28503     "name": "DeleteUser_Profiles",
28504     "group": "User_Profiles",
28505     "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>",
28506     "version": "0.0.0",
28507     "filename": "server/api/userProfile/index.js",
28508     "groupTitle": "User_Profiles"
28509   },
28510   {
28511     "type": "get",
28512     "url": "/api/userProfiles/describe",
28513     "title": "Gets table info about User Profiles",
28514     "examples": [
28515       {
28516         "title": "Example usage:",
28517         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28518         "type": "json"
28519       }
28520     ],
28521     "name": "DescribeUser_Profiles",
28522     "group": "User_Profiles",
28523     "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>",
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/{id}/resources?section={section}",
28531     "title": "Get Resources assigned to a Section",
28532     "examples": [
28533       {
28534         "title": "Example usage:",
28535         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28536         "type": "json"
28537       }
28538     ],
28539     "name": "GetResources",
28540     "group": "User_Profiles",
28541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/sections",
28549     "title": "Get sections associated to a User Profile",
28550     "examples": [
28551       {
28552         "title": "Example usage:",
28553         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28554         "type": "json"
28555       }
28556     ],
28557     "name": "GetSections",
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",
28567     "title": "Gets a list of User Profiles",
28568     "examples": [
28569       {
28570         "title": "Example usage:",
28571         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28572         "type": "json"
28573       }
28574     ],
28575     "name": "GetUser_Profiles",
28576     "group": "User_Profiles",
28577     "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>",
28578     "version": "0.0.0",
28579     "filename": "server/api/userProfile/index.js",
28580     "groupTitle": "User_Profiles"
28581   },
28582   {
28583     "type": "delete",
28584     "url": "/api/userProfiles/{id}/resources",
28585     "title": "Removes resources' permissions from User Profile",
28586     "examples": [
28587       {
28588         "title": "Example usage:",
28589         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28590         "type": "json"
28591       }
28592     ],
28593     "name": "RemoveResources",
28594     "group": "User_Profiles",
28595     "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>",
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}/sections",
28603     "title": "Removes sections' permissions from User Profile",
28604     "examples": [
28605       {
28606         "title": "Example usage:",
28607         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28608         "type": "json"
28609       }
28610     ],
28611     "name": "RemoveSections",
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": "get",
28620     "url": "/api/userProfiles/{id}",
28621     "title": "Gets a single User Profile",
28622     "examples": [
28623       {
28624         "title": "Example usage:",
28625         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28626         "type": "json"
28627       }
28628     ],
28629     "name": "ShowUser_Profiles",
28630     "group": "User_Profiles",
28631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
28638     "url": "/api/userProfiles/{id}",
28639     "title": "Update an existing User Profile",
28640     "examples": [
28641       {
28642         "title": "Example usage:",
28643         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28644         "type": "json"
28645       }
28646     ],
28647     "name": "updateUser_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": "post",
28656     "url": "/api/users/{id}/chat_interactions",
28657     "title": "Add chat interaction tabs to an agent",
28658     "examples": [
28659       {
28660         "title": "Example usage:",
28661         "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",
28662         "type": "json"
28663       }
28664     ],
28665     "name": "AddChatInteractions",
28666     "group": "Users",
28667     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28668     "version": "0.0.0",
28669     "filename": "server/api/user/index.js",
28670     "groupTitle": "Users"
28671   },
28672   {
28673     "type": "post",
28674     "url": "/api/users/{id}/chat_websites",
28675     "title": "Add a Chat Website to a user",
28676     "examples": [
28677       {
28678         "title": "Example usage:",
28679         "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",
28680         "type": "json"
28681       }
28682     ],
28683     "name": "AddChatWebsites",
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}/contacts",
28693     "title": "Add contacts to a user",
28694     "examples": [
28695       {
28696         "title": "Example usage:",
28697         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28698         "type": "json"
28699       }
28700     ],
28701     "name": "AddContacts",
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}/fax_accounts",
28711     "title": "Add a Fax Account to a user",
28712     "examples": [
28713       {
28714         "title": "Example usage:",
28715         "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",
28716         "type": "json"
28717       }
28718     ],
28719     "name": "AddFaxAccounts",
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_interactions",
28729     "title": "Add fax interaction tabs to an agent",
28730     "examples": [
28731       {
28732         "title": "Example usage:",
28733         "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",
28734         "type": "json"
28735       }
28736     ],
28737     "name": "AddFaxInteractions",
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}/mail_accounts",
28747     "title": "Add a Mail Account to a user",
28748     "examples": [
28749       {
28750         "title": "Example usage:",
28751         "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",
28752         "type": "json"
28753       }
28754     ],
28755     "name": "AddMailAccounts",
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_interactions",
28765     "title": "Add mail interaction tabs to an agent",
28766     "examples": [
28767       {
28768         "title": "Example usage:",
28769         "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",
28770         "type": "json"
28771       }
28772     ],
28773     "name": "AddMailInteractions",
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}/openchannel_accounts",
28783     "title": "Add a Open Channel Account to a user",
28784     "examples": [
28785       {
28786         "title": "Example usage:",
28787         "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",
28788         "type": "json"
28789       }
28790     ],
28791     "name": "AddOpenchannelAccounts",
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_interactions",
28801     "title": "Add openchannel interaction tabs to an agent",
28802     "examples": [
28803       {
28804         "title": "Example usage:",
28805         "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",
28806         "type": "json"
28807       }
28808     ],
28809     "name": "AddOpenchannelInteractions",
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}/queues",
28819     "title": "Add queues to an agent",
28820     "examples": [
28821       {
28822         "title": "Example usage:",
28823         "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",
28824         "type": "json"
28825       }
28826     ],
28827     "name": "AddQueues",
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}/sms_accounts",
28837     "title": "Add a Sms Account to a user",
28838     "examples": [
28839       {
28840         "title": "Example usage:",
28841         "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",
28842         "type": "json"
28843       }
28844     ],
28845     "name": "AddSmsAccounts",
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_interactions",
28855     "title": "Add sms interaction tabs to an agent",
28856     "examples": [
28857       {
28858         "title": "Example usage:",
28859         "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",
28860         "type": "json"
28861       }
28862     ],
28863     "name": "AddSmsInteractions",
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}/square_projects",
28873     "title": "Add a Square Project to a user",
28874     "examples": [
28875       {
28876         "title": "Example usage:",
28877         "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",
28878         "type": "json"
28879       }
28880     ],
28881     "name": "AddSquareProjects",
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}/teams",
28891     "title": "Add teams to an agent",
28892     "examples": [
28893       {
28894         "title": "Example usage:",
28895         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28896         "type": "json"
28897       }
28898     ],
28899     "name": "AddTeams",
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}/whatsapp_accounts",
28909     "title": "Add a Whatsapp Account to a user",
28910     "examples": [
28911       {
28912         "title": "Example usage:",
28913         "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",
28914         "type": "json"
28915       }
28916     ],
28917     "name": "AddWhatsappAccounts",
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_interactions",
28927     "title": "Add Whatsapp interaction tabs to an agent",
28928     "examples": [
28929       {
28930         "title": "Example usage:",
28931         "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",
28932         "type": "json"
28933       }
28934     ],
28935     "name": "AddWhatsappInteractions",
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": "put",
28944     "url": "/api/users/{id}/password",
28945     "title": "Change user password",
28946     "examples": [
28947       {
28948         "title": "Example usage:",
28949         "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",
28950         "type": "json"
28951       }
28952     ],
28953     "name": "ChangePwd",
28954     "group": "Users",
28955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
28962     "url": "/api/users",
28963     "title": "Create a new user",
28964     "examples": [
28965       {
28966         "title": "Example usage:",
28967         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28968         "type": "json"
28969       }
28970     ],
28971     "name": "Create",
28972     "group": "Users",
28973     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}/api_key",
28981     "title": "Create a new API access key for the user",
28982     "examples": [
28983       {
28984         "title": "Example usage:",
28985         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28986         "type": "json"
28987       }
28988     ],
28989     "name": "CreateApiKey",
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": "delete",
28998     "url": "/api/users/{id}",
28999     "title": "Deletes a user",
29000     "examples": [
29001       {
29002         "title": "Example usage:",
29003         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29004         "type": "json"
29005       }
29006     ],
29007     "name": "Delete",
29008     "group": "Users",
29009     "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>",
29010     "version": "0.0.0",
29011     "filename": "server/api/user/index.js",
29012     "groupTitle": "Users"
29013   },
29014   {
29015     "type": "get",
29016     "url": "/api/users/describe",
29017     "title": "Gets table info about Users",
29018     "examples": [
29019       {
29020         "title": "Example usage:",
29021         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29022         "type": "json"
29023       }
29024     ],
29025     "name": "DescribeUsers",
29026     "group": "Users",
29027     "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>",
29028     "version": "0.0.0",
29029     "filename": "server/api/user/index.js",
29030     "groupTitle": "Users"
29031   },
29032   {
29033     "type": "get",
29034     "url": "/api/users/{id}/agents",
29035     "title": "GetAgents",
29036     "examples": [
29037       {
29038         "title": "Example usage:",
29039         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29040         "type": "json"
29041       }
29042     ],
29043     "name": "GetAgents",
29044     "group": "Users",
29045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/api_key",
29053     "title": "Get the API access key for the user",
29054     "examples": [
29055       {
29056         "title": "Example usage:",
29057         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29058         "type": "json"
29059       }
29060     ],
29061     "name": "GetApiKey",
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}/groups",
29071     "title": "GetChatGroups",
29072     "examples": [
29073       {
29074         "title": "Example usage:",
29075         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29076         "type": "json"
29077       }
29078     ],
29079     "name": "GetChatGroups",
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}/chat/interactions",
29089     "title": "GetChatInteractions",
29090     "examples": [
29091       {
29092         "title": "Example usage:",
29093         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29094         "type": "json"
29095       }
29096     ],
29097     "name": "GetChatInteractions",
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_websites",
29107     "title": "GetChatWebsites",
29108     "examples": [
29109       {
29110         "title": "Example usage:",
29111         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29112         "type": "json"
29113       }
29114     ],
29115     "name": "GetChatWebsites",
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}/contacts",
29125     "title": "GetContacts",
29126     "examples": [
29127       {
29128         "title": "Example usage:",
29129         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29130         "type": "json"
29131       }
29132     ],
29133     "name": "GetContacts",
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}/fax_accounts",
29143     "title": "GetFaxAccounts",
29144     "examples": [
29145       {
29146         "title": "Example usage:",
29147         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29148         "type": "json"
29149       }
29150     ],
29151     "name": "GetFaxAccounts",
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/interactions",
29161     "title": "GetFaxInteractions",
29162     "examples": [
29163       {
29164         "title": "Example usage:",
29165         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29166         "type": "json"
29167       }
29168     ],
29169     "name": "GetFaxInteractions",
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}/lists",
29179     "title": "GetLists",
29180     "examples": [
29181       {
29182         "title": "Example usage:",
29183         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29184         "type": "json"
29185       }
29186     ],
29187     "name": "GetLists",
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}/mail_accounts",
29197     "title": "GetMailAccounts",
29198     "examples": [
29199       {
29200         "title": "Example usage:",
29201         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29202         "type": "json"
29203       }
29204     ],
29205     "name": "GetMailAccounts",
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/interactions",
29215     "title": "GetMailInteractions",
29216     "examples": [
29217       {
29218         "title": "Example usage:",
29219         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29220         "type": "json"
29221       }
29222     ],
29223     "name": "GetMailInteractions",
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}/openchannel_accounts",
29233     "title": "GetOpenchannelAccounts",
29234     "examples": [
29235       {
29236         "title": "Example usage:",
29237         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29238         "type": "json"
29239       }
29240     ],
29241     "name": "GetOpenchannelAccounts",
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/interactions",
29251     "title": "GetOpenchannelInteractions",
29252     "examples": [
29253       {
29254         "title": "Example usage:",
29255         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29256         "type": "json"
29257       }
29258     ],
29259     "name": "GetOpenchannelInteractions",
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}/prefixes",
29269     "title": "GetPrefixes",
29270     "examples": [
29271       {
29272         "title": "Example usage:",
29273         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29274         "type": "json"
29275       }
29276     ],
29277     "name": "GetPrefixes",
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}/queues?channel={channel}",
29287     "title": "Gets Queues list",
29288     "examples": [
29289       {
29290         "title": "Example usage:",
29291         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29292         "type": "json"
29293       }
29294     ],
29295     "name": "GetQueues",
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}/recordings",
29305     "title": "GetRecordings",
29306     "examples": [
29307       {
29308         "title": "Example usage:",
29309         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29310         "type": "json"
29311       }
29312     ],
29313     "name": "GetRecordings",
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}/scheduled_calls",
29323     "title": "GetScheduledCalls",
29324     "examples": [
29325       {
29326         "title": "Example usage:",
29327         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29328         "type": "json"
29329       }
29330     ],
29331     "name": "GetScheduledCalls",
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}/screen_recordings",
29341     "title": "GetScreenRecordings",
29342     "examples": [
29343       {
29344         "title": "Example usage:",
29345         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29346         "type": "json"
29347       }
29348     ],
29349     "name": "GetScreenRecordings",
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}/sms_accounts",
29359     "title": "GetSmsAccounts",
29360     "examples": [
29361       {
29362         "title": "Example usage:",
29363         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29364         "type": "json"
29365       }
29366     ],
29367     "name": "GetSmsAccounts",
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/interactions",
29377     "title": "GetSmsInteractions",
29378     "examples": [
29379       {
29380         "title": "Example usage:",
29381         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29382         "type": "json"
29383       }
29384     ],
29385     "name": "GetSmsInteractions",
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}/square_projects",
29395     "title": "GetSquareProjects",
29396     "examples": [
29397       {
29398         "title": "Example usage:",
29399         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29400         "type": "json"
29401       }
29402     ],
29403     "name": "GetSquareProjects",
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}/teams",
29413     "title": "GetTeams",
29414     "examples": [
29415       {
29416         "title": "Example usage:",
29417         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29418         "type": "json"
29419       }
29420     ],
29421     "name": "GetTeams",
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",
29431     "title": "Gets a list of Users",
29432     "examples": [
29433       {
29434         "title": "Example usage:",
29435         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29436         "type": "json"
29437       }
29438     ],
29439     "name": "GetUsers",
29440     "group": "Users",
29441     "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>",
29442     "version": "0.0.0",
29443     "filename": "server/api/user/index.js",
29444     "groupTitle": "Users"
29445   },
29446   {
29447     "type": "get",
29448     "url": "/api/users/{id}/queues_rt",
29449     "title": "GetVoiceQueuesRt",
29450     "examples": [
29451       {
29452         "title": "Example usage:",
29453         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29454         "type": "json"
29455       }
29456     ],
29457     "name": "GetVoiceQueuesRt",
29458     "group": "Users",
29459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/whatsapp_accounts",
29467     "title": "GetWhatsappAccounts",
29468     "examples": [
29469       {
29470         "title": "Example usage:",
29471         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29472         "type": "json"
29473       }
29474     ],
29475     "name": "GetWhatsappAccounts",
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/interactions",
29485     "title": "GetWhatsappInteractions",
29486     "examples": [
29487       {
29488         "title": "Example usage:",
29489         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29490         "type": "json"
29491       }
29492     ],
29493     "name": "GetWhatsappInteractions",
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": "post",
29502     "url": "/api/users/{id}/login",
29503     "title": "Login",
29504     "examples": [
29505       {
29506         "title": "Example usage:",
29507         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29508         "type": "json"
29509       }
29510     ],
29511     "name": "Login",
29512     "group": "Users",
29513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/logout",
29521     "title": "Logout",
29522     "examples": [
29523       {
29524         "title": "Example usage:",
29525         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29526         "type": "json"
29527       }
29528     ],
29529     "name": "Logout",
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}/pause",
29539     "title": "Pause",
29540     "examples": [
29541       {
29542         "title": "Example usage:",
29543         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29544         "type": "json"
29545       }
29546     ],
29547     "name": "Pause",
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": "delete",
29556     "url": "/api/users/{id}/api_key",
29557     "title": "Remove API access key for the user",
29558     "examples": [
29559       {
29560         "title": "Example usage:",
29561         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29562         "type": "json"
29563       }
29564     ],
29565     "name": "RemoveApiKey",
29566     "group": "Users",
29567     "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>",
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}/chat_interactions",
29575     "title": "Removes interactions from an agent",
29576     "examples": [
29577       {
29578         "title": "Example usage:",
29579         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29580         "type": "json"
29581       }
29582     ],
29583     "name": "RemoveChatInteractions",
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_websites",
29593     "title": "Removes a Chat Website from a user",
29594     "examples": [
29595       {
29596         "title": "Example usage:",
29597         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29598         "type": "json"
29599       }
29600     ],
29601     "name": "RemoveChatWebsites",
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}/fax_accounts",
29611     "title": "Removes a Fax Account from a user",
29612     "examples": [
29613       {
29614         "title": "Example usage:",
29615         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29616         "type": "json"
29617       }
29618     ],
29619     "name": "RemoveFaxAccounts",
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_interactions",
29629     "title": "Removes interactions from an agent",
29630     "examples": [
29631       {
29632         "title": "Example usage:",
29633         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29634         "type": "json"
29635       }
29636     ],
29637     "name": "RemoveFaxInteractions",
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}/mail_accounts",
29647     "title": "Removes a Mail Account from a user",
29648     "examples": [
29649       {
29650         "title": "Example usage:",
29651         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29652         "type": "json"
29653       }
29654     ],
29655     "name": "RemoveMailAccounts",
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_interactions",
29665     "title": "Removes interactions from an agent",
29666     "examples": [
29667       {
29668         "title": "Example usage:",
29669         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29670         "type": "json"
29671       }
29672     ],
29673     "name": "RemoveMailInteractions",
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}/openchannel_accounts",
29683     "title": "Removes a Open Channel Account from a user",
29684     "examples": [
29685       {
29686         "title": "Example usage:",
29687         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29688         "type": "json"
29689       }
29690     ],
29691     "name": "RemoveOpenchannelAccounts",
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_interactions",
29701     "title": "Removes openchannel interactions from an agent",
29702     "examples": [
29703       {
29704         "title": "Example usage:",
29705         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29706         "type": "json"
29707       }
29708     ],
29709     "name": "RemoveOpenchannelInteractions",
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}/queues",
29719     "title": "Remove queues to an agent",
29720     "examples": [
29721       {
29722         "title": "Example usage:",
29723         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29724         "type": "json"
29725       }
29726     ],
29727     "name": "RemoveQueues",
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}/sms_accounts",
29737     "title": "Removes a Sms Account from a user",
29738     "examples": [
29739       {
29740         "title": "Example usage:",
29741         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29742         "type": "json"
29743       }
29744     ],
29745     "name": "RemoveSmsAccounts",
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_interactions",
29755     "title": "Removes interactions from an agent",
29756     "examples": [
29757       {
29758         "title": "Example usage:",
29759         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29760         "type": "json"
29761       }
29762     ],
29763     "name": "RemoveSmsInteractions",
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}/square_projects",
29773     "title": "Removes a Square Project from a user",
29774     "examples": [
29775       {
29776         "title": "Example usage:",
29777         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29778         "type": "json"
29779       }
29780     ],
29781     "name": "RemoveSquareProjects",
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}/teams",
29791     "title": "Removes teams from an agent",
29792     "examples": [
29793       {
29794         "title": "Example usage:",
29795         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29796         "type": "json"
29797       }
29798     ],
29799     "name": "RemoveTeams",
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}/whatsapp_accounts",
29809     "title": "Removes a Whatsapp Account from a user",
29810     "examples": [
29811       {
29812         "title": "Example usage:",
29813         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29814         "type": "json"
29815       }
29816     ],
29817     "name": "RemoveWhatsappAccounts",
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_interactions",
29827     "title": "Removes Whatsapp interactions from an agent",
29828     "examples": [
29829       {
29830         "title": "Example usage:",
29831         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29832         "type": "json"
29833       }
29834     ],
29835     "name": "RemoveWhatsappInteractions",
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": "get",
29844     "url": "/api/users/{id}",
29845     "title": "Gets a single User",
29846     "examples": [
29847       {
29848         "title": "Example usage:",
29849         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29850         "type": "json"
29851       }
29852     ],
29853     "name": "ShowUsers",
29854     "group": "Users",
29855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
29862     "url": "/api/users/{id}/unpause",
29863     "title": "Unpause",
29864     "examples": [
29865       {
29866         "title": "Example usage:",
29867         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29868         "type": "json"
29869       }
29870     ],
29871     "name": "Unpause",
29872     "group": "Users",
29873     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
29880     "url": "/api/users/whoami",
29881     "title": "WhoAmI",
29882     "examples": [
29883       {
29884         "title": "Example usage:",
29885         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29886         "type": "json"
29887       }
29888     ],
29889     "name": "WhoAmI",
29890     "group": "Users",
29891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
29898     "url": "/api/users/{id}/avatar",
29899     "title": "Add avatar",
29900     "examples": [
29901       {
29902         "title": "Example usage:",
29903         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29904         "type": "json"
29905       }
29906     ],
29907     "name": "addAvatar",
29908     "group": "Users",
29909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/create_many",
29917     "title": "Create Users",
29918     "examples": [
29919       {
29920         "title": "Example usage:",
29921         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29922         "type": "json"
29923       }
29924     ],
29925     "name": "bulkCreate",
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": "get",
29934     "url": "/api/users/{id}/avatar",
29935     "title": "Get avatar",
29936     "examples": [
29937       {
29938         "title": "Example usage:",
29939         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29940         "type": "json"
29941       }
29942     ],
29943     "name": "getAvatar",
29944     "group": "Users",
29945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/open_tabs",
29953     "title": "Get interactions opened tabs",
29954     "examples": [
29955       {
29956         "title": "Example usage:",
29957         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29958         "type": "json"
29959       }
29960     ],
29961     "name": "getOpenTabs",
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/presence",
29971     "title": "Gets agent presence",
29972     "examples": [
29973       {
29974         "title": "Example usage:",
29975         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29976         "type": "json"
29977       }
29978     ],
29979     "name": "getPresence",
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": "put",
29988     "url": "/api/users/{id}",
29989     "title": "Update an existing User",
29990     "examples": [
29991       {
29992         "title": "Example usage:",
29993         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29994         "type": "json"
29995       }
29996     ],
29997     "name": "updateUsers",
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": "post",
30006     "url": "/api/variables",
30007     "title": "Creates a new Variable",
30008     "examples": [
30009       {
30010         "title": "Example usage:",
30011         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30012         "type": "json"
30013       }
30014     ],
30015     "name": "CreateVariables",
30016     "group": "Variables",
30017     "parameter": {
30018       "fields": {
30019         "Body": [
30020           {
30021             "group": "Body",
30022             "type": "String",
30023             "optional": false,
30024             "field": "name",
30025             "description": ""
30026           },
30027           {
30028             "group": "Body",
30029             "type": "String",
30030             "optional": true,
30031             "field": "description",
30032             "description": ""
30033           }
30034         ]
30035       }
30036     },
30037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30038     "version": "0.0.0",
30039     "filename": "server/api/variable/index.js",
30040     "groupTitle": "Variables"
30041   },
30042   {
30043     "type": "delete",
30044     "url": "/api/variables/{id}",
30045     "title": "Deletes a Variable",
30046     "examples": [
30047       {
30048         "title": "Example usage:",
30049         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30050         "type": "json"
30051       }
30052     ],
30053     "name": "DeleteVariables",
30054     "group": "Variables",
30055     "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>",
30056     "version": "0.0.0",
30057     "filename": "server/api/variable/index.js",
30058     "groupTitle": "Variables"
30059   },
30060   {
30061     "type": "get",
30062     "url": "/api/variables",
30063     "title": "Gets a list of Variables",
30064     "examples": [
30065       {
30066         "title": "Example usage:",
30067         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30068         "type": "json"
30069       }
30070     ],
30071     "name": "GetVariables",
30072     "group": "Variables",
30073     "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>",
30074     "version": "0.0.0",
30075     "filename": "server/api/variable/index.js",
30076     "groupTitle": "Variables"
30077   },
30078   {
30079     "type": "get",
30080     "url": "/api/variables/{id}",
30081     "title": "Gets a single Variable",
30082     "examples": [
30083       {
30084         "title": "Example usage:",
30085         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30086         "type": "json"
30087       }
30088     ],
30089     "name": "ShowVariables",
30090     "group": "Variables",
30091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30092     "version": "0.0.0",
30093     "filename": "server/api/variable/index.js",
30094     "groupTitle": "Variables"
30095   },
30096   {
30097     "type": "put",
30098     "url": "/api/variables/{id}",
30099     "title": "Update an existing Variable",
30100     "examples": [
30101       {
30102         "title": "Example usage:",
30103         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30104         "type": "json"
30105       }
30106     ],
30107     "name": "updateVariables",
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": "get",
30116     "url": "/api/version/fetch",
30117     "title": "Fetch git version",
30118     "examples": [
30119       {
30120         "title": "Example usage:",
30121         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30122         "type": "json"
30123       }
30124     ],
30125     "name": "FetchVersion",
30126     "group": "Version",
30127     "description": "<p>Motion run the following command: git fetch origin master</p>",
30128     "version": "0.0.0",
30129     "filename": "server/api/version/index.js",
30130     "groupTitle": "Version"
30131   },
30132   {
30133     "type": "get",
30134     "url": "/api/version",
30135     "title": "Gets version",
30136     "examples": [
30137       {
30138         "title": "Example usage:",
30139         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30140         "type": "json"
30141       }
30142     ],
30143     "name": "GetVersion",
30144     "group": "Version",
30145     "description": "<p>Motion returns the current and latest motion version.</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/migrations",
30153     "title": "Launch database migrations",
30154     "examples": [
30155       {
30156         "title": "Example usage:",
30157         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30158         "type": "json"
30159       }
30160     ],
30161     "name": "MigrateVersion",
30162     "group": "Version",
30163     "description": "<p>Motion launch the database migrations, according to the application 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/pull",
30171     "title": "Pull git version",
30172     "examples": [
30173       {
30174         "title": "Example usage:",
30175         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30176         "type": "json"
30177       }
30178     ],
30179     "name": "PullVersion",
30180     "group": "Version",
30181     "description": "<p>Motion run the following command: git pull</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/reset",
30189     "title": "Reset git version",
30190     "examples": [
30191       {
30192         "title": "Example usage:",
30193         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30194         "type": "json"
30195       }
30196     ],
30197     "name": "ResetVersion",
30198     "group": "Version",
30199     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</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/restart",
30207     "title": "Restart motion2 after update",
30208     "examples": [
30209       {
30210         "title": "Example usage:",
30211         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30212         "type": "json"
30213       }
30214     ],
30215     "name": "RestartVersion",
30216     "group": "Version",
30217     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30218     "version": "0.0.0",
30219     "filename": "server/api/version/index.js",
30220     "groupTitle": "Version"
30221   },
30222   {
30223     "type": "get",
30224     "url": "/api/voice/agents/reports/describe",
30225     "title": "Gets table info about Agent Reports",
30226     "examples": [
30227       {
30228         "title": "Example usage:",
30229         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30230         "type": "json"
30231       }
30232     ],
30233     "name": "DescribeAgent_Reports",
30234     "group": "Voice_Agent_Reports",
30235     "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>",
30236     "version": "0.0.0",
30237     "filename": "server/api/voiceAgentReport/index.js",
30238     "groupTitle": "Voice_Agent_Reports"
30239   },
30240   {
30241     "type": "get",
30242     "url": "/api/voice/agents/reports",
30243     "title": "Gets a list of Agent Reports",
30244     "examples": [
30245       {
30246         "title": "Example usage:",
30247         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30248         "type": "json"
30249       }
30250     ],
30251     "name": "GetAgent_Reports",
30252     "group": "Voice_Agent_Reports",
30253     "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>",
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/{id}",
30261     "title": "Gets a single Agent Report",
30262     "examples": [
30263       {
30264         "title": "Example usage:",
30265         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30266         "type": "json"
30267       }
30268     ],
30269     "name": "ShowAgent_Reports",
30270     "group": "Voice_Agent_Reports",
30271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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/calls/reports/describe",
30279     "title": "Gets table info about Call Reports",
30280     "examples": [
30281       {
30282         "title": "Example usage:",
30283         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30284         "type": "json"
30285       }
30286     ],
30287     "name": "DescribeCall_Reports",
30288     "group": "Voice_Call_Reports",
30289     "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>",
30290     "version": "0.0.0",
30291     "filename": "server/api/voiceCallReport/index.js",
30292     "groupTitle": "Voice_Call_Reports"
30293   },
30294   {
30295     "type": "get",
30296     "url": "/api/voice/calls/reports",
30297     "title": "Gets a list of Call Reports",
30298     "examples": [
30299       {
30300         "title": "Example usage:",
30301         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30302         "type": "json"
30303       }
30304     ],
30305     "name": "GetCall_Reports",
30306     "group": "Voice_Call_Reports",
30307     "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>",
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/{id}",
30315     "title": "Gets a single Call Report",
30316     "examples": [
30317       {
30318         "title": "Example usage:",
30319         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30320         "type": "json"
30321       }
30322     ],
30323     "name": "ShowCall_Reports",
30324     "group": "Voice_Call_Reports",
30325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30326     "version": "0.0.0",
30327     "filename": "server/api/voiceCallReport/index.js",
30328     "groupTitle": "Voice_Call_Reports"
30329   },
30330   {
30331     "type": "put",
30332     "url": "/api/voice/calls/reports/{id}",
30333     "title": "Update a single cdr",
30334     "examples": [
30335       {
30336         "title": "Example usage:",
30337         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30338         "type": "json"
30339       }
30340     ],
30341     "name": "update",
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": "post",
30350     "url": "/api/voice/chanspy",
30351     "title": "Creates a new ChanSpy",
30352     "examples": [
30353       {
30354         "title": "Example usage:",
30355         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30356         "type": "json"
30357       }
30358     ],
30359     "name": "CreateChanSpy",
30360     "group": "Voice_ChanSpy",
30361     "parameter": {
30362       "fields": {
30363         "Body": [
30364           {
30365             "group": "Body",
30366             "type": "String",
30367             "optional": true,
30368             "field": "name",
30369             "description": ""
30370           },
30371           {
30372             "group": "Body",
30373             "type": "String",
30374             "optional": false,
30375             "field": "prefix",
30376             "description": ""
30377           },
30378           {
30379             "group": "Body",
30380             "type": "String",
30381             "optional": true,
30382             "field": "options",
30383             "description": ""
30384           },
30385           {
30386             "group": "Body",
30387             "type": "Boolean",
30388             "optional": true,
30389             "field": "auth",
30390             "description": ""
30391           },
30392           {
30393             "group": "Body",
30394             "type": "String",
30395             "optional": true,
30396             "field": "password",
30397             "description": ""
30398           },
30399           {
30400             "group": "Body",
30401             "type": "Boolean",
30402             "optional": true,
30403             "field": "record",
30404             "description": ""
30405           },
30406           {
30407             "group": "Body",
30408             "type": "String",
30409             "optional": true,
30410             "field": "recordingFormat",
30411             "description": ""
30412           },
30413           {
30414             "group": "Body",
30415             "type": "String",
30416             "optional": true,
30417             "field": "description",
30418             "description": ""
30419           }
30420         ]
30421       }
30422     },
30423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30424     "version": "0.0.0",
30425     "filename": "server/api/voiceChanSpy/index.js",
30426     "groupTitle": "Voice_ChanSpy"
30427   },
30428   {
30429     "type": "delete",
30430     "url": "/api/voice/chanspy/{id}",
30431     "title": "Deletes a ChanSpy",
30432     "examples": [
30433       {
30434         "title": "Example usage:",
30435         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30436         "type": "json"
30437       }
30438     ],
30439     "name": "DeleteChanSpy",
30440     "group": "Voice_ChanSpy",
30441     "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>",
30442     "version": "0.0.0",
30443     "filename": "server/api/voiceChanSpy/index.js",
30444     "groupTitle": "Voice_ChanSpy"
30445   },
30446   {
30447     "type": "get",
30448     "url": "/api/voice/chanspy",
30449     "title": "Gets a list of ChanSpy",
30450     "examples": [
30451       {
30452         "title": "Example usage:",
30453         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30454         "type": "json"
30455       }
30456     ],
30457     "name": "GetChanSpy",
30458     "group": "Voice_ChanSpy",
30459     "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>",
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/{id}",
30467     "title": "Gets a single ChanSpy",
30468     "examples": [
30469       {
30470         "title": "Example usage:",
30471         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30472         "type": "json"
30473       }
30474     ],
30475     "name": "ShowChanSpy",
30476     "group": "Voice_ChanSpy",
30477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30478     "version": "0.0.0",
30479     "filename": "server/api/voiceChanSpy/index.js",
30480     "groupTitle": "Voice_ChanSpy"
30481   },
30482   {
30483     "type": "put",
30484     "url": "/api/voice/chanspy/{id}",
30485     "title": "Update an existing ChanSpy",
30486     "examples": [
30487       {
30488         "title": "Example usage:",
30489         "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",
30490         "type": "json"
30491       }
30492     ],
30493     "name": "updateChanSpy",
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": "post",
30502     "url": "/api/voice/contexts",
30503     "title": "Create a new context",
30504     "examples": [
30505       {
30506         "title": "Example usage:",
30507         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30508         "type": "json"
30509       }
30510     ],
30511     "name": "Create",
30512     "group": "Voice_Contexts",
30513     "parameter": {
30514       "fields": {
30515         "Body": [
30516           {
30517             "group": "Body",
30518             "type": "String",
30519             "optional": true,
30520             "field": "name",
30521             "description": ""
30522           },
30523           {
30524             "group": "Body",
30525             "type": "String",
30526             "optional": true,
30527             "field": "description",
30528             "description": ""
30529           },
30530           {
30531             "group": "Body",
30532             "type": "Boolean",
30533             "optional": true,
30534             "field": "defaultEntry",
30535             "description": ""
30536           }
30537         ]
30538       }
30539     },
30540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30541     "version": "0.0.0",
30542     "filename": "server/api/voiceContext/index.js",
30543     "groupTitle": "Voice_Contexts"
30544   },
30545   {
30546     "type": "delete",
30547     "url": "/api/voice/contexts/{id}",
30548     "title": "Deletes a context",
30549     "examples": [
30550       {
30551         "title": "Example usage:",
30552         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30553         "type": "json"
30554       }
30555     ],
30556     "name": "Delete",
30557     "group": "Voice_Contexts",
30558     "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>",
30559     "version": "0.0.0",
30560     "filename": "server/api/voiceContext/index.js",
30561     "groupTitle": "Voice_Contexts"
30562   },
30563   {
30564     "type": "get",
30565     "url": "/api/voice/contexts",
30566     "title": "Gets a list of Contexts",
30567     "examples": [
30568       {
30569         "title": "Example usage:",
30570         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30571         "type": "json"
30572       }
30573     ],
30574     "name": "GetContexts",
30575     "group": "Voice_Contexts",
30576     "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>",
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/{id}",
30584     "title": "Gets a single Context",
30585     "examples": [
30586       {
30587         "title": "Example usage:",
30588         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30589         "type": "json"
30590       }
30591     ],
30592     "name": "ShowContexts",
30593     "group": "Voice_Contexts",
30594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30595     "version": "0.0.0",
30596     "filename": "server/api/voiceContext/index.js",
30597     "groupTitle": "Voice_Contexts"
30598   },
30599   {
30600     "type": "put",
30601     "url": "/api/voice/contexts/{id}",
30602     "title": "Update an existing context",
30603     "examples": [
30604       {
30605         "title": "Example usage:",
30606         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30607         "type": "json"
30608       }
30609     ],
30610     "name": "Update",
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": "get",
30619     "url": "/api/voice/dials/reports/describe",
30620     "title": "Gets table info about Dial Reports",
30621     "examples": [
30622       {
30623         "title": "Example usage:",
30624         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30625         "type": "json"
30626       }
30627     ],
30628     "name": "DescribeDial_Reports",
30629     "group": "Voice_Dial_Reports",
30630     "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>",
30631     "version": "0.0.0",
30632     "filename": "server/api/voiceDialReport/index.js",
30633     "groupTitle": "Voice_Dial_Reports"
30634   },
30635   {
30636     "type": "get",
30637     "url": "/api/voice/dials/reports",
30638     "title": "Gets a list of Dial Reports",
30639     "examples": [
30640       {
30641         "title": "Example usage:",
30642         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30643         "type": "json"
30644       }
30645     ],
30646     "name": "GetDial_Reports",
30647     "group": "Voice_Dial_Reports",
30648     "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>",
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/{id}",
30656     "title": "Gets a single Dial Report",
30657     "examples": [
30658       {
30659         "title": "Example usage:",
30660         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30661         "type": "json"
30662       }
30663     ],
30664     "name": "ShowDial_Reports",
30665     "group": "Voice_Dial_Reports",
30666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30667     "version": "0.0.0",
30668     "filename": "server/api/voiceDialReport/index.js",
30669     "groupTitle": "Voice_Dial_Reports"
30670   },
30671   {
30672     "type": "delete",
30673     "url": "/api/voice/extensions/{id}",
30674     "title": "Deletes a Extension",
30675     "examples": [
30676       {
30677         "title": "Example usage:",
30678         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30679         "type": "json"
30680       }
30681     ],
30682     "name": "DeleteExtensions",
30683     "group": "Voice_Extensions",
30684     "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>",
30685     "version": "0.0.0",
30686     "filename": "server/api/voiceExtension/index.js",
30687     "groupTitle": "Voice_Extensions"
30688   },
30689   {
30690     "type": "get",
30691     "url": "/api/voice/extensions",
30692     "title": "Gets a list of Extensions",
30693     "examples": [
30694       {
30695         "title": "Example usage:",
30696         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30697         "type": "json"
30698       }
30699     ],
30700     "name": "GetExtensions",
30701     "group": "Voice_Extensions",
30702     "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>",
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/{id}",
30710     "title": "Gets a single Extension",
30711     "examples": [
30712       {
30713         "title": "Example usage:",
30714         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30715         "type": "json"
30716       }
30717     ],
30718     "name": "ShowExtensions",
30719     "group": "Voice_Extensions",
30720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30721     "version": "0.0.0",
30722     "filename": "server/api/voiceExtension/index.js",
30723     "groupTitle": "Voice_Extensions"
30724   },
30725   {
30726     "type": "post",
30727     "url": "/api/voice/extensions",
30728     "title": "Create new applications",
30729     "examples": [
30730       {
30731         "title": "Example usage:",
30732         "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",
30733         "type": "json"
30734       }
30735     ],
30736     "name": "addApplications",
30737     "group": "Voice_Extensions",
30738     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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 an extension",
30747     "examples": [
30748       {
30749         "title": "Example usage:",
30750         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30751         "type": "json"
30752       }
30753     ],
30754     "name": "create",
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": "put",
30763     "url": "/api/voice/extensions/{id}",
30764     "title": "Update an extension",
30765     "examples": [
30766       {
30767         "title": "Example usage:",
30768         "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",
30769         "type": "json"
30770       }
30771     ],
30772     "name": "update",
30773     "group": "Voice_Extensions",
30774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
30781     "url": "/api/voice/mohs",
30782     "title": "Create a new a new MOH",
30783     "examples": [
30784       {
30785         "title": "Example usage:",
30786         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30787         "type": "json"
30788       }
30789     ],
30790     "name": "AddMoh",
30791     "group": "Voice_MOHs",
30792     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30793     "version": "0.0.0",
30794     "filename": "server/api/voiceMusicOnHold/index.js",
30795     "groupTitle": "Voice_MOHs"
30796   },
30797   {
30798     "type": "post",
30799     "url": "/api/voice/mohs/{id}/sounds",
30800     "title": "Add sound to MOH",
30801     "examples": [
30802       {
30803         "title": "Example usage:",
30804         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30805         "type": "json"
30806       }
30807     ],
30808     "name": "AddSound",
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": "delete",
30817     "url": "/api/voice/mohs/{id}",
30818     "title": "Deletes an MOH",
30819     "examples": [
30820       {
30821         "title": "Example usage:",
30822         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30823         "type": "json"
30824       }
30825     ],
30826     "name": "DestroyMoh",
30827     "group": "Voice_MOHs",
30828     "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>",
30829     "version": "0.0.0",
30830     "filename": "server/api/voiceMusicOnHold/index.js",
30831     "groupTitle": "Voice_MOHs"
30832   },
30833   {
30834     "type": "get",
30835     "url": "/api/voice/mohs",
30836     "title": "Gets a list of Music On Holds",
30837     "examples": [
30838       {
30839         "title": "Example usage:",
30840         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30841         "type": "json"
30842       }
30843     ],
30844     "name": "GetMusic_On_Holds",
30845     "group": "Voice_MOHs",
30846     "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>",
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/{id}/sounds",
30854     "title": "Gets sounds from MOH",
30855     "examples": [
30856       {
30857         "title": "Example usage:",
30858         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30859         "type": "json"
30860       }
30861     ],
30862     "name": "GetSounds",
30863     "group": "Voice_MOHs",
30864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30865     "version": "0.0.0",
30866     "filename": "server/api/voiceMusicOnHold/index.js",
30867     "groupTitle": "Voice_MOHs"
30868   },
30869   {
30870     "type": "delete",
30871     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30872     "title": "Remove sound from MOH",
30873     "examples": [
30874       {
30875         "title": "Example usage:",
30876         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30877         "type": "json"
30878       }
30879     ],
30880     "name": "RemoveSound",
30881     "group": "Voice_MOHs",
30882     "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>",
30883     "version": "0.0.0",
30884     "filename": "server/api/voiceMusicOnHold/index.js",
30885     "groupTitle": "Voice_MOHs"
30886   },
30887   {
30888     "type": "get",
30889     "url": "/api/voice/mohs/{id}",
30890     "title": "Gets a single Music On Hold",
30891     "examples": [
30892       {
30893         "title": "Example usage:",
30894         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30895         "type": "json"
30896       }
30897     ],
30898     "name": "ShowMusic_On_Holds",
30899     "group": "Voice_MOHs",
30900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
30907     "url": "/api/voice/mohs/{id}",
30908     "title": "Update an existing Music On Hold",
30909     "examples": [
30910       {
30911         "title": "Example usage:",
30912         "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",
30913         "type": "json"
30914       }
30915     ],
30916     "name": "updateMusic_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": "post",
30925     "url": "/api/voice/mails",
30926     "title": "Creates a new Mail",
30927     "examples": [
30928       {
30929         "title": "Example usage:",
30930         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30931         "type": "json"
30932       }
30933     ],
30934     "name": "CreateMails",
30935     "group": "Voice_Mails",
30936     "parameter": {
30937       "fields": {
30938         "Body": [
30939           {
30940             "group": "Body",
30941             "type": "String",
30942             "optional": true,
30943             "field": "customer_id",
30944             "description": ""
30945           },
30946           {
30947             "group": "Body",
30948             "type": "String",
30949             "optional": true,
30950             "field": "context",
30951             "description": ""
30952           },
30953           {
30954             "group": "Body",
30955             "type": "String",
30956             "optional": false,
30957             "field": "mailbox",
30958             "description": ""
30959           },
30960           {
30961             "group": "Body",
30962             "type": "String",
30963             "optional": true,
30964             "field": "password",
30965             "description": ""
30966           },
30967           {
30968             "group": "Body",
30969             "type": "String",
30970             "optional": true,
30971             "field": "fullname",
30972             "description": ""
30973           },
30974           {
30975             "group": "Body",
30976             "type": "String",
30977             "optional": true,
30978             "field": "email",
30979             "description": ""
30980           },
30981           {
30982             "group": "Body",
30983             "type": "String",
30984             "optional": true,
30985             "field": "pager",
30986             "description": ""
30987           },
30988           {
30989             "group": "Body",
30990             "type": "String",
30991             "optional": true,
30992             "field": "tz",
30993             "description": ""
30994           },
30995           {
30996             "group": "Body",
30997             "type": "String",
30998             "allowedValues": [
30999               "\"yes\"",
31000               "\"no\""
31001             ],
31002             "optional": false,
31003             "field": "attach",
31004             "description": ""
31005           },
31006           {
31007             "group": "Body",
31008             "type": "String",
31009             "allowedValues": [
31010               "\"yes\"",
31011               "\"no\""
31012             ],
31013             "optional": false,
31014             "field": "saycid",
31015             "description": ""
31016           },
31017           {
31018             "group": "Body",
31019             "type": "String",
31020             "optional": true,
31021             "field": "dialout",
31022             "description": ""
31023           },
31024           {
31025             "group": "Body",
31026             "type": "String",
31027             "optional": true,
31028             "field": "callback",
31029             "description": ""
31030           },
31031           {
31032             "group": "Body",
31033             "type": "String",
31034             "allowedValues": [
31035               "\"yes\"",
31036               "\"no\""
31037             ],
31038             "optional": false,
31039             "field": "review",
31040             "description": ""
31041           },
31042           {
31043             "group": "Body",
31044             "type": "String",
31045             "allowedValues": [
31046               "\"yes\"",
31047               "\"no\""
31048             ],
31049             "optional": false,
31050             "field": "operator",
31051             "description": ""
31052           },
31053           {
31054             "group": "Body",
31055             "type": "String",
31056             "allowedValues": [
31057               "\"yes\"",
31058               "\"no\""
31059             ],
31060             "optional": false,
31061             "field": "envelope",
31062             "description": ""
31063           },
31064           {
31065             "group": "Body",
31066             "type": "String",
31067             "allowedValues": [
31068               "\"yes\"",
31069               "\"no\""
31070             ],
31071             "optional": false,
31072             "field": "sayduration",
31073             "description": ""
31074           },
31075           {
31076             "group": "Body",
31077             "type": "String",
31078             "optional": false,
31079             "field": "saydurationm",
31080             "description": ""
31081           },
31082           {
31083             "group": "Body",
31084             "type": "String",
31085             "allowedValues": [
31086               "\"yes\"",
31087               "\"no\""
31088             ],
31089             "optional": false,
31090             "field": "sendvoicemail",
31091             "description": ""
31092           },
31093           {
31094             "group": "Body",
31095             "type": "String",
31096             "allowedValues": [
31097               "\"yes\"",
31098               "\"no\""
31099             ],
31100             "optional": false,
31101             "field": "delete",
31102             "description": ""
31103           },
31104           {
31105             "group": "Body",
31106             "type": "String",
31107             "allowedValues": [
31108               "\"yes\"",
31109               "\"no\""
31110             ],
31111             "optional": false,
31112             "field": "nextaftercmd",
31113             "description": ""
31114           },
31115           {
31116             "group": "Body",
31117             "type": "String",
31118             "allowedValues": [
31119               "\"yes\"",
31120               "\"no\""
31121             ],
31122             "optional": false,
31123             "field": "forcename",
31124             "description": ""
31125           },
31126           {
31127             "group": "Body",
31128             "type": "String",
31129             "allowedValues": [
31130               "\"yes\"",
31131               "\"no\""
31132             ],
31133             "optional": false,
31134             "field": "forcegreetings",
31135             "description": ""
31136           },
31137           {
31138             "group": "Body",
31139             "type": "String",
31140             "allowedValues": [
31141               "\"yes\"",
31142               "\"no\""
31143             ],
31144             "optional": false,
31145             "field": "hidefromdir",
31146             "description": ""
31147           },
31148           {
31149             "group": "Body",
31150             "type": "String",
31151             "optional": true,
31152             "field": "stamp",
31153             "description": ""
31154           },
31155           {
31156             "group": "Body",
31157             "type": "String",
31158             "optional": true,
31159             "field": "emailsubject",
31160             "description": ""
31161           },
31162           {
31163             "group": "Body",
31164             "type": "String",
31165             "optional": true,
31166             "field": "emailbody",
31167             "description": ""
31168           },
31169           {
31170             "group": "Body",
31171             "type": "Integer",
31172             "optional": false,
31173             "field": "maxsecs",
31174             "description": ""
31175           },
31176           {
31177             "group": "Body",
31178             "type": "Integer",
31179             "optional": false,
31180             "field": "maxmsg",
31181             "description": ""
31182           },
31183           {
31184             "group": "Body",
31185             "type": "Virtual",
31186             "optional": true,
31187             "field": "name",
31188             "description": ""
31189           }
31190         ]
31191       }
31192     },
31193     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31194     "version": "0.0.0",
31195     "filename": "server/api/voiceMail/index.js",
31196     "groupTitle": "Voice_Mails"
31197   },
31198   {
31199     "type": "delete",
31200     "url": "/api/voice/mails/{id}",
31201     "title": "Deletes a Mail",
31202     "examples": [
31203       {
31204         "title": "Example usage:",
31205         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31206         "type": "json"
31207       }
31208     ],
31209     "name": "DeleteMails",
31210     "group": "Voice_Mails",
31211     "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>",
31212     "version": "0.0.0",
31213     "filename": "server/api/voiceMail/index.js",
31214     "groupTitle": "Voice_Mails"
31215   },
31216   {
31217     "type": "get",
31218     "url": "/api/voice/mails",
31219     "title": "Gets a list of Mails",
31220     "examples": [
31221       {
31222         "title": "Example usage:",
31223         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31224         "type": "json"
31225       }
31226     ],
31227     "name": "GetMails",
31228     "group": "Voice_Mails",
31229     "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>",
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/{id}",
31237     "title": "Gets a single Mail",
31238     "examples": [
31239       {
31240         "title": "Example usage:",
31241         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31242         "type": "json"
31243       }
31244     ],
31245     "name": "ShowMails",
31246     "group": "Voice_Mails",
31247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/messages",
31255     "title": "Gets voice mail messages",
31256     "examples": [
31257       {
31258         "title": "Example usage:",
31259         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31260         "type": "json"
31261       }
31262     ],
31263     "name": "getMessages",
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": "put",
31272     "url": "/api/voice/mails/{id}",
31273     "title": "Update an existing Mail",
31274     "examples": [
31275       {
31276         "title": "Example usage:",
31277         "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",
31278         "type": "json"
31279       }
31280     ],
31281     "name": "updateMails",
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": "post",
31290     "url": "/api/voice/mails/messages",
31291     "title": "Creates a new Message",
31292     "examples": [
31293       {
31294         "title": "Example usage:",
31295         "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",
31296         "type": "json"
31297       }
31298     ],
31299     "name": "CreateMessages",
31300     "group": "Voice_Messages",
31301     "parameter": {
31302       "fields": {
31303         "Body": [
31304           {
31305             "group": "Body",
31306             "type": "Virtual",
31307             "optional": true,
31308             "field": "name",
31309             "description": ""
31310           },
31311           {
31312             "group": "Body",
31313             "type": "Integer",
31314             "optional": false,
31315             "field": "msgnum",
31316             "description": ""
31317           },
31318           {
31319             "group": "Body",
31320             "type": "String",
31321             "optional": true,
31322             "field": "dir",
31323             "description": ""
31324           },
31325           {
31326             "group": "Body",
31327             "type": "String",
31328             "optional": true,
31329             "field": "context",
31330             "description": ""
31331           },
31332           {
31333             "group": "Body",
31334             "type": "String",
31335             "optional": true,
31336             "field": "macrocontext",
31337             "description": ""
31338           },
31339           {
31340             "group": "Body",
31341             "type": "String",
31342             "optional": true,
31343             "field": "callerid",
31344             "description": ""
31345           },
31346           {
31347             "group": "Body",
31348             "type": "String",
31349             "optional": true,
31350             "field": "origtime",
31351             "description": ""
31352           },
31353           {
31354             "group": "Body",
31355             "type": "String",
31356             "optional": true,
31357             "field": "duration",
31358             "description": ""
31359           },
31360           {
31361             "group": "Body",
31362             "type": "String",
31363             "optional": true,
31364             "field": "mailboxuser",
31365             "description": ""
31366           },
31367           {
31368             "group": "Body",
31369             "type": "String",
31370             "optional": true,
31371             "field": "mailboxcontext",
31372             "description": ""
31373           },
31374           {
31375             "group": "Body",
31376             "type": "Blob",
31377             "optional": true,
31378             "field": "recording",
31379             "description": ""
31380           },
31381           {
31382             "group": "Body",
31383             "type": "String",
31384             "optional": true,
31385             "field": "flag",
31386             "description": ""
31387           },
31388           {
31389             "group": "Body",
31390             "type": "String",
31391             "optional": true,
31392             "field": "msg_id",
31393             "description": ""
31394           },
31395           {
31396             "group": "Body",
31397             "type": "String",
31398             "optional": true,
31399             "field": "stamp",
31400             "description": ""
31401           }
31402         ]
31403       }
31404     },
31405     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31406     "version": "0.0.0",
31407     "filename": "server/api/voiceMailMessage/index.js",
31408     "groupTitle": "Voice_Messages"
31409   },
31410   {
31411     "type": "delete",
31412     "url": "/api/voice/mails/messages/{id}",
31413     "title": "Deletes a Message",
31414     "examples": [
31415       {
31416         "title": "Example usage:",
31417         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31418         "type": "json"
31419       }
31420     ],
31421     "name": "DeleteMessages",
31422     "group": "Voice_Messages",
31423     "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>",
31424     "version": "0.0.0",
31425     "filename": "server/api/voiceMailMessage/index.js",
31426     "groupTitle": "Voice_Messages"
31427   },
31428   {
31429     "type": "get",
31430     "url": "/api/voice/mails/messages",
31431     "title": "Gets a list of Messages",
31432     "examples": [
31433       {
31434         "title": "Example usage:",
31435         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31436         "type": "json"
31437       }
31438     ],
31439     "name": "GetMessages",
31440     "group": "Voice_Messages",
31441     "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>",
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/{id}",
31449     "title": "Gets a single Message",
31450     "examples": [
31451       {
31452         "title": "Example usage:",
31453         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31454         "type": "json"
31455       }
31456     ],
31457     "name": "ShowMessages",
31458     "group": "Voice_Messages",
31459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31460     "version": "0.0.0",
31461     "filename": "server/api/voiceMailMessage/index.js",
31462     "groupTitle": "Voice_Messages"
31463   },
31464   {
31465     "type": "get",
31466     "url": "voice/mails/messages/{id}/download",
31467     "title": "Download Voice Message",
31468     "examples": [
31469       {
31470         "title": "Example usage:",
31471         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31472         "type": "json"
31473       }
31474     ],
31475     "name": "download",
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": "put",
31484     "url": "/api/voice/mails/messages/{id}",
31485     "title": "Update an existing Message",
31486     "examples": [
31487       {
31488         "title": "Example usage:",
31489         "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",
31490         "type": "json"
31491       }
31492     ],
31493     "name": "updateMessages",
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": "post",
31502     "url": "/api/voice/prefixes/{id}/teams",
31503     "title": "Add teams to voice prefix",
31504     "examples": [
31505       {
31506         "title": "Example usage:",
31507         "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",
31508         "type": "json"
31509       }
31510     ],
31511     "name": "AddTeams",
31512     "group": "Voice_Prefix",
31513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31514     "version": "0.0.0",
31515     "filename": "server/api/voicePrefix/index.js",
31516     "groupTitle": "Voice_Prefix"
31517   },
31518   {
31519     "type": "get",
31520     "url": "/api/voice/prefixes/{id}/teams",
31521     "title": "Gets voice prefix team",
31522     "examples": [
31523       {
31524         "title": "Example usage:",
31525         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
31526         "type": "json"
31527       }
31528     ],
31529     "name": "GetTeams",
31530     "group": "Voice_Prefix",
31531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
31538     "url": "/api/voice/prefixes/{id}/users",
31539     "title": "Add agents to a prefix",
31540     "examples": [
31541       {
31542         "title": "Example usage:",
31543         "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",
31544         "type": "json"
31545       }
31546     ],
31547     "name": "AddAgents",
31548     "group": "Voice_Prefixes",
31549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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_Prefixes"
31553   },
31554   {
31555     "type": "delete",
31556     "url": "/api/voice/prefixes/{id}",
31557     "title": "Deletes a Prefix",
31558     "examples": [
31559       {
31560         "title": "Example usage:",
31561         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31562         "type": "json"
31563       }
31564     ],
31565     "name": "DeletePrefixes",
31566     "group": "Voice_Prefixes",
31567     "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>",
31568     "version": "0.0.0",
31569     "filename": "server/api/voicePrefix/index.js",
31570     "groupTitle": "Voice_Prefixes"
31571   },
31572   {
31573     "type": "get",
31574     "url": "/api/voice/prefixes/describe",
31575     "title": "Gets table info about Prefixes",
31576     "examples": [
31577       {
31578         "title": "Example usage:",
31579         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31580         "type": "json"
31581       }
31582     ],
31583     "name": "DescribePrefixes",
31584     "group": "Voice_Prefixes",
31585     "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>",
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/{id}/users",
31593     "title": "Gets agents from prefix",
31594     "examples": [
31595       {
31596         "title": "Example usage:",
31597         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31598         "type": "json"
31599       }
31600     ],
31601     "name": "GetAgents",
31602     "group": "Voice_Prefixes",
31603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
31611     "title": "Gets a list of Prefixes",
31612     "examples": [
31613       {
31614         "title": "Example usage:",
31615         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31616         "type": "json"
31617       }
31618     ],
31619     "name": "GetPrefixes",
31620     "group": "Voice_Prefixes",
31621     "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>",
31622     "version": "0.0.0",
31623     "filename": "server/api/voicePrefix/index.js",
31624     "groupTitle": "Voice_Prefixes"
31625   },
31626   {
31627     "type": "delete",
31628     "url": "/api/voice/prefixes/{id}/users",
31629     "title": "Removes agents from a prefix",
31630     "examples": [
31631       {
31632         "title": "Example usage:",
31633         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31634         "type": "json"
31635       }
31636     ],
31637     "name": "RemoveAgents",
31638     "group": "Voice_Prefixes",
31639     "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>",
31640     "version": "0.0.0",
31641     "filename": "server/api/voicePrefix/index.js",
31642     "groupTitle": "Voice_Prefixes"
31643   },
31644   {
31645     "type": "get",
31646     "url": "/api/voice/prefixes/{id}",
31647     "title": "Gets a single Prefix",
31648     "examples": [
31649       {
31650         "title": "Example usage:",
31651         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31652         "type": "json"
31653       }
31654     ],
31655     "name": "ShowPrefixes",
31656     "group": "Voice_Prefixes",
31657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
31664     "url": "/api/voice/prefixes/{id}",
31665     "title": "Update an existing prefix",
31666     "examples": [
31667       {
31668         "title": "Example usage:",
31669         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31670         "type": "json"
31671       }
31672     ],
31673     "name": "Update",
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": "post",
31682     "url": "/api/voice/prefixes",
31683     "title": "Create a prefix",
31684     "examples": [
31685       {
31686         "title": "Example usage:",
31687         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31688         "type": "json"
31689       }
31690     ],
31691     "name": "create",
31692     "group": "Voice_Prefixes",
31693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
31700     "url": "/api/voice/queues/reports/describe",
31701     "title": "Gets table info about Queue Reports",
31702     "examples": [
31703       {
31704         "title": "Example usage:",
31705         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31706         "type": "json"
31707       }
31708     ],
31709     "name": "DescribeQueue_Reports",
31710     "group": "Voice_Queue_Reports",
31711     "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>",
31712     "version": "0.0.0",
31713     "filename": "server/api/voiceQueueReport/index.js",
31714     "groupTitle": "Voice_Queue_Reports"
31715   },
31716   {
31717     "type": "get",
31718     "url": "/api/voice/queues/reports",
31719     "title": "Gets a list of Queue Reports",
31720     "examples": [
31721       {
31722         "title": "Example usage:",
31723         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31724         "type": "json"
31725       }
31726     ],
31727     "name": "GetQueue_Reports",
31728     "group": "Voice_Queue_Reports",
31729     "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>",
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/{id}",
31737     "title": "Gets a single Queue Report",
31738     "examples": [
31739       {
31740         "title": "Example usage:",
31741         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31742         "type": "json"
31743       }
31744     ],
31745     "name": "ShowQueue_Reports",
31746     "group": "Voice_Queue_Reports",
31747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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/index",
31755     "title": "Get Voice Queues Report",
31756     "examples": [
31757       {
31758         "title": "Example usage:",
31759         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31760         "type": "json"
31761       }
31762     ],
31763     "name": "getVoiceQueuesReport",
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": "post",
31772     "url": "/api/voice/queues/{id}/users",
31773     "title": "Add agents to queue",
31774     "examples": [
31775       {
31776         "title": "Example usage:",
31777         "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",
31778         "type": "json"
31779       }
31780     ],
31781     "name": "AddAgents",
31782     "group": "Voice_Queues",
31783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31784     "version": "0.0.0",
31785     "filename": "server/api/voiceQueue/index.js",
31786     "groupTitle": "Voice_Queues"
31787   },
31788   {
31789     "type": "post",
31790     "url": "/api/voice/queues/{id}/blacklists",
31791     "title": "Add blacklists to a queue",
31792     "examples": [
31793       {
31794         "title": "Example usage:",
31795         "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",
31796         "type": "json"
31797       }
31798     ],
31799     "name": "AddBlackLists",
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}/lists",
31809     "title": "Add lists to a queue",
31810     "examples": [
31811       {
31812         "title": "Example usage:",
31813         "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",
31814         "type": "json"
31815       }
31816     ],
31817     "name": "AddLists",
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}/teams",
31827     "title": "Add teams to queue",
31828     "examples": [
31829       {
31830         "title": "Example usage:",
31831         "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",
31832         "type": "json"
31833       }
31834     ],
31835     "name": "AddTeams",
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/clone",
31845     "title": "Clone an existing Queue",
31846     "examples": [
31847       {
31848         "title": "Example usage:",
31849         "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",
31850         "type": "json"
31851       }
31852     ],
31853     "name": "CloneQueues",
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",
31863     "title": "Creates a new Queue",
31864     "examples": [
31865       {
31866         "title": "Example usage:",
31867         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31868         "type": "json"
31869       }
31870     ],
31871     "name": "CreateQueues",
31872     "group": "Voice_Queues",
31873     "parameter": {
31874       "fields": {
31875         "Body": [
31876           {
31877             "group": "Body",
31878             "type": "String",
31879             "optional": false,
31880             "field": "name",
31881             "description": ""
31882           },
31883           {
31884             "group": "Body",
31885             "type": "String",
31886             "allowedValues": [
31887               "\"inbound\"",
31888               "\"outbound\""
31889             ],
31890             "optional": false,
31891             "field": "type",
31892             "description": ""
31893           },
31894           {
31895             "group": "Body",
31896             "type": "String",
31897             "optional": true,
31898             "field": "musiconhold",
31899             "description": ""
31900           },
31901           {
31902             "group": "Body",
31903             "type": "String",
31904             "optional": true,
31905             "field": "announce",
31906             "description": ""
31907           },
31908           {
31909             "group": "Body",
31910             "type": "String",
31911             "allowedValues": [
31912               "\"rr\"",
31913               "\"ringall\"",
31914               "\"leastrecent\"",
31915               "\"fewestcalls\"",
31916               "\"random\"",
31917               "\"rrmemory\"",
31918               "\"linear\"",
31919               "\"wrandom\"",
31920               "\"rrordered\""
31921             ],
31922             "optional": false,
31923             "field": "strategy",
31924             "description": ""
31925           },
31926           {
31927             "group": "Body",
31928             "type": "Integer",
31929             "optional": true,
31930             "field": "servicelevel",
31931             "description": ""
31932           },
31933           {
31934             "group": "Body",
31935             "type": "String",
31936             "optional": true,
31937             "field": "context",
31938             "description": ""
31939           },
31940           {
31941             "group": "Body",
31942             "type": "Integer",
31943             "optional": true,
31944             "field": "penaltymemberslimit",
31945             "description": ""
31946           },
31947           {
31948             "group": "Body",
31949             "type": "Integer",
31950             "optional": true,
31951             "field": "timeout",
31952             "description": ""
31953           },
31954           {
31955             "group": "Body",
31956             "type": "Integer",
31957             "optional": true,
31958             "field": "retry",
31959             "description": ""
31960           },
31961           {
31962             "group": "Body",
31963             "type": "String",
31964             "optional": true,
31965             "field": "timeoutpriority",
31966             "description": ""
31967           },
31968           {
31969             "group": "Body",
31970             "type": "Integer",
31971             "optional": true,
31972             "field": "weight",
31973             "description": ""
31974           },
31975           {
31976             "group": "Body",
31977             "type": "Integer",
31978             "optional": true,
31979             "field": "wrapuptime",
31980             "description": ""
31981           },
31982           {
31983             "group": "Body",
31984             "type": "String",
31985             "allowedValues": [
31986               "\"yes\"",
31987               "\"no\""
31988             ],
31989             "optional": true,
31990             "field": "autofill",
31991             "description": ""
31992           },
31993           {
31994             "group": "Body",
31995             "type": "String",
31996             "allowedValues": [
31997               "\"yes\"",
31998               "\"no\"",
31999               "\"all\""
32000             ],
32001             "optional": true,
32002             "field": "autopause",
32003             "description": ""
32004           },
32005           {
32006             "group": "Body",
32007             "type": "Integer",
32008             "optional": true,
32009             "field": "autopausedelay",
32010             "description": ""
32011           },
32012           {
32013             "group": "Body",
32014             "type": "String",
32015             "allowedValues": [
32016               "\"yes\"",
32017               "\"no\""
32018             ],
32019             "optional": true,
32020             "field": "autopausebusy",
32021             "description": ""
32022           },
32023           {
32024             "group": "Body",
32025             "type": "String",
32026             "allowedValues": [
32027               "\"yes\"",
32028               "\"no\""
32029             ],
32030             "optional": true,
32031             "field": "autopauseunavail",
32032             "description": ""
32033           },
32034           {
32035             "group": "Body",
32036             "type": "Integer",
32037             "optional": true,
32038             "field": "maxlen",
32039             "description": ""
32040           },
32041           {
32042             "group": "Body",
32043             "type": "String",
32044             "allowedValues": [
32045               "\"yes\"",
32046               "\"no\""
32047             ],
32048             "optional": true,
32049             "field": "setinterfacevar",
32050             "description": ""
32051           },
32052           {
32053             "group": "Body",
32054             "type": "String",
32055             "allowedValues": [
32056               "\"yes\"",
32057               "\"no\""
32058             ],
32059             "optional": true,
32060             "field": "setqueueentryvar",
32061             "description": ""
32062           },
32063           {
32064             "group": "Body",
32065             "type": "String",
32066             "allowedValues": [
32067               "\"yes\"",
32068               "\"no\""
32069             ],
32070             "optional": true,
32071             "field": "setqueuevar",
32072             "description": ""
32073           },
32074           {
32075             "group": "Body",
32076             "type": "String",
32077             "allowedValues": [
32078               "\"yes\"",
32079               "\"no\""
32080             ],
32081             "optional": true,
32082             "field": "eventmemberstatus",
32083             "description": ""
32084           },
32085           {
32086             "group": "Body",
32087             "type": "String",
32088             "optional": true,
32089             "field": "membermacro",
32090             "description": ""
32091           },
32092           {
32093             "group": "Body",
32094             "type": "String",
32095             "optional": true,
32096             "field": "membergosub",
32097             "description": ""
32098           },
32099           {
32100             "group": "Body",
32101             "type": "Integer",
32102             "optional": true,
32103             "field": "announce_frequency",
32104             "description": ""
32105           },
32106           {
32107             "group": "Body",
32108             "type": "Integer",
32109             "optional": true,
32110             "field": "min_announce_frequency",
32111             "description": ""
32112           },
32113           {
32114             "group": "Body",
32115             "type": "Integer",
32116             "optional": true,
32117             "field": "periodic_announce_frequency",
32118             "description": ""
32119           },
32120           {
32121             "group": "Body",
32122             "type": "String",
32123             "allowedValues": [
32124               "\"yes\"",
32125               "\"no\""
32126             ],
32127             "optional": true,
32128             "field": "random_periodic_announce",
32129             "description": ""
32130           },
32131           {
32132             "group": "Body",
32133             "type": "String",
32134             "allowedValues": [
32135               "\"yes\"",
32136               "\"no\""
32137             ],
32138             "optional": true,
32139             "field": "relative_periodic_announce",
32140             "description": ""
32141           },
32142           {
32143             "group": "Body",
32144             "type": "String",
32145             "allowedValues": [
32146               "\"yes\"",
32147               "\"no\"",
32148               "\"once\""
32149             ],
32150             "optional": true,
32151             "field": "announce_holdtime",
32152             "description": ""
32153           },
32154           {
32155             "group": "Body",
32156             "type": "String",
32157             "optional": true,
32158             "field": "announce_position",
32159             "description": ""
32160           },
32161           {
32162             "group": "Body",
32163             "type": "String",
32164             "allowedValues": [
32165               "\"yes\"",
32166               "\"no\""
32167             ],
32168             "optional": true,
32169             "field": "announce_to_first_user",
32170             "description": ""
32171           },
32172           {
32173             "group": "Body",
32174             "type": "Integer",
32175             "optional": true,
32176             "field": "announce_position_limit",
32177             "description": ""
32178           },
32179           {
32180             "group": "Body",
32181             "type": "String",
32182             "allowedValues": [
32183               "\"0\"",
32184               "\"5\"",
32185               "\"10\"",
32186               "\"15\"",
32187               "\"20\"",
32188               "\"30\""
32189             ],
32190             "optional": true,
32191             "field": "announce_round_seconds",
32192             "description": ""
32193           },
32194           {
32195             "group": "Body",
32196             "type": "String",
32197             "optional": true,
32198             "field": "monitor_format",
32199             "description": ""
32200           },
32201           {
32202             "group": "Body",
32203             "type": "String",
32204             "optional": true,
32205             "field": "monitor_type",
32206             "description": ""
32207           },
32208           {
32209             "group": "Body",
32210             "type": "String",
32211             "optional": true,
32212             "field": "queue_youarenext",
32213             "description": ""
32214           },
32215           {
32216             "group": "Body",
32217             "type": "String",
32218             "optional": true,
32219             "field": "queue_thereare",
32220             "description": ""
32221           },
32222           {
32223             "group": "Body",
32224             "type": "String",
32225             "optional": true,
32226             "field": "queue_callswaiting",
32227             "description": ""
32228           },
32229           {
32230             "group": "Body",
32231             "type": "String",
32232             "optional": true,
32233             "field": "queue_holdtime",
32234             "description": ""
32235           },
32236           {
32237             "group": "Body",
32238             "type": "String",
32239             "optional": true,
32240             "field": "queue_minute",
32241             "description": ""
32242           },
32243           {
32244             "group": "Body",
32245             "type": "String",
32246             "optional": true,
32247             "field": "queue_minutes",
32248             "description": ""
32249           },
32250           {
32251             "group": "Body",
32252             "type": "String",
32253             "optional": true,
32254             "field": "queue_seconds",
32255             "description": ""
32256           },
32257           {
32258             "group": "Body",
32259             "type": "String",
32260             "optional": true,
32261             "field": "queue_thankyou",
32262             "description": ""
32263           },
32264           {
32265             "group": "Body",
32266             "type": "String",
32267             "optional": true,
32268             "field": "queue_reporthold",
32269             "description": ""
32270           },
32271           {
32272             "group": "Body",
32273             "type": "String",
32274             "optional": true,
32275             "field": "queue_quantity1",
32276             "description": ""
32277           },
32278           {
32279             "group": "Body",
32280             "type": "String",
32281             "optional": true,
32282             "field": "queue_quantity2",
32283             "description": ""
32284           },
32285           {
32286             "group": "Body",
32287             "type": "String",
32288             "optional": true,
32289             "field": "queue_periodic_announce",
32290             "description": ""
32291           },
32292           {
32293             "group": "Body",
32294             "type": "String",
32295             "optional": true,
32296             "field": "queue_less_than",
32297             "description": ""
32298           },
32299           {
32300             "group": "Body",
32301             "type": "Text",
32302             "optional": true,
32303             "field": "periodic_announce",
32304             "description": ""
32305           },
32306           {
32307             "group": "Body",
32308             "type": "String",
32309             "optional": true,
32310             "field": "joinempty",
32311             "description": ""
32312           },
32313           {
32314             "group": "Body",
32315             "type": "String",
32316             "optional": true,
32317             "field": "leavewhenempty",
32318             "description": ""
32319           },
32320           {
32321             "group": "Body",
32322             "type": "String",
32323             "allowedValues": [
32324               "\"yes\"",
32325               "\"no\""
32326             ],
32327             "optional": true,
32328             "field": "reportholdtime",
32329             "description": ""
32330           },
32331           {
32332             "group": "Body",
32333             "type": "String",
32334             "allowedValues": [
32335               "\"yes\"",
32336               "\"no\""
32337             ],
32338             "optional": true,
32339             "field": "ringinuse",
32340             "description": ""
32341           },
32342           {
32343             "group": "Body",
32344             "type": "Integer",
32345             "optional": true,
32346             "field": "memberdelay",
32347             "description": ""
32348           },
32349           {
32350             "group": "Body",
32351             "type": "String",
32352             "allowedValues": [
32353               "\"yes\"",
32354               "\"no\""
32355             ],
32356             "optional": true,
32357             "field": "timeoutrestart",
32358             "description": ""
32359           },
32360           {
32361             "group": "Body",
32362             "type": "String",
32363             "optional": true,
32364             "field": "defaultrule",
32365             "description": ""
32366           },
32367           {
32368             "group": "Body",
32369             "type": "String",
32370             "optional": true,
32371             "field": "description",
32372             "description": ""
32373           },
32374           {
32375             "group": "Body",
32376             "type": "Boolean",
32377             "optional": true,
32378             "field": "acw",
32379             "description": ""
32380           },
32381           {
32382             "group": "Body",
32383             "type": "Integer",
32384             "optional": true,
32385             "field": "acwTimeout",
32386             "description": ""
32387           },
32388           {
32389             "group": "Body",
32390             "type": "Boolean",
32391             "optional": true,
32392             "field": "dialActive",
32393             "description": "<p>Active/Disactive Campaign</p>"
32394           },
32395           {
32396             "group": "Body",
32397             "type": "String",
32398             "allowedValues": [
32399               "\"preview\"",
32400               "\"progressive\"",
32401               "\"power\"",
32402               "\"predictive\"",
32403               "\"booked\""
32404             ],
32405             "optional": true,
32406             "field": "dialMethod",
32407             "description": "<p>Dial Method.</p>"
32408           },
32409           {
32410             "group": "Body",
32411             "type": "Integer",
32412             "optional": true,
32413             "field": "dialLimitChannel",
32414             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32415           },
32416           {
32417             "group": "Body",
32418             "type": "Integer",
32419             "optional": true,
32420             "field": "dialLimitQueue",
32421             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32422           },
32423           {
32424             "group": "Body",
32425             "type": "Float",
32426             "optional": true,
32427             "field": "dialPowerLevel",
32428             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32429           },
32430           {
32431             "group": "Body",
32432             "type": "String",
32433             "allowedValues": [
32434               "\"agentBusyFactor\"",
32435               "\"dropRate\""
32436             ],
32437             "optional": true,
32438             "field": "dialPredictiveOptimization",
32439             "description": "<p>Only for predictive method.</p>"
32440           },
32441           {
32442             "group": "Body",
32443             "type": "Float",
32444             "optional": true,
32445             "field": "dialPredictiveOptimizationPercentage",
32446             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32447           },
32448           {
32449             "group": "Body",
32450             "type": "Integer",
32451             "optional": true,
32452             "field": "dialPredictiveInterval",
32453             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32454           },
32455           {
32456             "group": "Body",
32457             "type": "String",
32458             "optional": true,
32459             "field": "dialOriginateCallerIdName",
32460             "description": ""
32461           },
32462           {
32463             "group": "Body",
32464             "type": "String",
32465             "optional": true,
32466             "field": "dialOriginateCallerIdNumber",
32467             "description": ""
32468           },
32469           {
32470             "group": "Body",
32471             "type": "Integer",
32472             "optional": true,
32473             "field": "dialOriginateTimeout",
32474             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32475           },
32476           {
32477             "group": "Body",
32478             "type": "String",
32479             "optional": true,
32480             "field": "dialQueueOptions",
32481             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32482           },
32483           {
32484             "group": "Body",
32485             "type": "Integer",
32486             "optional": true,
32487             "field": "dialQueueTimeout",
32488             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32489           },
32490           {
32491             "group": "Body",
32492             "type": "String",
32493             "optional": true,
32494             "field": "dialQueueProject",
32495             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32496           },
32497           {
32498             "group": "Body",
32499             "type": "Integer",
32500             "optional": true,
32501             "field": "dialCongestionMaxRetry",
32502             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32503           },
32504           {
32505             "group": "Body",
32506             "type": "Integer",
32507             "optional": true,
32508             "field": "dialCongestionRetryFrequency",
32509             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32510           },
32511           {
32512             "group": "Body",
32513             "type": "Integer",
32514             "optional": true,
32515             "field": "dialBusyMaxRetry",
32516             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32517           },
32518           {
32519             "group": "Body",
32520             "type": "Integer",
32521             "optional": true,
32522             "field": "dialBusyRetryFrequency",
32523             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32524           },
32525           {
32526             "group": "Body",
32527             "type": "Integer",
32528             "optional": true,
32529             "field": "dialNoAnswerMaxRetry",
32530             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32531           },
32532           {
32533             "group": "Body",
32534             "type": "Integer",
32535             "optional": true,
32536             "field": "dialNoAnswerRetryFrequency",
32537             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32538           },
32539           {
32540             "group": "Body",
32541             "type": "Integer",
32542             "optional": true,
32543             "field": "dialGlobalMaxRetry",
32544             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32545           },
32546           {
32547             "group": "Body",
32548             "type": "String",
32549             "optional": true,
32550             "field": "dialTimezone",
32551             "description": ""
32552           },
32553           {
32554             "group": "Body",
32555             "type": "String",
32556             "optional": true,
32557             "field": "dialGlobalInterval",
32558             "description": ""
32559           },
32560           {
32561             "group": "Body",
32562             "type": "String",
32563             "optional": true,
32564             "field": "dialPrefix",
32565             "description": ""
32566           },
32567           {
32568             "group": "Body",
32569             "type": "String",
32570             "allowedValues": [
32571               "\"always\"",
32572               "\"never\"",
32573               "\"onlyIfOpen\""
32574             ],
32575             "optional": true,
32576             "field": "dialCheckDuplicateType",
32577             "description": ""
32578           },
32579           {
32580             "group": "Body",
32581             "type": "Boolean",
32582             "optional": true,
32583             "field": "dialAMDActive",
32584             "description": "<p>Active/Disactive AMD</p>"
32585           },
32586           {
32587             "group": "Body",
32588             "type": "Integer",
32589             "optional": true,
32590             "field": "dialAMDInitialSilence",
32591             "description": "<p>#AMD Initial Silence</p>"
32592           },
32593           {
32594             "group": "Body",
32595             "type": "Integer",
32596             "optional": true,
32597             "field": "dialAMDGreeting",
32598             "description": "<p>#AMD Greeting</p>"
32599           },
32600           {
32601             "group": "Body",
32602             "type": "Integer",
32603             "optional": true,
32604             "field": "dialAMDAfterGreetingSilence",
32605             "description": "<p>#AMD After Greeting Silence</p>"
32606           },
32607           {
32608             "group": "Body",
32609             "type": "Integer",
32610             "optional": true,
32611             "field": "dialAMDTotalAnalysisTime",
32612             "description": "<p>#AMD Total Analysis Time</p>"
32613           },
32614           {
32615             "group": "Body",
32616             "type": "Integer",
32617             "optional": true,
32618             "field": "dialAMDMinWordLength",
32619             "description": "<p>#AMD Min Word Length</p>"
32620           },
32621           {
32622             "group": "Body",
32623             "type": "Integer",
32624             "optional": true,
32625             "field": "dialAMDBetweenWordsSilence",
32626             "description": "<p>#AMD Between Words Silence</p>"
32627           },
32628           {
32629             "group": "Body",
32630             "type": "Integer",
32631             "optional": true,
32632             "field": "dialAMDMaximumNumberOfWords",
32633             "description": "<p>#AMD Maximum Number Of Words</p>"
32634           },
32635           {
32636             "group": "Body",
32637             "type": "Integer",
32638             "optional": true,
32639             "field": "dialAMDSilenceThreshold",
32640             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32641           },
32642           {
32643             "group": "Body",
32644             "type": "Integer",
32645             "optional": true,
32646             "field": "dialAMDMaximumWordLength",
32647             "description": "<p>#AMD Maximum Word Length</p>"
32648           },
32649           {
32650             "group": "Body",
32651             "type": "Integer",
32652             "optional": true,
32653             "field": "dialRecallMeTimeout",
32654             "description": "<p>#RecallMe Timeout (min:1)</p>"
32655           },
32656           {
32657             "group": "Body",
32658             "type": "Boolean",
32659             "optional": true,
32660             "field": "dialRecallInQueue",
32661             "description": "<p>Active/Disactive Recall In Queue</p>"
32662           },
32663           {
32664             "group": "Body",
32665             "type": "String",
32666             "allowedValues": [
32667               "\"DESC\"",
32668               "\"ASC\""
32669             ],
32670             "optional": true,
32671             "field": "dialOrderByScheduledAt",
32672             "description": ""
32673           },
32674           {
32675             "group": "Body",
32676             "type": "String",
32677             "optional": true,
32678             "field": "dialQueueProject2",
32679             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32680           },
32681           {
32682             "group": "Body",
32683             "type": "Boolean",
32684             "optional": true,
32685             "field": "dialAgiAfterHangupClient",
32686             "description": ""
32687           },
32688           {
32689             "group": "Body",
32690             "type": "Boolean",
32691             "optional": true,
32692             "field": "dialAgiAfterHangupAgent",
32693             "description": ""
32694           },
32695           {
32696             "group": "Body",
32697             "type": "Integer",
32698             "optional": true,
32699             "field": "dialRandomLastDigitCallerIdNumber",
32700             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32701           },
32702           {
32703             "group": "Body",
32704             "type": "Integer",
32705             "optional": true,
32706             "field": "dialCutDigit",
32707             "description": "<p>Cut Digit (min:1, max:15)</p>"
32708           },
32709           {
32710             "group": "Body",
32711             "type": "Integer",
32712             "optional": true,
32713             "field": "dialNoSuchNumberMaxRetry",
32714             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32715           },
32716           {
32717             "group": "Body",
32718             "type": "Integer",
32719             "optional": true,
32720             "field": "dialNoSuchNumberRetryFrequency",
32721             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32722           },
32723           {
32724             "group": "Body",
32725             "type": "Integer",
32726             "optional": true,
32727             "field": "dialDropMaxRetry",
32728             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32729           },
32730           {
32731             "group": "Body",
32732             "type": "Integer",
32733             "optional": true,
32734             "field": "dialDropRetryFrequency",
32735             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32736           },
32737           {
32738             "group": "Body",
32739             "type": "Integer",
32740             "optional": true,
32741             "field": "dialAbandonedMaxRetry",
32742             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32743           },
32744           {
32745             "group": "Body",
32746             "type": "Integer",
32747             "optional": true,
32748             "field": "dialAbandonedRetryFrequency",
32749             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32750           },
32751           {
32752             "group": "Body",
32753             "type": "Integer",
32754             "optional": true,
32755             "field": "dialMachineMaxRetry",
32756             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32757           },
32758           {
32759             "group": "Body",
32760             "type": "Integer",
32761             "optional": true,
32762             "field": "dialMachineRetryFrequency",
32763             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32764           },
32765           {
32766             "group": "Body",
32767             "type": "Integer",
32768             "optional": true,
32769             "field": "dialAgentRejectMaxRetry",
32770             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32771           },
32772           {
32773             "group": "Body",
32774             "type": "Integer",
32775             "optional": true,
32776             "field": "dialAgentRejectRetryFrequency",
32777             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32778           },
32779           {
32780             "group": "Body",
32781             "type": "Integer",
32782             "optional": true,
32783             "field": "mandatoryDispositionPauseId",
32784             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32785           },
32786           {
32787             "group": "Body",
32788             "type": "Boolean",
32789             "optional": true,
32790             "field": "mandatoryDisposition",
32791             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32792           },
32793           {
32794             "group": "Body",
32795             "type": "Integer",
32796             "optional": true,
32797             "field": "dialPredictiveIntervalMaxThreshold",
32798             "description": ""
32799           },
32800           {
32801             "group": "Body",
32802             "type": "Integer",
32803             "optional": true,
32804             "field": "dialPredictiveIntervalMinThreshold",
32805             "description": ""
32806           },
32807           {
32808             "group": "Body",
32809             "type": "Boolean",
32810             "optional": true,
32811             "field": "dialPreviewAutoRecallMe",
32812             "description": ""
32813           }
32814         ]
32815       }
32816     },
32817     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32818     "version": "0.0.0",
32819     "filename": "server/api/voiceQueue/index.js",
32820     "groupTitle": "Voice_Queues"
32821   },
32822   {
32823     "type": "delete",
32824     "url": "/api/voice/queues/{id}",
32825     "title": "Deletes a Queue",
32826     "examples": [
32827       {
32828         "title": "Example usage:",
32829         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32830         "type": "json"
32831       }
32832     ],
32833     "name": "DeleteQueues",
32834     "group": "Voice_Queues",
32835     "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>",
32836     "version": "0.0.0",
32837     "filename": "server/api/voiceQueue/index.js",
32838     "groupTitle": "Voice_Queues"
32839   },
32840   {
32841     "type": "get",
32842     "url": "/api/voice/queues/{id}/users",
32843     "title": "Gets queue agents",
32844     "examples": [
32845       {
32846         "title": "Example usage:",
32847         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32848         "type": "json"
32849       }
32850     ],
32851     "name": "GetAgents",
32852     "group": "Voice_Queues",
32853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/blacklists",
32861     "title": "Get queue blacklists",
32862     "examples": [
32863       {
32864         "title": "Example usage:",
32865         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32866         "type": "json"
32867       }
32868     ],
32869     "name": "GetBlackLists",
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}/finals",
32879     "title": "Gets queue hopper finals",
32880     "examples": [
32881       {
32882         "title": "Example usage:",
32883         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32884         "type": "json"
32885       }
32886     ],
32887     "name": "GetHopperFinals",
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}/hopper_histories",
32897     "title": "Gets queue hopper histories",
32898     "examples": [
32899       {
32900         "title": "Example usage:",
32901         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32902         "type": "json"
32903       }
32904     ],
32905     "name": "GetHopperHistories",
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}/hoppers",
32915     "title": "Gets queue hoppers",
32916     "examples": [
32917       {
32918         "title": "Example usage:",
32919         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32920         "type": "json"
32921       }
32922     ],
32923     "name": "GetHoppers",
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}/lists",
32933     "title": "Get queue lists",
32934     "examples": [
32935       {
32936         "title": "Example usage:",
32937         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32938         "type": "json"
32939       }
32940     ],
32941     "name": "GetLists",
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}/members",
32951     "title": "Gets queue members",
32952     "examples": [
32953       {
32954         "title": "Example usage:",
32955         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32956         "type": "json"
32957       }
32958     ],
32959     "name": "GetMembers",
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",
32969     "title": "Gets a list of Queues",
32970     "examples": [
32971       {
32972         "title": "Example usage:",
32973         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32974         "type": "json"
32975       }
32976     ],
32977     "name": "GetQueues",
32978     "group": "Voice_Queues",
32979     "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>",
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/{id}/teams",
32987     "title": "Gets queue team",
32988     "examples": [
32989       {
32990         "title": "Example usage:",
32991         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32992         "type": "json"
32993       }
32994     ],
32995     "name": "GetTeams",
32996     "group": "Voice_Queues",
32997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32998     "version": "0.0.0",
32999     "filename": "server/api/voiceQueue/index.js",
33000     "groupTitle": "Voice_Queues"
33001   },
33002   {
33003     "type": "delete",
33004     "url": "/api/voice/queues/{id}/users",
33005     "title": "Removes agents from a queue",
33006     "examples": [
33007       {
33008         "title": "Example usage:",
33009         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33010         "type": "json"
33011       }
33012     ],
33013     "name": "RemoveAgents",
33014     "group": "Voice_Queues",
33015     "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>",
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}/blacklists",
33023     "title": "Remove blacklists from a queue",
33024     "examples": [
33025       {
33026         "title": "Example usage:",
33027         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33028         "type": "json"
33029       }
33030     ],
33031     "name": "RemoveBlackLists",
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}/lists",
33041     "title": "Remove lists from a queue",
33042     "examples": [
33043       {
33044         "title": "Example usage:",
33045         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33046         "type": "json"
33047       }
33048     ],
33049     "name": "RemoveLists",
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": "get",
33058     "url": "/api/voice/queues/{id}",
33059     "title": "Gets a single Queue",
33060     "examples": [
33061       {
33062         "title": "Example usage:",
33063         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33064         "type": "json"
33065       }
33066     ],
33067     "name": "ShowQueues",
33068     "group": "Voice_Queues",
33069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/blacks",
33077     "title": "Gets queue hopper blacks",
33078     "examples": [
33079       {
33080         "title": "Example usage:",
33081         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33082         "type": "json"
33083       }
33084     ],
33085     "name": "getHopperBlacks",
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": "put",
33094     "url": "/api/voice/queues/{id}",
33095     "title": "Update an existing Queue",
33096     "examples": [
33097       {
33098         "title": "Example usage:",
33099         "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",
33100         "type": "json"
33101       }
33102     ],
33103     "name": "updateQueues",
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": "post",
33112     "url": "/api/voice/recordings",
33113     "title": "Creates a new Recording",
33114     "examples": [
33115       {
33116         "title": "Example usage:",
33117         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33118         "type": "json"
33119       }
33120     ],
33121     "name": "CreateRecordings",
33122     "group": "Voice_Recordings",
33123     "parameter": {
33124       "fields": {
33125         "Body": [
33126           {
33127             "group": "Body",
33128             "type": "Virtual",
33129             "optional": true,
33130             "field": "format",
33131             "description": ""
33132           },
33133           {
33134             "group": "Body",
33135             "type": "String",
33136             "optional": true,
33137             "field": "uniqueid",
33138             "description": ""
33139           },
33140           {
33141             "group": "Body",
33142             "type": "String",
33143             "optional": true,
33144             "field": "channel",
33145             "description": ""
33146           },
33147           {
33148             "group": "Body",
33149             "type": "String",
33150             "optional": true,
33151             "field": "membername",
33152             "description": ""
33153           },
33154           {
33155             "group": "Body",
33156             "type": "String",
33157             "optional": true,
33158             "field": "calleridnum",
33159             "description": ""
33160           },
33161           {
33162             "group": "Body",
33163             "type": "String",
33164             "optional": true,
33165             "field": "calleridname",
33166             "description": ""
33167           },
33168           {
33169             "group": "Body",
33170             "type": "String",
33171             "optional": true,
33172             "field": "connectedlinenum",
33173             "description": ""
33174           },
33175           {
33176             "group": "Body",
33177             "type": "String",
33178             "optional": true,
33179             "field": "connectedlinename",
33180             "description": ""
33181           },
33182           {
33183             "group": "Body",
33184             "type": "String",
33185             "optional": true,
33186             "field": "accountcode",
33187             "description": ""
33188           },
33189           {
33190             "group": "Body",
33191             "type": "String",
33192             "optional": true,
33193             "field": "context",
33194             "description": ""
33195           },
33196           {
33197             "group": "Body",
33198             "type": "String",
33199             "optional": true,
33200             "field": "exten",
33201             "description": ""
33202           },
33203           {
33204             "group": "Body",
33205             "type": "String",
33206             "optional": true,
33207             "field": "value",
33208             "description": ""
33209           },
33210           {
33211             "group": "Body",
33212             "type": "String",
33213             "optional": true,
33214             "field": "type",
33215             "description": ""
33216           },
33217           {
33218             "group": "Body",
33219             "type": "Integer",
33220             "optional": true,
33221             "field": "rating",
33222             "description": ""
33223           },
33224           {
33225             "group": "Body",
33226             "type": "String",
33227             "optional": true,
33228             "field": "queue",
33229             "description": ""
33230           },
33231           {
33232             "group": "Body",
33233             "type": "String",
33234             "optional": true,
33235             "field": "userDisposition",
33236             "description": ""
33237           },
33238           {
33239             "group": "Body",
33240             "type": "String",
33241             "optional": true,
33242             "field": "userSecondDisposition",
33243             "description": ""
33244           },
33245           {
33246             "group": "Body",
33247             "type": "String",
33248             "optional": true,
33249             "field": "userThirdDisposition",
33250             "description": ""
33251           },
33252           {
33253             "group": "Body",
33254             "type": "Text",
33255             "optional": true,
33256             "field": "location",
33257             "description": ""
33258           },
33259           {
33260             "group": "Body",
33261             "type": "String",
33262             "optional": true,
33263             "field": "transcribeName",
33264             "description": ""
33265           },
33266           {
33267             "group": "Body",
33268             "type": "String",
33269             "optional": true,
33270             "field": "transcribeStatus",
33271             "description": ""
33272           },
33273           {
33274             "group": "Body",
33275             "type": "Text",
33276             "optional": true,
33277             "field": "fileUri",
33278             "description": ""
33279           },
33280           {
33281             "group": "Body",
33282             "type": "Text",
33283             "optional": true,
33284             "field": "fileText",
33285             "description": ""
33286           },
33287           {
33288             "group": "Body",
33289             "type": "Text",
33290             "optional": true,
33291             "field": "failureReason",
33292             "description": ""
33293           },
33294           {
33295             "group": "Body",
33296             "type": "String",
33297             "optional": true,
33298             "field": "sentiment",
33299             "description": ""
33300           },
33301           {
33302             "group": "Body",
33303             "type": "Float",
33304             "optional": true,
33305             "field": "sPositive",
33306             "description": ""
33307           },
33308           {
33309             "group": "Body",
33310             "type": "Float",
33311             "optional": true,
33312             "field": "sNegative",
33313             "description": ""
33314           },
33315           {
33316             "group": "Body",
33317             "type": "Float",
33318             "optional": true,
33319             "field": "sNeutral",
33320             "description": ""
33321           },
33322           {
33323             "group": "Body",
33324             "type": "Float",
33325             "optional": true,
33326             "field": "sMixed",
33327             "description": ""
33328           },
33329           {
33330             "group": "Body",
33331             "type": "Boolean",
33332             "optional": true,
33333             "field": "tempSentiment",
33334             "description": ""
33335           },
33336           {
33337             "group": "Body",
33338             "type": "String",
33339             "optional": true,
33340             "field": "createdAt",
33341             "description": ""
33342           },
33343           {
33344             "group": "Body",
33345             "type": "String",
33346             "optional": true,
33347             "field": "updatedAt",
33348             "description": ""
33349           }
33350         ]
33351       }
33352     },
33353     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33354     "version": "0.0.0",
33355     "filename": "server/api/voiceRecording/index.js",
33356     "groupTitle": "Voice_Recordings"
33357   },
33358   {
33359     "type": "get",
33360     "url": "/api/voice/recordings/describe",
33361     "title": "Gets table info about Recordings",
33362     "examples": [
33363       {
33364         "title": "Example usage:",
33365         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33366         "type": "json"
33367       }
33368     ],
33369     "name": "DescribeRecordings",
33370     "group": "Voice_Recordings",
33371     "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>",
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",
33379     "title": "Gets a list of Recordings",
33380     "examples": [
33381       {
33382         "title": "Example usage:",
33383         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33384         "type": "json"
33385       }
33386     ],
33387     "name": "GetRecordings",
33388     "group": "Voice_Recordings",
33389     "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>",
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/{id}",
33397     "title": "Gets a single Recording",
33398     "examples": [
33399       {
33400         "title": "Example usage:",
33401         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33402         "type": "json"
33403       }
33404     ],
33405     "name": "ShowRecordings",
33406     "group": "Voice_Recordings",
33407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33408     "version": "0.0.0",
33409     "filename": "server/api/voiceRecording/index.js",
33410     "groupTitle": "Voice_Recordings"
33411   },
33412   {
33413     "type": "delete",
33414     "url": "/api/voice/recordings/{id}",
33415     "title": "Delete voice recording",
33416     "examples": [
33417       {
33418         "title": "Example usage:",
33419         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33420         "type": "json"
33421       }
33422     ],
33423     "name": "destroy",
33424     "group": "Voice_Recordings",
33425     "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>",
33426     "version": "0.0.0",
33427     "filename": "server/api/voiceRecording/index.js",
33428     "groupTitle": "Voice_Recordings"
33429   },
33430   {
33431     "type": "get",
33432     "url": "/api/voice/recordings/{id}/download",
33433     "title": "Download Recording",
33434     "examples": [
33435       {
33436         "title": "Example usage:",
33437         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33438         "type": "json"
33439       }
33440     ],
33441     "name": "download",
33442     "group": "Voice_Recordings",
33443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/downloads",
33451     "title": "Download Recording",
33452     "examples": [
33453       {
33454         "title": "Example usage:",
33455         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33456         "type": "json"
33457       }
33458     ],
33459     "name": "downloads",
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": "post",
33468     "url": "/api/voice/recordings/{id}/transcribe",
33469     "title": "Run Transcribe Recording",
33470     "examples": [
33471       {
33472         "title": "Example usage:",
33473         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33474         "type": "json"
33475       }
33476     ],
33477     "name": "transcribe",
33478     "group": "Voice_Recordings",
33479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
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 -v -u {name}:{password} -X GET",
33492         "type": "json"
33493       }
33494     ],
33495     "name": "transcribe",
33496     "group": "Voice_Recordings",
33497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
33504     "url": "/api/voice/recordings/{id}",
33505     "title": "Update an existing Recording",
33506     "examples": [
33507       {
33508         "title": "Example usage:",
33509         "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",
33510         "type": "json"
33511       }
33512     ],
33513     "name": "updateRecordings",
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": "post",
33522     "url": "/api/voice/transfers/reports",
33523     "title": "Creates a new Transfer Report",
33524     "examples": [
33525       {
33526         "title": "Example usage:",
33527         "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",
33528         "type": "json"
33529       }
33530     ],
33531     "name": "CreateTransfer_Reports",
33532     "group": "Voice_Transfer_Reports",
33533     "parameter": {
33534       "fields": {
33535         "Body": [
33536           {
33537             "group": "Body",
33538             "type": "String",
33539             "allowedValues": [
33540               "\"blind\"",
33541               "\"attended\""
33542             ],
33543             "optional": true,
33544             "field": "type",
33545             "description": ""
33546           },
33547           {
33548             "group": "Body",
33549             "type": "String",
33550             "optional": true,
33551             "field": "result",
33552             "description": ""
33553           },
33554           {
33555             "group": "Body",
33556             "type": "String",
33557             "optional": true,
33558             "field": "transfererchannel",
33559             "description": ""
33560           },
33561           {
33562             "group": "Body",
33563             "type": "String",
33564             "optional": true,
33565             "field": "transferercalleridnum",
33566             "description": ""
33567           },
33568           {
33569             "group": "Body",
33570             "type": "String",
33571             "optional": true,
33572             "field": "transferercalleridname",
33573             "description": ""
33574           },
33575           {
33576             "group": "Body",
33577             "type": "String",
33578             "optional": true,
33579             "field": "transfererconnectedlinenum",
33580             "description": ""
33581           },
33582           {
33583             "group": "Body",
33584             "type": "String",
33585             "optional": true,
33586             "field": "transfererconnectedlinename",
33587             "description": ""
33588           },
33589           {
33590             "group": "Body",
33591             "type": "String",
33592             "optional": true,
33593             "field": "transfereraccountcode",
33594             "description": ""
33595           },
33596           {
33597             "group": "Body",
33598             "type": "String",
33599             "optional": true,
33600             "field": "transferercontext",
33601             "description": ""
33602           },
33603           {
33604             "group": "Body",
33605             "type": "String",
33606             "optional": true,
33607             "field": "transfererexten",
33608             "description": ""
33609           },
33610           {
33611             "group": "Body",
33612             "type": "String",
33613             "optional": true,
33614             "field": "transfererlinkedid",
33615             "description": ""
33616           },
33617           {
33618             "group": "Body",
33619             "type": "String",
33620             "optional": true,
33621             "field": "transfereechannel",
33622             "description": ""
33623           },
33624           {
33625             "group": "Body",
33626             "type": "String",
33627             "optional": true,
33628             "field": "transfereecalleridnum",
33629             "description": ""
33630           },
33631           {
33632             "group": "Body",
33633             "type": "String",
33634             "optional": true,
33635             "field": "transfereecalleridname",
33636             "description": ""
33637           },
33638           {
33639             "group": "Body",
33640             "type": "String",
33641             "optional": true,
33642             "field": "transfereeconnectedlinenum",
33643             "description": ""
33644           },
33645           {
33646             "group": "Body",
33647             "type": "String",
33648             "optional": true,
33649             "field": "transfereeconnectedlinename",
33650             "description": ""
33651           },
33652           {
33653             "group": "Body",
33654             "type": "String",
33655             "optional": true,
33656             "field": "transfereeaccountcode",
33657             "description": ""
33658           },
33659           {
33660             "group": "Body",
33661             "type": "String",
33662             "optional": true,
33663             "field": "transfereecontext",
33664             "description": ""
33665           },
33666           {
33667             "group": "Body",
33668             "type": "String",
33669             "optional": true,
33670             "field": "transfereeexten",
33671             "description": ""
33672           },
33673           {
33674             "group": "Body",
33675             "type": "String",
33676             "optional": true,
33677             "field": "transfereelinkedid",
33678             "description": ""
33679           },
33680           {
33681             "group": "Body",
33682             "type": "String",
33683             "allowedValues": [
33684               "\"Yes\"",
33685               "\"No\""
33686             ],
33687             "optional": true,
33688             "field": "isexternal",
33689             "description": ""
33690           },
33691           {
33692             "group": "Body",
33693             "type": "String",
33694             "optional": true,
33695             "field": "context",
33696             "description": ""
33697           },
33698           {
33699             "group": "Body",
33700             "type": "String",
33701             "optional": true,
33702             "field": "extension",
33703             "description": ""
33704           }
33705         ]
33706       }
33707     },
33708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33709     "version": "0.0.0",
33710     "filename": "server/api/voiceTransferReport/index.js",
33711     "groupTitle": "Voice_Transfer_Reports"
33712   },
33713   {
33714     "type": "delete",
33715     "url": "/api/voice/transfers/reports/{id}",
33716     "title": "Deletes a Transfer Report",
33717     "examples": [
33718       {
33719         "title": "Example usage:",
33720         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33721         "type": "json"
33722       }
33723     ],
33724     "name": "DeleteTransfer_Reports",
33725     "group": "Voice_Transfer_Reports",
33726     "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>",
33727     "version": "0.0.0",
33728     "filename": "server/api/voiceTransferReport/index.js",
33729     "groupTitle": "Voice_Transfer_Reports"
33730   },
33731   {
33732     "type": "get",
33733     "url": "/api/voice/transfers/reports/describe",
33734     "title": "Gets table info about Transfer Reports",
33735     "examples": [
33736       {
33737         "title": "Example usage:",
33738         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33739         "type": "json"
33740       }
33741     ],
33742     "name": "DescribeTransfer_Reports",
33743     "group": "Voice_Transfer_Reports",
33744     "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>",
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",
33752     "title": "Gets a list of Transfer Reports",
33753     "examples": [
33754       {
33755         "title": "Example usage:",
33756         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33757         "type": "json"
33758       }
33759     ],
33760     "name": "GetTransfer_Reports",
33761     "group": "Voice_Transfer_Reports",
33762     "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>",
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/{id}",
33770     "title": "Gets a single Transfer Report",
33771     "examples": [
33772       {
33773         "title": "Example usage:",
33774         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33775         "type": "json"
33776       }
33777     ],
33778     "name": "ShowTransfer_Reports",
33779     "group": "Voice_Transfer_Reports",
33780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33781     "version": "0.0.0",
33782     "filename": "server/api/voiceTransferReport/index.js",
33783     "groupTitle": "Voice_Transfer_Reports"
33784   },
33785   {
33786     "type": "put",
33787     "url": "/api/voice/transfers/reports/{id}",
33788     "title": "Update an existing Transfer Report",
33789     "examples": [
33790       {
33791         "title": "Example usage:",
33792         "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",
33793         "type": "json"
33794       }
33795     ],
33796     "name": "updateTransfer_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": "post",
33805     "url": "/api/integrations/vtiger/accounts",
33806     "title": "Creates a new Vtiger Account",
33807     "examples": [
33808       {
33809         "title": "Example usage:",
33810         "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",
33811         "type": "json"
33812       }
33813     ],
33814     "name": "CreateVtiger_Accounts",
33815     "group": "Vtiger_Accounts",
33816     "parameter": {
33817       "fields": {
33818         "Body": [
33819           {
33820             "group": "Body",
33821             "type": "String",
33822             "optional": false,
33823             "field": "name",
33824             "description": ""
33825           },
33826           {
33827             "group": "Body",
33828             "type": "String",
33829             "optional": true,
33830             "field": "description",
33831             "description": ""
33832           },
33833           {
33834             "group": "Body",
33835             "type": "String",
33836             "optional": false,
33837             "field": "username",
33838             "description": ""
33839           },
33840           {
33841             "group": "Body",
33842             "type": "String",
33843             "optional": false,
33844             "field": "moduleName",
33845             "description": ""
33846           },
33847           {
33848             "group": "Body",
33849             "type": "String",
33850             "optional": false,
33851             "field": "remoteUri",
33852             "description": ""
33853           },
33854           {
33855             "group": "Body",
33856             "type": "String",
33857             "optional": false,
33858             "field": "serverUrl",
33859             "description": ""
33860           },
33861           {
33862             "group": "Body",
33863             "type": "String",
33864             "optional": false,
33865             "field": "accessKey",
33866             "description": ""
33867           }
33868         ]
33869       }
33870     },
33871     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33872     "version": "0.0.0",
33873     "filename": "server/api/intVtigerAccount/index.js",
33874     "groupTitle": "Vtiger_Accounts"
33875   },
33876   {
33877     "type": "delete",
33878     "url": "/api/integrations/vtiger/accounts/{id}",
33879     "title": "Deletes a Vtiger Account",
33880     "examples": [
33881       {
33882         "title": "Example usage:",
33883         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33884         "type": "json"
33885       }
33886     ],
33887     "name": "DeleteVtiger_Accounts",
33888     "group": "Vtiger_Accounts",
33889     "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>",
33890     "version": "0.0.0",
33891     "filename": "server/api/intVtigerAccount/index.js",
33892     "groupTitle": "Vtiger_Accounts"
33893   },
33894   {
33895     "type": "get",
33896     "url": "/api/integrations/vtiger/accounts",
33897     "title": "Gets a list of Vtiger Accounts",
33898     "examples": [
33899       {
33900         "title": "Example usage:",
33901         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33902         "type": "json"
33903       }
33904     ],
33905     "name": "GetVtiger_Accounts",
33906     "group": "Vtiger_Accounts",
33907     "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>",
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/{id}",
33915     "title": "Gets a single Vtiger Account",
33916     "examples": [
33917       {
33918         "title": "Example usage:",
33919         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33920         "type": "json"
33921       }
33922     ],
33923     "name": "ShowVtiger_Accounts",
33924     "group": "Vtiger_Accounts",
33925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33926     "version": "0.0.0",
33927     "filename": "server/api/intVtigerAccount/index.js",
33928     "groupTitle": "Vtiger_Accounts"
33929   },
33930   {
33931     "type": "post",
33932     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33933     "title": "Creates new configuration",
33934     "examples": [
33935       {
33936         "title": "Example usage:",
33937         "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",
33938         "type": "json"
33939       }
33940     ],
33941     "name": "addConfiguration",
33942     "group": "Vtiger_Accounts",
33943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
33950     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33951     "title": "Gets account configurations",
33952     "examples": [
33953       {
33954         "title": "Example usage:",
33955         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33956         "type": "json"
33957       }
33958     ],
33959     "name": "getConfigurations",
33960     "group": "Vtiger_Accounts",
33961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
33969     "title": "Gets account fields",
33970     "examples": [
33971       {
33972         "title": "Example usage:",
33973         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33974         "type": "json"
33975       }
33976     ],
33977     "name": "getFields",
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": "put",
33986     "url": "/api/integrations/vtiger/accounts/{id}",
33987     "title": "Update an existing Vtiger Account",
33988     "examples": [
33989       {
33990         "title": "Example usage:",
33991         "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",
33992         "type": "json"
33993       }
33994     ],
33995     "name": "updateVtiger_Accounts",
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": "post",
34004     "url": "/api/integrations/vtiger/configurations",
34005     "title": "Creates a new Vtiger Configuration",
34006     "examples": [
34007       {
34008         "title": "Example usage:",
34009         "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",
34010         "type": "json"
34011       }
34012     ],
34013     "name": "CreateVtiger_Configurations",
34014     "group": "Vtiger_Configurations",
34015     "parameter": {
34016       "fields": {
34017         "Body": [
34018           {
34019             "group": "Body",
34020             "type": "String",
34021             "optional": true,
34022             "field": "name",
34023             "description": ""
34024           },
34025           {
34026             "group": "Body",
34027             "type": "String",
34028             "optional": true,
34029             "field": "description",
34030             "description": ""
34031           }
34032         ]
34033       }
34034     },
34035     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34036     "version": "0.0.0",
34037     "filename": "server/api/intVtigerConfiguration/index.js",
34038     "groupTitle": "Vtiger_Configurations"
34039   },
34040   {
34041     "type": "delete",
34042     "url": "/api/integrations/vtiger/configurations/{id}",
34043     "title": "Deletes a Vtiger Configuration",
34044     "examples": [
34045       {
34046         "title": "Example usage:",
34047         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34048         "type": "json"
34049       }
34050     ],
34051     "name": "DeleteVtiger_Configurations",
34052     "group": "Vtiger_Configurations",
34053     "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>",
34054     "version": "0.0.0",
34055     "filename": "server/api/intVtigerConfiguration/index.js",
34056     "groupTitle": "Vtiger_Configurations"
34057   },
34058   {
34059     "type": "get",
34060     "url": "/api/integrations/vtiger/configurations",
34061     "title": "Gets a list of Vtiger Configurations",
34062     "examples": [
34063       {
34064         "title": "Example usage:",
34065         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34066         "type": "json"
34067       }
34068     ],
34069     "name": "GetVtiger_Configurations",
34070     "group": "Vtiger_Configurations",
34071     "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>",
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/{id}",
34079     "title": "Gets a single Vtiger Configuration",
34080     "examples": [
34081       {
34082         "title": "Example usage:",
34083         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34084         "type": "json"
34085       }
34086     ],
34087     "name": "ShowVtiger_Configurations",
34088     "group": "Vtiger_Configurations",
34089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
34097     "title": "Gets configurations descriptions",
34098     "examples": [
34099       {
34100         "title": "Example usage:",
34101         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34102         "type": "json"
34103       }
34104     ],
34105     "name": "getDescriptions",
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}/fields",
34115     "title": "Gets configurations fields",
34116     "examples": [
34117       {
34118         "title": "Example usage:",
34119         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34120         "type": "json"
34121       }
34122     ],
34123     "name": "getFields",
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}/subjects",
34133     "title": "Gets configurations subjects",
34134     "examples": [
34135       {
34136         "title": "Example usage:",
34137         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34138         "type": "json"
34139       }
34140     ],
34141     "name": "getSubjects",
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": "put",
34150     "url": "/api/integrations/vtiger/configurations/{id}",
34151     "title": "Update an existing Vtiger Configuration",
34152     "examples": [
34153       {
34154         "title": "Example usage:",
34155         "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",
34156         "type": "json"
34157       }
34158     ],
34159     "name": "updateVtiger_Configurations",
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": "post",
34168     "url": "/api/integrations/vtiger/fields",
34169     "title": "Creates a new Vtiger Field",
34170     "examples": [
34171       {
34172         "title": "Example usage:",
34173         "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",
34174         "type": "json"
34175       }
34176     ],
34177     "name": "CreateVtiger_Fields",
34178     "group": "Vtiger_Fields",
34179     "parameter": {
34180       "fields": {
34181         "Body": [
34182           {
34183             "group": "Body",
34184             "type": "String",
34185             "allowedValues": [
34186               "\"string\"",
34187               "\"variable\"",
34188               "\"customVariable\"",
34189               "\"keyValue\"",
34190               "\"picklist\""
34191             ],
34192             "optional": true,
34193             "field": "type",
34194             "description": ""
34195           },
34196           {
34197             "group": "Body",
34198             "type": "String",
34199             "optional": true,
34200             "field": "content",
34201             "description": ""
34202           },
34203           {
34204             "group": "Body",
34205             "type": "String",
34206             "optional": true,
34207             "field": "key",
34208             "description": ""
34209           },
34210           {
34211             "group": "Body",
34212             "type": "String",
34213             "allowedValues": [
34214               "\"string\"",
34215               "\"variable\"",
34216               "\"customVariable\""
34217             ],
34218             "optional": true,
34219             "field": "keyType",
34220             "description": ""
34221           },
34222           {
34223             "group": "Body",
34224             "type": "String",
34225             "optional": true,
34226             "field": "keyContent",
34227             "description": ""
34228           },
34229           {
34230             "group": "Body",
34231             "type": "String",
34232             "optional": true,
34233             "field": "idField",
34234             "description": ""
34235           },
34236           {
34237             "group": "Body",
34238             "type": "String",
34239             "optional": true,
34240             "field": "nameField",
34241             "description": ""
34242           },
34243           {
34244             "group": "Body",
34245             "type": "Boolean",
34246             "optional": true,
34247             "field": "customField",
34248             "description": ""
34249           },
34250           {
34251             "group": "Body",
34252             "type": "String",
34253             "optional": true,
34254             "field": "variableName",
34255             "description": ""
34256           }
34257         ]
34258       }
34259     },
34260     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34261     "version": "0.0.0",
34262     "filename": "server/api/intVtigerField/index.js",
34263     "groupTitle": "Vtiger_Fields"
34264   },
34265   {
34266     "type": "delete",
34267     "url": "/api/integrations/vtiger/fields/{id}",
34268     "title": "Deletes a Vtiger Field",
34269     "examples": [
34270       {
34271         "title": "Example usage:",
34272         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34273         "type": "json"
34274       }
34275     ],
34276     "name": "DeleteVtiger_Fields",
34277     "group": "Vtiger_Fields",
34278     "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>",
34279     "version": "0.0.0",
34280     "filename": "server/api/intVtigerField/index.js",
34281     "groupTitle": "Vtiger_Fields"
34282   },
34283   {
34284     "type": "get",
34285     "url": "/api/integrations/vtiger/fields",
34286     "title": "Gets a list of Vtiger Fields",
34287     "examples": [
34288       {
34289         "title": "Example usage:",
34290         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34291         "type": "json"
34292       }
34293     ],
34294     "name": "GetVtiger_Fields",
34295     "group": "Vtiger_Fields",
34296     "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>",
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/{id}",
34304     "title": "Gets a single Vtiger Field",
34305     "examples": [
34306       {
34307         "title": "Example usage:",
34308         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34309         "type": "json"
34310       }
34311     ],
34312     "name": "ShowVtiger_Fields",
34313     "group": "Vtiger_Fields",
34314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34315     "version": "0.0.0",
34316     "filename": "server/api/intVtigerField/index.js",
34317     "groupTitle": "Vtiger_Fields"
34318   },
34319   {
34320     "type": "put",
34321     "url": "/api/integrations/vtiger/fields/{id}",
34322     "title": "Update an existing Vtiger Field",
34323     "examples": [
34324       {
34325         "title": "Example usage:",
34326         "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",
34327         "type": "json"
34328       }
34329     ],
34330     "name": "updateVtiger_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": "post",
34339     "url": "/api/webbar/answer",
34340     "title": "answer webrtc call",
34341     "examples": [
34342       {
34343         "title": "Example usage:",
34344         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34345         "type": "json"
34346       }
34347     ],
34348     "name": "Web_Bar_answer",
34349     "group": "WebBar",
34350     "parameter": {
34351       "fields": {
34352         "Body": [
34353           {
34354             "group": "Body",
34355             "type": "String",
34356             "optional": false,
34357             "field": "sessionId",
34358             "description": ""
34359           },
34360           {
34361             "group": "Body",
34362             "type": "number",
34363             "optional": false,
34364             "field": "userId",
34365             "description": ""
34366           }
34367         ]
34368       }
34369     },
34370     "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>",
34371     "version": "0.0.0",
34372     "filename": "server/api/webbar/index.js",
34373     "groupTitle": "WebBar"
34374   },
34375   {
34376     "type": "post",
34377     "url": "/api/webbar/calls",
34378     "title": "webrtc call list",
34379     "examples": [
34380       {
34381         "title": "Example usage:",
34382         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34383         "type": "json"
34384       }
34385     ],
34386     "name": "Web_Bar_calls",
34387     "group": "WebBar",
34388     "parameter": {
34389       "fields": {
34390         "Body": [
34391           {
34392             "group": "Body",
34393             "type": "number",
34394             "optional": false,
34395             "field": "userId",
34396             "description": ""
34397           }
34398         ]
34399       }
34400     },
34401     "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>",
34402     "version": "0.0.0",
34403     "filename": "server/api/webbar/index.js",
34404     "groupTitle": "WebBar"
34405   },
34406   {
34407     "type": "post",
34408     "url": "/api/webbar/hangup",
34409     "title": "hangup webrtc call",
34410     "examples": [
34411       {
34412         "title": "Example usage:",
34413         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34414         "type": "json"
34415       }
34416     ],
34417     "name": "Web_Bar_hangup",
34418     "group": "WebBar",
34419     "parameter": {
34420       "fields": {
34421         "Body": [
34422           {
34423             "group": "Body",
34424             "type": "String",
34425             "optional": false,
34426             "field": "sessionId",
34427             "description": ""
34428           },
34429           {
34430             "group": "Body",
34431             "type": "number",
34432             "optional": false,
34433             "field": "userId",
34434             "description": ""
34435           }
34436         ]
34437       }
34438     },
34439     "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>",
34440     "version": "0.0.0",
34441     "filename": "server/api/webbar/index.js",
34442     "groupTitle": "WebBar"
34443   },
34444   {
34445     "type": "post",
34446     "url": "/api/webbar/unhold",
34447     "title": "unhold webrtc call",
34448     "examples": [
34449       {
34450         "title": "Example usage:",
34451         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34452         "type": "json"
34453       }
34454     ],
34455     "name": "Web_Bar_hold",
34456     "group": "WebBar",
34457     "parameter": {
34458       "fields": {
34459         "Body": [
34460           {
34461             "group": "Body",
34462             "type": "String",
34463             "optional": false,
34464             "field": "sessionId",
34465             "description": ""
34466           },
34467           {
34468             "group": "Body",
34469             "type": "number",
34470             "optional": false,
34471             "field": "userId",
34472             "description": ""
34473           }
34474         ]
34475       }
34476     },
34477     "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>",
34478     "version": "0.0.0",
34479     "filename": "server/api/webbar/index.js",
34480     "groupTitle": "WebBar"
34481   },
34482   {
34483     "type": "post",
34484     "url": "/api/webbar/hold",
34485     "title": "hold webrtc call",
34486     "examples": [
34487       {
34488         "title": "Example usage:",
34489         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34490         "type": "json"
34491       }
34492     ],
34493     "name": "Web_Bar_hold",
34494     "group": "WebBar",
34495     "parameter": {
34496       "fields": {
34497         "Body": [
34498           {
34499             "group": "Body",
34500             "type": "String",
34501             "optional": true,
34502             "field": "sessionId",
34503             "description": ""
34504           },
34505           {
34506             "group": "Body",
34507             "type": "number",
34508             "optional": false,
34509             "field": "userId",
34510             "description": ""
34511           }
34512         ]
34513       }
34514     },
34515     "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>",
34516     "version": "0.0.0",
34517     "filename": "server/api/webbar/index.js",
34518     "groupTitle": "WebBar"
34519   },
34520   {
34521     "type": "post",
34522     "url": "/api/webbar/originate",
34523     "title": "Originate new webrtc call",
34524     "examples": [
34525       {
34526         "title": "Example usage:",
34527         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34528         "type": "json"
34529       }
34530     ],
34531     "name": "Web_Bar_originate",
34532     "group": "WebBar",
34533     "parameter": {
34534       "fields": {
34535         "Body": [
34536           {
34537             "group": "Body",
34538             "type": "String",
34539             "optional": false,
34540             "field": "callNumber",
34541             "description": ""
34542           },
34543           {
34544             "group": "Body",
34545             "type": "number",
34546             "optional": false,
34547             "field": "userId",
34548             "description": ""
34549           },
34550           {
34551             "group": "Body",
34552             "type": "String",
34553             "optional": false,
34554             "field": "callerId",
34555             "description": ""
34556           },
34557           {
34558             "group": "Body",
34559             "type": "String",
34560             "optional": false,
34561             "field": "callbackUrl",
34562             "description": ""
34563           }
34564         ]
34565       }
34566     },
34567     "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>",
34568     "version": "0.0.0",
34569     "filename": "server/api/webbar/index.js",
34570     "groupTitle": "WebBar"
34571   },
34572   {
34573     "type": "post",
34574     "url": "/api/webbar/transfer",
34575     "title": "blind transfer webrtc call",
34576     "examples": [
34577       {
34578         "title": "Example usage:",
34579         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34580         "type": "json"
34581       }
34582     ],
34583     "name": "Web_Bar_transfer",
34584     "group": "WebBar",
34585     "parameter": {
34586       "fields": {
34587         "Body": [
34588           {
34589             "group": "Body",
34590             "type": "number",
34591             "optional": false,
34592             "field": "userId",
34593             "description": ""
34594           },
34595           {
34596             "group": "Body",
34597             "type": "string",
34598             "optional": false,
34599             "field": "sessionId",
34600             "description": ""
34601           },
34602           {
34603             "group": "Body",
34604             "type": "string",
34605             "optional": false,
34606             "field": "transferNumber",
34607             "description": ""
34608           }
34609         ]
34610       }
34611     },
34612     "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>",
34613     "version": "0.0.0",
34614     "filename": "server/api/webbar/index.js",
34615     "groupTitle": "WebBar"
34616   },
34617   {
34618     "type": "post",
34619     "url": "/api/whatsapp/accounts/{id}/users",
34620     "title": "Add agents to a whatsapp account",
34621     "examples": [
34622       {
34623         "title": "Example usage:",
34624         "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",
34625         "type": "json"
34626       }
34627     ],
34628     "name": "AddAgents",
34629     "group": "Whatsapp_Accounts",
34630     "description": "<p>Motion will return a HTTP status code <code>201</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/whatsappAccount/index.js",
34633     "groupTitle": "Whatsapp_Accounts"
34634   },
34635   {
34636     "type": "post",
34637     "url": "/api/whatsapp/accounts",
34638     "title": "Creates a new Account",
34639     "examples": [
34640       {
34641         "title": "Example usage:",
34642         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34643         "type": "json"
34644       }
34645     ],
34646     "name": "CreateAccounts",
34647     "group": "Whatsapp_Accounts",
34648     "parameter": {
34649       "fields": {
34650         "Body": [
34651           {
34652             "group": "Body",
34653             "type": "String",
34654             "optional": false,
34655             "field": "name",
34656             "description": ""
34657           },
34658           {
34659             "group": "Body",
34660             "type": "String",
34661             "optional": false,
34662             "field": "key",
34663             "description": ""
34664           },
34665           {
34666             "group": "Body",
34667             "type": "String",
34668             "optional": false,
34669             "field": "remote",
34670             "description": ""
34671           },
34672           {
34673             "group": "Body",
34674             "type": "String",
34675             "optional": true,
34676             "field": "token",
34677             "description": ""
34678           },
34679           {
34680             "group": "Body",
34681             "type": "String",
34682             "optional": true,
34683             "field": "phone",
34684             "description": ""
34685           },
34686           {
34687             "group": "Body",
34688             "type": "String",
34689             "allowedValues": [
34690               "\"twilio\""
34691             ],
34692             "optional": true,
34693             "field": "type",
34694             "description": ""
34695           },
34696           {
34697             "group": "Body",
34698             "type": "String",
34699             "optional": true,
34700             "field": "accountSid",
34701             "description": ""
34702           },
34703           {
34704             "group": "Body",
34705             "type": "String",
34706             "optional": true,
34707             "field": "authToken",
34708             "description": ""
34709           },
34710           {
34711             "group": "Body",
34712             "type": "Text",
34713             "optional": true,
34714             "field": "notificationTemplate",
34715             "description": ""
34716           },
34717           {
34718             "group": "Body",
34719             "type": "Boolean",
34720             "optional": true,
34721             "field": "notificationSound",
34722             "description": ""
34723           },
34724           {
34725             "group": "Body",
34726             "type": "Boolean",
34727             "optional": true,
34728             "field": "notificationShake",
34729             "description": ""
34730           },
34731           {
34732             "group": "Body",
34733             "type": "Integer",
34734             "optional": true,
34735             "field": "waitForTheAssignedAgent",
34736             "description": ""
34737           },
34738           {
34739             "group": "Body",
34740             "type": "Boolean",
34741             "optional": true,
34742             "field": "queueTransfer",
34743             "description": ""
34744           },
34745           {
34746             "group": "Body",
34747             "type": "Integer",
34748             "optional": true,
34749             "field": "queueTransferTimeout",
34750             "description": ""
34751           },
34752           {
34753             "group": "Body",
34754             "type": "Boolean",
34755             "optional": true,
34756             "field": "agentTransfer",
34757             "description": ""
34758           },
34759           {
34760             "group": "Body",
34761             "type": "Integer",
34762             "optional": true,
34763             "field": "agentTransferTimeout",
34764             "description": ""
34765           },
34766           {
34767             "group": "Body",
34768             "type": "Integer",
34769             "optional": true,
34770             "field": "mandatoryDispositionPauseId",
34771             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34772           },
34773           {
34774             "group": "Body",
34775             "type": "Boolean",
34776             "optional": true,
34777             "field": "mandatoryDisposition",
34778             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34779           },
34780           {
34781             "group": "Body",
34782             "type": "String",
34783             "optional": true,
34784             "field": "description",
34785             "description": ""
34786           }
34787         ]
34788       }
34789     },
34790     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34791     "version": "0.0.0",
34792     "filename": "server/api/whatsappAccount/index.js",
34793     "groupTitle": "Whatsapp_Accounts"
34794   },
34795   {
34796     "type": "delete",
34797     "url": "/api/whatsapp/accounts/{id}",
34798     "title": "Deletes a Account",
34799     "examples": [
34800       {
34801         "title": "Example usage:",
34802         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34803         "type": "json"
34804       }
34805     ],
34806     "name": "DeleteAccounts",
34807     "group": "Whatsapp_Accounts",
34808     "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>",
34809     "version": "0.0.0",
34810     "filename": "server/api/whatsappAccount/index.js",
34811     "groupTitle": "Whatsapp_Accounts"
34812   },
34813   {
34814     "type": "get",
34815     "url": "/api/whatsapp/accounts/describe",
34816     "title": "Gets table info about Accounts",
34817     "examples": [
34818       {
34819         "title": "Example usage:",
34820         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34821         "type": "json"
34822       }
34823     ],
34824     "name": "DescribeAccounts",
34825     "group": "Whatsapp_Accounts",
34826     "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>",
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",
34834     "title": "Gets a list of Accounts",
34835     "examples": [
34836       {
34837         "title": "Example usage:",
34838         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34839         "type": "json"
34840       }
34841     ],
34842     "name": "GetAccounts",
34843     "group": "Whatsapp_Accounts",
34844     "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>",
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/{id}/users",
34852     "title": "Gets agents from whatsapp account",
34853     "examples": [
34854       {
34855         "title": "Example usage:",
34856         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34857         "type": "json"
34858       }
34859     ],
34860     "name": "GetAgents",
34861     "group": "Whatsapp_Accounts",
34862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34863     "version": "0.0.0",
34864     "filename": "server/api/whatsappAccount/index.js",
34865     "groupTitle": "Whatsapp_Accounts"
34866   },
34867   {
34868     "type": "delete",
34869     "url": "/api/whatsapp/accounts/{id}/users",
34870     "title": "Removes agents from a whatsapp account",
34871     "examples": [
34872       {
34873         "title": "Example usage:",
34874         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34875         "type": "json"
34876       }
34877     ],
34878     "name": "RemoveAgents",
34879     "group": "Whatsapp_Accounts",
34880     "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>",
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}/canned_answers",
34888     "title": "Removes canned answers from account",
34889     "examples": [
34890       {
34891         "title": "Example usage:",
34892         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34893         "type": "json"
34894       }
34895     ],
34896     "name": "RemoveAnswers",
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}/dispositions",
34906     "title": "Removes dispositions from account",
34907     "examples": [
34908       {
34909         "title": "Example usage:",
34910         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34911         "type": "json"
34912       }
34913     ],
34914     "name": "RemoveDispositions",
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": "get",
34923     "url": "/api/whatsapp/accounts/{id}",
34924     "title": "Gets a single Account",
34925     "examples": [
34926       {
34927         "title": "Example usage:",
34928         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34929         "type": "json"
34930       }
34931     ],
34932     "name": "ShowAccounts",
34933     "group": "Whatsapp_Accounts",
34934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
34941     "url": "/api/whatsapp/messages/{id}/accept",
34942     "title": "Accepts message",
34943     "examples": [
34944       {
34945         "title": "Example usage:",
34946         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34947         "type": "json"
34948       }
34949     ],
34950     "name": "acceptMessage",
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/whatsappMessage/index.js",
34955     "groupTitle": "Whatsapp_Accounts"
34956   },
34957   {
34958     "type": "post",
34959     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34960     "title": "Creates new canned answer",
34961     "examples": [
34962       {
34963         "title": "Example usage:",
34964         "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",
34965         "type": "json"
34966       }
34967     ],
34968     "name": "addAnswer",
34969     "group": "Whatsapp_Accounts",
34970     "parameter": {
34971       "fields": {
34972         "Body": [
34973           {
34974             "group": "Body",
34975             "type": "String",
34976             "optional": false,
34977             "field": "key",
34978             "description": ""
34979           },
34980           {
34981             "group": "Body",
34982             "type": "Text",
34983             "optional": false,
34984             "field": "value",
34985             "description": ""
34986           },
34987           {
34988             "group": "Body",
34989             "type": "String",
34990             "optional": true,
34991             "field": "description",
34992             "description": ""
34993           },
34994           {
34995             "group": "Body",
34996             "type": "Virtual",
34997             "optional": true,
34998             "field": "name",
34999             "description": ""
35000           }
35001         ]
35002       }
35003     },
35004     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35005     "version": "0.0.0",
35006     "filename": "server/api/whatsappAccount/index.js",
35007     "groupTitle": "Whatsapp_Accounts"
35008   },
35009   {
35010     "type": "post",
35011     "url": "/api/whatsapp/accounts/{id}/applications",
35012     "title": "Creates new applications",
35013     "examples": [
35014       {
35015         "title": "Example usage:",
35016         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35017         "type": "json"
35018       }
35019     ],
35020     "name": "addApplications",
35021     "group": "Whatsapp_Accounts",
35022     "parameter": {
35023       "fields": {
35024         "Body": [
35025           {
35026             "group": "Body",
35027             "type": "Integer",
35028             "optional": false,
35029             "field": "priority",
35030             "description": ""
35031           },
35032           {
35033             "group": "Body",
35034             "type": "String",
35035             "optional": false,
35036             "field": "app",
35037             "description": ""
35038           },
35039           {
35040             "group": "Body",
35041             "type": "Text",
35042             "optional": true,
35043             "field": "appdata",
35044             "description": ""
35045           },
35046           {
35047             "group": "Body",
35048             "type": "String",
35049             "optional": true,
35050             "field": "description",
35051             "description": ""
35052           },
35053           {
35054             "group": "Body",
35055             "type": "String",
35056             "optional": true,
35057             "field": "interval",
35058             "description": ""
35059           }
35060         ]
35061       }
35062     },
35063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35064     "version": "0.0.0",
35065     "filename": "server/api/whatsappAccount/index.js",
35066     "groupTitle": "Whatsapp_Accounts"
35067   },
35068   {
35069     "type": "post",
35070     "url": "/api/whatsapp/accounts/{id}/dispositions",
35071     "title": "Creates new disposition",
35072     "examples": [
35073       {
35074         "title": "Example usage:",
35075         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35076         "type": "json"
35077       }
35078     ],
35079     "name": "addDisposition",
35080     "group": "Whatsapp_Accounts",
35081     "parameter": {
35082       "fields": {
35083         "Body": [
35084           {
35085             "group": "Body",
35086             "type": "String",
35087             "optional": false,
35088             "field": "name",
35089             "description": ""
35090           },
35091           {
35092             "group": "Body",
35093             "type": "String",
35094             "allowedValues": [
35095               "\"first\"",
35096               "\"second\"",
35097               "\"third\""
35098             ],
35099             "optional": false,
35100             "field": "level",
35101             "description": ""
35102           },
35103           {
35104             "group": "Body",
35105             "type": "String",
35106             "optional": true,
35107             "field": "description",
35108             "description": ""
35109           }
35110         ]
35111       }
35112     },
35113     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35114     "version": "0.0.0",
35115     "filename": "server/api/whatsappAccount/index.js",
35116     "groupTitle": "Whatsapp_Accounts"
35117   },
35118   {
35119     "type": "get",
35120     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35121     "title": "Gets account canned answers",
35122     "examples": [
35123       {
35124         "title": "Example usage:",
35125         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35126         "type": "json"
35127       }
35128     ],
35129     "name": "getAnswers",
35130     "group": "Whatsapp_Accounts",
35131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
35139     "title": "Gets account applications",
35140     "examples": [
35141       {
35142         "title": "Example usage:",
35143         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35144         "type": "json"
35145       }
35146     ],
35147     "name": "getApplications",
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}/dispositions",
35157     "title": "Gets account dispositions",
35158     "examples": [
35159       {
35160         "title": "Example usage:",
35161         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35162         "type": "json"
35163       }
35164     ],
35165     "name": "getDispositions",
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": "post",
35174     "url": "/api/whatsapp/accounts/{id}/notify",
35175     "title": "Notify new message",
35176     "examples": [
35177       {
35178         "title": "Example usage:",
35179         "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",
35180         "type": "json"
35181       }
35182     ],
35183     "name": "notify",
35184     "group": "Whatsapp_Accounts",
35185     "description": "<p>Motion 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>",
35186     "version": "0.0.0",
35187     "filename": "server/api/whatsappAccount/index.js",
35188     "groupTitle": "Whatsapp_Accounts"
35189   },
35190   {
35191     "type": "put",
35192     "url": "/api/whatsapp/messages/{id}/reject",
35193     "title": "Rejects message",
35194     "examples": [
35195       {
35196         "title": "Example usage:",
35197         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35198         "type": "json"
35199       }
35200     ],
35201     "name": "rejectMessage",
35202     "group": "Whatsapp_Accounts",
35203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35204     "version": "0.0.0",
35205     "filename": "server/api/whatsappMessage/index.js",
35206     "groupTitle": "Whatsapp_Accounts"
35207   },
35208   {
35209     "type": "post",
35210     "url": "/api/whatsapp/accounts/{id}/send",
35211     "title": "Send new whatsapp message",
35212     "examples": [
35213       {
35214         "title": "Example usage:",
35215         "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",
35216         "type": "json"
35217       }
35218     ],
35219     "name": "sendWhatsapp",
35220     "group": "Whatsapp_Accounts",
35221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35222     "version": "0.0.0",
35223     "filename": "server/api/whatsappAccount/index.js",
35224     "groupTitle": "Whatsapp_Accounts"
35225   },
35226   {
35227     "type": "post",
35228     "url": "/api/whatsapp/messages/{id}/status",
35229     "title": "Receive message status",
35230     "examples": [
35231       {
35232         "title": "Example usage:",
35233         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35234         "type": "json"
35235       }
35236     ],
35237     "name": "statusMessage",
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/whatsappMessage/index.js",
35242     "groupTitle": "Whatsapp_Accounts"
35243   },
35244   {
35245     "type": "put",
35246     "url": "/api/whatsapp/accounts/{id}",
35247     "title": "Update an existing Account",
35248     "examples": [
35249       {
35250         "title": "Example usage:",
35251         "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",
35252         "type": "json"
35253       }
35254     ],
35255     "name": "updateAccounts",
35256     "group": "Whatsapp_Accounts",
35257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35258     "version": "0.0.0",
35259     "filename": "server/api/whatsappAccount/index.js",
35260     "groupTitle": "Whatsapp_Accounts"
35261   },
35262   {
35263     "type": "post",
35264     "url": "/api/whatsapp/applications",
35265     "title": "Creates a new Application",
35266     "examples": [
35267       {
35268         "title": "Example usage:",
35269         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35270         "type": "json"
35271       }
35272     ],
35273     "name": "CreateApplications",
35274     "group": "Whatsapp_Applications",
35275     "parameter": {
35276       "fields": {
35277         "Body": [
35278           {
35279             "group": "Body",
35280             "type": "Integer",
35281             "optional": false,
35282             "field": "priority",
35283             "description": ""
35284           },
35285           {
35286             "group": "Body",
35287             "type": "String",
35288             "optional": false,
35289             "field": "app",
35290             "description": ""
35291           },
35292           {
35293             "group": "Body",
35294             "type": "Text",
35295             "optional": true,
35296             "field": "appdata",
35297             "description": ""
35298           },
35299           {
35300             "group": "Body",
35301             "type": "String",
35302             "optional": true,
35303             "field": "description",
35304             "description": ""
35305           },
35306           {
35307             "group": "Body",
35308             "type": "String",
35309             "optional": true,
35310             "field": "interval",
35311             "description": ""
35312           }
35313         ]
35314       }
35315     },
35316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35317     "version": "0.0.0",
35318     "filename": "server/api/whatsappApplication/index.js",
35319     "groupTitle": "Whatsapp_Applications"
35320   },
35321   {
35322     "type": "delete",
35323     "url": "/api/whatsapp/applications/{id}",
35324     "title": "Deletes a Application",
35325     "examples": [
35326       {
35327         "title": "Example usage:",
35328         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35329         "type": "json"
35330       }
35331     ],
35332     "name": "DeleteApplications",
35333     "group": "Whatsapp_Applications",
35334     "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>",
35335     "version": "0.0.0",
35336     "filename": "server/api/whatsappApplication/index.js",
35337     "groupTitle": "Whatsapp_Applications"
35338   },
35339   {
35340     "type": "get",
35341     "url": "/api/whatsapp/applications",
35342     "title": "Gets a list of Applications",
35343     "examples": [
35344       {
35345         "title": "Example usage:",
35346         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35347         "type": "json"
35348       }
35349     ],
35350     "name": "GetApplications",
35351     "group": "Whatsapp_Applications",
35352     "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>",
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/{id}",
35360     "title": "Gets a single Application",
35361     "examples": [
35362       {
35363         "title": "Example usage:",
35364         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35365         "type": "json"
35366       }
35367     ],
35368     "name": "ShowApplications",
35369     "group": "Whatsapp_Applications",
35370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35371     "version": "0.0.0",
35372     "filename": "server/api/whatsappApplication/index.js",
35373     "groupTitle": "Whatsapp_Applications"
35374   },
35375   {
35376     "type": "put",
35377     "url": "/api/whatsapp/applications/{id}",
35378     "title": "Update an existing Application",
35379     "examples": [
35380       {
35381         "title": "Example usage:",
35382         "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",
35383         "type": "json"
35384       }
35385     ],
35386     "name": "updateApplications",
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": "post",
35395     "url": "/api/whatsapp/interactions/{id}/tags",
35396     "title": "Add tags to the interaction",
35397     "examples": [
35398       {
35399         "title": "Example usage:",
35400         "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",
35401         "type": "json"
35402       }
35403     ],
35404     "name": "AddTags",
35405     "group": "Whatsapp_Interactions",
35406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35407     "version": "0.0.0",
35408     "filename": "server/api/whatsappInteraction/index.js",
35409     "groupTitle": "Whatsapp_Interactions"
35410   },
35411   {
35412     "type": "post",
35413     "url": "/api/whatsapp/interactions",
35414     "title": "Creates a new Interaction",
35415     "examples": [
35416       {
35417         "title": "Example usage:",
35418         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35419         "type": "json"
35420       }
35421     ],
35422     "name": "CreateInteractions",
35423     "group": "Whatsapp_Interactions",
35424     "parameter": {
35425       "fields": {
35426         "Body": [
35427           {
35428             "group": "Body",
35429             "type": "Boolean",
35430             "optional": true,
35431             "field": "closed",
35432             "description": ""
35433           },
35434           {
35435             "group": "Body",
35436             "type": "String",
35437             "optional": true,
35438             "field": "closedAt",
35439             "description": ""
35440           },
35441           {
35442             "group": "Body",
35443             "type": "String",
35444             "optional": true,
35445             "field": "disposition",
35446             "description": ""
35447           },
35448           {
35449             "group": "Body",
35450             "type": "String",
35451             "optional": true,
35452             "field": "secondDisposition",
35453             "description": ""
35454           },
35455           {
35456             "group": "Body",
35457             "type": "String",
35458             "optional": true,
35459             "field": "thirdDisposition",
35460             "description": ""
35461           },
35462           {
35463             "group": "Body",
35464             "type": "String",
35465             "optional": true,
35466             "field": "note",
35467             "description": ""
35468           },
35469           {
35470             "group": "Body",
35471             "type": "String",
35472             "optional": true,
35473             "field": "phone",
35474             "description": ""
35475           },
35476           {
35477             "group": "Body",
35478             "type": "String",
35479             "optional": true,
35480             "field": "read1stAt",
35481             "description": ""
35482           },
35483           {
35484             "group": "Body",
35485             "type": "String",
35486             "allowedValues": [
35487               "\"in\"",
35488               "\"out\""
35489             ],
35490             "optional": false,
35491             "field": "firstMsgDirection",
35492             "description": ""
35493           },
35494           {
35495             "group": "Body",
35496             "type": "String",
35497             "optional": true,
35498             "field": "lastMsgAt",
35499             "description": ""
35500           },
35501           {
35502             "group": "Body",
35503             "type": "String",
35504             "allowedValues": [
35505               "\"in\"",
35506               "\"out\""
35507             ],
35508             "optional": false,
35509             "field": "lastMsgDirection",
35510             "description": ""
35511           },
35512           {
35513             "group": "Body",
35514             "type": "Boolean",
35515             "optional": true,
35516             "field": "autoreplyExecuted",
35517             "description": ""
35518           }
35519         ]
35520       }
35521     },
35522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35523     "version": "0.0.0",
35524     "filename": "server/api/whatsappInteraction/index.js",
35525     "groupTitle": "Whatsapp_Interactions"
35526   },
35527   {
35528     "type": "delete",
35529     "url": "/api/whatsapp/interactions/{id}",
35530     "title": "Deletes a Interaction",
35531     "examples": [
35532       {
35533         "title": "Example usage:",
35534         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35535         "type": "json"
35536       }
35537     ],
35538     "name": "DeleteInteractions",
35539     "group": "Whatsapp_Interactions",
35540     "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>",
35541     "version": "0.0.0",
35542     "filename": "server/api/whatsappInteraction/index.js",
35543     "groupTitle": "Whatsapp_Interactions"
35544   },
35545   {
35546     "type": "get",
35547     "url": "/api/whatsapp/interactions/describe",
35548     "title": "Gets table info about Interactions",
35549     "examples": [
35550       {
35551         "title": "Example usage:",
35552         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35553         "type": "json"
35554       }
35555     ],
35556     "name": "DescribeInteractions",
35557     "group": "Whatsapp_Interactions",
35558     "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>",
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",
35566     "title": "Gets a list of Interactions",
35567     "examples": [
35568       {
35569         "title": "Example usage:",
35570         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35571         "type": "json"
35572       }
35573     ],
35574     "name": "GetInteractions",
35575     "group": "Whatsapp_Interactions",
35576     "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>",
35577     "version": "0.0.0",
35578     "filename": "server/api/whatsappInteraction/index.js",
35579     "groupTitle": "Whatsapp_Interactions"
35580   },
35581   {
35582     "type": "delete",
35583     "url": "/api/whatsapp/interactions/{id}/tags",
35584     "title": "Removes tags from interaction",
35585     "examples": [
35586       {
35587         "title": "Example usage:",
35588         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35589         "type": "json"
35590       }
35591     ],
35592     "name": "RemoveTags",
35593     "group": "Whatsapp_Interactions",
35594     "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>",
35595     "version": "0.0.0",
35596     "filename": "server/api/whatsappInteraction/index.js",
35597     "groupTitle": "Whatsapp_Interactions"
35598   },
35599   {
35600     "type": "get",
35601     "url": "/api/whatsapp/interactions/{id}",
35602     "title": "Gets a single Interaction",
35603     "examples": [
35604       {
35605         "title": "Example usage:",
35606         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35607         "type": "json"
35608       }
35609     ],
35610     "name": "ShowInteractions",
35611     "group": "Whatsapp_Interactions",
35612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
35619     "url": "/api/whatsapp/interactions/{id}/messages",
35620     "title": "Creates new messages",
35621     "examples": [
35622       {
35623         "title": "Example usage:",
35624         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35625         "type": "json"
35626       }
35627     ],
35628     "name": "addMessage",
35629     "group": "Whatsapp_Interactions",
35630     "parameter": {
35631       "fields": {
35632         "Body": [
35633           {
35634             "group": "Body",
35635             "type": "Text",
35636             "optional": false,
35637             "field": "body",
35638             "description": ""
35639           },
35640           {
35641             "group": "Body",
35642             "type": "Boolean",
35643             "optional": true,
35644             "field": "read",
35645             "description": ""
35646           },
35647           {
35648             "group": "Body",
35649             "type": "String",
35650             "allowedValues": [
35651               "\"in\"",
35652               "\"out\""
35653             ],
35654             "optional": false,
35655             "field": "direction",
35656             "description": ""
35657           },
35658           {
35659             "group": "Body",
35660             "type": "String",
35661             "optional": true,
35662             "field": "messageId",
35663             "description": ""
35664           },
35665           {
35666             "group": "Body",
35667             "type": "String",
35668             "optional": true,
35669             "field": "phone",
35670             "description": ""
35671           },
35672           {
35673             "group": "Body",
35674             "type": "String",
35675             "optional": true,
35676             "field": "readAt",
35677             "description": ""
35678           },
35679           {
35680             "group": "Body",
35681             "type": "Boolean",
35682             "optional": true,
35683             "field": "secret",
35684             "description": ""
35685           },
35686           {
35687             "group": "Body",
35688             "type": "String",
35689             "optional": true,
35690             "field": "providerName",
35691             "description": ""
35692           },
35693           {
35694             "group": "Body",
35695             "type": "Text",
35696             "optional": true,
35697             "field": "providerResponse",
35698             "description": ""
35699           }
35700         ]
35701       }
35702     },
35703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35704     "version": "0.0.0",
35705     "filename": "server/api/whatsappInteraction/index.js",
35706     "groupTitle": "Whatsapp_Interactions"
35707   },
35708   {
35709     "type": "get",
35710     "url": "/api/whatsapp/interactions/{id}/download",
35711     "title": "Gets interaction",
35712     "examples": [
35713       {
35714         "title": "Example usage:",
35715         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35716         "type": "json"
35717       }
35718     ],
35719     "name": "download",
35720     "group": "Whatsapp_Interactions",
35721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
35729     "title": "Gets interaction messages",
35730     "examples": [
35731       {
35732         "title": "Example usage:",
35733         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35734         "type": "json"
35735       }
35736     ],
35737     "name": "getMessages",
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": "put",
35746     "url": "/api/whatsapp/interactions/{id}",
35747     "title": "Update an existing Interaction",
35748     "examples": [
35749       {
35750         "title": "Example usage:",
35751         "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",
35752         "type": "json"
35753       }
35754     ],
35755     "name": "updateInteractions",
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": "post",
35764     "url": "/api/whatsapp/messages",
35765     "title": "Creates a new Message",
35766     "examples": [
35767       {
35768         "title": "Example usage:",
35769         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35770         "type": "json"
35771       }
35772     ],
35773     "name": "CreateMessages",
35774     "group": "Whatsapp_Messages",
35775     "parameter": {
35776       "fields": {
35777         "Body": [
35778           {
35779             "group": "Body",
35780             "type": "Text",
35781             "optional": false,
35782             "field": "body",
35783             "description": ""
35784           },
35785           {
35786             "group": "Body",
35787             "type": "Boolean",
35788             "optional": true,
35789             "field": "read",
35790             "description": ""
35791           },
35792           {
35793             "group": "Body",
35794             "type": "String",
35795             "allowedValues": [
35796               "\"in\"",
35797               "\"out\""
35798             ],
35799             "optional": false,
35800             "field": "direction",
35801             "description": ""
35802           },
35803           {
35804             "group": "Body",
35805             "type": "String",
35806             "optional": true,
35807             "field": "messageId",
35808             "description": ""
35809           },
35810           {
35811             "group": "Body",
35812             "type": "String",
35813             "optional": true,
35814             "field": "phone",
35815             "description": ""
35816           },
35817           {
35818             "group": "Body",
35819             "type": "String",
35820             "optional": true,
35821             "field": "readAt",
35822             "description": ""
35823           },
35824           {
35825             "group": "Body",
35826             "type": "Boolean",
35827             "optional": true,
35828             "field": "secret",
35829             "description": ""
35830           },
35831           {
35832             "group": "Body",
35833             "type": "String",
35834             "optional": true,
35835             "field": "providerName",
35836             "description": ""
35837           },
35838           {
35839             "group": "Body",
35840             "type": "Text",
35841             "optional": true,
35842             "field": "providerResponse",
35843             "description": ""
35844           }
35845         ]
35846       }
35847     },
35848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35849     "version": "0.0.0",
35850     "filename": "server/api/whatsappMessage/index.js",
35851     "groupTitle": "Whatsapp_Messages"
35852   },
35853   {
35854     "type": "delete",
35855     "url": "/api/whatsapp/messages/{id}",
35856     "title": "Deletes a Message",
35857     "examples": [
35858       {
35859         "title": "Example usage:",
35860         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35861         "type": "json"
35862       }
35863     ],
35864     "name": "DeleteMessages",
35865     "group": "Whatsapp_Messages",
35866     "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>",
35867     "version": "0.0.0",
35868     "filename": "server/api/whatsappMessage/index.js",
35869     "groupTitle": "Whatsapp_Messages"
35870   },
35871   {
35872     "type": "get",
35873     "url": "/api/whatsapp/messages/describe",
35874     "title": "Gets table info about Messages",
35875     "examples": [
35876       {
35877         "title": "Example usage:",
35878         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35879         "type": "json"
35880       }
35881     ],
35882     "name": "DescribeMessages",
35883     "group": "Whatsapp_Messages",
35884     "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>",
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",
35892     "title": "Gets a list of Messages",
35893     "examples": [
35894       {
35895         "title": "Example usage:",
35896         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35897         "type": "json"
35898       }
35899     ],
35900     "name": "GetMessages",
35901     "group": "Whatsapp_Messages",
35902     "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>",
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/{id}",
35910     "title": "Gets a single Message",
35911     "examples": [
35912       {
35913         "title": "Example usage:",
35914         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35915         "type": "json"
35916       }
35917     ],
35918     "name": "ShowMessages",
35919     "group": "Whatsapp_Messages",
35920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35921     "version": "0.0.0",
35922     "filename": "server/api/whatsappMessage/index.js",
35923     "groupTitle": "Whatsapp_Messages"
35924   },
35925   {
35926     "type": "put",
35927     "url": "/api/whatsapp/messages/{id}",
35928     "title": "Update an existing Message",
35929     "examples": [
35930       {
35931         "title": "Example usage:",
35932         "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",
35933         "type": "json"
35934       }
35935     ],
35936     "name": "updateMessages",
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": "post",
35945     "url": "/api/whatsapp/reports/queue",
35946     "title": "Creates a new Whatsapp Queue Report",
35947     "examples": [
35948       {
35949         "title": "Example usage:",
35950         "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",
35951         "type": "json"
35952       }
35953     ],
35954     "name": "CreateWhatsapp_Queue_Reports",
35955     "group": "Whatsapp_Queue_Reports",
35956     "parameter": {
35957       "fields": {
35958         "Body": [
35959           {
35960             "group": "Body",
35961             "type": "String",
35962             "optional": false,
35963             "field": "uniqueid",
35964             "description": ""
35965           },
35966           {
35967             "group": "Body",
35968             "type": "String",
35969             "optional": true,
35970             "field": "from",
35971             "description": ""
35972           },
35973           {
35974             "group": "Body",
35975             "type": "String",
35976             "optional": true,
35977             "field": "joinAt",
35978             "description": ""
35979           },
35980           {
35981             "group": "Body",
35982             "type": "String",
35983             "optional": true,
35984             "field": "leaveAt",
35985             "description": ""
35986           },
35987           {
35988             "group": "Body",
35989             "type": "String",
35990             "optional": true,
35991             "field": "acceptAt",
35992             "description": ""
35993           },
35994           {
35995             "group": "Body",
35996             "type": "String",
35997             "optional": true,
35998             "field": "exitAt",
35999             "description": ""
36000           },
36001           {
36002             "group": "Body",
36003             "type": "String",
36004             "optional": true,
36005             "field": "reason",
36006             "description": ""
36007           }
36008         ]
36009       }
36010     },
36011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36012     "version": "0.0.0",
36013     "filename": "server/api/whatsappQueueReport/index.js",
36014     "groupTitle": "Whatsapp_Queue_Reports"
36015   },
36016   {
36017     "type": "delete",
36018     "url": "/api/whatsapp/reports/queue/{id}",
36019     "title": "Deletes a Whatsapp Queue Report",
36020     "examples": [
36021       {
36022         "title": "Example usage:",
36023         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36024         "type": "json"
36025       }
36026     ],
36027     "name": "DeleteWhatsapp_Queue_Reports",
36028     "group": "Whatsapp_Queue_Reports",
36029     "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>",
36030     "version": "0.0.0",
36031     "filename": "server/api/whatsappQueueReport/index.js",
36032     "groupTitle": "Whatsapp_Queue_Reports"
36033   },
36034   {
36035     "type": "get",
36036     "url": "/api/whatsapp/reports/queue/describe",
36037     "title": "Gets table info about Whatsapp Queue Reports",
36038     "examples": [
36039       {
36040         "title": "Example usage:",
36041         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36042         "type": "json"
36043       }
36044     ],
36045     "name": "DescribeWhatsapp_Queue_Reports",
36046     "group": "Whatsapp_Queue_Reports",
36047     "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>",
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",
36055     "title": "Gets a list of Whatsapp Queue Reports",
36056     "examples": [
36057       {
36058         "title": "Example usage:",
36059         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36060         "type": "json"
36061       }
36062     ],
36063     "name": "GetWhatsapp_Queue_Reports",
36064     "group": "Whatsapp_Queue_Reports",
36065     "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>",
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/{id}",
36073     "title": "Gets a single Whatsapp Queue Report",
36074     "examples": [
36075       {
36076         "title": "Example usage:",
36077         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36078         "type": "json"
36079       }
36080     ],
36081     "name": "ShowWhatsapp_Queue_Reports",
36082     "group": "Whatsapp_Queue_Reports",
36083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36084     "version": "0.0.0",
36085     "filename": "server/api/whatsappQueueReport/index.js",
36086     "groupTitle": "Whatsapp_Queue_Reports"
36087   },
36088   {
36089     "type": "put",
36090     "url": "/api/whatsapp/reports/queue/{id}",
36091     "title": "Update an existing Whatsapp Queue Report",
36092     "examples": [
36093       {
36094         "title": "Example usage:",
36095         "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",
36096         "type": "json"
36097       }
36098     ],
36099     "name": "updateWhatsapp_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": "post",
36108     "url": "/api/whatsapp/queues/{id}/users",
36109     "title": "Add agents to a queue",
36110     "examples": [
36111       {
36112         "title": "Example usage:",
36113         "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",
36114         "type": "json"
36115       }
36116     ],
36117     "name": "AddAgents",
36118     "group": "Whatsapp_Queues",
36119     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36120     "version": "0.0.0",
36121     "filename": "server/api/whatsappQueue/index.js",
36122     "groupTitle": "Whatsapp_Queues"
36123   },
36124   {
36125     "type": "post",
36126     "url": "/api/whatsapp/queues/{id}/teams",
36127     "title": "Add teams to a queue",
36128     "examples": [
36129       {
36130         "title": "Example usage:",
36131         "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",
36132         "type": "json"
36133       }
36134     ],
36135     "name": "AddTeams",
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",
36145     "title": "Creates a new Queue",
36146     "examples": [
36147       {
36148         "title": "Example usage:",
36149         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36150         "type": "json"
36151       }
36152     ],
36153     "name": "CreateQueues",
36154     "group": "Whatsapp_Queues",
36155     "parameter": {
36156       "fields": {
36157         "Body": [
36158           {
36159             "group": "Body",
36160             "type": "String",
36161             "optional": true,
36162             "field": "name",
36163             "description": ""
36164           },
36165           {
36166             "group": "Body",
36167             "type": "Integer",
36168             "optional": true,
36169             "field": "timeout",
36170             "description": ""
36171           },
36172           {
36173             "group": "Body",
36174             "type": "String",
36175             "allowedValues": [
36176               "\"rrmemory\"",
36177               "\"beepall\"",
36178               "\"roundrobin\""
36179             ],
36180             "optional": true,
36181             "field": "strategy",
36182             "description": ""
36183           },
36184           {
36185             "group": "Body",
36186             "type": "String",
36187             "optional": true,
36188             "field": "description",
36189             "description": ""
36190           }
36191         ]
36192       }
36193     },
36194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36195     "version": "0.0.0",
36196     "filename": "server/api/whatsappQueue/index.js",
36197     "groupTitle": "Whatsapp_Queues"
36198   },
36199   {
36200     "type": "delete",
36201     "url": "/api/whatsapp/queues/{id}",
36202     "title": "Deletes a Queue",
36203     "examples": [
36204       {
36205         "title": "Example usage:",
36206         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36207         "type": "json"
36208       }
36209     ],
36210     "name": "DeleteQueues",
36211     "group": "Whatsapp_Queues",
36212     "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>",
36213     "version": "0.0.0",
36214     "filename": "server/api/whatsappQueue/index.js",
36215     "groupTitle": "Whatsapp_Queues"
36216   },
36217   {
36218     "type": "get",
36219     "url": "/api/whatsapp/queues/describe",
36220     "title": "Gets table info about Queues",
36221     "examples": [
36222       {
36223         "title": "Example usage:",
36224         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36225         "type": "json"
36226       }
36227     ],
36228     "name": "DescribeQueues",
36229     "group": "Whatsapp_Queues",
36230     "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>",
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/{id}/users",
36238     "title": "Gets queue agents",
36239     "examples": [
36240       {
36241         "title": "Example usage:",
36242         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36243         "type": "json"
36244       }
36245     ],
36246     "name": "GetAgents",
36247     "group": "Whatsapp_Queues",
36248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
36256     "title": "GetMembers",
36257     "examples": [
36258       {
36259         "title": "Example usage:",
36260         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36261         "type": "json"
36262       }
36263     ],
36264     "name": "GetMembers",
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",
36274     "title": "Gets a list of Queues",
36275     "examples": [
36276       {
36277         "title": "Example usage:",
36278         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36279         "type": "json"
36280       }
36281     ],
36282     "name": "GetQueues",
36283     "group": "Whatsapp_Queues",
36284     "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>",
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/{id}/teams",
36292     "title": "Gets queues list",
36293     "examples": [
36294       {
36295         "title": "Example usage:",
36296         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36297         "type": "json"
36298       }
36299     ],
36300     "name": "GetTeams",
36301     "group": "Whatsapp_Queues",
36302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36303     "version": "0.0.0",
36304     "filename": "server/api/whatsappQueue/index.js",
36305     "groupTitle": "Whatsapp_Queues"
36306   },
36307   {
36308     "type": "delete",
36309     "url": "/api/whatsapp/queues/{id}/users",
36310     "title": "Removes agents from a queue",
36311     "examples": [
36312       {
36313         "title": "Example usage:",
36314         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36315         "type": "json"
36316       }
36317     ],
36318     "name": "RemoveAgents",
36319     "group": "Whatsapp_Queues",
36320     "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>",
36321     "version": "0.0.0",
36322     "filename": "server/api/whatsappQueue/index.js",
36323     "groupTitle": "Whatsapp_Queues"
36324   },
36325   {
36326     "type": "get",
36327     "url": "/api/whatsapp/queues/{id}",
36328     "title": "Gets a single Queue",
36329     "examples": [
36330       {
36331         "title": "Example usage:",
36332         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36333         "type": "json"
36334       }
36335     ],
36336     "name": "ShowQueues",
36337     "group": "Whatsapp_Queues",
36338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
36345     "url": "/api/whatsapp/queues/{id}",
36346     "title": "Update an existing Queue",
36347     "examples": [
36348       {
36349         "title": "Example usage:",
36350         "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",
36351         "type": "json"
36352       }
36353     ],
36354     "name": "updateQueues",
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": "post",
36363     "url": "/api/whatsapp/reports/transfer",
36364     "title": "Creates a new Whatsapp Transfer Report",
36365     "examples": [
36366       {
36367         "title": "Example usage:",
36368         "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",
36369         "type": "json"
36370       }
36371     ],
36372     "name": "CreateWhatsapp_Transfer_Reports",
36373     "group": "Whatsapp_Transfer_Reports",
36374     "parameter": {
36375       "fields": {
36376         "Body": [
36377           {
36378             "group": "Body",
36379             "type": "String",
36380             "optional": false,
36381             "field": "uniqueid",
36382             "description": ""
36383           },
36384           {
36385             "group": "Body",
36386             "type": "String",
36387             "allowedValues": [
36388               "\"account\"",
36389               "\"agent\"",
36390               "\"queue\""
36391             ],
36392             "optional": false,
36393             "field": "type",
36394             "description": ""
36395           },
36396           {
36397             "group": "Body",
36398             "type": "String",
36399             "optional": true,
36400             "field": "transferredAt",
36401             "description": ""
36402           }
36403         ]
36404       }
36405     },
36406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36407     "version": "0.0.0",
36408     "filename": "server/api/whatsappTransferReport/index.js",
36409     "groupTitle": "Whatsapp_Transfer_Reports"
36410   },
36411   {
36412     "type": "delete",
36413     "url": "/api/whatsapp/reports/transfer/{id}",
36414     "title": "Deletes a Whatsapp Transfer Report",
36415     "examples": [
36416       {
36417         "title": "Example usage:",
36418         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36419         "type": "json"
36420       }
36421     ],
36422     "name": "DeleteWhatsapp_Transfer_Reports",
36423     "group": "Whatsapp_Transfer_Reports",
36424     "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>",
36425     "version": "0.0.0",
36426     "filename": "server/api/whatsappTransferReport/index.js",
36427     "groupTitle": "Whatsapp_Transfer_Reports"
36428   },
36429   {
36430     "type": "get",
36431     "url": "/api/whatsapp/reports/transfer/describe",
36432     "title": "Gets table info about Whatsapp Transfer Reports",
36433     "examples": [
36434       {
36435         "title": "Example usage:",
36436         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36437         "type": "json"
36438       }
36439     ],
36440     "name": "DescribeWhatsapp_Transfer_Reports",
36441     "group": "Whatsapp_Transfer_Reports",
36442     "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>",
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",
36450     "title": "Gets a list of Whatsapp Transfer Reports",
36451     "examples": [
36452       {
36453         "title": "Example usage:",
36454         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36455         "type": "json"
36456       }
36457     ],
36458     "name": "GetWhatsapp_Transfer_Reports",
36459     "group": "Whatsapp_Transfer_Reports",
36460     "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>",
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/{id}",
36468     "title": "Gets a single Whatsapp Transfer Report",
36469     "examples": [
36470       {
36471         "title": "Example usage:",
36472         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36473         "type": "json"
36474       }
36475     ],
36476     "name": "ShowWhatsapp_Transfer_Reports",
36477     "group": "Whatsapp_Transfer_Reports",
36478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36479     "version": "0.0.0",
36480     "filename": "server/api/whatsappTransferReport/index.js",
36481     "groupTitle": "Whatsapp_Transfer_Reports"
36482   },
36483   {
36484     "type": "put",
36485     "url": "/api/whatsapp/reports/transfer/{id}",
36486     "title": "Update an existing Whatsapp Transfer Report",
36487     "examples": [
36488       {
36489         "title": "Example usage:",
36490         "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",
36491         "type": "json"
36492       }
36493     ],
36494     "name": "updateWhatsapp_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": "post",
36503     "url": "/api/integrations/zendesk/accounts",
36504     "title": "Creates a new Zendesk Account",
36505     "examples": [
36506       {
36507         "title": "Example usage:",
36508         "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",
36509         "type": "json"
36510       }
36511     ],
36512     "name": "CreateZendesk_Accounts",
36513     "group": "Zendesk_Accounts",
36514     "parameter": {
36515       "fields": {
36516         "Body": [
36517           {
36518             "group": "Body",
36519             "type": "String",
36520             "optional": true,
36521             "field": "name",
36522             "description": ""
36523           },
36524           {
36525             "group": "Body",
36526             "type": "String",
36527             "optional": true,
36528             "field": "description",
36529             "description": ""
36530           },
36531           {
36532             "group": "Body",
36533             "type": "String",
36534             "optional": true,
36535             "field": "username",
36536             "description": ""
36537           },
36538           {
36539             "group": "Body",
36540             "type": "String",
36541             "optional": true,
36542             "field": "password",
36543             "description": ""
36544           },
36545           {
36546             "group": "Body",
36547             "type": "String",
36548             "optional": true,
36549             "field": "token",
36550             "description": ""
36551           },
36552           {
36553             "group": "Body",
36554             "type": "String",
36555             "optional": true,
36556             "field": "remoteUri",
36557             "description": ""
36558           },
36559           {
36560             "group": "Body",
36561             "type": "String",
36562             "allowedValues": [
36563               "\"password\"",
36564               "\"token\""
36565             ],
36566             "optional": true,
36567             "field": "authType",
36568             "description": ""
36569           },
36570           {
36571             "group": "Body",
36572             "type": "String",
36573             "optional": false,
36574             "field": "serverUrl",
36575             "description": ""
36576           },
36577           {
36578             "group": "Body",
36579             "type": "String",
36580             "allowedValues": [
36581               "\"integrationTab\"",
36582               "\"newTab\""
36583             ],
36584             "optional": true,
36585             "field": "type",
36586             "description": ""
36587           }
36588         ]
36589       }
36590     },
36591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36592     "version": "0.0.0",
36593     "filename": "server/api/intZendeskAccount/index.js",
36594     "groupTitle": "Zendesk_Accounts"
36595   },
36596   {
36597     "type": "delete",
36598     "url": "/api/integrations/zendesk/accounts/{id}",
36599     "title": "Deletes a Zendesk Account",
36600     "examples": [
36601       {
36602         "title": "Example usage:",
36603         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36604         "type": "json"
36605       }
36606     ],
36607     "name": "DeleteZendesk_Accounts",
36608     "group": "Zendesk_Accounts",
36609     "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>",
36610     "version": "0.0.0",
36611     "filename": "server/api/intZendeskAccount/index.js",
36612     "groupTitle": "Zendesk_Accounts"
36613   },
36614   {
36615     "type": "get",
36616     "url": "/api/integrations/zendesk/accounts",
36617     "title": "Gets a list of Zendesk Accounts",
36618     "examples": [
36619       {
36620         "title": "Example usage:",
36621         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36622         "type": "json"
36623       }
36624     ],
36625     "name": "GetZendesk_Accounts",
36626     "group": "Zendesk_Accounts",
36627     "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>",
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/{id}",
36635     "title": "Gets a single Zendesk Account",
36636     "examples": [
36637       {
36638         "title": "Example usage:",
36639         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36640         "type": "json"
36641       }
36642     ],
36643     "name": "ShowZendesk_Accounts",
36644     "group": "Zendesk_Accounts",
36645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36646     "version": "0.0.0",
36647     "filename": "server/api/intZendeskAccount/index.js",
36648     "groupTitle": "Zendesk_Accounts"
36649   },
36650   {
36651     "type": "post",
36652     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36653     "title": "Creates new configuration",
36654     "examples": [
36655       {
36656         "title": "Example usage:",
36657         "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",
36658         "type": "json"
36659       }
36660     ],
36661     "name": "addConfiguration",
36662     "group": "Zendesk_Accounts",
36663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
36670     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36671     "title": "Gets account configurations",
36672     "examples": [
36673       {
36674         "title": "Example usage:",
36675         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36676         "type": "json"
36677       }
36678     ],
36679     "name": "getConfigurations",
36680     "group": "Zendesk_Accounts",
36681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
36689     "title": "Gets account fields",
36690     "examples": [
36691       {
36692         "title": "Example usage:",
36693         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36694         "type": "json"
36695       }
36696     ],
36697     "name": "getFields",
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": "put",
36706     "url": "/api/integrations/zendesk/accounts/{id}",
36707     "title": "Update an existing Zendesk Account",
36708     "examples": [
36709       {
36710         "title": "Example usage:",
36711         "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",
36712         "type": "json"
36713       }
36714     ],
36715     "name": "updateZendesk_Accounts",
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": "post",
36724     "url": "/api/integrations/zendesk/configurations",
36725     "title": "Creates a new Zendesk Configuration",
36726     "examples": [
36727       {
36728         "title": "Example usage:",
36729         "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",
36730         "type": "json"
36731       }
36732     ],
36733     "name": "CreateZendesk_Configurations",
36734     "group": "Zendesk_Configurations",
36735     "parameter": {
36736       "fields": {
36737         "Body": [
36738           {
36739             "group": "Body",
36740             "type": "String",
36741             "optional": true,
36742             "field": "name",
36743             "description": ""
36744           },
36745           {
36746             "group": "Body",
36747             "type": "String",
36748             "optional": true,
36749             "field": "description",
36750             "description": ""
36751           }
36752         ]
36753       }
36754     },
36755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36756     "version": "0.0.0",
36757     "filename": "server/api/intZendeskConfiguration/index.js",
36758     "groupTitle": "Zendesk_Configurations"
36759   },
36760   {
36761     "type": "delete",
36762     "url": "/api/integrations/zendesk/configurations/{id}",
36763     "title": "Deletes a Zendesk Configuration",
36764     "examples": [
36765       {
36766         "title": "Example usage:",
36767         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36768         "type": "json"
36769       }
36770     ],
36771     "name": "DeleteZendesk_Configurations",
36772     "group": "Zendesk_Configurations",
36773     "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>",
36774     "version": "0.0.0",
36775     "filename": "server/api/intZendeskConfiguration/index.js",
36776     "groupTitle": "Zendesk_Configurations"
36777   },
36778   {
36779     "type": "get",
36780     "url": "/api/integrations/zendesk/configurations",
36781     "title": "Gets a list of Zendesk Configurations",
36782     "examples": [
36783       {
36784         "title": "Example usage:",
36785         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36786         "type": "json"
36787       }
36788     ],
36789     "name": "GetZendesk_Configurations",
36790     "group": "Zendesk_Configurations",
36791     "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>",
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/{id}",
36799     "title": "Gets a single Zendesk Configuration",
36800     "examples": [
36801       {
36802         "title": "Example usage:",
36803         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36804         "type": "json"
36805       }
36806     ],
36807     "name": "ShowZendesk_Configurations",
36808     "group": "Zendesk_Configurations",
36809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
36817     "title": "Gets configurations descriptions",
36818     "examples": [
36819       {
36820         "title": "Example usage:",
36821         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36822         "type": "json"
36823       }
36824     ],
36825     "name": "getDescriptions",
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}/fields",
36835     "title": "Gets configurations fields",
36836     "examples": [
36837       {
36838         "title": "Example usage:",
36839         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36840         "type": "json"
36841       }
36842     ],
36843     "name": "getFields",
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}/subjects",
36853     "title": "Gets configurations subjects",
36854     "examples": [
36855       {
36856         "title": "Example usage:",
36857         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36858         "type": "json"
36859       }
36860     ],
36861     "name": "getSubjects",
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}/tags",
36871     "title": "Gets configurations tags",
36872     "examples": [
36873       {
36874         "title": "Example usage:",
36875         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36876         "type": "json"
36877       }
36878     ],
36879     "name": "getTags",
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": "post",
36888     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36889     "title": "Sets new tags",
36890     "examples": [
36891       {
36892         "title": "Example usage:",
36893         "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",
36894         "type": "json"
36895       }
36896     ],
36897     "name": "setTags",
36898     "group": "Zendesk_Configurations",
36899     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
36906     "url": "/api/integrations/zendesk/configurations/{id}",
36907     "title": "Update an existing Zendesk Configuration",
36908     "examples": [
36909       {
36910         "title": "Example usage:",
36911         "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",
36912         "type": "json"
36913       }
36914     ],
36915     "name": "updateZendesk_Configurations",
36916     "group": "Zendesk_Configurations",
36917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
36924     "url": "/api/integrations/zendesk/fields",
36925     "title": "Creates a new Zendesk Field",
36926     "examples": [
36927       {
36928         "title": "Example usage:",
36929         "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",
36930         "type": "json"
36931       }
36932     ],
36933     "name": "CreateZendesk_Fields",
36934     "group": "Zendesk_Fields",
36935     "parameter": {
36936       "fields": {
36937         "Body": [
36938           {
36939             "group": "Body",
36940             "type": "String",
36941             "allowedValues": [
36942               "\"string\"",
36943               "\"variable\"",
36944               "\"customVariable\"",
36945               "\"keyValue\"",
36946               "\"picklist\""
36947             ],
36948             "optional": true,
36949             "field": "type",
36950             "description": ""
36951           },
36952           {
36953             "group": "Body",
36954             "type": "String",
36955             "optional": true,
36956             "field": "content",
36957             "description": ""
36958           },
36959           {
36960             "group": "Body",
36961             "type": "String",
36962             "optional": true,
36963             "field": "key",
36964             "description": ""
36965           },
36966           {
36967             "group": "Body",
36968             "type": "String",
36969             "allowedValues": [
36970               "\"string\"",
36971               "\"variable\"",
36972               "\"customVariable\""
36973             ],
36974             "optional": true,
36975             "field": "keyType",
36976             "description": ""
36977           },
36978           {
36979             "group": "Body",
36980             "type": "String",
36981             "optional": true,
36982             "field": "keyContent",
36983             "description": ""
36984           },
36985           {
36986             "group": "Body",
36987             "type": "String",
36988             "optional": true,
36989             "field": "idField",
36990             "description": ""
36991           },
36992           {
36993             "group": "Body",
36994             "type": "String",
36995             "optional": true,
36996             "field": "nameField",
36997             "description": ""
36998           },
36999           {
37000             "group": "Body",
37001             "type": "Boolean",
37002             "optional": true,
37003             "field": "customField",
37004             "description": ""
37005           },
37006           {
37007             "group": "Body",
37008             "type": "String",
37009             "optional": true,
37010             "field": "variableName",
37011             "description": ""
37012           }
37013         ]
37014       }
37015     },
37016     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37017     "version": "0.0.0",
37018     "filename": "server/api/intZendeskField/index.js",
37019     "groupTitle": "Zendesk_Fields"
37020   },
37021   {
37022     "type": "delete",
37023     "url": "/api/integrations/zendesk/fields/{id}",
37024     "title": "Deletes a Zendesk Field",
37025     "examples": [
37026       {
37027         "title": "Example usage:",
37028         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37029         "type": "json"
37030       }
37031     ],
37032     "name": "DeleteZendesk_Fields",
37033     "group": "Zendesk_Fields",
37034     "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>",
37035     "version": "0.0.0",
37036     "filename": "server/api/intZendeskField/index.js",
37037     "groupTitle": "Zendesk_Fields"
37038   },
37039   {
37040     "type": "get",
37041     "url": "/api/integrations/zendesk/fields",
37042     "title": "Gets a list of Zendesk Fields",
37043     "examples": [
37044       {
37045         "title": "Example usage:",
37046         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37047         "type": "json"
37048       }
37049     ],
37050     "name": "GetZendesk_Fields",
37051     "group": "Zendesk_Fields",
37052     "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>",
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/{id}",
37060     "title": "Gets a single Zendesk Field",
37061     "examples": [
37062       {
37063         "title": "Example usage:",
37064         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37065         "type": "json"
37066       }
37067     ],
37068     "name": "ShowZendesk_Fields",
37069     "group": "Zendesk_Fields",
37070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37071     "version": "0.0.0",
37072     "filename": "server/api/intZendeskField/index.js",
37073     "groupTitle": "Zendesk_Fields"
37074   },
37075   {
37076     "type": "put",
37077     "url": "/api/integrations/zendesk/fields/{id}",
37078     "title": "Update an existing Zendesk Field",
37079     "examples": [
37080       {
37081         "title": "Example usage:",
37082         "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",
37083         "type": "json"
37084       }
37085     ],
37086     "name": "updateZendesk_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": "post",
37095     "url": "/api/integrations/zoho/accounts",
37096     "title": "Creates a new Zoho Account",
37097     "examples": [
37098       {
37099         "title": "Example usage:",
37100         "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",
37101         "type": "json"
37102       }
37103     ],
37104     "name": "CreateZoho_Accounts",
37105     "group": "Zoho_Accounts",
37106     "parameter": {
37107       "fields": {
37108         "Body": [
37109           {
37110             "group": "Body",
37111             "type": "String",
37112             "optional": true,
37113             "field": "name",
37114             "description": ""
37115           },
37116           {
37117             "group": "Body",
37118             "type": "String",
37119             "optional": true,
37120             "field": "description",
37121             "description": ""
37122           },
37123           {
37124             "group": "Body",
37125             "type": "String",
37126             "optional": true,
37127             "field": "host",
37128             "description": ""
37129           },
37130           {
37131             "group": "Body",
37132             "type": "String",
37133             "optional": true,
37134             "field": "zone",
37135             "description": ""
37136           },
37137           {
37138             "group": "Body",
37139             "type": "String",
37140             "optional": true,
37141             "field": "clientId",
37142             "description": ""
37143           },
37144           {
37145             "group": "Body",
37146             "type": "String",
37147             "optional": true,
37148             "field": "clientSecret",
37149             "description": ""
37150           },
37151           {
37152             "group": "Body",
37153             "type": "String",
37154             "optional": false,
37155             "field": "serverUrl",
37156             "description": ""
37157           },
37158           {
37159             "group": "Body",
37160             "type": "String",
37161             "optional": true,
37162             "field": "code",
37163             "description": ""
37164           },
37165           {
37166             "group": "Body",
37167             "type": "String",
37168             "optional": true,
37169             "field": "refreshToken",
37170             "description": ""
37171           }
37172         ]
37173       }
37174     },
37175     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37176     "version": "0.0.0",
37177     "filename": "server/api/intZohoAccount/index.js",
37178     "groupTitle": "Zoho_Accounts"
37179   },
37180   {
37181     "type": "delete",
37182     "url": "/api/integrations/zoho/accounts/{id}",
37183     "title": "Deletes a Zoho Account",
37184     "examples": [
37185       {
37186         "title": "Example usage:",
37187         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37188         "type": "json"
37189       }
37190     ],
37191     "name": "DeleteZoho_Accounts",
37192     "group": "Zoho_Accounts",
37193     "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>",
37194     "version": "0.0.0",
37195     "filename": "server/api/intZohoAccount/index.js",
37196     "groupTitle": "Zoho_Accounts"
37197   },
37198   {
37199     "type": "get",
37200     "url": "/api/integrations/zoho/accounts",
37201     "title": "Gets a list of Zoho Accounts",
37202     "examples": [
37203       {
37204         "title": "Example usage:",
37205         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37206         "type": "json"
37207       }
37208     ],
37209     "name": "GetZoho_Accounts",
37210     "group": "Zoho_Accounts",
37211     "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>",
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/{id}",
37219     "title": "Gets a single Zoho Account",
37220     "examples": [
37221       {
37222         "title": "Example usage:",
37223         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37224         "type": "json"
37225       }
37226     ],
37227     "name": "ShowZoho_Accounts",
37228     "group": "Zoho_Accounts",
37229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37230     "version": "0.0.0",
37231     "filename": "server/api/intZohoAccount/index.js",
37232     "groupTitle": "Zoho_Accounts"
37233   },
37234   {
37235     "type": "post",
37236     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37237     "title": "Creates new configuration",
37238     "examples": [
37239       {
37240         "title": "Example usage:",
37241         "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",
37242         "type": "json"
37243       }
37244     ],
37245     "name": "addConfiguration",
37246     "group": "Zoho_Accounts",
37247     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
37254     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37255     "title": "Gets account configurations",
37256     "examples": [
37257       {
37258         "title": "Example usage:",
37259         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37260         "type": "json"
37261       }
37262     ],
37263     "name": "getConfigurations",
37264     "group": "Zoho_Accounts",
37265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
37273     "title": "Gets account fields",
37274     "examples": [
37275       {
37276         "title": "Example usage:",
37277         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37278         "type": "json"
37279       }
37280     ],
37281     "name": "getFields",
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": "put",
37290     "url": "/api/integrations/zoho/accounts/{id}",
37291     "title": "Update an existing Zoho Account",
37292     "examples": [
37293       {
37294         "title": "Example usage:",
37295         "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",
37296         "type": "json"
37297       }
37298     ],
37299     "name": "updateZoho_Accounts",
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": "post",
37308     "url": "/api/integrations/zoho/configurations",
37309     "title": "Creates a new Zoho Configuration",
37310     "examples": [
37311       {
37312         "title": "Example usage:",
37313         "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",
37314         "type": "json"
37315       }
37316     ],
37317     "name": "CreateZoho_Configurations",
37318     "group": "Zoho_Configurations",
37319     "parameter": {
37320       "fields": {
37321         "Body": [
37322           {
37323             "group": "Body",
37324             "type": "String",
37325             "optional": true,
37326             "field": "name",
37327             "description": ""
37328           },
37329           {
37330             "group": "Body",
37331             "type": "String",
37332             "allowedValues": [
37333               "\"lead\"",
37334               "\"contact\"",
37335               "\"nothing\""
37336             ],
37337             "optional": true,
37338             "field": "moduleCreate",
37339             "description": ""
37340           },
37341           {
37342             "group": "Body",
37343             "type": "String",
37344             "allowedValues": [
37345               "\"contact_lead\"",
37346               "\"contact\"",
37347               "\"lead\""
37348             ],
37349             "optional": true,
37350             "field": "moduleSearch",
37351             "description": ""
37352           },
37353           {
37354             "group": "Body",
37355             "type": "String",
37356             "optional": true,
37357             "field": "description",
37358             "description": ""
37359           }
37360         ]
37361       }
37362     },
37363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37364     "version": "0.0.0",
37365     "filename": "server/api/intZohoConfiguration/index.js",
37366     "groupTitle": "Zoho_Configurations"
37367   },
37368   {
37369     "type": "delete",
37370     "url": "/api/integrations/zoho/configurations/{id}",
37371     "title": "Deletes a Zoho Configuration",
37372     "examples": [
37373       {
37374         "title": "Example usage:",
37375         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37376         "type": "json"
37377       }
37378     ],
37379     "name": "DeleteZoho_Configurations",
37380     "group": "Zoho_Configurations",
37381     "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>",
37382     "version": "0.0.0",
37383     "filename": "server/api/intZohoConfiguration/index.js",
37384     "groupTitle": "Zoho_Configurations"
37385   },
37386   {
37387     "type": "get",
37388     "url": "/api/integrations/zoho/configurations",
37389     "title": "Gets a list of Zoho Configurations",
37390     "examples": [
37391       {
37392         "title": "Example usage:",
37393         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37394         "type": "json"
37395       }
37396     ],
37397     "name": "GetZoho_Configurations",
37398     "group": "Zoho_Configurations",
37399     "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>",
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/{id}",
37407     "title": "Gets a single Zoho Configuration",
37408     "examples": [
37409       {
37410         "title": "Example usage:",
37411         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37412         "type": "json"
37413       }
37414     ],
37415     "name": "ShowZoho_Configurations",
37416     "group": "Zoho_Configurations",
37417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
37425     "title": "Gets configurations descriptions",
37426     "examples": [
37427       {
37428         "title": "Example usage:",
37429         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37430         "type": "json"
37431       }
37432     ],
37433     "name": "getDescriptions",
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}/fields",
37443     "title": "Gets configurations fields",
37444     "examples": [
37445       {
37446         "title": "Example usage:",
37447         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37448         "type": "json"
37449       }
37450     ],
37451     "name": "getFields",
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}/subjects",
37461     "title": "Gets configurations subjects",
37462     "examples": [
37463       {
37464         "title": "Example usage:",
37465         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37466         "type": "json"
37467       }
37468     ],
37469     "name": "getSubjects",
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": "put",
37478     "url": "/api/integrations/zoho/configurations/{id}",
37479     "title": "Update an existing Zoho Configuration",
37480     "examples": [
37481       {
37482         "title": "Example usage:",
37483         "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",
37484         "type": "json"
37485       }
37486     ],
37487     "name": "updateZoho_Configurations",
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": "post",
37496     "url": "/api/integrations/zoho/fields",
37497     "title": "Creates a new Zoho Field",
37498     "examples": [
37499       {
37500         "title": "Example usage:",
37501         "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",
37502         "type": "json"
37503       }
37504     ],
37505     "name": "CreateZoho_Fields",
37506     "group": "Zoho_Fields",
37507     "parameter": {
37508       "fields": {
37509         "Body": [
37510           {
37511             "group": "Body",
37512             "type": "String",
37513             "allowedValues": [
37514               "\"string\"",
37515               "\"variable\"",
37516               "\"customVariable\"",
37517               "\"keyValue\"",
37518               "\"picklist\""
37519             ],
37520             "optional": true,
37521             "field": "type",
37522             "description": ""
37523           },
37524           {
37525             "group": "Body",
37526             "type": "String",
37527             "optional": true,
37528             "field": "content",
37529             "description": ""
37530           },
37531           {
37532             "group": "Body",
37533             "type": "String",
37534             "optional": true,
37535             "field": "key",
37536             "description": ""
37537           },
37538           {
37539             "group": "Body",
37540             "type": "String",
37541             "allowedValues": [
37542               "\"string\"",
37543               "\"variable\"",
37544               "\"customVariable\""
37545             ],
37546             "optional": true,
37547             "field": "keyType",
37548             "description": ""
37549           },
37550           {
37551             "group": "Body",
37552             "type": "String",
37553             "optional": true,
37554             "field": "keyContent",
37555             "description": ""
37556           },
37557           {
37558             "group": "Body",
37559             "type": "String",
37560             "optional": true,
37561             "field": "idField",
37562             "description": ""
37563           },
37564           {
37565             "group": "Body",
37566             "type": "String",
37567             "optional": true,
37568             "field": "nameField",
37569             "description": ""
37570           },
37571           {
37572             "group": "Body",
37573             "type": "Boolean",
37574             "optional": true,
37575             "field": "customField",
37576             "description": ""
37577           },
37578           {
37579             "group": "Body",
37580             "type": "String",
37581             "optional": true,
37582             "field": "variableName",
37583             "description": ""
37584           }
37585         ]
37586       }
37587     },
37588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37589     "version": "0.0.0",
37590     "filename": "server/api/intZohoField/index.js",
37591     "groupTitle": "Zoho_Fields"
37592   },
37593   {
37594     "type": "delete",
37595     "url": "/api/integrations/zoho/fields/{id}",
37596     "title": "Deletes a Zoho Field",
37597     "examples": [
37598       {
37599         "title": "Example usage:",
37600         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37601         "type": "json"
37602       }
37603     ],
37604     "name": "DeleteZoho_Fields",
37605     "group": "Zoho_Fields",
37606     "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>",
37607     "version": "0.0.0",
37608     "filename": "server/api/intZohoField/index.js",
37609     "groupTitle": "Zoho_Fields"
37610   },
37611   {
37612     "type": "get",
37613     "url": "/api/integrations/zoho/fields",
37614     "title": "Gets a list of Zoho Fields",
37615     "examples": [
37616       {
37617         "title": "Example usage:",
37618         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37619         "type": "json"
37620       }
37621     ],
37622     "name": "GetZoho_Fields",
37623     "group": "Zoho_Fields",
37624     "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>",
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/{id}",
37632     "title": "Gets a single Zoho Field",
37633     "examples": [
37634       {
37635         "title": "Example usage:",
37636         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37637         "type": "json"
37638       }
37639     ],
37640     "name": "ShowZoho_Fields",
37641     "group": "Zoho_Fields",
37642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37643     "version": "0.0.0",
37644     "filename": "server/api/intZohoField/index.js",
37645     "groupTitle": "Zoho_Fields"
37646   },
37647   {
37648     "type": "put",
37649     "url": "/api/integrations/zoho/fields/{id}",
37650     "title": "Update an existing Zoho Field",
37651     "examples": [
37652       {
37653         "title": "Example usage:",
37654         "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",
37655         "type": "json"
37656       }
37657     ],
37658     "name": "updateZoho_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": "post",
37667     "url": "/api/cdr",
37668     "title": "Creates a new Cdr",
37669     "examples": [
37670       {
37671         "title": "Example usage:",
37672         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37673         "type": "json"
37674       }
37675     ],
37676     "name": "CreateCdrs",
37677     "group": "cdr",
37678     "parameter": {
37679       "fields": {
37680         "Body": [
37681           {
37682             "group": "Body",
37683             "type": "String",
37684             "optional": false,
37685             "field": "calldate",
37686             "description": ""
37687           },
37688           {
37689             "group": "Body",
37690             "type": "String",
37691             "optional": true,
37692             "field": "clid",
37693             "description": ""
37694           },
37695           {
37696             "group": "Body",
37697             "type": "String",
37698             "optional": true,
37699             "field": "src",
37700             "description": ""
37701           },
37702           {
37703             "group": "Body",
37704             "type": "String",
37705             "optional": true,
37706             "field": "dst",
37707             "description": ""
37708           },
37709           {
37710             "group": "Body",
37711             "type": "String",
37712             "optional": true,
37713             "field": "dcontext",
37714             "description": ""
37715           },
37716           {
37717             "group": "Body",
37718             "type": "String",
37719             "optional": true,
37720             "field": "channel",
37721             "description": ""
37722           },
37723           {
37724             "group": "Body",
37725             "type": "String",
37726             "optional": true,
37727             "field": "dstchannel",
37728             "description": ""
37729           },
37730           {
37731             "group": "Body",
37732             "type": "String",
37733             "optional": true,
37734             "field": "lastapp",
37735             "description": ""
37736           },
37737           {
37738             "group": "Body",
37739             "type": "String",
37740             "optional": true,
37741             "field": "lastdata",
37742             "description": ""
37743           },
37744           {
37745             "group": "Body",
37746             "type": "Integer",
37747             "optional": false,
37748             "field": "duration",
37749             "description": ""
37750           },
37751           {
37752             "group": "Body",
37753             "type": "Integer",
37754             "optional": false,
37755             "field": "billsec",
37756             "description": ""
37757           },
37758           {
37759             "group": "Body",
37760             "type": "String",
37761             "optional": true,
37762             "field": "disposition",
37763             "description": ""
37764           },
37765           {
37766             "group": "Body",
37767             "type": "Integer",
37768             "optional": false,
37769             "field": "amaflags",
37770             "description": ""
37771           },
37772           {
37773             "group": "Body",
37774             "type": "String",
37775             "optional": true,
37776             "field": "accountcode",
37777             "description": ""
37778           },
37779           {
37780             "group": "Body",
37781             "type": "String",
37782             "optional": true,
37783             "field": "userfield",
37784             "description": ""
37785           },
37786           {
37787             "group": "Body",
37788             "type": "String",
37789             "optional": true,
37790             "field": "uniqueid",
37791             "description": ""
37792           },
37793           {
37794             "group": "Body",
37795             "type": "String",
37796             "optional": true,
37797             "field": "linkedid",
37798             "description": ""
37799           },
37800           {
37801             "group": "Body",
37802             "type": "String",
37803             "optional": true,
37804             "field": "sequence",
37805             "description": ""
37806           },
37807           {
37808             "group": "Body",
37809             "type": "String",
37810             "optional": true,
37811             "field": "peeraccount",
37812             "description": ""
37813           },
37814           {
37815             "group": "Body",
37816             "type": "String",
37817             "optional": true,
37818             "field": "type",
37819             "description": ""
37820           },
37821           {
37822             "group": "Body",
37823             "type": "String",
37824             "optional": true,
37825             "field": "tag",
37826             "description": ""
37827           }
37828         ]
37829       }
37830     },
37831     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37832     "version": "0.0.0",
37833     "filename": "server/api/cdr/index.js",
37834     "groupTitle": "cdr"
37835   },
37836   {
37837     "type": "delete",
37838     "url": "/api/cdr/{id}",
37839     "title": "Deletes a Cdr",
37840     "examples": [
37841       {
37842         "title": "Example usage:",
37843         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37844         "type": "json"
37845       }
37846     ],
37847     "name": "DeleteCdrs",
37848     "group": "cdr",
37849     "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>",
37850     "version": "0.0.0",
37851     "filename": "server/api/cdr/index.js",
37852     "groupTitle": "cdr"
37853   },
37854   {
37855     "type": "get",
37856     "url": "/api/cdr/describe",
37857     "title": "Gets table info about Cdrs",
37858     "examples": [
37859       {
37860         "title": "Example usage:",
37861         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37862         "type": "json"
37863       }
37864     ],
37865     "name": "DescribeCdrs",
37866     "group": "cdr",
37867     "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>",
37868     "version": "0.0.0",
37869     "filename": "server/api/cdr/index.js",
37870     "groupTitle": "cdr"
37871   },
37872   {
37873     "type": "get",
37874     "url": "/api/cdr",
37875     "title": "Gets a list of Cdrs",
37876     "examples": [
37877       {
37878         "title": "Example usage:",
37879         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37880         "type": "json"
37881       }
37882     ],
37883     "name": "GetCdrs",
37884     "group": "cdr",
37885     "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>",
37886     "version": "0.0.0",
37887     "filename": "server/api/cdr/index.js",
37888     "groupTitle": "cdr"
37889   },
37890   {
37891     "type": "get",
37892     "url": "/api/cdr/{id}",
37893     "title": "Gets a single Cdr",
37894     "examples": [
37895       {
37896         "title": "Example usage:",
37897         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37898         "type": "json"
37899       }
37900     ],
37901     "name": "ShowCdrs",
37902     "group": "cdr",
37903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37904     "version": "0.0.0",
37905     "filename": "server/api/cdr/index.js",
37906     "groupTitle": "cdr"
37907   },
37908   {
37909     "type": "put",
37910     "url": "/api/cdr/{id}",
37911     "title": "Update an existing Cdr",
37912     "examples": [
37913       {
37914         "title": "Example usage:",
37915         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37916         "type": "json"
37917       }
37918     ],
37919     "name": "updateCdrs",
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": "post",
37928     "url": "/api/voiceQueuesLog",
37929     "title": "Creates a new VoiceQueuesLog",
37930     "examples": [
37931       {
37932         "title": "Example usage:",
37933         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37934         "type": "json"
37935       }
37936     ],
37937     "name": "CreateVoiceQueuesLogs",
37938     "group": "voiceQueuesLog",
37939     "parameter": {
37940       "fields": {
37941         "Body": [
37942           {
37943             "group": "Body",
37944             "type": "String",
37945             "optional": true,
37946             "field": "time",
37947             "description": ""
37948           },
37949           {
37950             "group": "Body",
37951             "type": "String",
37952             "optional": false,
37953             "field": "callid",
37954             "description": ""
37955           },
37956           {
37957             "group": "Body",
37958             "type": "String",
37959             "optional": false,
37960             "field": "queuename",
37961             "description": ""
37962           },
37963           {
37964             "group": "Body",
37965             "type": "String",
37966             "optional": false,
37967             "field": "agent",
37968             "description": ""
37969           },
37970           {
37971             "group": "Body",
37972             "type": "String",
37973             "optional": false,
37974             "field": "event",
37975             "description": ""
37976           },
37977           {
37978             "group": "Body",
37979             "type": "String",
37980             "optional": false,
37981             "field": "data",
37982             "description": ""
37983           },
37984           {
37985             "group": "Body",
37986             "type": "String",
37987             "optional": false,
37988             "field": "data1",
37989             "description": ""
37990           },
37991           {
37992             "group": "Body",
37993             "type": "String",
37994             "optional": false,
37995             "field": "data2",
37996             "description": ""
37997           },
37998           {
37999             "group": "Body",
38000             "type": "String",
38001             "optional": false,
38002             "field": "data3",
38003             "description": ""
38004           },
38005           {
38006             "group": "Body",
38007             "type": "String",
38008             "optional": false,
38009             "field": "data4",
38010             "description": ""
38011           },
38012           {
38013             "group": "Body",
38014             "type": "String",
38015             "optional": false,
38016             "field": "data5",
38017             "description": ""
38018           },
38019           {
38020             "group": "Body",
38021             "type": "String",
38022             "optional": false,
38023             "field": "dtm",
38024             "description": ""
38025           }
38026         ]
38027       }
38028     },
38029     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38030     "version": "0.0.0",
38031     "filename": "server/api/voiceQueuesLog/index.js",
38032     "groupTitle": "voiceQueuesLog"
38033   },
38034   {
38035     "type": "delete",
38036     "url": "/api/voiceQueuesLog/{id}",
38037     "title": "Deletes a VoiceQueuesLog",
38038     "examples": [
38039       {
38040         "title": "Example usage:",
38041         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38042         "type": "json"
38043       }
38044     ],
38045     "name": "DeleteVoiceQueuesLogs",
38046     "group": "voiceQueuesLog",
38047     "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>",
38048     "version": "0.0.0",
38049     "filename": "server/api/voiceQueuesLog/index.js",
38050     "groupTitle": "voiceQueuesLog"
38051   },
38052   {
38053     "type": "get",
38054     "url": "/api/voiceQueuesLog",
38055     "title": "Gets a list of VoiceQueuesLogs",
38056     "examples": [
38057       {
38058         "title": "Example usage:",
38059         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38060         "type": "json"
38061       }
38062     ],
38063     "name": "GetVoiceQueuesLogs",
38064     "group": "voiceQueuesLog",
38065     "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>",
38066     "version": "0.0.0",
38067     "filename": "server/api/voiceQueuesLog/index.js",
38068     "groupTitle": "voiceQueuesLog"
38069   },
38070   {
38071     "type": "get",
38072     "url": "/api/voiceQueuesLog/{id}",
38073     "title": "Gets a single VoiceQueuesLog",
38074     "examples": [
38075       {
38076         "title": "Example usage:",
38077         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38078         "type": "json"
38079       }
38080     ],
38081     "name": "ShowVoiceQueuesLogs",
38082     "group": "voiceQueuesLog",
38083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38084     "version": "0.0.0",
38085     "filename": "server/api/voiceQueuesLog/index.js",
38086     "groupTitle": "voiceQueuesLog"
38087   },
38088   {
38089     "type": "put",
38090     "url": "/api/voiceQueuesLog/{id}",
38091     "title": "Update an existing VoiceQueuesLog",
38092     "examples": [
38093       {
38094         "title": "Example usage:",
38095         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38096         "type": "json"
38097       }
38098     ],
38099     "name": "updateVoiceQueuesLogs",
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 ]