-[\r {\r "type": "delete",\r "url": "/api/actions/{id}",\r "title": "Deletes a Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "put",\r "url": "/api/actions/{id}",\r "title": "Update an existing Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "post",\r "url": "/api/analytics/custom_reports",\r "title": "Creates a new Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Deletes a Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports",\r "title": "Gets a list of Analytic Custom Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Gets a single Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Update an existing Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/default_reports",\r "title": "Creates a new Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Deletes a Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports",\r "title": "Gets a list of Analytic Default Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Gets a single Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Update an existing Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/extracted_reports",\r "title": "Creates a new Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"csv\"",\r "\"pdf\"",\r "\"xls\""\r ],\r "optional": false,\r "field": "output",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "savename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "startDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "endDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"manual\"",\r "\"scheduled\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Deletes a Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports",\r "title": "Gets a list of Analytic Extacted Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Gets a single Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}/download",\r "title": "Download Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Update an existing Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/create_many",\r "title": "Creates many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "BulkCreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/destroy_many?ids={ids}",\r "title": "Deletes many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "BulkDeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports",\r "title": "Creates a new Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Deletes a Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports",\r "title": "Gets a list of Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Gets a single Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/{id}/create_many",\r "title": "Rewrite fields set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addFields",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Update an existing Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/metrics",\r "title": "Creates a new Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "metric",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "delete",\r "url": "/api/analytics/metrics/{id}",\r "title": "Deletes a Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics",\r "title": "Gets a list of Analytic Metric",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics/{id}",\r "title": "Gets a single Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "put",\r "url": "/api/analytics/metrics/{id}",\r "title": "Update an existing Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "post",\r "url": "/api/analytics/tree_reports",\r "title": "Creates a new Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "tree",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Deletes a Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports",\r "title": "Gets a list of Analytic Tree Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Gets a single Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Update an existing Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "post",\r "url": "/api/auth/google",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authGoogle/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/auth/local",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authLocal/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/automations",\r "title": "Creates a new Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAutomations",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "delete",\r "url": "/api/automations/{id}",\r "title": "Deletes a Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations",\r "title": "Gets a list of Automations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAutomations",\r "group": "Automations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}",\r "title": "Gets a single Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addActions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/conditions",\r "title": "Creates new conditions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConditions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/actions",\r "title": "Gets Automation Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/conditions",\r "title": "Gets Automation Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConditions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "put",\r "url": "/api/automations/{id}",\r "title": "Update an existing Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Add blacklists to a campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/lists",\r "title": "Add lists to a campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns",\r "title": "Creates a new Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCampaigns",\r "group": "Campaigns",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ivr\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "limitCalls",\r "description": "<p>Max 200 calls.</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}",\r "title": "Deletes a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Get campaign blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns",\r "title": "Gets a list of Campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/finals",\r "title": "Gets campaign hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hopper_histories",\r "title": "Gets campaign hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hoppers",\r "title": "Gets campaign hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/lists",\r "title": "Get campaign lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Remove blacklists from a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/lists",\r "title": "Remove lists from a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}",\r "title": "Gets a single Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacks",\r "title": "Gets campaign hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "put",\r "url": "/api/campaigns/{id}",\r "title": "Update an existing Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/canned_answers",\r "title": "Creates a new Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCanned_Answers",\r "group": "Canned_Answers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "delete",\r "url": "/api/canned_answers/{id}",\r "title": "Deletes a Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers",\r "title": "Gets a list of Canned Answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers/{id}",\r "title": "Gets a single Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "put",\r "url": "/api/canned_answers/{id}",\r "title": "Update an existing Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "delete",\r "url": "/api/chat/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "get",\r "url": "/api/chat/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "put",\r "url": "/api/chat/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "post",\r "url": "/api/chat/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Chat_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/chat/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/chat/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/chat/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/chat/enquiries/{id}",\r "title": "Deletes a Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "get",\r "url": "/api/chat/enquiries/{id}",\r "title": "Gets a single Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "put",\r "url": "/api/chat/enquiries/{id}",\r "title": "Update an existing Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"CLOSED\"",\r "\"ABANDON\"",\r "\"UNMANAGED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"good\"",\r "\"bad\""\r ],\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ChatVisitorId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/chat/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Chat_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Blob",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Chat_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Blob",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Chat_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "put",\r "url": "/api/chat/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Deletes a Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "get",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Gets a single Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "put",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Update an existing Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Chat_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "put",\r "url": "/api/chat/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/session/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Chat_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websitename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websiteaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "websiteid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitoremail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "abandon",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "post",\r "url": "/api/chat/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Chat_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websitename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websiteaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "websiteid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitoremail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/session/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "Chat_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/session/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/chat/session/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/chat/session/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/chat/session/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/chat/session/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/session/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/visitors/{id}",\r "title": "Deletes a Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "get",\r "url": "/api/chat/visitors/{id}",\r "title": "Gets a single Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "put",\r "url": "/api/chat/visitors/{id}",\r "title": "Update an existing Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "delete",\r "url": "/api/chat/website_fields/{id}",\r "title": "Deletes a Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "get",\r "url": "/api/chat/website_fields/{id}",\r "title": "Gets a single Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "put",\r "url": "/api/chat/website_fields/{id}",\r "title": "Update an existing Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "post",\r "url": "/api/chat/websites",\r "title": "Creates a new Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateWebsites",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color_focus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "animation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rounded\"",\r "\"squared\""\r ],\r "optional": true,\r "field": "header_shape",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_online",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "online_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "start_chat_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_offline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "offline_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_message_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "download_transcript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enquiry_forwarding",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_forwarding_address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enquiry_enable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "rating_enable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_send",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_skip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "show_service_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agents_busy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "message_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "logo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultLogo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "whiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultWhiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}",\r "title": "Deletes a Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites",\r "title": "Gets a list of Websites",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}",\r "title": "Gets a single Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"CLOSED\"",\r "\"ABANDON\"",\r "\"UNMANAGED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"good\"",\r "\"bad\""\r ],\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ChatVisitorId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Creates new Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addProactiveActions",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"mouseOver\"",\r "\"timeout\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "selector",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/fields",\r "title": "Creates new Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/fields -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addWebsiteFields",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "component",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "index",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "required",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "validation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "editable",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Gets Website Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Gets Website Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/interactions",\r "title": "Gets Website Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Gets Website Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getProactiveActions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/fields",\r "title": "Gets Website Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "getWebsiteFields",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "put",\r "url": "/api/chat/websites/{id}",\r "title": "Update an existing Website",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/cm/companies",\r "title": "Creates a new Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCompanies",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "companyId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailDomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sStreet",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sPostalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCountry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/companies/{id}",\r "title": "Deletes a Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies",\r "title": "Gets a list of Companies",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}",\r "title": "Gets a single Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "post",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "put",\r "url": "/api/cm/companies/{id}",\r "title": "Update an existing Company",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/contacts/{id}",\r "title": "Deletes a Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteContacts",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/describe",\r "title": "Gets table info about Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeContacts",\r "group": "Cm_Contacts",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts",\r "title": "Create Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts",\r "title": "Create Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "index",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}",\r "title": "Gets a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "show",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "put",\r "url": "/api/cm/contacts/{id}",\r "title": "Update a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"fullName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "delete",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Deletes a Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields",\r "title": "Gets a list of Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Gets a single Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "put",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Update an existing Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper",\r "title": "Creates a new Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateHopper",\r "group": "Cm_Hopper",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countbusyretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countcongestionretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnoanswerretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ContactId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ListId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "UserId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "VoiceQueueId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "CampaignId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/describe",\r "title": "Gets table info about Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper",\r "group": "Cm_Hopper",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper",\r "title": "Gets a list of Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/{id}",\r "title": "Gets a single Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Deletes a Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/describe",\r "title": "Gets table info about Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper_Black",\r "group": "Cm_Hopper_Black",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black",\r "title": "Gets a list of Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Gets a single Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Update an existing Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/describe",\r "title": "Gets table info about HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperFinal",\r "group": "Cm_Hopper_Final",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final",\r "title": "Gets a list of HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Gets a single HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Update a single hopper final",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/describe",\r "title": "Gets table info about HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperHistory",\r "group": "Cm_Hopper_History",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history",\r "title": "Gets a list of HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Gets a single HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Update a single hopper history",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/preview/{id}",\r "title": "Call Dialer Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/preview/{id} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "callDialerContact",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper/{id}",\r "title": "Delete Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/preview",\r "title": "Gets Dialer Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDialerContacts",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper/{id}",\r "title": "Update an existing Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "post",\r "url": "/api/cm/lists",\r "title": "Creates a new List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateLists",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}",\r "title": "Deletes a List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/users",\r "title": "Gets agents from list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists",\r "title": "Gets a list of Lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}/users",\r "title": "Removes agents from a list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}",\r "title": "Gets a single List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/users",\r "title": "Adds agents to a list",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Creates a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addCustomField",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/lists/{id}/dispositions",\r "title": "Creates a new sub disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/lists/{id}/disposition -d '{\"name\": \"SATISFIED\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Gets Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getCustomFields",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/dispositions",\r "title": "Gets Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts/csv",\r "title": "Gets CSV List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "grunt",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "put",\r "url": "/api/cm/lists/{id}",\r "title": "Update an existing List",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/conditions/{id}",\r "title": "Deletes a Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "put",\r "url": "/api/conditions/{id}",\r "title": "Update an existing Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "post",\r "url": "/api/cm/custom_field",\r "title": "Create a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCustomField",\r "group": "Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Custom_Fields"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/items/{id}",\r "title": "Deletes a Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "get",\r "url": "/api/dashboards/items/{id}",\r "title": "Gets a single Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "put",\r "url": "/api/dashboards/items/{id}",\r "title": "Update an existing Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "post",\r "url": "/api/dashboards",\r "title": "Creates a new Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDashboards",\r "group": "Dashboards",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/{id}",\r "title": "Deletes a Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards",\r "title": "Gets a list of Dashboards",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}",\r "title": "Gets a single Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "post",\r "url": "/api/dashboards/{id}/items",\r "title": "Creates new item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addItem",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}/run",\r "title": "Run dashboard widgets queries",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "put",\r "url": "/api/dashboards/{id}",\r "title": "Update an existing Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}/items",\r "title": "Gets items",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getItems",\r "group": "Dashboars",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboars"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ecm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "headerinfo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "minrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "maxrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "modem",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "gateway",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "faxdetect",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "t38timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SIP\"",\r "\"IAX\"",\r "\"DADHI\"",\r "\"KHOMP\""\r ],\r "optional": true,\r "field": "tech",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Gets account pplications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "put",\r "url": "/api/fax/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "get",\r "url": "/api/fax/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "put",\r "url": "/api/fax/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "post",\r "url": "/api/fax/attachments",\r "title": "Creates a new Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAttachments",\r "group": "Fax_Attachments",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "path",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "basename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "delete",\r "url": "/api/fax/attachments/{id}",\r "title": "Deletes a Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "get",\r "url": "/api/fax/attachments",\r "title": "Gets a list of Attachments",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/fax/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/fax/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/fax/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/fax/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "get",\r "url": "/api/fax/attachments/{id}",\r "title": "Gets a single Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "put",\r "url": "/api/fax/attachments/{id}",\r "title": "Update an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "post",\r "url": "/api/fax/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Fax_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/fax/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/fax/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/fax/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/fax/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Fax_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotestationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "pagestransferred",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resolution",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "error",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "put",\r "url": "/api/fax/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Fax_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotestationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "pagestransferred",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resolution",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "error",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "delete",\r "url": "/api/fax/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Fax_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "put",\r "url": "/api/fax/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Fax_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "put",\r "url": "/api/fax/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Fax_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "post",\r "url": "/api/fax/sessions/reports",\r "title": "Creates a new Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSession_Reports",\r "group": "Fax_Session_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Deletes a Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Fax_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/fax/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/fax/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/fax/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/fax/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Update an existing Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Creates a new Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "apiKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Deletes a Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Gets a list of Freshdesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Gets a single Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Update an existing Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Creates a new Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Deletes a Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Gets a list of Freshdesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Gets a single Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Update an existing Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Creates a new Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Deletes a Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Gets a list of Freshdesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Gets a single Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Update an existing Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/integrations/reports",\r "title": "Creates a new Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntegration_Reports",\r "group": "Integration_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "integration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "eventChannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "ticketId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "integrationId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contacts",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interface",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcalledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentconnectAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentcomplete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcompleteAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "talktime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentacw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentringnoanswer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentringnoanswerAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentdump",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentdumpAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastevent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "destchannelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destlanguage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "projectId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "delete",\r "url": "/api/integrations/reports/{id}",\r "title": "Deletes a Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/describe",\r "title": "Gets table info about Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeIntegration_Reports",\r "group": "Integration_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports",\r "title": "Gets a list of Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/{id}",\r "title": "Gets a single Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "put",\r "url": "/api/integrations/reports/{id}",\r "title": "Update an existing Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "post",\r "url": "/api/intervals",\r "title": "Creates a new Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntervals",\r "group": "Intervals",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "delete",\r "url": "/api/intervals/{id}",\r "title": "Deletes a Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals",\r "title": "Gets a list of Intervals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntervals",\r "group": "Intervals",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}",\r "title": "Gets a single Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Creates a new sub interval",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInterval",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals/create_many",\r "title": "Create new sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Get sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "put",\r "url": "/api/intervals/{id}",\r "title": "Update an existing Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/jira",\r "title": "Creates a new issue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Creates_Issue",\r "group": "Issue",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Bug\""\r ],\r "optional": true,\r "field": "issuetype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "summary",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jira/index.js",\r "groupTitle": "Issue"\r },\r {\r "type": "post",\r "url": "/api/jscripty/inputs/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyInputReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "input_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/inputs/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/inputs/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/inputs/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/inputs/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/inputs/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/inputs/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/questions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyQuestionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "question_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_other_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_other_answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "index",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/sessions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptySessionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"started\"",\r "\"completed\"",\r "\"incomplete\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "last_question_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Jscripty_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "draft",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "production",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "put",\r "url": "/api/jscripty/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/license",\r "title": "Gets License Info",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "index",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "put",\r "url": "/api/license/{id}",\r "title": "Update an existing License",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateLiense",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Creates a new IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddImap",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "ssl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "delete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"UNSEEN\""\r ],\r "optional": true,\r "field": "filter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"IMAP\"",\r "\"POP3\""\r ],\r "optional": true,\r "field": "protocol",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"CONNECTING\"",\r "\"CONNECTED\"",\r "\"DISCONNECTED\"",\r "\"ERROR\"",\r "\"UNKNOWN\""\r ],\r "optional": true,\r "field": "state",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "connTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "authTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "keepalive",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Creates a new SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddSmtp",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "state",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "whiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "signature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "service",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Gets account IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetImap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Gets account SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Removes IMAP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveImmap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Removes SMTP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"replyMail\"",\r "\"sendSms\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '[{\"name\": \"vip\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "deleted",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/send",\r "title": "Send new mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendMail",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "put",\r "url": "/api/mail/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/verify",\r "title": "Verify mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "verifySmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "get",\r "url": "/api/mail/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "put",\r "url": "/api/mail/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "post",\r "url": "/api/mail/attachments",\r "title": "Creates a new Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAttachments",\r "group": "Mail_Attachments",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "domain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "size",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "path",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "basename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "delete",\r "url": "/api/mail/attachments/{id}",\r "title": "Deletes a Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "get",\r "url": "/api/mail/attachments",\r "title": "Gets a list of Attachments",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/mail/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/mail/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/mail/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/mail/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "get",\r "url": "/api/mail/attachments/{id}",\r "title": "Gets a single Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "put",\r "url": "/api/mail/attachments/{id}",\r "title": "Update an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "post",\r "url": "/api/mail/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Mail_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/mail/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/mail/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/mail/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "deleted",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/mail/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Mail_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Creates new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fromId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userFullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "put",\r "url": "/api/mail/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Mail_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fromId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userFullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "delete",\r "url": "/api/mail/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Mail_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "put",\r "url": "/api/mail/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Mail_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "put",\r "url": "/api/mail/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Mail_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailReport/index.js",\r "groupTitle": "Mail_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Mail_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailReport/index.js",\r "groupTitle": "Mail_Reports"\r },\r {\r "type": "post",\r "url": "/api/mail/out_servers",\r "title": "Creates a new SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSMTPs",\r "group": "Mail_SMTP",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "state",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "delete",\r "url": "/api/mail/out_servers/{id}",\r "title": "Deletes a SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers",\r "title": "Gets a list of SMTPs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers/{id}",\r "title": "Gets a single SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "put",\r "url": "/api/mail/out_servers/{id}",\r "title": "Update an existing SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Mail_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Mail_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/mail/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/mail/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/mail/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/mail/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Mail_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/describe",\r "title": "Gets table info about Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMember_Reports",\r "group": "Member_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports",\r "title": "Gets a list of Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/{id}",\r "title": "Gets a single Member Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/networks",\r "title": "Create a new network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "delete",\r "url": "/api/voice/networks/{id}",\r "title": "Deletes a network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks",\r "title": "Gets a list of Networks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetNetworks",\r "group": "Networks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks/{id}",\r "title": "Gets a single Network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowNetworks",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "put",\r "url": "/api/voice/networks/{id}",\r "title": "Update an existing network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "replyUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "replyMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "put",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "get",\r "url": "/api/openchannel/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "put",\r "url": "/api/openchannel/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "post",\r "url": "/api/openchannel/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Openchannel_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Openchannel_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "put",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Openchannel_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Openchannel_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "put",\r "url": "/api/openchannel/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Openchannel_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "put",\r "url": "/api/openchannel/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/reports",\r "title": "Creates a new Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/reports/{id}",\r "title": "Deletes a Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports",\r "title": "Gets a list of Openchannel Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/{id}",\r "title": "Gets a single Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "put",\r "url": "/api/openchannel/reports/{id}",\r "title": "Update an existing Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Openchannel_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Openchannel_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/openchannel/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/openchannel/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/openchannel/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/openchannel/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Openchannel_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "post",\r "url": "/api/pauses",\r "title": "Creates a new Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreatePauses",\r "group": "Pauses",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "delete",\r "url": "/api/pauses/{id}",\r "title": "Deletes a Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeletePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses",\r "title": "Gets a list of Pauses",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPauses",\r "group": "Pauses",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses/{id}",\r "title": "Gets a single Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowPauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "put",\r "url": "/api/pauses/{id}",\r "title": "Update an existing Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updatePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pm2/{id}",\r "title": "Gets a single pm2 process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Process",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/pm2",\r "title": "Gets pm2 processes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Processes",\r "group": "Pm2",\r "description": "<p>Motion returns the pm2 processes list.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "put",\r "url": "/api/pm2/{id}",\r "title": "Update an existing Process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateProcesses",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/rpc/campaigns/",\r "title": "Gets a list of campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Campaigns",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/agents",\r "title": "Gets a list of RTAgents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTAgents",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound/channels",\r "title": "Gets a list of RTOutboundChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTOutboundChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/telephones",\r "title": "Gets a list of RTTelephones",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTelephones",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/trunks",\r "title": "Gets a list of RTTrunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTrunks",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}",\r "title": "Gets a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannel",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelHangup",\r "group": "RPC_Realtime",\r "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelRedirect",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues",\r "title": "Gets a list of RTVoiceQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound",\r "title": "Gets a list of RTOutbound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels",\r "title": "Gets a list of RTVoiceQueuesChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueuesChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Creates a new Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "securityToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Deletes a Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Gets a list of Salesforce Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Gets a single Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Update an existing Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Creates a new Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Deletes a Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Gets a list of Salesforce Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Gets a single Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Update an existing Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/fields",\r "title": "Creates a new Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Deletes a Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields",\r "title": "Gets a list of Salesforce Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Gets a single Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Update an existing Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "post",\r "url": "/api/schedules",\r "title": "Creates a new Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSchedules",\r "group": "Schedules",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportRange",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "sendMail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "validityStart",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "validityEnd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cronType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cron",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "reportId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportOutput",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultEntry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "delete",\r "url": "/api/schedules/{id}",\r "title": "Deletes a Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules",\r "title": "Gets a list of Schedules",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSchedules",\r "group": "Schedules",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules/{id}",\r "title": "Gets a single Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "put",\r "url": "/api/schedules/{id}",\r "title": "Update an existing Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/settings",\r "title": "Gets a list of Settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSettings",\r "group": "Settings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}",\r "title": "Gets a single Setting",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSettings",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "put",\r "url": "/api/settings/{id}",\r "title": "Update settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo",\r "title": "Add logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo_login",\r "title": "Add logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo",\r "title": "Get logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo_login",\r "title": "Get logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"twilio\"",\r "\"skebby\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"basic\"",\r "\"classic\"",\r "\"classic+\""\r ],\r "optional": true,\r "field": "smstype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "put",\r "url": "/api/sms/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "get",\r "url": "/api/sms/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "put",\r "url": "/api/sms/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "post",\r "url": "/api/sms/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Sms_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/sms/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/sms/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/sms/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/sms/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Sms_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "errorcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "skebby_message_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "put",\r "url": "/api/sms/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Sms_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "errorcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "skebby_message_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "delete",\r "url": "/api/sms/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Sms_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "put",\r "url": "/api/sms/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Sms_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "put",\r "url": "/api/sms/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Sms_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountnumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "post",\r "url": "/api/sms/session/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Sms_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/session/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "Sms_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/session/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/sms/session/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/sms/session/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/sms/session/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/sms/session/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/session/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sounds",\r "title": "Gets a list of Sounds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Sounds",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}",\r "title": "Gets a single Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSounds",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/sounds",\r "title": "Create a new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "delete",\r "url": "/api/sounds/{id}",\r "title": "Deletes a sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroySound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}/download",\r "title": "Download Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "put",\r "url": "/api/sounds",\r "title": "Update an existing new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/square/details/reports",\r "title": "Creates a new Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "node",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/details/reports/{id}",\r "title": "Deletes a Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/describe",\r "title": "Gets table info about Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports",\r "title": "Gets a list of Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/{id}",\r "title": "Gets a single Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/details/reports/{id}",\r "title": "Update an existing Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "post",\r "url": "/api/square/odbc",\r "title": "Creates a new ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateODBCs",\r "group": "Square_ODBC",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dsn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "delete",\r "url": "/api/square/odbc/{id}",\r "title": "Deletes a ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc",\r "title": "Gets a list of ODBCs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}",\r "title": "Gets a single ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}/test",\r "title": "Test Odbc",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "test",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "put",\r "url": "/api/square/odbc/{id}",\r "title": "Update an existing ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "post",\r "url": "/api/square/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Square_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "preproduction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "production",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "delete",\r "url": "/api/square/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "put",\r "url": "/api/square/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "post",\r "url": "/api/square/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Square_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "saveName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "savePath",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/square/recordings/{id}",\r "title": "Deletes a Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "put",\r "url": "/api/square/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "post",\r "url": "/api/square/reports",\r "title": "Creates a new Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Reports",\r "group": "Square_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network_script",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "request",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "version",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingani2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callington",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingtns",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rdnis",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enhanced",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "threadid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/reports/{id}",\r "title": "Deletes a Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/describe",\r "title": "Gets table info about Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Reports",\r "group": "Square_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports",\r "title": "Gets a list of Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/{id}",\r "title": "Gets a single Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/reports/{id}",\r "title": "Update an existing Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Creates a new SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Deletes a SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Gets a list of SugarCRM Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Gets a single SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Update an existing SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Creates a new Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Deletes a Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Gets a list of Sugarcrm Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Gets a single Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Update an existing Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Creates a new Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Deletes a Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Gets a list of Sugarcrm Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Gets a single Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Update an existing Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/system",\r "title": "Gets system information",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/system -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSystemInformation",\r "group": "System_Information",\r "description": "<p>Motion returns the system information.</p>",\r "version": "0.0.0",\r "filename": "server/api/system/index.js",\r "groupTitle": "System_Information"\r },\r {\r "type": "post",\r "url": "/api/tags",\r "title": "Creates a new Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTags",\r "group": "Tags",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "delete",\r "url": "/api/tags/{id}",\r "title": "Deletes a Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags",\r "title": "Gets a list of Tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTags",\r "group": "Tags",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags/{id}",\r "title": "Gets a single Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "put",\r "url": "/api/tags/{id}",\r "title": "Update an existing Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/queues",\r "title": "Add queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams",\r "title": "Creates a new Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTeams",\r "group": "Teams",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}",\r "title": "Deletes a Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/users",\r "title": "Gets agents from team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams",\r "title": "Gets a list of Teams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Teams",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/users",\r "title": "Removes agents from a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/queues",\r "title": "Remove queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}",\r "title": "Gets a single Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/users",\r "title": "Adds agents to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "put",\r "url": "/api/teams/{id}",\r "title": "Update an existing Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/templates",\r "title": "Creates a new Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTemplates",\r "group": "Templates",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "delete",\r "url": "/api/templates/{id}",\r "title": "Deletes a Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates",\r "title": "Gets a list of Templates",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTemplates",\r "group": "Templates",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates/{id}",\r "title": "Gets a single Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "put",\r "url": "/api/templates/{id}",\r "title": "Update an existing Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "post",\r "url": "/api/triggers",\r "title": "Creates a new Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTriggers",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "delete",\r "url": "/api/triggers/{id}",\r "title": "Deletes a Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers",\r "title": "Gets a list of Triggers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTriggers",\r "group": "Triggers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}",\r "title": "Gets a single Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAction",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Creates a new \"AND\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAllCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Creates a new \"OR\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnyCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/actions",\r "title": "Gets Trigger Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Gets \"AND\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAllConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Gets \"OR\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnyConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "put",\r "url": "/api/triggers/{id}",\r "title": "Update an existing Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/trunks",\r "title": "Create a new trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Trunks",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"friend\"",\r "\"user\"",\r "\"peer\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ALLOWED_NOT_SCREENED\"",\r "\"ALLOWED_PASSED_SCREEN\"",\r "\"ALLOWED_FAILED_SCREEN\"",\r "\"ALLOWED\"",\r "\"PROHIB_NOT_SCREENED\"",\r "\"PROHIB_PASSED_SCREEN\"",\r "\"PROHIB_FAILED_SCREEN\"",\r "\"PROHIB\""\r ],\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "permit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "md5secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotesecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transport",\r "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rfc2833\"",\r "\"info\"",\r "\"shortinfo\"",\r "\"inband\"",\r "\"auto\""\r ],\r "optional": true,\r "field": "dtmfmode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"outgoing\""\r ],\r "optional": true,\r "field": "directmedia",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "directrtpsetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediapermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediadeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nat",\r "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedcallgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedpickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tonezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disallow",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "allow",\r "description": "<p>String is deprecated. Please use an Array as ["alaw", "ulaw", "gsm"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autoframing",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "insecure",\r "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trustrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trust_id_outbound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"never\""\r ],\r "optional": true,\r "field": "progressinband",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "promiscredir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "useclientcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "setvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "callcounter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "busylevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowoverlap",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowsubscribe",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowtransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ignoresdpversion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subscribecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "template",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"always\""\r ],\r "optional": true,\r "field": "videosupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxcallbitrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "rfc2833compensate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"accept\"",\r "\"refuse\"",\r "\"originate\""\r ],\r "optional": true,\r "field": "session_timers",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_expires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_minse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"uac\"",\r "\"uas\""\r ],\r "optional": true,\r "field": "session_refresher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_usertpsource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromdomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "qualify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "keepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtptimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpholdtimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpkeepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "sendrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "outboundproxy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackextension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timert1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timerb",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "qualifyfreq",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactpermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactdeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactacl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unsolicited_mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "use_q850_reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxforwards",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "encryption",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "avpf",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "force_avp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "icesupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "dtlsenable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"fingerprint\"",\r "\"certificate\""\r ],\r "optional": true,\r "field": "dtlsverify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dtlsrekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscertfile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsprivatekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscipher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscafile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscapath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"active\"",\r "\"passive\"",\r "\"actpass\""\r ],\r "optional": true,\r "field": "dtlssetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsfingerprint",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "usereqphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordonfeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordofffeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "call_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "registertrying",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "subscribemwi",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vmexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohinterpret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohsuggest",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parkinglot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"update,nonat\""\r ],\r "optional": true,\r "field": "canreinvite",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "registry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "otherFields",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": false,\r "field": "active",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "delete",\r "url": "/api/trunks/{id}",\r "title": "Deletes a trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks",\r "title": "Gets a list of Trunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTrunks",\r "group": "Trunks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks/{id}",\r "title": "Gets a single Trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTrunks",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "put",\r "url": "/api/trunks/{id}",\r "title": "Update an existing trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/contacts",\r "title": "Add contacts to a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/queues",\r "title": "Add queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/create_many",\r "title": "Creates many Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "BulkCreateUsers",\r "group": "Users",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": "<p>The name of the user</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "fullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"admin\"",\r "\"user\"",\r "\"agent\"",\r "\"telephone\""\r ],\r "optional": false,\r "field": "role",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "provider",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "internal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "salt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "zipcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userpic",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "online",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastLoginAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voicePause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "chatPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mailPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "faxPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "smsPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "openchannelPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pauseType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastPauseAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "chatCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarAutoAnswer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarEnableSettings",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarListenPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarExpires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarRemoteControl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarRemoteControlPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarEnableRecording",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarRingInUse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "chanspy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "ipaddr",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "regseconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fullcontact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regserver",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "useragent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastms",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"friend\"",\r "\"user\"",\r "\"peer\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ALLOWED_NOT_SCREENED\"",\r "\"ALLOWED_PASSED_SCREEN\"",\r "\"ALLOWED_FAILED_SCREEN\"",\r "\"ALLOWED\"",\r "\"PROHIB_NOT_SCREENED\"",\r "\"PROHIB_PASSED_SCREEN\"",\r "\"PROHIB_FAILED_SCREEN\"",\r "\"PROHIB\""\r ],\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "permit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "md5secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotesecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transport",\r "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rfc2833\"",\r "\"info\"",\r "\"shortinfo\"",\r "\"inband\"",\r "\"auto\""\r ],\r "optional": true,\r "field": "dtmfmode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"outgoing\""\r ],\r "optional": true,\r "field": "directmedia",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "directrtpsetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediapermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediadeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nat",\r "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedcallgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedpickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tonezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "disallow",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "allow",\r "description": "<p>String is deprecated. Please use an Array as ["alaw", "ulaw", "gsm"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autoframing",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "insecure",\r "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trustrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trust_id_outbound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"never\""\r ],\r "optional": true,\r "field": "progressinband",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "promiscredir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "useclientcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "setvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "callcounter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "busylevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowoverlap",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowsubscribe",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowtransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ignoresdpversion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subscribecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "template",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"always\""\r ],\r "optional": true,\r "field": "videosupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxcallbitrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "rfc2833compensate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"accept\"",\r "\"refuse\"",\r "\"originate\""\r ],\r "optional": true,\r "field": "session_timers",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_expires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_minse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"uac\"",\r "\"uas\""\r ],\r "optional": true,\r "field": "session_refresher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_usertpsource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromdomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "qualify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "keepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtptimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpholdtimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpkeepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "sendrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "outboundproxy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackextension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timert1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timerb",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "qualifyfreq",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactpermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactdeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactacl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unsolicited_mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "use_q850_reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxforwards",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "encryption",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "avpf",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "force_avp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "icesupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "dtlsenable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"fingerprint\"",\r "\"certificate\""\r ],\r "optional": true,\r "field": "dtlsverify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dtlsrekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscertfile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsprivatekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscipher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscafile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscapath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"active\"",\r "\"passive\"",\r "\"actpass\""\r ],\r "optional": true,\r "field": "dtlssetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsfingerprint",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "usereqphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordonfeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordofffeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "call_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "registertrying",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "subscribemwi",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vmexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohinterpret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohsuggest",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parkinglot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"update,nonat\""\r ],\r "optional": true,\r "field": "canreinvite",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "loginInPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resetPasswordToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resetPasswordExpires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "showWebBar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "permissions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/destroy_many?ids={ids}",\r "title": "Deletes many Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "BulkDeleteUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}/password",\r "title": "Change user password",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "ChangePwd",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users",\r "title": "Create a new user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}",\r "title": "Deletes a User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/describe",\r "title": "Gets table info about Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUsers",\r "group": "Users",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/contacts",\r "title": "GetContacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/lists",\r "title": "GetLists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/recordings",\r "title": "GetRecordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/teams",\r "title": "GetTeams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users",\r "title": "Gets a list of Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUsers",\r "group": "Users",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues_rt",\r "title": "GetVoiceQueuesRt",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesRt",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/login",\r "title": "Login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Login",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/logout",\r "title": "Logout",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Logout",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/pause",\r "title": "Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Pause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/queues",\r "title": "Remove queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}",\r "title": "Gets a single User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/unpause",\r "title": "Unpause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Unpause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/avatar",\r "title": "Add avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/avatar",\r "title": "Get avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}",\r "title": "Update an existing User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/variables",\r "title": "Creates a new Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVariables",\r "group": "Variables",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "delete",\r "url": "/api/variables/{id}",\r "title": "Deletes a Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables",\r "title": "Gets a list of Variables",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVariables",\r "group": "Variables",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables/{id}",\r "title": "Gets a single Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "put",\r "url": "/api/variables/{id}",\r "title": "Update an existing Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/version/fetch",\r "title": "Fetch git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "FetchVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git fetch origin master</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version",\r "title": "Gets version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVersion",\r "group": "Version",\r "description": "<p>Motion returns the current and latest motion version.</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/pull",\r "title": "Pull git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "PullVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git pull</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/reset",\r "title": "Reset git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ResetVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/restart",\r "title": "Restart motion2 after update",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RestartVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: pm2 restart motion</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/describe",\r "title": "Gets table info about Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAgent_Reports",\r "group": "Voice_Agent_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports",\r "title": "Gets a list of Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/{id}",\r "title": "Gets a single Agent Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/describe",\r "title": "Gets table info about Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeCall_Reports",\r "group": "Voice_Call_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports",\r "title": "Gets a list of Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Gets a single Call Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Update a single cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/chanspy",\r "title": "Creates a new ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateChanSpy",\r "group": "Voice_ChanSpy",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "prefix",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "record",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordingFormat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "delete",\r "url": "/api/voice/chanspy/{id}",\r "title": "Deletes a ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy",\r "title": "Gets a list of ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy/{id}",\r "title": "Gets a single ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "put",\r "url": "/api/voice/chanspy/{id}",\r "title": "Update an existing ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "post",\r "url": "/api/voice/contexts",\r "title": "Create a new context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Voice_Contexts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultEntry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "delete",\r "url": "/api/voice/contexts/{id}",\r "title": "Deletes a context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts",\r "title": "Gets a list of Contexts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts/{id}",\r "title": "Gets a single Context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "put",\r "url": "/api/voice/contexts/{id}",\r "title": "Update an existing context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/describe",\r "title": "Gets table info about Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeDial_Reports",\r "group": "Voice_Dial_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports",\r "title": "Gets a list of Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/{id}",\r "title": "Gets a single Dial Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Voice_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/voice/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/voice/dispositions",\r "title": "Gets a list of Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/voice/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/voice/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/voice/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/voice/dispositions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/voice/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/voice/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/voice/extensions/{id}",\r "title": "Deletes a Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions",\r "title": "Gets a list of Extensions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions/{id}",\r "title": "Gets a single Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create new applications",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create an extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "put",\r "url": "/api/voice/extensions/{id}",\r "title": "Update an extension",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs",\r "title": "Create a new a new MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Add sound to MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}",\r "title": "Deletes an MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DestroyMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs",\r "title": "Gets a list of Music On Holds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Gets sounds from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}/sounds/{id2}",\r "title": "Remove sound from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}",\r "title": "Gets a single Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "put",\r "url": "/api/voice/mohs/{id}",\r "title": "Update an existing Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mails",\r "title": "Creates a new Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMails",\r "group": "Voice_Mails",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customer_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pager",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tz",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "saycid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "review",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "envelope",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sayduration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "saydurationm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sendvoicemail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "delete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "nextaftercmd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcegreetings",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "hidefromdir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "stamp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailsubject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailbody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxsecs",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxmsg",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/{id}",\r "title": "Deletes a Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails",\r "title": "Gets a list of Mails",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}",\r "title": "Gets a single Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}/messages",\r "title": "Gets voice mail messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/{id}",\r "title": "Update an existing Mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "post",\r "url": "/api/voice/mails/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Voice_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "msgnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "macrocontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "origtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "recording",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "flag",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "msg_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "stamp",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "voice/mails/messages/{id}/download",\r "title": "Download Voice Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/describe",\r "title": "Gets table info about Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueue_Reports",\r "group": "Voice_Queue_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports",\r "title": "Gets a list of Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/{id}",\r "title": "Gets a single Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/users",\r "title": "Add agents to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Add blacklists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/black_lists",\r "title": "Add black lists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/black_lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Add lists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Add teams to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Voice_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"inbound\"",\r "\"outbound\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "musiconhold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ringall\"",\r "\"leastrecent\"",\r "\"fewestcalls\"",\r "\"random\"",\r "\"rrmemory\"",\r "\"linear\"",\r "\"wrandom\"",\r "\"rrordered\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "servicelevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "penaltymemberslimit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeoutpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "weight",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "wrapuptime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autofill",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"all\""\r ],\r "optional": true,\r "field": "autopause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "autopausedelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopausebusy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopauseunavail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxlen",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setinterfacevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueueentryvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueuevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "eventmemberstatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membermacro",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membergosub",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "min_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "periodic_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "random_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "relative_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"once\""\r ],\r "optional": true,\r "field": "announce_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce_position",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "announce_to_first_user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_position_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"0\"",\r "\"5\"",\r "\"10\"",\r "\"15\"",\r "\"20\"",\r "\"30\""\r ],\r "optional": true,\r "field": "announce_round_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_youarenext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thereare",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_callswaiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minute",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minutes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thankyou",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_reporthold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_less_than",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leavewhenempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "reportholdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ringinuse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberdelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "timeoutrestart",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultrule",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "acw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialActive",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"preview\"",\r "\"progressive\"",\r "\"power\"",\r "\"predictive\""\r ],\r "optional": true,\r "field": "dialMethod",\r "description": "<p>Dial Method.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitChannel",\r "description": "<p>Max 9999 channels, 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitQueue",\r "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPowerLevel",\r "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agentBusyFactor\"",\r "\"dropRate\""\r ],\r "optional": true,\r "field": "dialPredictiveOptimization",\r "description": "<p>Only for predictive method.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPredictiveOptimizationPercentage",\r "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialPredictiveInterval",\r "description": "<p>Intervall Predictive Minutes (min:5 max:30)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueOptions",\r "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialQueueTimeout",\r "description": "<p>Queue Timeout Seconds (min:1, max:99)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueProject",\r "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Get queue blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/finals",\r "title": "Gets queue hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hopper_histories",\r "title": "Gets queue hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hoppers",\r "title": "Gets queue hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Get queue lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/members",\r "title": "Gets queue members",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Gets queue team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/black_lists",\r "title": "Remove black lists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/black_lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Remove blacklists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Remove lists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacks",\r "title": "Gets queue hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "put",\r "url": "/api/voice/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Voice_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "updatedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/voice/recordings/{id}",\r "title": "Deletes a Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/describe",\r "title": "Gets table info about Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeRecordings",\r "group": "Voice_Recordings",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "put",\r "url": "/api/voice/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "post",\r "url": "/api/voice/transfers/reports",\r "title": "Creates a new Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"blind\"",\r "\"attended\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "result",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereraccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererlinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereechannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereelinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Yes\"",\r "\"No\""\r ],\r "optional": true,\r "field": "isexternal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Deletes a Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports",\r "title": "Gets a list of Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Gets a single Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Update an existing Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Creates a new Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"password\"",\r "\"token\""\r ],\r "optional": true,\r "field": "authType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Deletes a Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Gets a list of Zendesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Gets a single Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Update an existing Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Creates a new Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Deletes a Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Gets a list of Zendesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Gets a single Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Update an existing Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/fields",\r "title": "Creates a new Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Fields",\r "group": "Zendesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Deletes a Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields",\r "title": "Gets a list of Zendesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Gets a single Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Update an existing Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/cdr",\r "title": "Creates a new Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCdrs",\r "group": "cdr",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "calldate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "src",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dst",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dstchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastapp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "billsec",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userfield",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sequence",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "peeraccount",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tag",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "delete",\r "url": "/api/cdr/{id}",\r "title": "Deletes a Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr",\r "title": "Gets a list of Cdrs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCdrs",\r "group": "cdr",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr/{id}",\r "title": "Gets a single Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "put",\r "url": "/api/cdr/{id}",\r "title": "Update an existing Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "post",\r "url": "/api/voiceQueuesLog",\r "title": "Creates a new VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "time",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "agent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "event",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "dtm",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "delete",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Deletes a VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog",\r "title": "Gets a list of VoiceQueuesLogs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Gets a single VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "put",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Update an existing VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r }\r]
+[\r {\r "type": "delete",\r "url": "/api/actions/{id}",\r "title": "Deletes a Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "put",\r "url": "/api/actions/{id}",\r "title": "Update an existing Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateActions",\r "group": "Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/action/index.js",\r "groupTitle": "Actions"\r },\r {\r "type": "post",\r "url": "/api/analytics/custom_reports",\r "title": "Creates a new Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Deletes a Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports",\r "title": "Gets a list of Analytic Custom Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Gets a single Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/custom_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/custom_reports/{id}",\r "title": "Update an existing Analytic Custom Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Custom_Reports",\r "group": "Analytic_Custom_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticCustomReport/index.js",\r "groupTitle": "Analytic_Custom_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/default_reports",\r "title": "Creates a new Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "conditions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Deletes a Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports",\r "title": "Gets a list of Analytic Default Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Gets a single Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/preview",\r "title": "Report Preview",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "preview",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/query",\r "title": "Report Query SQL",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "query",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/default_reports/{id}/run",\r "title": "Report Run",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/default_reports/{id}",\r "title": "Update an existing Analytic Default Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Default_Reports",\r "group": "Analytic_Default_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticDefaultReport/index.js",\r "groupTitle": "Analytic_Default_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/extracted_reports",\r "title": "Creates a new Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"csv\"",\r "\"pdf\"",\r "\"xls\""\r ],\r "optional": false,\r "field": "output",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "savename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "startDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "endDate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"manual\"",\r "\"scheduled\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Deletes a Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports",\r "title": "Gets a list of Analytic Extacted Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Gets a single Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/extracted_reports/{id}/download",\r "title": "Download Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/extracted_reports/{id}",\r "title": "Update an existing Analytic Extracted Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Extacted_Reports",\r "group": "Analytic_Extracted_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticExtractedReport/index.js",\r "groupTitle": "Analytic_Extracted_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/create_many",\r "title": "Creates many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "BulkCreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/destroy_many?ids={ids}",\r "title": "Deletes many Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "BulkDeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports",\r "title": "Creates a new Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "alias",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "function",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "groupBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "orderBy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Deletes a Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports",\r "title": "Gets a list of Analytic Field Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Gets a single Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/field_reports/{id}/create_many",\r "title": "Rewrite fields set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addFields",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/field_reports/{id}",\r "title": "Update an existing Analytic Field Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Field_Reports",\r "group": "Analytic_Field_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticFieldReport/index.js",\r "groupTitle": "Analytic_Field_Reports"\r },\r {\r "type": "post",\r "url": "/api/analytics/metrics",\r "title": "Creates a new Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "table",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "metric",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "delete",\r "url": "/api/analytics/metrics/{id}",\r "title": "Deletes a Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics",\r "title": "Gets a list of Analytic Metric",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "get",\r "url": "/api/analytics/metrics/{id}",\r "title": "Gets a single Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "put",\r "url": "/api/analytics/metrics/{id}",\r "title": "Update an existing Analytic Metrics",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Metric",\r "group": "Analytic_Metrics",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticMetric/index.js",\r "groupTitle": "Analytic_Metrics"\r },\r {\r "type": "post",\r "url": "/api/analytics/tree_reports",\r "title": "Creates a new Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "tree",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "delete",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Deletes a Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports",\r "title": "Gets a list of Analytic Tree Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "get",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Gets a single Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "put",\r "url": "/api/analytics/tree_reports/{id}",\r "title": "Update an existing Analytic Tree Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAnalytic_Tree_Reports",\r "group": "Analytic_Tree_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/analyticTreeReport/index.js",\r "groupTitle": "Analytic_Tree_Reports"\r },\r {\r "type": "post",\r "url": "/api/auth/google",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authGoogle/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/auth/local",\r "title": "Creates a new User token",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Local_login",\r "group": "Authentication",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/authLocal/index.js",\r "groupTitle": "Authentication"\r },\r {\r "type": "post",\r "url": "/api/automations",\r "title": "Creates a new Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAutomations",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "delete",\r "url": "/api/automations/{id}",\r "title": "Deletes a Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations",\r "title": "Gets a list of Automations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAutomations",\r "group": "Automations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}",\r "title": "Gets a single Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addActions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/automations/{id}/conditions",\r "title": "Creates new conditions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConditions",\r "group": "Automations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/actions",\r "title": "Gets Automation Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "get",\r "url": "/api/automations/{id}/conditions",\r "title": "Gets Automation Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConditions",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "put",\r "url": "/api/automations/{id}",\r "title": "Update an existing Automation",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAutomations",\r "group": "Automations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/automation/index.js",\r "groupTitle": "Automations"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Add blacklists to a campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns/{id}/lists",\r "title": "Add lists to a campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/campaigns",\r "title": "Creates a new Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCampaigns",\r "group": "Campaigns",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ivr\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "limitCalls",\r "description": "<p>Max 200 calls.</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}",\r "title": "Deletes a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Get campaign blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns",\r "title": "Gets a list of Campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/finals",\r "title": "Gets campaign hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hopper_histories",\r "title": "Gets campaign hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/hoppers",\r "title": "Gets campaign hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/lists",\r "title": "Get campaign lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/blacklists",\r "title": "Remove blacklists from a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "delete",\r "url": "/api/campaigns/{id}/lists",\r "title": "Remove lists from a Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}",\r "title": "Gets a single Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "get",\r "url": "/api/campaigns/{id}/blacks",\r "title": "Gets campaign hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "put",\r "url": "/api/campaigns/{id}",\r "title": "Update an existing Campaign",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCampaigns",\r "group": "Campaigns",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/campaign/index.js",\r "groupTitle": "Campaigns"\r },\r {\r "type": "post",\r "url": "/api/canned_answers",\r "title": "Creates a new Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCanned_Answers",\r "group": "Canned_Answers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": false,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "delete",\r "url": "/api/canned_answers/{id}",\r "title": "Deletes a Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers",\r "title": "Gets a list of Canned Answers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "get",\r "url": "/api/canned_answers/{id}",\r "title": "Gets a single Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "put",\r "url": "/api/canned_answers/{id}",\r "title": "Update an existing Canned Answer",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCanned_Answers",\r "group": "Canned_Answers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cannedAnswer/index.js",\r "groupTitle": "Canned_Answers"\r },\r {\r "type": "delete",\r "url": "/api/chat/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "get",\r "url": "/api/chat/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "put",\r "url": "/api/chat/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Chat_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatApplication/index.js",\r "groupTitle": "Chat_Applications"\r },\r {\r "type": "post",\r "url": "/api/chat/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Chat_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/chat/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/chat/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/chat/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Chat_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatDisposition/index.js",\r "groupTitle": "Chat_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/chat/enquiries/{id}",\r "title": "Deletes a Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "get",\r "url": "/api/chat/enquiries/{id}",\r "title": "Gets a single Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "put",\r "url": "/api/chat/enquiries/{id}",\r "title": "Update an existing Enquiry",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/enquiries/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateEnquiries",\r "group": "Chat_Enquiries",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatEnquiry/index.js",\r "groupTitle": "Chat_Enquiries"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"CLOSED\"",\r "\"ABANDON\"",\r "\"UNMANAGED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"good\"",\r "\"bad\""\r ],\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ChatVisitorId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/chat/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Chat_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Chat_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Blob",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "get",\r "url": "/api/chat/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "put",\r "url": "/api/chat/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Chat_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatInteraction/index.js",\r "groupTitle": "Chat_Interactions"\r },\r {\r "type": "post",\r "url": "/api/chat/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Chat_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Blob",\r "optional": false,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Chat_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "get",\r "url": "/api/chat/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "put",\r "url": "/api/chat/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Chat_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatMessage/index.js",\r "groupTitle": "Chat_Messages"\r },\r {\r "type": "delete",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Deletes a Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "get",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Gets a single Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "put",\r "url": "/api/chat/proactive_actions/{id}",\r "title": "Update an existing Proactive Action",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProactive_Actions",\r "group": "Chat_Proactive_Actions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatProactiveAction/index.js",\r "groupTitle": "Chat_Proactive_Actions"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Chat_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "get",\r "url": "/api/chat/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "put",\r "url": "/api/chat/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Chat_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Chat_Queues"\r },\r {\r "type": "post",\r "url": "/api/chat/session/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Chat_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websitename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websiteaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "websiteid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitoremail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "abandon",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "post",\r "url": "/api/chat/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Chat_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websitename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "websiteaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "websiteid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitorname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "visitoremail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/session/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "Chat_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/session/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/chat/session/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/chat/session/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/chat/session/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/chat/session/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "get",\r "url": "/api/chat/session/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "put",\r "url": "/api/chat/session/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/session/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Chat_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatSessionReport/index.js",\r "groupTitle": "Chat_Reports"\r },\r {\r "type": "delete",\r "url": "/api/chat/visitors/{id}",\r "title": "Deletes a Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "get",\r "url": "/api/chat/visitors/{id}",\r "title": "Gets a single Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "put",\r "url": "/api/chat/visitors/{id}",\r "title": "Update an existing Visitor",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/visitors/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVisitors",\r "group": "Chat_Visitors",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatVisitor/index.js",\r "groupTitle": "Chat_Visitors"\r },\r {\r "type": "delete",\r "url": "/api/chat/website_fields/{id}",\r "title": "Deletes a Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "get",\r "url": "/api/chat/website_fields/{id}",\r "title": "Gets a single Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "put",\r "url": "/api/chat/website_fields/{id}",\r "title": "Update an existing Website Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/website_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateWebsite_Fields",\r "group": "Chat_Website_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsiteField/index.js",\r "groupTitle": "Chat_Website_Fields"\r },\r {\r "type": "post",\r "url": "/api/chat/websites",\r "title": "Creates a new Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateWebsites",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color_focus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "color_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "animation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rounded\"",\r "\"squared\""\r ],\r "optional": true,\r "field": "header_shape",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_online",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "online_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "start_chat_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "header_offline",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "offline_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_message_placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_button",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "download_transcript",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enquiry_forwarding",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enquiry_forwarding_address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "enquiry_enable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "rating_enable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_message",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_send",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rating_skip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "show_service_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agents_busy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "message_title",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "logo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultLogo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "whiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultWhiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "delete",\r "url": "/api/chat/websites/{id}",\r "title": "Deletes a Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites",\r "title": "Gets a list of Websites",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}",\r "title": "Gets a single Website",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"internal\"",\r "\"external\"",\r "\"group\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"CLOSED\"",\r "\"ABANDON\"",\r "\"UNMANAGED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"good\"",\r "\"bad\""\r ],\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "ratingMessage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\"",\r "\"requester\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ChatVisitorId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Creates new Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addProactiveActions",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"mouseOver\"",\r "\"timeout\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "selector",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/chat/websites/{id}/fields",\r "title": "Creates new Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/fields -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addWebsiteFields",\r "group": "Chat_Websites",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "component",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "index",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "placeholder",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "required",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "validation",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "editable",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/applications",\r "title": "Gets Website Applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/dispositions",\r "title": "Gets Website Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/interactions",\r "title": "Gets Website Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/proactive_actions",\r "title": "Gets Website Proactive Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getProactiveActions",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "get",\r "url": "/api/chat/websites/{id}/fields",\r "title": "Gets Website Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "getWebsiteFields",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "put",\r "url": "/api/chat/websites/{id}",\r "title": "Update an existing Website",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateWebsites",\r "group": "Chat_Websites",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatWebsite/index.js",\r "groupTitle": "Chat_Websites"\r },\r {\r "type": "post",\r "url": "/api/cm/companies",\r "title": "Creates a new Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCompanies",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "companyId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "website",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailDomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sStreet",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sPostalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sCountry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/companies/{id}",\r "title": "Deletes a Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies",\r "title": "Gets a list of Companies",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}",\r "title": "Gets a single Company",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "post",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Companies",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "get",\r "url": "/api/cm/companies/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "put",\r "url": "/api/cm/companies/{id}",\r "title": "Update an existing Company",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCompanies",\r "group": "Cm_Companies",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCompany/index.js",\r "groupTitle": "Cm_Companies"\r },\r {\r "type": "delete",\r "url": "/api/cm/contacts/{id}",\r "title": "Deletes a Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteContacts",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/describe",\r "title": "Gets table info about Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeContacts",\r "group": "Cm_Contacts",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts",\r "title": "Create Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "post",\r "url": "/api/cm/contacts",\r "title": "Create Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "index",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "get",\r "url": "/api/cm/contacts/{id}",\r "title": "Gets a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "show",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "put",\r "url": "/api/cm/contacts/{id}",\r "title": "Update a single Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"fullName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Contacts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmContact/index.js",\r "groupTitle": "Cm_Contacts"\r },\r {\r "type": "delete",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Deletes a Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields",\r "title": "Gets a list of Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "get",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Gets a single Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "put",\r "url": "/api/cm/custom_fields/{id}",\r "title": "Update an existing Custom Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateCustom_Fields",\r "group": "Cm_Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Cm_Custom_Fields"\r },\r {\r "type": "post",\r "url": "/api/cm/hopper",\r "title": "Creates a new Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateHopper",\r "group": "Cm_Hopper",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "scheduledat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countbusyretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countcongestionretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "countnoanswerretry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ContactId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ListId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "UserId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "VoiceQueueId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "CampaignId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/describe",\r "title": "Gets table info about Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper",\r "group": "Cm_Hopper",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper",\r "title": "Gets a list of Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/{id}",\r "title": "Gets a single Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Deletes a Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/describe",\r "title": "Gets table info about Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopper_Black",\r "group": "Cm_Hopper_Black",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black",\r "title": "Gets a list of Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Gets a single Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_black/{id}",\r "title": "Update an existing Hopper Black",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper_Black",\r "group": "Cm_Hopper_Black",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperBlack/index.js",\r "groupTitle": "Cm_Hopper_Black"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/describe",\r "title": "Gets table info about HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperFinal",\r "group": "Cm_Hopper_Final",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final",\r "title": "Gets a list of HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Gets a single HopperFinal",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperFinal",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_final/{id}",\r "title": "Update a single hopper final",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_Final",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperFinal/index.js",\r "groupTitle": "Cm_Hopper_Final"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/describe",\r "title": "Gets table info about HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeHopperHistory",\r "group": "Cm_Hopper_History",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history",\r "title": "Gets a list of HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Gets a single HopperHistory",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowHopperHistory",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper_history/{id}",\r "title": "Update a single hopper history",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Cm_Hopper_History",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopperHistory/index.js",\r "groupTitle": "Cm_Hopper_History"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/preview/{id}",\r "title": "Call Dialer Contact",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/preview/{id} -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "callDialerContact",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "delete",\r "url": "/api/cm/hopper/{id}",\r "title": "Delete Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroy",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "get",\r "url": "/api/cm/hopper/preview",\r "title": "Gets Dialer Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/hopper/preview -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDialerContacts",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "put",\r "url": "/api/cm/hopper/{id}",\r "title": "Update an existing Hopper",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateHopper",\r "group": "Cm_Hopper",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmHopper/index.js",\r "groupTitle": "Cm_Hopper"\r },\r {\r "type": "post",\r "url": "/api/cm/lists",\r "title": "Creates a new List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateLists",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}",\r "title": "Deletes a List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/users",\r "title": "Gets agents from list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists",\r "title": "Gets a list of Lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/cm/lists/{id}/users",\r "title": "Removes agents from a list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}",\r "title": "Gets a single List",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/users",\r "title": "Adds agents to a list",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Creates new contacts",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addContacts",\r "group": "Cm_Lists",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "firstName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "street",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "postalCode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dateOfBirth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fax",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Creates a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addCustomField",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "post",\r "url": "/api/lists/{id}/dispositions",\r "title": "Creates a new sub disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/lists/{id}/disposition -d '{\"name\": \"SATISFIED\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts",\r "title": "Gets List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getContacts",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/fields",\r "title": "Gets Custom Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getCustomFields",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/dispositions",\r "title": "Gets Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "get",\r "url": "/api/cm/lists/{id}/contacts/csv",\r "title": "Gets CSV List Contacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "grunt",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "put",\r "url": "/api/cm/lists/{id}",\r "title": "Update an existing List",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateLists",\r "group": "Cm_Lists",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmList/index.js",\r "groupTitle": "Cm_Lists"\r },\r {\r "type": "delete",\r "url": "/api/conditions/{id}",\r "title": "Deletes a Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "put",\r "url": "/api/conditions/{id}",\r "title": "Update an existing Condition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateConditions",\r "group": "Conditions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/condition/index.js",\r "groupTitle": "Conditions"\r },\r {\r "type": "post",\r "url": "/api/cm/custom_field",\r "title": "Create a new custom field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCustomField",\r "group": "Custom_Fields",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cmCustomField/index.js",\r "groupTitle": "Custom_Fields"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/items/{id}",\r "title": "Deletes a Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "get",\r "url": "/api/dashboards/items/{id}",\r "title": "Gets a single Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "put",\r "url": "/api/dashboards/items/{id}",\r "title": "Update an existing Dashboard Item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDashboard_Items",\r "group": "Dashboard_Items",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboardItem/index.js",\r "groupTitle": "Dashboard_Items"\r },\r {\r "type": "post",\r "url": "/api/dashboards",\r "title": "Creates a new Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDashboards",\r "group": "Dashboards",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "delete",\r "url": "/api/dashboards/{id}",\r "title": "Deletes a Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards",\r "title": "Gets a list of Dashboards",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}",\r "title": "Gets a single Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "post",\r "url": "/api/dashboards/{id}/items",\r "title": "Creates new item",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addItem",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}/run",\r "title": "Run dashboard widgets queries",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/run -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "run",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "put",\r "url": "/api/dashboards/{id}",\r "title": "Update an existing Dashboard",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDashboards",\r "group": "Dashboards",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboards"\r },\r {\r "type": "get",\r "url": "/api/dashboards/{id}/items",\r "title": "Gets items",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getItems",\r "group": "Dashboars",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/dashboard/index.js",\r "groupTitle": "Dashboars"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ecm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "headerinfo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "minrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"2400\"",\r "\"4800\"",\r "\"7200\"",\r "\"9600\"",\r "\"12000\"",\r "\"14400\""\r ],\r "optional": true,\r "field": "maxrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "modem",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "gateway",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "faxdetect",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "t38timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SIP\"",\r "\"IAX\"",\r "\"DADHI\"",\r "\"KHOMP\""\r ],\r "optional": true,\r "field": "tech",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": false,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "post",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Fax_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/applications",\r "title": "Gets account pplications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "get",\r "url": "/api/fax/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "put",\r "url": "/api/fax/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Fax_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAccount/index.js",\r "groupTitle": "Fax_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/fax/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "get",\r "url": "/api/fax/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "put",\r "url": "/api/fax/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Fax_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxApplication/index.js",\r "groupTitle": "Fax_Applications"\r },\r {\r "type": "post",\r "url": "/api/fax/attachments",\r "title": "Creates a new Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAttachments",\r "group": "Fax_Attachments",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "path",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "basename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "delete",\r "url": "/api/fax/attachments/{id}",\r "title": "Deletes a Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "get",\r "url": "/api/fax/attachments",\r "title": "Gets a list of Attachments",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/fax/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/fax/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/fax/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/fax/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "get",\r "url": "/api/fax/attachments/{id}",\r "title": "Gets a single Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "put",\r "url": "/api/fax/attachments/{id}",\r "title": "Update an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAttachments",\r "group": "Fax_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxAttachment/index.js",\r "groupTitle": "Fax_Attachments"\r },\r {\r "type": "post",\r "url": "/api/fax/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Fax_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/fax/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/fax/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/fax/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Fax_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxDisposition/index.js",\r "groupTitle": "Fax_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/fax/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Fax_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Fax_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotestationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "pagestransferred",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resolution",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "error",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "get",\r "url": "/api/fax/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "put",\r "url": "/api/fax/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Fax_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxInteraction/index.js",\r "groupTitle": "Fax_Interactions"\r },\r {\r "type": "post",\r "url": "/api/fax/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Fax_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "localstationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotestationid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "pagestransferred",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resolution",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "error",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "delete",\r "url": "/api/fax/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Fax_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "get",\r "url": "/api/fax/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "put",\r "url": "/api/fax/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Fax_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxMessage/index.js",\r "groupTitle": "Fax_Messages"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Fax_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "get",\r "url": "/api/fax/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "put",\r "url": "/api/fax/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Fax_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Fax_Queues"\r },\r {\r "type": "post",\r "url": "/api/fax/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Fax_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Fax_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxReport/index.js",\r "groupTitle": "Fax_Reports"\r },\r {\r "type": "post",\r "url": "/api/fax/sessions/reports",\r "title": "Creates a new Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSession_Reports",\r "group": "Fax_Session_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "delete",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Deletes a Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Fax_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/fax/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/fax/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/fax/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/fax/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "put",\r "url": "/api/fax/sessions/reports/{id}",\r "title": "Update an existing Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSession_Reports",\r "group": "Fax_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxSessionReport/index.js",\r "groupTitle": "Fax_Session_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Creates a new Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "apiKey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Deletes a Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts",\r "title": "Gets a list of Freshdesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Gets a single Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/accounts/{id}",\r "title": "Update an existing Freshdesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Accounts",\r "group": "Freshdesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskAccount/index.js",\r "groupTitle": "Freshdesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Creates a new Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Deletes a Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations",\r "title": "Gets a list of Freshdesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Gets a single Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/configurations/{id}",\r "title": "Update an existing Freshdesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Configurations",\r "group": "Freshdesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskConfiguration/index.js",\r "groupTitle": "Freshdesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Creates a new Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Deletes a Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields",\r "title": "Gets a list of Freshdesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Gets a single Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/freshdesk/fields/{id}",\r "title": "Update an existing Freshdesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateFreshdesk_Fields",\r "group": "Freshdesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intFreshdeskField/index.js",\r "groupTitle": "Freshdesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/integrations/reports",\r "title": "Creates a new Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntegration_Reports",\r "group": "Integration_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "integration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "eventChannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exitStatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "ticketId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "integrationId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contacts",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interface",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcalledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentconnectAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentcomplete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentcompleteAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "talktime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentacw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentringnoanswer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentringnoanswerAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "agentdump",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "agentdumpAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastevent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "channelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "destchannelstate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destchannelstatedesc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destlanguage",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "destuniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENT\"",\r "\"SENDING\"",\r "\"RECEIVED\"",\r "\"FAILED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "url",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "appdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "projectId",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "delete",\r "url": "/api/integrations/reports/{id}",\r "title": "Deletes a Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/describe",\r "title": "Gets table info about Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeIntegration_Reports",\r "group": "Integration_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports",\r "title": "Gets a list of Integration Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "get",\r "url": "/api/integrations/reports/{id}",\r "title": "Gets a single Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "put",\r "url": "/api/integrations/reports/{id}",\r "title": "Update an existing Integration Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateIntegration_Reports",\r "group": "Integration_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/integrationReport/index.js",\r "groupTitle": "Integration_Reports"\r },\r {\r "type": "post",\r "url": "/api/intervals",\r "title": "Creates a new Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateIntervals",\r "group": "Intervals",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "delete",\r "url": "/api/intervals/{id}",\r "title": "Deletes a Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals",\r "title": "Gets a list of Intervals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetIntervals",\r "group": "Intervals",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}",\r "title": "Gets a single Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Creates a new sub interval",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInterval",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/intervals/{id}/sub_intervals/create_many",\r "title": "Create new sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "get",\r "url": "/api/intervals/{id}/sub_intervals",\r "title": "Get sub intervals set",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "put",\r "url": "/api/intervals/{id}",\r "title": "Update an existing Interval",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateIntervals",\r "group": "Intervals",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/interval/index.js",\r "groupTitle": "Intervals"\r },\r {\r "type": "post",\r "url": "/api/jira",\r "title": "Creates a new issue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST",\r "type": "json"\r }\r ],\r "name": "Creates_Issue",\r "group": "Issue",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Bug\""\r ],\r "optional": true,\r "field": "issuetype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "summary",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jira/index.js",\r "groupTitle": "Issue"\r },\r {\r "type": "post",\r "url": "/api/jscripty/inputs/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyInputReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "input_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "input_value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/inputs/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/inputs/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/inputs/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/inputs/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/inputs/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/inputs/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/inputs/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/inputs/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyInputReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyInputReport/index.js",\r "groupTitle": "JscriptyInputReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/questions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptyQuestionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "question_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_other_label",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_other_answer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "question_options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "index",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/questions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptyQuestionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyQuestionReport/index.js",\r "groupTitle": "JscriptyQuestionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/sessions/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "JscriptySessionReport",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "sourceid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"started\"",\r "\"completed\"",\r "\"incomplete\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "last_question_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "get",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "put",\r "url": "/api/jscripty/sessions/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "JscriptySessionReport",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptySessionReport/index.js",\r "groupTitle": "JscriptySessionReport"\r },\r {\r "type": "post",\r "url": "/api/jscripty/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Jscripty_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "draft",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "production",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "delete",\r "url": "/api/jscripty/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/jscripty/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "put",\r "url": "/api/jscripty/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Jscripty_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/jscriptyProject/index.js",\r "groupTitle": "Jscripty_Projects"\r },\r {\r "type": "get",\r "url": "/api/license",\r "title": "Gets License Info",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "index",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "put",\r "url": "/api/license/{id}",\r "title": "Update an existing License",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/license/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateLiense",\r "group": "License",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/license/index.js",\r "groupTitle": "License"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Creates a new IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddImap",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "ssl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "delete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"UNSEEN\""\r ],\r "optional": true,\r "field": "filter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"IMAP\"",\r "\"POP3\""\r ],\r "optional": true,\r "field": "protocol",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"CONNECTING\"",\r "\"CONNECTED\"",\r "\"DISCONNECTED\"",\r "\"ERROR\"",\r "\"UNKNOWN\""\r ],\r "optional": true,\r "field": "state",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "connTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "authTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "keepalive",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Creates a new SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddSmtp",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "state",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "whiteLabel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "signature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "custom",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "service",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Gets account IMAP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetImap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Gets account SMTP server",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/in_servers",\r "title": "Removes IMAP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveImmap",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/accounts/{id}/out_servers",\r "title": "Removes SMTP server from an account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"replyMail\"",\r "\"sendSms\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '[{\"name\": \"vip\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Mail_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "deleted",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "post",\r "url": "/api/mail/accounts/{id}/send",\r "title": "Send new mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "sendMail",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "put",\r "url": "/api/mail/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "get",\r "url": "/api/mail/accounts/{id}/verify",\r "title": "Verify mail account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "verifySmtp",\r "group": "Mail_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAccount/index.js",\r "groupTitle": "Mail_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/mail/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "get",\r "url": "/api/mail/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "put",\r "url": "/api/mail/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Mail_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailApplication/index.js",\r "groupTitle": "Mail_Applications"\r },\r {\r "type": "post",\r "url": "/api/mail/attachments",\r "title": "Creates a new Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAttachments",\r "group": "Mail_Attachments",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "domain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "size",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "path",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "basename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "delete",\r "url": "/api/mail/attachments/{id}",\r "title": "Deletes a Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "get",\r "url": "/api/mail/attachments",\r "title": "Gets a list of Attachments",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/mail/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/mail/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/mail/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/mail/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "get",\r "url": "/api/mail/attachments/{id}",\r "title": "Gets a single Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "put",\r "url": "/api/mail/attachments/{id}",\r "title": "Update an existing Attachment",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateAttachments",\r "group": "Mail_Attachments",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailAttachment/index.js",\r "groupTitle": "Mail_Attachments"\r },\r {\r "type": "post",\r "url": "/api/mail/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Mail_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/mail/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/mail/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/mail/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Mail_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailDisposition/index.js",\r "groupTitle": "Mail_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "deleted",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/mail/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Mail_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Creates new message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Mail_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fromId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userFullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "get",\r "url": "/api/mail/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "put",\r "url": "/api/mail/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Mail_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailInteraction/index.js",\r "groupTitle": "Mail_Interactions"\r },\r {\r "type": "post",\r "url": "/api/mail/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Mail_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "messageId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "inReplyTo",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "cc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "bcc",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fromId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "attachment",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "text",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "html",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userFullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "delete",\r "url": "/api/mail/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Mail_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "get",\r "url": "/api/mail/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "put",\r "url": "/api/mail/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Mail_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailMessage/index.js",\r "groupTitle": "Mail_Messages"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "post",\r "url": "/api/mail/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Mail_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "put",\r "url": "/api/mail/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Mail_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Mail_Queues"\r },\r {\r "type": "get",\r "url": "/api/mail/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Mail_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailReport/index.js",\r "groupTitle": "Mail_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Mail_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailReport/index.js",\r "groupTitle": "Mail_Reports"\r },\r {\r "type": "post",\r "url": "/api/mail/out_servers",\r "title": "Creates a new SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSMTPs",\r "group": "Mail_SMTP",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "service",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pass",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "secure",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "state",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "delete",\r "url": "/api/mail/out_servers/{id}",\r "title": "Deletes a SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers",\r "title": "Gets a list of SMTPs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/out_servers/{id}",\r "title": "Gets a single SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "put",\r "url": "/api/mail/out_servers/{id}",\r "title": "Update an existing SMTP",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSMTPs",\r "group": "Mail_SMTP",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailServerOut/index.js",\r "groupTitle": "Mail_SMTP"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Mail_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Mail_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/mail/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/mail/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/mail/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/mail/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/mail/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Mail_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailSessionReport/index.js",\r "groupTitle": "Mail_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/describe",\r "title": "Gets table info about Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMember_Reports",\r "group": "Member_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports",\r "title": "Gets a list of Member Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "get",\r "url": "/api/members/reports/{id}",\r "title": "Gets a single Member Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMember_Reports",\r "group": "Member_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/memberReport/index.js",\r "groupTitle": "Member_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/networks",\r "title": "Create a new network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "delete",\r "url": "/api/voice/networks/{id}",\r "title": "Deletes a network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks",\r "title": "Gets a list of Networks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetNetworks",\r "group": "Networks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "get",\r "url": "/api/networks/{id}",\r "title": "Gets a single Network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowNetworks",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "put",\r "url": "/api/voice/networks/{id}",\r "title": "Update an existing network",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Networks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/network/index.js",\r "groupTitle": "Networks"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "replyUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "replyMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\"",\r "\"sendMail\"",\r "\"sendSms\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "post",\r "url": "/api/openchannel/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Openchannel_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "get",\r "url": "/api/openchannel/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "put",\r "url": "/api/openchannel/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Openchannel_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelAccount/index.js",\r "groupTitle": "Openchannel_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "get",\r "url": "/api/openchannel/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "put",\r "url": "/api/openchannel/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Openchannel_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelApplication/index.js",\r "groupTitle": "Openchannel_Applications"\r },\r {\r "type": "post",\r "url": "/api/openchannel/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Openchannel_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/openchannel/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Openchannel_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelDisposition/index.js",\r "groupTitle": "Openchannel_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Openchannel_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Openchannel_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "get",\r "url": "/api/openchannel/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "put",\r "url": "/api/openchannel/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Openchannel_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelInteraction/index.js",\r "groupTitle": "Openchannel_Interactions"\r },\r {\r "type": "post",\r "url": "/api/openchannel/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Openchannel_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Openchannel_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "get",\r "url": "/api/openchannel/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "put",\r "url": "/api/openchannel/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Openchannel_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelMessage/index.js",\r "groupTitle": "Openchannel_Messages"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Openchannel_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "get",\r "url": "/api/openchannel/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "put",\r "url": "/api/openchannel/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Openchannel_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Openchannel_Queues"\r },\r {\r "type": "post",\r "url": "/api/openchannel/reports",\r "title": "Creates a new Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/reports/{id}",\r "title": "Deletes a Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports",\r "title": "Gets a list of Openchannel Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/reports/{id}",\r "title": "Gets a single Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "put",\r "url": "/api/openchannel/reports/{id}",\r "title": "Update an existing Openchannel Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateOpenchannel_Reports",\r "group": "Openchannel_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelReport/index.js",\r "groupTitle": "Openchannel_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports/describe",\r "title": "Gets table info about Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSession_Reports",\r "group": "Openchannel_Session_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports",\r "title": "Gets a list of Session Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSession_Reports",\r "group": "Openchannel_Session_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/openchannel/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/openchannel/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/openchannel/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/openchannel/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "get",\r "url": "/api/openchannel/sessions/reports/{id}",\r "title": "Gets a single Session Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/sessions/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSession_Reports",\r "group": "Openchannel_Session_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelSessionReport/index.js",\r "groupTitle": "Openchannel_Session_Reports"\r },\r {\r "type": "post",\r "url": "/api/pauses",\r "title": "Creates a new Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreatePauses",\r "group": "Pauses",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "delete",\r "url": "/api/pauses/{id}",\r "title": "Deletes a Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeletePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses",\r "title": "Gets a list of Pauses",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPauses",\r "group": "Pauses",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pauses/{id}",\r "title": "Gets a single Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowPauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "put",\r "url": "/api/pauses/{id}",\r "title": "Update an existing Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updatePauses",\r "group": "Pauses",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pause/index.js",\r "groupTitle": "Pauses"\r },\r {\r "type": "get",\r "url": "/api/pm2/{id}",\r "title": "Gets a single pm2 process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Process",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/pm2",\r "title": "Gets pm2 processes",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetPm2Processes",\r "group": "Pm2",\r "description": "<p>Motion returns the pm2 processes list.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "put",\r "url": "/api/pm2/{id}",\r "title": "Update an existing Process",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateProcesses",\r "group": "Pm2",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/pm2/index.js",\r "groupTitle": "Pm2"\r },\r {\r "type": "get",\r "url": "/api/rpc/campaigns/",\r "title": "Gets a list of campaigns",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Campaigns",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/agents",\r "title": "Gets a list of RTAgents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTAgents",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound/channels",\r "title": "Gets a list of RTOutboundChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTOutboundChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/telephones",\r "title": "Gets a list of RTTelephones",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTelephones",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/trunks",\r "title": "Gets a list of RTTrunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTTrunks",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}",\r "title": "Gets a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannel",\r "group": "RPC_Realtime",\r "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelHangup",\r "group": "RPC_Realtime",\r "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",\r "title": "Hangup a single RTVoiceQueueChannel",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueueChannelRedirect",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues",\r "title": "Gets a list of RTVoiceQueues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/outbound",\r "title": "Gets a list of RTOutbound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueues",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "get",\r "url": "/api/rpc/voice/queues/channels",\r "title": "Gets a list of RTVoiceQueuesChannels",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RTVoiceQueuesChannels",\r "group": "RPC_Realtime",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/rpc/index.js",\r "groupTitle": "RPC_Realtime"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Creates a new Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clientSecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "securityToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Deletes a Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts",\r "title": "Gets a list of Salesforce Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Gets a single Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/accounts/{id}",\r "title": "Update an existing Salesforce Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Accounts",\r "group": "Salesforce_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceAccount/index.js",\r "groupTitle": "Salesforce_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Creates a new Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Deletes a Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations",\r "title": "Gets a list of Salesforce Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Gets a single Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/configurations/{id}",\r "title": "Update an existing Salesforce Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Configurations",\r "group": "Salesforce_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceConfiguration/index.js",\r "groupTitle": "Salesforce_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/salesforce/fields",\r "title": "Creates a new Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Deletes a Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields",\r "title": "Gets a list of Salesforce Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Gets a single Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/salesforce/fields/{id}",\r "title": "Update an existing Salesforce Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSalesforce_Fields",\r "group": "Salesforce_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSalesforceField/index.js",\r "groupTitle": "Salesforce_Fields"\r },\r {\r "type": "post",\r "url": "/api/schedules",\r "title": "Creates a new Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSchedules",\r "group": "Schedules",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "active",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportRange",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "sendMail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "validityStart",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "validityEnd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cronType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "cron",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "reportId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reportOutput",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultEntry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "delete",\r "url": "/api/schedules/{id}",\r "title": "Deletes a Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules",\r "title": "Gets a list of Schedules",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSchedules",\r "group": "Schedules",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/schedules/{id}",\r "title": "Gets a single Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "put",\r "url": "/api/schedules/{id}",\r "title": "Update an existing Schedule",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSchedules",\r "group": "Schedules",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/schedule/index.js",\r "groupTitle": "Schedules"\r },\r {\r "type": "get",\r "url": "/api/settings",\r "title": "Gets a list of Settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSettings",\r "group": "Settings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}",\r "title": "Gets a single Setting",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSettings",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "put",\r "url": "/api/settings/{id}",\r "title": "Update settings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo",\r "title": "Add logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/settings/{id}/logo_login",\r "title": "Add logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo",\r "title": "Get logo",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLogo",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "get",\r "url": "/api/settings/{id}/logo_login",\r "title": "Get logo login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/settings/{id}/logo_login -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getLogoLogin",\r "group": "Settings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/setting/index.js",\r "groupTitle": "Settings"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts",\r "title": "Creates a new Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateAccounts",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"twilio\"",\r "\"skebby\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"basic\"",\r "\"classic\"",\r "\"classic+\""\r ],\r "optional": true,\r "field": "smstype",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remote",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "acceptUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "acceptMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "rejectMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closeUrl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"GET\"",\r "\"POST\""\r ],\r "optional": true,\r "field": "closeMethod",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "actions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/accounts/{id}",\r "title": "Deletes a Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts",\r "title": "Gets a list of Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}",\r "title": "Gets a single Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Creates new applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"queue\"",\r "\"agent\""\r ],\r "optional": true,\r "field": "app",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "interval",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "data7",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data8",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data9",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "data10",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Creates new disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"Satisfied\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDisposition",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Creates many dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addDispositions",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "post",\r "url": "/api/sms/accounts/{id}/interactions",\r "title": "Creates new interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addInteraction",\r "group": "Sms_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/applications",\r "title": "Gets account applications",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getApplications",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/dispositions",\r "title": "Gets account dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDispositions",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "get",\r "url": "/api/sms/accounts/{id}/interactions",\r "title": "Gets account interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getInteraction",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "put",\r "url": "/api/sms/accounts/{id}",\r "title": "Update an existing Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateAccounts",\r "group": "Sms_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsAccount/index.js",\r "groupTitle": "Sms_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/sms/applications/{id}",\r "title": "Deletes a Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "get",\r "url": "/api/sms/applications/{id}",\r "title": "Gets a single Application",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "put",\r "url": "/api/sms/applications/{id}",\r "title": "Update an existing Application",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateApplications",\r "group": "Sms_Applications",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsApplication/index.js",\r "groupTitle": "Sms_Applications"\r },\r {\r "type": "post",\r "url": "/api/sms/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Sms_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/sms/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/sms/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/sms/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Sms_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsDisposition/index.js",\r "groupTitle": "Sms_Dispositions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions",\r "title": "Creates a new Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateInteractions",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsIn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsOut",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"NEW\"",\r "\"OPEN\"",\r "\"PENDING\"",\r "\"CLOSED\""\r ],\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"SENDING\"",\r "\"SENT\"",\r "\"RECEIVED\"",\r "\"FAILED\"",\r "\"NOTE\""\r ],\r "optional": true,\r "field": "lastEvent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastEventAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "waiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "tags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "openReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "arrivedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "closedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "ParentId",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voiceSource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "account",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "delete",\r "url": "/api/sms/interactions/{id}",\r "title": "Deletes a Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/describe",\r "title": "Gets table info about Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeInteractions",\r "group": "Sms_Interactions",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions",\r "title": "Gets a list of Interactions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}",\r "title": "Gets a single Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Creates new messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addMessage",\r "group": "Sms_Interactions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "errorcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "skebby_message_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "get",\r "url": "/api/sms/interactions/{id}/messages",\r "title": "Gets interaction messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "put",\r "url": "/api/sms/interactions/{id}",\r "title": "Update an existing Interaction",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateInteractions",\r "group": "Sms_Interactions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsInteraction/index.js",\r "groupTitle": "Sms_Interactions"\r },\r {\r "type": "post",\r "url": "/api/sms/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Sms_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "to",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "body",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "status",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "errorcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "skebby_message_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "res_data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "source",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auto",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "delete",\r "url": "/api/sms/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/describe",\r "title": "Gets table info about Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeMessages",\r "group": "Sms_Messages",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "get",\r "url": "/api/sms/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "put",\r "url": "/api/sms/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Sms_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsMessage/index.js",\r "groupTitle": "Sms_Messages"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/users",\r "title": "Add agents to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Add teams to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Sms_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rrmemory\"",\r "\"beepall\"",\r "\"roundrobin\""\r ],\r "optional": true,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastAgent",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Gets queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "get",\r "url": "/api/sms/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "put",\r "url": "/api/sms/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Sms_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Sms_Queues"\r },\r {\r "type": "post",\r "url": "/api/sms/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Sms_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "from",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountnumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "messageid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calledAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rejectedAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "post",\r "url": "/api/sms/session/reports",\r "title": "Creates a new Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateReports",\r "group": "Sms_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountaddress",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "memberid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "roomid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "fidelity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "completeAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "complete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agent\""\r ],\r "optional": true,\r "field": "completeReason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeslot",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "delete",\r "url": "/api/sms/session/reports/{id}",\r "title": "Deletes a Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports/describe",\r "title": "Gets table info about Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeReports",\r "group": "Sms_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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?name=john.doe,jane.miller</code></p> <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?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports",\r "title": "Gets a list of Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/session/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/sms/session/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/sms/session/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/sms/session/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/sms/session/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/session/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sms/reports/{id}",\r "title": "Gets a single Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "put",\r "url": "/api/sms/session/reports/{id}",\r "title": "Update an existing Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/session/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateReports",\r "group": "Sms_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsSessionReport/index.js",\r "groupTitle": "Sms_Reports"\r },\r {\r "type": "get",\r "url": "/api/sounds",\r "title": "Gets a list of Sounds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Sounds",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}",\r "title": "Gets a single Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSounds",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/sounds",\r "title": "Create a new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "delete",\r "url": "/api/sounds/{id}",\r "title": "Deletes a sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "destroySound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "get",\r "url": "/api/sounds/{id}/download",\r "title": "Download Sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "put",\r "url": "/api/sounds",\r "title": "Update an existing new sound",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateSound",\r "group": "Sounds",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/sound/index.js",\r "groupTitle": "Sounds"\r },\r {\r "type": "post",\r "url": "/api/square/details/reports",\r "title": "Creates a new Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "node",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "application",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "data",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/details/reports/{id}",\r "title": "Deletes a Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/describe",\r "title": "Gets table info about Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports",\r "title": "Gets a list of Square Detail Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/details/reports/{id}",\r "title": "Gets a single Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/details/reports/{id}",\r "title": "Update an existing Square Detail Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Detail_Reports",\r "group": "Square_Details_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReportDetail/index.js",\r "groupTitle": "Square_Details_Reports"\r },\r {\r "type": "post",\r "url": "/api/square/odbc",\r "title": "Creates a new ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateODBCs",\r "group": "Square_ODBC",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dsn",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "delete",\r "url": "/api/square/odbc/{id}",\r "title": "Deletes a ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc",\r "title": "Gets a list of ODBCs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}",\r "title": "Gets a single ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "get",\r "url": "/api/square/odbc/{id}/test",\r "title": "Test Odbc",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "test",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "put",\r "url": "/api/square/odbc/{id}",\r "title": "Update an existing ODBC",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateODBCs",\r "group": "Square_ODBC",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareOdbc/index.js",\r "groupTitle": "Square_ODBC"\r },\r {\r "type": "post",\r "url": "/api/square/projects",\r "title": "Creates a new Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateProjects",\r "group": "Square_Projects",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "notes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "preproduction",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "production",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "delete",\r "url": "/api/square/projects/{id}",\r "title": "Deletes a Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects",\r "title": "Gets a list of Projects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "get",\r "url": "/api/square/projects/{id}",\r "title": "Gets a single Project",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "put",\r "url": "/api/square/projects/{id}",\r "title": "Update an existing Project",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateProjects",\r "group": "Square_Projects",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareProject/index.js",\r "groupTitle": "Square_Projects"\r },\r {\r "type": "post",\r "url": "/api/square/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Square_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "projectName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "saveName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "filename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "savePath",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/square/recordings/{id}",\r "title": "Deletes a Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "get",\r "url": "/api/square/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "put",\r "url": "/api/square/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Square_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareRecording/index.js",\r "groupTitle": "Square_Recordings"\r },\r {\r "type": "post",\r "url": "/api/square/reports",\r "title": "Creates a new Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateSquare_Reports",\r "group": "Square_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "network_script",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "request",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "version",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingani2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callington",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callingtns",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dnid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "rdnis",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "priority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "enhanced",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "threadid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "project_name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leaveAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "delete",\r "url": "/api/square/reports/{id}",\r "title": "Deletes a Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/describe",\r "title": "Gets table info about Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeSquare_Reports",\r "group": "Square_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports",\r "title": "Gets a list of Square Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "get",\r "url": "/api/square/reports/{id}",\r "title": "Gets a single Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "put",\r "url": "/api/square/reports/{id}",\r "title": "Update an existing Square Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSquare_Reports",\r "group": "Square_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/squareReport/index.js",\r "groupTitle": "Square_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Creates a new SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Deletes a SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations",\r "title": "Gets a list of SugarCRM Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Gets a single SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/configurations/{id}",\r "title": "Update an existing SugarCRM Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarCRM_Configurations",\r "group": "SugarCRM_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "SugarCRM_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Creates a new Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Deletes a Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts",\r "title": "Gets a list of Sugarcrm Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Gets a single Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/accounts/{id}",\r "title": "Update an existing Sugarcrm Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Accounts",\r "group": "Sugarcrm_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmAccount/index.js",\r "groupTitle": "Sugarcrm_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Sugarcrm_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmConfiguration/index.js",\r "groupTitle": "Sugarcrm_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Creates a new Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Deletes a Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields",\r "title": "Gets a list of Sugarcrm Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Gets a single Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/sugarcrm/fields/{id}",\r "title": "Update an existing Sugarcrm Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateSugarcrm_Fields",\r "group": "Sugarcrm_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intSugarcrmField/index.js",\r "groupTitle": "Sugarcrm_Fields"\r },\r {\r "type": "get",\r "url": "/api/system",\r "title": "Gets system information",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/system -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetSystemInformation",\r "group": "System_Information",\r "description": "<p>Motion returns the system information.</p>",\r "version": "0.0.0",\r "filename": "server/api/system/index.js",\r "groupTitle": "System_Information"\r },\r {\r "type": "post",\r "url": "/api/tags",\r "title": "Creates a new Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTags",\r "group": "Tags",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "delete",\r "url": "/api/tags/{id}",\r "title": "Deletes a Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags",\r "title": "Gets a list of Tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTags",\r "group": "Tags",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "get",\r "url": "/api/tags/{id}",\r "title": "Gets a single Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "put",\r "url": "/api/tags/{id}",\r "title": "Update an existing Tag",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTags",\r "group": "Tags",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/tag/index.js",\r "groupTitle": "Tags"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/queues",\r "title": "Add queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams",\r "title": "Creates a new Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTeams",\r "group": "Teams",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}",\r "title": "Deletes a Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/users",\r "title": "Gets agents from team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams",\r "title": "Gets a list of Teams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Teams",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/users",\r "title": "Removes agents from a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/teams/{id}/queues",\r "title": "Remove queues to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/sms/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/smsQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/chat/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/chatQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/mail/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/mailQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/fax/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/faxQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "delete",\r "url": "/api/openchannel/queues/{id}/teams",\r "title": "Remove teams from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/openchannelQueue/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "get",\r "url": "/api/teams/{id}",\r "title": "Gets a single Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/teams/{id}/users",\r "title": "Adds agents to a team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAgents",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "put",\r "url": "/api/teams/{id}",\r "title": "Update an existing Team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTeams",\r "group": "Teams",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/team/index.js",\r "groupTitle": "Teams"\r },\r {\r "type": "post",\r "url": "/api/templates",\r "title": "Creates a new Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTemplates",\r "group": "Templates",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "html",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "delete",\r "url": "/api/templates/{id}",\r "title": "Deletes a Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates",\r "title": "Gets a list of Templates",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTemplates",\r "group": "Templates",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "get",\r "url": "/api/templates/{id}",\r "title": "Gets a single Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "put",\r "url": "/api/templates/{id}",\r "title": "Update an existing Template",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTemplates",\r "group": "Templates",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/template/index.js",\r "groupTitle": "Templates"\r },\r {\r "type": "post",\r "url": "/api/triggers",\r "title": "Creates a new Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateTriggers",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "status",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "delete",\r "url": "/api/triggers/{id}",\r "title": "Deletes a Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers",\r "title": "Gets a list of Triggers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTriggers",\r "group": "Triggers",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}",\r "title": "Gets a single Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/actions",\r "title": "Creates new actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAction",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "action",\r "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data1",\r "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data2",\r "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data3",\r "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "data6",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Creates a new \"AND\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAllCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Creates a new \"OR\"condition",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addAnyCondition",\r "group": "Triggers",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "field",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "value",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/actions",\r "title": "Gets Trigger Actions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getActions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/all_conditions",\r "title": "Gets \"AND\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAllConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "get",\r "url": "/api/triggers/{id}/any_conditions",\r "title": "Gets \"OR\" Trigger Conditions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAnyConditions",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "put",\r "url": "/api/triggers/{id}",\r "title": "Update an existing Trigger",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateTriggers",\r "group": "Triggers",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trigger/index.js",\r "groupTitle": "Triggers"\r },\r {\r "type": "post",\r "url": "/api/trunks",\r "title": "Create a new trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Trunks",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"friend\"",\r "\"user\"",\r "\"peer\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ALLOWED_NOT_SCREENED\"",\r "\"ALLOWED_PASSED_SCREEN\"",\r "\"ALLOWED_FAILED_SCREEN\"",\r "\"ALLOWED\"",\r "\"PROHIB_NOT_SCREENED\"",\r "\"PROHIB_PASSED_SCREEN\"",\r "\"PROHIB_FAILED_SCREEN\"",\r "\"PROHIB\""\r ],\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "permit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "md5secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotesecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transport",\r "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rfc2833\"",\r "\"info\"",\r "\"shortinfo\"",\r "\"inband\"",\r "\"auto\""\r ],\r "optional": true,\r "field": "dtmfmode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"outgoing\""\r ],\r "optional": true,\r "field": "directmedia",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "directrtpsetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediapermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediadeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nat",\r "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedcallgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedpickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tonezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disallow",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "allow",\r "description": "<p>String is deprecated. Please use an Array as ["alaw", "ulaw", "gsm"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autoframing",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "insecure",\r "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trustrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trust_id_outbound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"never\""\r ],\r "optional": true,\r "field": "progressinband",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "promiscredir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "useclientcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "setvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "callcounter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "busylevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowoverlap",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowsubscribe",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowtransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ignoresdpversion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subscribecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "template",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"always\""\r ],\r "optional": true,\r "field": "videosupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxcallbitrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "rfc2833compensate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"accept\"",\r "\"refuse\"",\r "\"originate\""\r ],\r "optional": true,\r "field": "session_timers",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_expires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_minse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"uac\"",\r "\"uas\""\r ],\r "optional": true,\r "field": "session_refresher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_usertpsource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromdomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "qualify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "keepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtptimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpholdtimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpkeepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "sendrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "outboundproxy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackextension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timert1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timerb",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "qualifyfreq",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactpermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactdeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactacl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unsolicited_mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "use_q850_reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxforwards",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "encryption",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "avpf",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "force_avp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "icesupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "dtlsenable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"fingerprint\"",\r "\"certificate\""\r ],\r "optional": true,\r "field": "dtlsverify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dtlsrekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscertfile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsprivatekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscipher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscafile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscapath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"active\"",\r "\"passive\"",\r "\"actpass\""\r ],\r "optional": true,\r "field": "dtlssetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsfingerprint",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "usereqphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordonfeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordofffeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "call_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "registertrying",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "subscribemwi",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vmexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohinterpret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohsuggest",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parkinglot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"update,nonat\""\r ],\r "optional": true,\r "field": "canreinvite",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "registry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "otherFields",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": false,\r "field": "active",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "delete",\r "url": "/api/trunks/{id}",\r "title": "Deletes a trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks",\r "title": "Gets a list of Trunks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTrunks",\r "group": "Trunks",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "get",\r "url": "/api/trunks/{id}",\r "title": "Gets a single Trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTrunks",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "put",\r "url": "/api/trunks/{id}",\r "title": "Update an existing trunk",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Trunks",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/trunk/index.js",\r "groupTitle": "Trunks"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/contacts",\r "title": "Add contacts to a user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/queues",\r "title": "Add queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/create_many",\r "title": "Creates many Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "BulkCreateUsers",\r "group": "Users",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": "<p>The name of the user</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "fullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"admin\"",\r "\"user\"",\r "\"agent\"",\r "\"telephone\""\r ],\r "optional": false,\r "field": "role",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "provider",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "internal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "salt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "phone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mobile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "address",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "zipcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userpic",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "city",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "country",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "online",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastLoginAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "voicePause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "chatPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "mailPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "faxPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "smsPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "openchannelPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pauseType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastPauseAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "chatCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "mailCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "faxCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "smsCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "openchannelCapacity",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarAutoAnswer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarEnableSettings",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarListenPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarExpires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarRemoteControl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "phoneBarRemoteControlPort",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarEnableRecording",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "phoneBarRingInUse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "chanspy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "host",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "ipaddr",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "port",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "regseconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fullcontact",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regserver",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "useragent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "lastms",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"friend\"",\r "\"user\"",\r "\"peer\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ALLOWED_NOT_SCREENED\"",\r "\"ALLOWED_PASSED_SCREEN\"",\r "\"ALLOWED_FAILED_SCREEN\"",\r "\"ALLOWED\"",\r "\"PROHIB_NOT_SCREENED\"",\r "\"PROHIB_PASSED_SCREEN\"",\r "\"PROHIB_FAILED_SCREEN\"",\r "\"PROHIB\""\r ],\r "optional": true,\r "field": "callingpres",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "deny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "permit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "md5secret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remotesecret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transport",\r "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"rfc2833\"",\r "\"info\"",\r "\"shortinfo\"",\r "\"inband\"",\r "\"auto\""\r ],\r "optional": true,\r "field": "dtmfmode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"outgoing\""\r ],\r "optional": true,\r "field": "directmedia",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "directrtpsetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediapermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "directmediadeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nat",\r "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedcallgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "namedpickupgroup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "language",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tonezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "disallow",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "allow",\r "description": "<p>String is deprecated. Please use an Array as ["alaw", "ulaw", "gsm"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autoframing",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "insecure",\r "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trustrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "trust_id_outbound",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"never\""\r ],\r "optional": true,\r "field": "progressinband",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "promiscredir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "useclientcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "setvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "callcounter",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "busylevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowoverlap",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowsubscribe",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "allowtransfer",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ignoresdpversion",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "subscribecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "template",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"always\""\r ],\r "optional": true,\r "field": "videosupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxcallbitrate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "rfc2833compensate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"accept\"",\r "\"refuse\"",\r "\"originate\""\r ],\r "optional": true,\r "field": "session_timers",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_expires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "session_minse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"uac\"",\r "\"uas\""\r ],\r "optional": true,\r "field": "session_refresher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "t38pt_usertpsource",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "regexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromdomain",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fromuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "qualify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "keepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultip",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtptimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpholdtimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rtpkeepalive",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "sendrpid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "outboundproxy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callbackextension",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timert1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timerb",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "qualifyfreq",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactpermit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactdeny",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "contactacl",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "unsolicited_mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "use_q850_reason",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxforwards",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "encryption",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "avpf",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "force_avp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "icesupport",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "dtlsenable",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"fingerprint\"",\r "\"certificate\""\r ],\r "optional": true,\r "field": "dtlsverify",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dtlsrekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscertfile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsprivatekey",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscipher",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscafile",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlscapath",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"active\"",\r "\"passive\"",\r "\"actpass\""\r ],\r "optional": true,\r "field": "dtlssetup",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dtlsfingerprint",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "usereqphone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordonfeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordofffeature",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "call_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "registertrying",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "subscribemwi",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "vmexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohinterpret",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mohsuggest",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "parkinglot",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"nonat\"",\r "\"update\"",\r "\"update,nonat\""\r ],\r "optional": true,\r "field": "canreinvite",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "loginInPause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resetPasswordToken",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "resetPasswordExpires",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "showWebBar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Text",\r "optional": true,\r "field": "permissions",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/destroy_many?ids={ids}",\r "title": "Deletes many Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "BulkDeleteUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}/password",\r "title": "Change user password",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "ChangePwd",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users",\r "title": "Create a new user",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}",\r "title": "Deletes a User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/describe",\r "title": "Gets table info about Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeUsers",\r "group": "Users",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/contacts",\r "title": "GetContacts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContacts",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/lists",\r "title": "GetLists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues?channel={channel}",\r "title": "Gets Queues list",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/recordings",\r "title": "GetRecordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/teams",\r "title": "GetTeams",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users",\r "title": "Gets a list of Users",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetUsers",\r "group": "Users",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/queues_rt",\r "title": "GetVoiceQueuesRt",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesRt",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/login",\r "title": "Login",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Login",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/logout",\r "title": "Logout",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Logout",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/pause",\r "title": "Pause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Pause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "delete",\r "url": "/api/users/{id}/queues",\r "title": "Remove queues to an agent",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveQueues",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}",\r "title": "Gets a single User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/unpause",\r "title": "Unpause",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "Unpause",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/users/{id}/avatar",\r "title": "Add avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "addAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "get",\r "url": "/api/users/{id}/avatar",\r "title": "Get avatar",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getAvatar",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "put",\r "url": "/api/users/{id}",\r "title": "Update an existing User",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateUsers",\r "group": "Users",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/user/index.js",\r "groupTitle": "Users"\r },\r {\r "type": "post",\r "url": "/api/variables",\r "title": "Creates a new Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVariables",\r "group": "Variables",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "delete",\r "url": "/api/variables/{id}",\r "title": "Deletes a Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables",\r "title": "Gets a list of Variables",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVariables",\r "group": "Variables",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/variables/{id}",\r "title": "Gets a single Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "put",\r "url": "/api/variables/{id}",\r "title": "Update an existing Variable",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVariables",\r "group": "Variables",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/variable/index.js",\r "groupTitle": "Variables"\r },\r {\r "type": "get",\r "url": "/api/version/fetch",\r "title": "Fetch git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "FetchVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git fetch origin master</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version",\r "title": "Gets version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVersion",\r "group": "Version",\r "description": "<p>Motion returns the current and latest motion version.</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/pull",\r "title": "Pull git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "PullVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git pull</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/reset",\r "title": "Reset git version",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ResetVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/version/restart",\r "title": "Restart motion2 after update",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "RestartVersion",\r "group": "Version",\r "description": "<p>Motion run the following command: pm2 restart motion</p>",\r "version": "0.0.0",\r "filename": "server/api/version/index.js",\r "groupTitle": "Version"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/describe",\r "title": "Gets table info about Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeAgent_Reports",\r "group": "Voice_Agent_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports",\r "title": "Gets a list of Agent Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/agents/reports/{id}",\r "title": "Gets a single Agent Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowAgent_Reports",\r "group": "Voice_Agent_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceAgentReport/index.js",\r "groupTitle": "Voice_Agent_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/describe",\r "title": "Gets table info about Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeCall_Reports",\r "group": "Voice_Call_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports",\r "title": "Gets a list of Call Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Gets a single Call Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCall_Reports",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/calls/reports/{id}",\r "title": "Update a single cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Call_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceCallReport/index.js",\r "groupTitle": "Voice_Call_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/chanspy",\r "title": "Creates a new ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateChanSpy",\r "group": "Voice_ChanSpy",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "prefix",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "options",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "auth",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "record",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "recordingFormat",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "delete",\r "url": "/api/voice/chanspy/{id}",\r "title": "Deletes a ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy",\r "title": "Gets a list of ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "get",\r "url": "/api/voice/chanspy/{id}",\r "title": "Gets a single ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "put",\r "url": "/api/voice/chanspy/{id}",\r "title": "Update an existing ChanSpy",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateChanSpy",\r "group": "Voice_ChanSpy",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceChanSpy/index.js",\r "groupTitle": "Voice_ChanSpy"\r },\r {\r "type": "post",\r "url": "/api/voice/contexts",\r "title": "Create a new context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "Create",\r "group": "Voice_Contexts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "defaultEntry",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "delete",\r "url": "/api/voice/contexts/{id}",\r "title": "Deletes a context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "Delete",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts",\r "title": "Gets a list of Contexts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/contexts/{id}",\r "title": "Gets a single Context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowContexts",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "put",\r "url": "/api/voice/contexts/{id}",\r "title": "Update an existing context",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "Update",\r "group": "Voice_Contexts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceContext/index.js",\r "groupTitle": "Voice_Contexts"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/describe",\r "title": "Gets table info about Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeDial_Reports",\r "group": "Voice_Dial_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports",\r "title": "Gets a list of Dial Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/dials/reports/{id}",\r "title": "Gets a single Dial Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDial_Reports",\r "group": "Voice_Dial_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDialReport/index.js",\r "groupTitle": "Voice_Dial_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/dispositions",\r "title": "Creates a new Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateDispositions",\r "group": "Voice_Dispositions",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/voice/dispositions/{id}",\r "title": "Deletes a Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/voice/dispositions",\r "title": "Gets a list of Dispositions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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/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/voice/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/voice/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/voice/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/voice/dispositions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "get",\r "url": "/api/voice/dispositions/{id}",\r "title": "Gets a single Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "put",\r "url": "/api/voice/dispositions/{id}",\r "title": "Update an existing Disposition",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateDispositions",\r "group": "Voice_Dispositions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceDisposition/index.js",\r "groupTitle": "Voice_Dispositions"\r },\r {\r "type": "delete",\r "url": "/api/voice/extensions/{id}",\r "title": "Deletes a Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions",\r "title": "Gets a list of Extensions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "get",\r "url": "/api/voice/extensions/{id}",\r "title": "Gets a single Extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowExtensions",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create new applications",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addApplications",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/extensions",\r "title": "Create an extension",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "create",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "put",\r "url": "/api/voice/extensions/{id}",\r "title": "Update an extension",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "update",\r "group": "Voice_Extensions",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceExtension/index.js",\r "groupTitle": "Voice_Extensions"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs",\r "title": "Create a new a new MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Add sound to MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}",\r "title": "Deletes an MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DestroyMoh",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs",\r "title": "Gets a list of Music On Holds",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}/sounds",\r "title": "Gets sounds from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "GetSounds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "delete",\r "url": "/api/voice/mohs/{id}/sounds/{id2}",\r "title": "Remove sound from MOH",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveSound",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "get",\r "url": "/api/voice/mohs/{id}",\r "title": "Gets a single Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "put",\r "url": "/api/voice/mohs/{id}",\r "title": "Update an existing Music On Hold",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMusic_On_Holds",\r "group": "Voice_MOHs",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMusicOnHold/index.js",\r "groupTitle": "Voice_MOHs"\r },\r {\r "type": "post",\r "url": "/api/voice/mails",\r "title": "Creates a new Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateMails",\r "group": "Voice_Mails",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "customer_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "mailbox",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "fullname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "email",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "pager",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tz",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "attach",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "saycid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callback",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "review",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "operator",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "envelope",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sayduration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "saydurationm",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "sendvoicemail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "delete",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "nextaftercmd",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "forcegreetings",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": false,\r "field": "hidefromdir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "stamp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailsubject",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "emailbody",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxsecs",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "maxmsg",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/{id}",\r "title": "Deletes a Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails",\r "title": "Gets a list of Mails",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}",\r "title": "Gets a single Mail",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/{id}/messages",\r "title": "Gets voice mail messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getMessages",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/{id}",\r "title": "Update an existing Mail",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMails",\r "group": "Voice_Mails",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMail/index.js",\r "groupTitle": "Voice_Mails"\r },\r {\r "type": "post",\r "url": "/api/voice/mails/messages",\r "title": "Creates a new Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateMessages",\r "group": "Voice_Messages",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "msgnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dir",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "macrocontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "callerid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "origtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxuser",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "mailboxcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Blob",\r "optional": true,\r "field": "recording",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "flag",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "msg_id",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "stamp",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "delete",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Deletes a Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages",\r "title": "Gets a list of Messages",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Gets a single Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "voice/mails/messages/{id}/download",\r "title": "Download Voice Message",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "put",\r "url": "/api/voice/mails/messages/{id}",\r "title": "Update an existing Message",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateMessages",\r "group": "Voice_Messages",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceMailMessage/index.js",\r "groupTitle": "Voice_Messages"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/describe",\r "title": "Gets table info about Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeQueue_Reports",\r "group": "Voice_Queue_Reports",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports",\r "title": "Gets a list of Queue Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/reports/{id}",\r "title": "Gets a single Queue Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueue_Reports",\r "group": "Voice_Queue_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueueReport/index.js",\r "groupTitle": "Voice_Queue_Reports"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/users",\r "title": "Add agents to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Add blacklists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/black_lists",\r "title": "Add black lists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/black_lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "AddBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Add lists to a queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Add teams to queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "AddTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/queues",\r "title": "Creates a new Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateQueues",\r "group": "Voice_Queues",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"inbound\"",\r "\"outbound\""\r ],\r "optional": false,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "musiconhold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"ringall\"",\r "\"leastrecent\"",\r "\"fewestcalls\"",\r "\"random\"",\r "\"rrmemory\"",\r "\"linear\"",\r "\"wrandom\"",\r "\"rrordered\""\r ],\r "optional": false,\r "field": "strategy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "servicelevel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "penaltymemberslimit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "timeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "retry",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "timeoutpriority",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "weight",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "wrapuptime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autofill",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"all\""\r ],\r "optional": true,\r "field": "autopause",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "autopausedelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopausebusy",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "autopauseunavail",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "maxlen",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setinterfacevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueueentryvar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "setqueuevar",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "eventmemberstatus",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membermacro",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membergosub",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "min_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "periodic_announce_frequency",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "random_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "relative_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\"",\r "\"once\""\r ],\r "optional": true,\r "field": "announce_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "announce_position",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "announce_to_first_user",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "announce_position_limit",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"0\"",\r "\"5\"",\r "\"10\"",\r "\"15\"",\r "\"20\"",\r "\"30\""\r ],\r "optional": true,\r "field": "announce_round_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "monitor_type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_youarenext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thereare",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_callswaiting",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_holdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minute",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_minutes",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_seconds",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_thankyou",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_reporthold",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_quantity2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue_less_than",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "periodic_announce",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "joinempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "leavewhenempty",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "reportholdtime",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "ringinuse",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "memberdelay",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"yes\"",\r "\"no\""\r ],\r "optional": true,\r "field": "timeoutrestart",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "defaultrule",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "acw",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "acwTimeout",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "dialActive",\r "description": "<p>Active/Disactive Campaign</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"preview\"",\r "\"progressive\"",\r "\"power\"",\r "\"predictive\""\r ],\r "optional": true,\r "field": "dialMethod",\r "description": "<p>Dial Method.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitChannel",\r "description": "<p>Max 9999 channels, 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialLimitQueue",\r "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPowerLevel",\r "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"agentBusyFactor\"",\r "\"dropRate\""\r ],\r "optional": true,\r "field": "dialPredictiveOptimization",\r "description": "<p>Only for predictive method.</p>"\r },\r {\r "group": "Body",\r "type": "Float",\r "optional": true,\r "field": "dialPredictiveOptimizationPercentage",\r "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialPredictiveInterval",\r "description": "<p>Intervall Predictive Minutes (min:5 max:30)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdName",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialOriginateCallerIdNumber",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialOriginateTimeout",\r "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueOptions",\r "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialQueueTimeout",\r "description": "<p>Queue Timeout Seconds (min:1, max:99)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialQueueProject",\r "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionMaxRetry",\r "description": "<p>#Congestion Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialCongestionRetryFrequency",\r "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyMaxRetry",\r "description": "<p>#Busy Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialBusyRetryFrequency",\r "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerMaxRetry",\r "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialNoAnswerRetryFrequency",\r "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "dialGlobalMaxRetry",\r "description": "<p>#Global Max Retry (min:1, max:999)</p>"\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialTimezone",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dialGlobalInterval",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}",\r "title": "Deletes a Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/users",\r "title": "Gets queue agents",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Get queue blacklists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/finals",\r "title": "Gets queue hopper finals",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperFinals",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hopper_histories",\r "title": "Gets queue hopper histories",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHopperHistories",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/hoppers",\r "title": "Gets queue hoppers",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetHoppers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Get queue lists",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/members",\r "title": "Gets queue members",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetMembers",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues",\r "title": "Gets a list of Queues",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/teams",\r "title": "Gets queue team",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "GetTeams",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/users",\r "title": "Removes agents from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveAgents",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/black_lists",\r "title": "Remove black lists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/black_lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/blacklists",\r "title": "Remove blacklists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveBlackLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "delete",\r "url": "/api/voice/queues/{id}/lists",\r "title": "Remove lists from a queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "RemoveLists",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}",\r "title": "Gets a single Queue",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "get",\r "url": "/api/voice/queues/{id}/blacks",\r "title": "Gets queue hopper blacks",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getHopperBlacks",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "put",\r "url": "/api/voice/queues/{id}",\r "title": "Update an existing Queue",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateQueues",\r "group": "Voice_Queues",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueue/index.js",\r "groupTitle": "Voice_Queues"\r },\r {\r "type": "post",\r "url": "/api/voice/recordings",\r "title": "Creates a new Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateRecordings",\r "group": "Voice_Recordings",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "Virtual",\r "optional": true,\r "field": "format",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "membername",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "calleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "connectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "exten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "value",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": true,\r "field": "rating",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "queue",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "createdAt",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "updatedAt",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "delete",\r "url": "/api/voice/recordings/{id}",\r "title": "Deletes a Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/describe",\r "title": "Gets table info about Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "DescribeRecordings",\r "group": "Voice_Recordings",\r "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>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings",\r "title": "Gets a list of Recordings",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}",\r "title": "Gets a single Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "get",\r "url": "/api/voice/recordings/{id}/download",\r "title": "Download Recording",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "download",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "put",\r "url": "/api/voice/recordings/{id}",\r "title": "Update an existing Recording",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateRecordings",\r "group": "Voice_Recordings",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceRecording/index.js",\r "groupTitle": "Voice_Recordings"\r },\r {\r "type": "post",\r "url": "/api/voice/transfers/reports",\r "title": "Creates a new Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"blind\"",\r "\"attended\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "result",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereraccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transferercontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfererlinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereechannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridnum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecalleridname",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinenum",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeconnectedlinename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeaccountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereecontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereeexten",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "transfereelinkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"Yes\"",\r "\"No\""\r ],\r "optional": true,\r "field": "isexternal",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "context",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "extension",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "delete",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Deletes a Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports",\r "title": "Gets a list of Transfer Reports",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "get",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Gets a single Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "put",\r "url": "/api/voice/transfers/reports/{id}",\r "title": "Update an existing Transfer Report",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateTransfer_Reports",\r "group": "Voice_Transfer_Reports",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceTransferReport/index.js",\r "groupTitle": "Voice_Transfer_Reports"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Creates a new Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "username",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "password",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "token",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "remoteUri",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"password\"",\r "\"token\""\r ],\r "optional": true,\r "field": "authType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "serverUrl",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Deletes a Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts",\r "title": "Gets a list of Zendesk Accounts",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Gets a single Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Creates new configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "addConfiguration",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/configurations",\r "title": "Gets account configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getConfigurations",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/accounts/{id}/fields",\r "title": "Gets account fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/accounts/{id}",\r "title": "Update an existing Zendesk Account",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Accounts",\r "group": "Zendesk_Accounts",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskAccount/index.js",\r "groupTitle": "Zendesk_Accounts"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Creates a new Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "name",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "description",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Deletes a Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations",\r "title": "Gets a list of Zendesk Configurations",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Gets a single Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/descriptions",\r "title": "Gets configurations descriptions",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getDescriptions",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/fields",\r "title": "Gets configurations fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getFields",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/subjects",\r "title": "Gets configurations subjects",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getSubjects",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Gets configurations tags",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",\r "type": "json"\r }\r ],\r "name": "getTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/configurations/{id}/tags",\r "title": "Sets new tags",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "setTags",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/configurations/{id}",\r "title": "Update an existing Zendesk Configuration",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Configurations",\r "group": "Zendesk_Configurations",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskConfiguration/index.js",\r "groupTitle": "Zendesk_Configurations"\r },\r {\r "type": "post",\r "url": "/api/integrations/zendesk/fields",\r "title": "Creates a new Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "CreateZendesk_Fields",\r "group": "Zendesk_Fields",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\"",\r "\"keyValue\""\r ],\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "content",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "key",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "allowedValues": [\r "\"string\"",\r "\"variable\"",\r "\"customVariable\""\r ],\r "optional": true,\r "field": "keyType",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "keyContent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "idField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "nameField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Boolean",\r "optional": true,\r "field": "customField",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "variableName",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "delete",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Deletes a Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields",\r "title": "Gets a list of Zendesk Fields",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "get",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Gets a single Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "put",\r "url": "/api/integrations/zendesk/fields/{id}",\r "title": "Update an existing Zendesk Field",\r "examples": [\r {\r "title": "Example usage:",\r "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",\r "type": "json"\r }\r ],\r "name": "updateZendesk_Fields",\r "group": "Zendesk_Fields",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/intZendeskField/index.js",\r "groupTitle": "Zendesk_Fields"\r },\r {\r "type": "post",\r "url": "/api/cdr",\r "title": "Creates a new Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateCdrs",\r "group": "cdr",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "calldate",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "clid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "src",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dst",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dcontext",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "channel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "dstchannel",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastapp",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "lastdata",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "duration",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "billsec",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "disposition",\r "description": ""\r },\r {\r "group": "Body",\r "type": "Integer",\r "optional": false,\r "field": "amaflags",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "accountcode",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "userfield",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "uniqueid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "linkedid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "sequence",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "peeraccount",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "type",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "tag",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "delete",\r "url": "/api/cdr/{id}",\r "title": "Deletes a Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr",\r "title": "Gets a list of Cdrs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetCdrs",\r "group": "cdr",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "get",\r "url": "/api/cdr/{id}",\r "title": "Gets a single Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "put",\r "url": "/api/cdr/{id}",\r "title": "Update an existing Cdr",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateCdrs",\r "group": "cdr",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/cdr/index.js",\r "groupTitle": "cdr"\r },\r {\r "type": "post",\r "url": "/api/voiceQueuesLog",\r "title": "Creates a new VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",\r "type": "json"\r }\r ],\r "name": "CreateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "parameter": {\r "fields": {\r "Body": [\r {\r "group": "Body",\r "type": "String",\r "optional": true,\r "field": "time",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "callid",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "queuename",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "agent",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "event",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data1",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data2",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data3",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data4",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "data5",\r "description": ""\r },\r {\r "group": "Body",\r "type": "String",\r "optional": false,\r "field": "dtm",\r "description": ""\r }\r ]\r }\r },\r "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "delete",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Deletes a VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",\r "type": "json"\r }\r ],\r "name": "DeleteVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog",\r "title": "Gets a list of VoiceQueuesLogs",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "GetVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "get",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Gets a single VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",\r "type": "json"\r }\r ],\r "name": "ShowVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r },\r {\r "type": "put",\r "url": "/api/voiceQueuesLog/{id}",\r "title": "Update an existing VoiceQueuesLog",\r "examples": [\r {\r "title": "Example usage:",\r "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",\r "type": "json"\r }\r ],\r "name": "updateVoiceQueuesLogs",\r "group": "voiceQueuesLog",\r "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",\r "version": "0.0.0",\r "filename": "server/api/voiceQueuesLog/index.js",\r "groupTitle": "voiceQueuesLog"\r }\r]