AccuTrace
API for use with AccuZip's AccuTrace postal mail tracking service. For more information, see: http://www.accuzip.com/accutrace/index.htm
Base URI
https://
{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest
your prefix
string
required
Example:
https://demo.iaccutrace.com/servoy-service/rest_ws/mod_rest
appDirectory
string
optional
accutrace-html5
Operations:
Upload for Create or Update LIVINGMAIL
-
date parameter needs to be the last in request URL. Forward slash is part of the data being passed in as parameters, and not meant to be a part of the url as a folder, you have to double url encode it. The double url encoded value of a forward slash is: %252F, example: 02/02 -> 02%252F02
-
MANDATORY (VERY IMPORTANT) ? (question mark) in request needs to be removed. Otherwise the RESTful API will fail.
example: incorrect (has ‘?’): GET http://localhost:8080/servoy-service/rest_ws_rest/ws_job_reports/{{token}}/?jobId=246008
example: correct (’?’ removed) GET http://localhost:8080/servoy-service/rest_ws_rest/ws_job_reports/{{token}}/jobId=246008
Version Test
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
reportNumber
string
required
In Home Delivery Performances report number 2.
Example:
2
jobId
number
required
Example:
246008
level
string
optional
Maximum number of levels for this report is 2.
Example:
1
getDataSet
string
optional
true
getChart
string
optional
true
detailedInfo
string
optional
true
subBarcode
string
optional
testbar
subImbd
string
optional
testimbd
status
string
optional
Required for level 2.
Example:
[Not Scanned | Early | On Time | Late | En Route]
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=2&jobId=246008&level=1&getDataSet=true&getChart=true&detailedInfo=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 5,
"totalRowsCountAndSumDisplay": "Total Rows: 5, Sum: 4",
"dataset": {
"columnCount": 4,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 5,
"columnNames": [
"status",
"count",
"percent",
"rightspace"
],
"rows": [
[
"Not Scanned",
1,
"25.0%",
null
],
[
"Early",
1,
"25.0%",
null
],
[
"On Time",
0,
"0%",
null
],
[
"Late",
0,
"0%",
null
],
[
"En Route",
2,
"50.0%",
null
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[1,1,0,0,2], ['Not Scanned', 'Early', 'On Time', 'Late', 'En Route'], 'Date', 'Scans', '900', '290', 'PieChart', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[1,1,0,0,2]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"#%%color_inhome_not_scanned%%\", \"#%%color_inhome_early%%\", \"#%%color_inhome_on_time%%\", \"#%%color_inhome_late%%\", \"#%%color_inhome_en_route%%\"]}",
"chartType": "PieChart",
"yAxisLabel": "Scans",
"title": "",
"dataLabels": "['Not Scanned', 'Early', 'On Time', 'Late', 'En Route']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "Date",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"status"
],
"name": "In Home Delivery Performance",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446035283277,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=2&jobId=246008&level=2&getDataSet=true&detailedInfo=true&status=Not Scanned/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 4,
"columnTypes": [
12,
12,
12,
93
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date"
],
"rows": [
[
"16038210242",
"01311201109533327734",
" ",
null
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "In Home Delivery Performance",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446054755039,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by First Scan Date report number is 3.
Example:
3
level
number
required
Maximum number of levels for this report is 2.
Example:
1
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
date
string
required
Required for level 2. M/DD format. MUST be the last parameter in request. Need to encode last parameter date / (slash) -> %252F
Example:
5/18 and encoded => 5%252F18
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=3&level=1&getDataSet=true&getChart=true&detailedInfo=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 3,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"scanned_date",
"total",
"rightspace"
],
"rows": [
[
"10/27",
2,
""
],
[
"10/28",
1,
""
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[2,1], ['10/27','10/28'], 'Date', 'Scans', '900', '290', 'ColumnChart', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[2,1]",
"elementToMatchSize": null,
"colorOptions": null,
"chartType": "ColumnChart",
"yAxisLabel": "Scans",
"title": "",
"dataLabels": "['10/27','10/28']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "Date",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"date"
],
"name": "Results by First Scan Date",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446049629393,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}Rest GET and JSON Response. (format for date 10/27 => 10%252F27)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=3&getDataSet=true&getChart=false&detailedInfo=true&level=2&date=10%252F27/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 4,
"columnTypes": [
12,
12,
12,
93
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"scanned_first"
],
"rows": [
[
"18222161656",
"01311201109533327735",
" ",
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
}
],
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1445968594000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by First Scan Date",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446055888575,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobid
number
required
Example:
246008
reportNumber
number
required
Out for Delivery report number is 5.
Example:
5
level
number
required
Maximum number of levels for this report is 2.
Example:
1
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
date
string
required
Required for level 2. M/DD format. MUST be the last parameter in request. Need to encode last parameter date / (slash) -> %252F
Example:
5/18 and encoded: 05%252F18
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=5&level=1&getDataSet=true&detailedInfo=true&getChart=true/ HTTP/1.1
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1, Sum: 1",
"dataset": {
"columnCount": 2,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"scanned_date",
"total"
],
"rows": [
[
"10/28",
1
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[1], ['10/28'], 'Date', 'Pieces', '900', '290', 'ColumnChart', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[1]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"#%%color_bar_chart%%\"]}",
"chartType": "ColumnChart",
"yAxisLabel": "Pieces",
"title": "",
"dataLabels": "['10/28']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "Date",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"date"
],
"name": "Out for Delivery (by Date)",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446049629441,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}
HTTP/1.1 200 OK (format for date 10/28 => 10%252F28)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=5&getDataSet=true&getChart=false&detailedInfo=true&level=2&date=10%252F28/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
12,
93,
93
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"scanned_first",
"scanned_last"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446021097000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446025800000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Out for Delivery (by Date)",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446061052652,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
702145
reportNumber
number
required
Results by First Scan Date report number is 4.
Example:
4
level
number
required
Maximum number of levels for this report is 1.
Example:
1
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=4&level=1&getDataSet=true&getChart=true&detailedInfo=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 4,
"columnTypes": [
12,
12,
12,
93
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446025800000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Out for Delivery (Today)",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446063966592,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 1
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
702145
reportNumber
number
required
Out for Delivery (All) report number is 6.
Example:
6
level
number
required
Maximum number of levels for this report is 1.
Example:
1
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
page
string
optional
If not provided returns all data.
Example:
1
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=6&level=1&getDataSet=true&detailedInfo=true&page=1/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 4,
"columnTypes": [
12,
12,
12,
93
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446025800000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Out for Delivery (All)",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446061797025,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 1
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
702145
reportNumber
number
required
Results by State report number is 7.
Example:
7
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
state
string
required
Required for level 2.
Example:
CA
zip
string
required
Required for levels 3 and 4.
Example:
93422
page
string
optional
If not provided returns all data.
Example:
1
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=7&level=1&getDataSet=true&getChart=true&detailedInfo=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 5,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"name",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"NY",
"1.00",
1,
1,
"100.00%"
],
[
"PA",
"0.50",
3,
2,
"66.67%"
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[100.00,66.67], ['NY','PA'], 'State', 'Percent', '900', '290', 'GeoMap', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[100.00,66.67]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"0x%%color_chart_gradient_light%%\", \"0x%%color_chart_gradient_dark%%\"], \"mapColor\": \"%%color_chart_gradient_dark%%\"}",
"chartType": "GeoMap",
"yAxisLabel": "Percent",
"title": "",
"dataLabels": "['NY','PA']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "State",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"state"
],
"name": "Results by State",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446668871169,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=7&level=2&getDataSet=true&detailedInfo=true&getChart=false&state=NY/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"145",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by State",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446670322724,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=7&level=3&getDataSet=true&detailedInfo=true&getChart=false&zip=145/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"14572",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by State",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446670614819,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=7&level=4&getDataSet=true&detailedInfo=true&getChart=false&zip=14572/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by State",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446670876109,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
702145
reportNumber
number
required
Results by County report number is 8.
Example:
8
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
state
string
required
Required for levels 2 and 3.
Example:
CA
zip
string
required
Required for levels 3 and 4.
Example:
019 FRESNO (level 3), 93422 (level 4)
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=8&level=1&getDataSet=true&getChart=true&detailedInfo=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 5,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"name",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"NY",
"1.00",
1,
1,
"100.00%"
],
[
"PA",
"0.50",
3,
2,
"66.67%"
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[100.00,66.67], ['NY','PA'], 'State', 'Percent', '900', '290', 'GeoMap', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[100.00,66.67]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"0x%%color_chart_gradient_light%%\", \"0x%%color_chart_gradient_dark%%\"], \"mapColor\": \"%%color_chart_gradient_dark%%\"}",
"chartType": "GeoMap",
"yAxisLabel": "Percent",
"title": "",
"dataLabels": "['NY','PA']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "State",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"state"
],
"name": "Results by County",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446668871169,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": true,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=8&level=2&getDataSet=true&getChart=true&detailedInfo=true&state=NY/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
-5,
-5,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"county",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage",
"county_number"
],
"rows": [
[
"101 STEUBEN",
"1.00",
1,
1,
"100.00%",
"101"
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[100.00], ['101'], 'County', 'Percent', '900', '290', 'GeoMapNY', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[100.00]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"0x%%color_chart_gradient_light%%\", \"0x%%color_chart_gradient_dark%%\"], \"mapColor\": \"%%color_chart_gradient_dark%%\"}",
"chartType": "GeoMapNY",
"yAxisLabel": "Percent",
"title": "",
"dataLabels": "['101']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "County",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip",
"parent.state"
],
"name": "Results by County",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446671873841,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=8&level=3&getDataSet=true&getChart=false&detailedInfo=true&state=NY&zip=101/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"14572",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by County",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446838536591,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=8&level=4&getDataSet=true&detailedInfo=true&getChart=false&zip=14572/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by County",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446673138177,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by County report number is 9.
Example:
9
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
ndc
string
required
Required for level 2.
Example:
NDC DETROIT
state
string
required
Required for level 2.
Example:
CA
zip
string
required
Required for levels 2, 3 and 4.
Example:
page
string
optional
If not provided returns all data.
Example:
1
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=9&level=1&getDataSet=true&detailedInfo=true&getChart=true/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 3,
"totalRowsCountAndSumDisplay": "Total Rows: 3",
"dataset": {
"columnCount": 7,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 3,
"columnNames": [
"name",
"state",
"zipcode",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"ASF BUFFALO",
"NY",
"140",
"1.00",
1,
1,
"100.00%"
],
[
"NDC PHILA",
"PA",
"19205",
"0.50",
2,
2,
"100.00%"
],
[
"NDC PITTSBURGH",
"PA",
"15195",
null,
1,
0,
"0.00%"
]
]
},
"chart": {
"div_id": "chart_div",
"js": "drawChartFusion('', \"return null;\",[[100,100,0],[0,0,-100]], ['ASF BUFFALO','NDC PHILA','NDC PITTSBURGH'], 'NDC', 'Percent', '900', '290', 'ColumnChart', '', '','chart_div');",
"html5": "<div id='chart_div'></div>",
"properties": {
"width": 900,
"data": "[[100,100,0],[0,0,-100]]",
"elementToMatchSize": null,
"colorOptions": "{\"colors\": [\"#%%color_bar_chart%%\"]}",
"chartType": "ColumnChart",
"yAxisLabel": "Percent",
"title": "",
"dataLabels": "['ASF BUFFALO','NDC PHILA','NDC PITTSBURGH']",
"height": 290,
"callback": "return null;",
"xAxisLabel": "NDC",
"options": "''",
"divId": "chart_div"
}
},
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"ndc",
"state",
"zip"
],
"name": "Results by NDC",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446731747651,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=9&level=2&getDataSet=true&getChart=false&detailedInfo=true&ndc=NDC PHILA&state=PA&zip=19205/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"182",
"0.00",
1,
1,
"100.00%"
],
[
"188",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by NDC",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446733407653,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=9&getChart=false&getDataSet=true&detailedInfo=true&level=3&zip=188/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"18801",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by NDC",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446736555092,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=9&level=4&getChart=false&getDataSet=true&detailedInfo=true&zip=18801/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by NDC",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446737216885,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by SCF report number is 10.
Example:
10
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
scf
string
required
Required for level 2.
Example:
SCF BALTIMORE
state
string
required
Required for level 2.
Example:
MD
zip
string
required
Required for levels 2, 3 and 4.
Example:
021 (level 2), 02136 (levels 3 and 4)
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=10&getDataSet=true&detailedInfo=true&getChart=false&level=1/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 3,
"totalRowsCountAndSumDisplay": "Total Rows: 3",
"dataset": {
"columnCount": 7,
"columnTypes": [
12,
12,
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 3,
"columnNames": [
"name",
"state",
"zipcode",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"SCF LEHIGH VALLEY",
"PA",
"180",
"0.50",
2,
2,
"100.00%"
],
[
"SCF PITTSBURGH",
"PA",
"150",
null,
1,
0,
"0.00%"
],
[
"SCF ROCHESTER",
"NY",
"144",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"scf",
"state",
"zip"
],
"name": "Results by SCF",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446738543414,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=10&getDataSet=true&getChart=false&detailedInfo=true&level=2&scf=SCF LEHIGH VALLEY&state=PA&zip=180/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"182",
"0.00",
1,
1,
"100.00%"
],
[
"188",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by SCF",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446739593358,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=10&getDataSet=true&getChart=false&detailedInfo=true&level=3&zip=188/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"18801",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by SCF",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446740060939,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=10&getDataSet=true&getChart=false&detailedInfo=true&level=4&zip=18801/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by SCF",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446740375282,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by 3-Digit ZIP Code report number is 11.
Example:
11
level
number
required
Maximum number of levels for this report is 3.
Example:
3
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
zip
string
optional
Required for levels 2 and 3.
Example:
012 (level 2), 02136 (level 3)
page
string
optional
If not provided returns all data.
Example:
1
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=11&level=1&getDataSet=true&detailedInfo=true&getChart=false/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"145",
"1.00",
1,
1,
"100.00%"
],
[
"160",
null,
1,
0,
"0.00%"
],
[
"182",
"0.00",
1,
1,
"100.00%"
],
[
"188",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by 3-Digit ZIP Code",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446741594516,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 3
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=11&level=2&getDataSet=true&detailedInfo=true&getChart=false&zip=188/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"18801",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by 3-Digit ZIP Code",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446741853171,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 3
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=11&level=3&getDataSet=true&detailedInfo=true&getChart=false&zip=18801/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by 3-Digit ZIP Code",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446742039713,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 3
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by 5-Digit ZIP Code report number is 12.
Example:
12
level
number
required
Maximum number of levels for this report is 2.
Example:
2
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
zip
string
optional
Required for level 2.
Example:
12075
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=12&level=1&getDataSet=true&detailedInfo=true&getChart=false/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"14572",
"1.00",
1,
1,
"100.00%"
],
[
"16038",
null,
1,
0,
"0.00%"
],
[
"18222",
"0.00",
1,
1,
"100.00%"
],
[
"18801",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by 5-Digit ZIP Code",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446742857308,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=12&getDataSet=true&detailedInfo=true&getChart=false&level=2&zip=18801/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by 5-Digit ZIP Code",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446743046729,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 2
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
reportNumber
string
required
Results By Single Piece report number 13.
Example:
13
jobId
number
optional
Example:
1
level
string
required
Example:
1
getDataSet
boolean
required
true
detailedInfo
boolean
required
true
page
string
optional
page to be loaded
Example:
1
useCache
boolean
optional
false
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=13&jobId=1&level=1&getDataSet=true&useCache=false&page=1&detailedInfo=true/ HTTP/1.1
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 5,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"barcode",
"imbdigit",
"useruniqueid",
"first_scan",
"last_scan"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
}
],
[
"16038210242",
"01311201109533327734",
" ",
null,
null
],
[
"18222161656",
"01311201109533327735",
" ",
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
}
],
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1445968594000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"pageNumber": 1,
"chart": null,
"numberOfPages": 1,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Single Piece",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446745966939,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 1
}
},
"success": true
}
HTTP/1.1 200 OK
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
reportNumber
string
required
Results By Single Piece report number 27.
Example:
27
jobId
number
optional
Example:
1
level
string
required
Example:
1
getDataSet
boolean
required
true
detailedInfo
boolean
required
true
page
string
optional
page to be loaded
Example:
1
useCache
boolean
optional
false
additionalOptions
string
required
Default:
singlePieceRedirect
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=13&jobId=1&level=1&getDataSet=true&useCache=false&page=1&detailedInfo=true&additionalOptions=singlePieceRedirect/ HTTP/1.1
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 5,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"barcode",
"imbdigit",
"useruniqueid",
"first_scan",
"last_scan"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
}
],
[
"16038210242",
"01311201109533327734",
" ",
null,
null
],
[
"18222161656",
"01311201109533327735",
" ",
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
}
],
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1445968594000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"pageNumber": 1,
"chart": null,
"numberOfPages": 1,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Single Piece",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446745966939,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 1
}
},
"success": true
}
HTTP/1.1 200 OK
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
reportNumber
string
required
Results By Single Piece report number 28.
Example:
28
jobId
number
optional
Example:
1
level
string
required
Example:
1
getDataSet
boolean
required
true
detailedInfo
boolean
required
true
page
string
optional
page to be loaded
Example:
1
useCache
boolean
optional
false
additionalOptions
string
required
Default:
singlePieceReturn
Responses
200
OK
See example responses below.
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=13&jobId=1&level=1&getDataSet=true&useCache=false&page=1&detailedInfo=true&additionalOptions=singlePieceReturn/ HTTP/1.1
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 5,
"columnTypes": null,
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"barcode",
"imbdigit",
"useruniqueid",
"first_scan",
"last_scan"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
}
],
[
"16038210242",
"01311201109533327734",
" ",
null,
null
],
[
"18222161656",
"01311201109533327735",
" ",
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1445968595000,
"javaClass": "java.sql.Timestamp"
}
],
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1445968594000,
"javaClass": "java.sql.Timestamp"
},
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
}
]
]
},
"pageNumber": 1,
"chart": null,
"numberOfPages": 1,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Single Piece",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446745966939,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 1
}
},
"success": true
}
HTTP/1.1 200 OK
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by Postal District report number is 14.
Example:
14
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
region
string
required
Required for levels 2 and 3.
Example:
CINCINNATI
state
string
required
Required for levels 2 and 3.
Example:
OH
zip
string
required
Required for levels 3 and 4.
Example:
452 (level 3), 45202 (level 4)
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=14&level=1&getDataSet=true&detailedInfo=true&getChart=false/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 3,
"totalRowsCountAndSumDisplay": "Total Rows: 3",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 3,
"columnNames": [
"name",
"state",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"CENTRAL PENNSYLVANIA",
"PA",
"0.50",
2,
2,
"100.00%"
],
[
"WESTERN NEW YORK",
"NY",
"1.00",
1,
1,
"100.00%"
],
[
"WESTERN PENNSYLVANIA",
"PA",
null,
1,
0,
"0.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"region",
"state"
],
"name": "Results by Postal District",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446748115124,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=14&level=2&getDataSet=true&detailedInfo=true&getChart=false®ion=CENTRAL PENNSYLVANIA&state=PA/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"182",
"0.00",
1,
1,
"100.00%"
],
[
"188",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip",
"parent.region",
"parent.state"
],
"name": "Results by Postal District",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446748486201,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=14&getDataSet=true&getChart=false&detailedInfo=true&level=3®ion=CENTRAL PENNSYLVANIA&state=PA&zip=188/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"18801",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by Postal District",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446748919542,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=14&getDataSet=true&getChart=false&detailedInfo=true&level=4&zip=18801/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"18801670551",
"01311201109533327736",
" ",
{
"time": 1446045849000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Postal District",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446749153671,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by Postal Area report number is 15.
Example:
15
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
region
string
required
Required for levels 2 and 3.
Example:
EASTERN
state
string
required
Required for levels 2 and 3.
Example:
OH
zip
string
required
Required for levels 3 and 4.
Example:
452 (level 3), 45202 (level 4)
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=15&level=1&getDataSet=true&detailedInfo=true&getChart=false/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 2,
"totalRowsCountAndSumDisplay": "Total Rows: 2",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 2,
"columnNames": [
"name",
"state",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"EASTERN",
"NY",
"1.00",
1,
1,
"100.00%"
],
[
"EASTERN",
"PA",
"0.50",
3,
2,
"66.67%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"region",
"state"
],
"name": "Results by Postal Area",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446750064182,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=15&getDataSet=true&getChart=false&detailedInfo=true&level=2®ion=EASTERN&state=NY/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"145",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip",
"parent.region",
"parent.state"
],
"name": "Results by Postal Area",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446839840925,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=15&getDataSet=true&getChart=false&detailedInfo=true&level=3®ion=EASTERN&state=NY&zip=145/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"14572",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by Postal Area",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446751249501,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=15&getDataSet=true&getChart=false&detailedInfo=true&level=4&zip=14572/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Postal Area",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446752130125,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
jobId
string
required
Example:
246008
reportNumber
number
required
Results by Postal Facility report number is 16.
Example:
16
level
number
required
Maximum number of levels for this report is 4.
Example:
4
getDataSet
boolean
optional
Indicates whether or not data is returned in the report object.
Example:
true
getChart
boolean
optional
Indicates whether or not a chart object is returned in the report object.
Example:
true
detailedInfo
boolean
optional
Indicates whether or not detailed information (number of report levels, report name, current level, next level parameter names, and if next level has a new chart) is returned in the report object.
Example:
true
region
string
required
Required for levels 2 and 3.
Example:
BADEN
state
string
required
Required for levels 2 and 3.
Example:
PA
zip
string
required
Required for levels 3 and 4.
Example:
150 (level 3), 15042 (level 4)
Responses
200
OK
See example responses below.
Examples
Success Response (level 1)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=16&getDataSet=true&detailedInfo=true&getChart=false&level=1/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 4,
"totalRowsCountAndSumDisplay": "Total Rows: 4",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 4,
"columnNames": [
"name",
"state",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"DRUMS",
"PA",
"0.00",
1,
1,
"100.00%"
],
[
"HARRISVILLE",
"PA",
null,
1,
0,
"0.00%"
],
[
"MONTROSE",
"PA",
"1.00",
1,
1,
"100.00%"
],
[
"WAYLAND",
"NY",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"region",
"state"
],
"name": "Results by Postal Facility",
"currentLevel": 1,
"chartLastUpdated": {
"time": 1446752547643,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 2)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=16&getDataSet=true&detailedInfo=true&getChart=false&level=2&state=NY®ion=WAYLAND/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip3",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"145",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip",
"parent.region",
"parent.state"
],
"name": "Results by Postal Facility",
"currentLevel": 2,
"chartLastUpdated": {
"time": 1446752808816,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 3)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=16&getDataSet=true&getChart=false&detailedInfo=true&level=3®ion=WAYLAND&state=NY&zip=145/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 5,
"columnTypes": [
12,
12,
-5,
-5,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"zip5",
"avg_elapsed_days",
"total_pieces",
"total_scans",
"scan_percentage"
],
"rows": [
[
"14572",
"1.00",
1,
1,
"100.00%"
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": [
"zip"
],
"name": "Results by Postal Facility",
"currentLevel": 3,
"chartLastUpdated": {
"time": 1446753099769,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}Success Response (level 4)
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/jobId=246008&reportNumber=16&getDataSet=true&getChart=false&detailedInfo=true&level=4&zip=14572/ HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"message": "",
"data": {
"recordCount": 1,
"totalRowsCountAndSumDisplay": "Total Rows: 1",
"dataset": {
"columnCount": 6,
"columnTypes": [
12,
12,
12,
93,
12,
12
],
"javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
"rowCount": 1,
"columnNames": [
"barcode",
"imbdigit",
"userid",
"last_scan_date",
"qr_scan_img",
"message_img"
],
"rows": [
[
"14572920164",
"01311201109533327732",
" ",
{
"time": 1446054995000,
"javaClass": "java.sql.Timestamp"
},
"",
""
]
]
},
"chart": null,
"version": "v3.0",
"detailedInfo": {
"nextLevelParams": null,
"name": "Results by Postal Facility",
"currentLevel": 4,
"chartLastUpdated": {
"time": 1446753313024,
"javaClass": "java.util.Date"
},
"nextLevelHasChart": false,
"maxLevels": 4
}
},
"success": true
}
GET
/ws_job_reports/
{token}Path variables
token
string
optional
Request parameters
reportNumber
string
required
Dashboard report number 1.
Example:
1
jobId
number
required
Example:
246008
level
string
required
Example:
1
getDataSet
boolean
optional
Example:
true
getChart
boolean
optional
Example:
true
detailedInfo
boolean
optional
Example:
true
Responses
200
OK
Body
Object
detailedInfo
Object
currentLevel
number
Example:
1
nextLevelHasChart
boolean
Example:
false
nextLevelParams
string
maxLevels
number
Example:
1
name
string
Example:
Dashboard
pageNumber
number
Example:
1
numberOfPages
number
Example:
0
data
Object
javaClass
string
Example:
org.mozilla.javascript.Undefined
success
boolean
Example:
true
recordCount
number
Example:
0
chart
Object
dataLabels
string
Example:
['Not Scanned', 'Early', 'On Time', 'Late', 'En Route']
yAxisLabel
string
Example:
Scans
data
string
Example:
[0,237,151,1,40]
options
string
chartType
string
Example:
PieChart
width
number
callback
string
xAxisLabel
string
Example:
Date
title
string
height
number
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/{token}?reportNumber=1&jobId=246008&level=1&getDataSet=true&getChart=true&detailedInfo=true HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"detailedInfo": {
"currentLevel": 1,
"nextLevelHasChart": false,
"nextLevelParams": null,
"maxLevels": 1,
"name": "Dashboard"
},
"pageNumber": 1,
"numberOfPages": 0,
"data": {
"javaClass": "org.mozilla.javascript.Undefined"
},
"success": true,
"recordCount": 0,
"chart": [
{
"dataLabels": "['Not Scanned', 'Early', 'On Time', 'Late', 'En Route']",
"yAxisLabel": "Scans",
"data": "[0,237,151,1,40]",
"options": "",
"chartType": "PieChart",
"width": null,
"callback": null,
"xAxisLabel": "Date",
"title": "",
"height": null
},
{
"dataLabels": "['AL','AR','AZ','CA','CO','CT','DC','DE','FL','GA','IA','ID','IL','IN','KS','KY','LA','MI','MN','MO','MS','MT','NC','ND','NE','NM','NV','NY','OH','OK','OR','PA','SC','SD','TN','TX','UT','VA','VT','WA','WI','WY']",
"yAxisLabel": "Percent",
"data": "[100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00,100.00]",
"options": "",
"chartType": "GeoMap",
"width": null,
"callback": null,
"xAxisLabel": "State",
"title": "",
"height": null
},
{
"dataLabels": "['10/22','10/23','10/24','10/25','10/26']",
"yAxisLabel": "Scans",
"data": "[108,209,96,13,3]",
"options": "",
"chartType": "ColumnChart",
"width": null,
"callback": null,
"xAxisLabel": "Date",
"title": "",
"height": null
},
{
"dataLabels": "['10/23','10/24','10/25','10/26','10/27','10/28','11/03']",
"yAxisLabel": "Pieces",
"data": "[38,199,137,3,9,2,1]",
"options": "",
"chartType": "ColumnChart",
"width": null,
"callback": null,
"xAxisLabel": "Date",
"title": "",
"height": null
},
{
"dataLabels": "['ASF ALBUQUERQUE','ASF BILLINGS','ASF BUFFALO','ASF FARGO','ASF OKLAHOMA CITY','ASF PHOENIX','ASF SALT LAKE CTY','ASF SIOUX FALLS','NDC ATLANTA','NDC CHICAGO','NDC CINCINN','NDC DALLAS','NDC DENVER','NDC DES MOINES','NDC DETROIT','NDC GREENSBORO','NDC JAXVILLE','NDC KANS CITY','NDC LOS ANGELS','NDC MEMPHIS','NDC MPLS/STP','NDC NEW JERSEY','NDC PHILA','NDC PITTSBURGH','NDC SAN FRAN','NDC SEATTLE','NDC SPFLD','NDC ST LOUIS','NDC WASHINGTON']",
"yAxisLabel": "Percent",
"data": "[[100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]",
"options": "",
"chartType": "ColumnChart",
"width": null,
"callback": null,
"xAxisLabel": "NDC",
"title": "",
"height": null
}
]
}
GET
/ws_job_reports/
{token}/Path variables
token
string
required
Request parameters
reportNumber
string
optional
jobId
string
optional
level
string
optional
getDataSet
string
optional
getChart
string
optional
detailedInfo
string
optional
exportType
string
optional
csv
GET
/ws_auth/
{CompanyID}/{Username}/{Password}
POST
/ws_auth
GET
/ws_auth/
{CompanyID}/{Username}/{Password}Get user information as well as authentication token/keys to make other API requests.
Path variables
CompanyID
string
required
Username
string
required
Password
string
required
URL Encode if special URL charactersa re used.
Responses
200
OK
Body
Object
token
string
Example:
2f8671b83821c5bc8c7307ef3eb6b238783bcbe13d68e995
data
Object
logo
string
Example:
data:image/png;base64,...
cloud_presort
string
adminKey
string
distributor_id
number
Example:
1
tenant_id
number
Example:
123
user_name
string
Example:
accuzip
distributorOptions
Object
chartColors
Object
color_line_chart
string
Example:
00538D
color_inhome_not_scanned
string
Example:
999999
color_chart_gradient_dark
string
Example:
006600
color_chart_gradient_light
string
Example:
D6EBE0
color_inhome_en_route
string
Example:
FFCC33
color_inhome_on_time
string
Example:
339933
color_inhome_late
string
Example:
A30000
color_bar_chart
string
Example:
00538D
color_inhome_early
string
Example:
FFFF33
customerId
string
Example:
123456789
name_first
string
Example:
firstName
email
string
Example:
theEmail@accuzip.com
api_key
string
Example:
49F67CE8-ECB9-4252-B6FD-76B0EA183ED0
admin
boolean
distributorKey
string
user_id
number
Example:
789
name_last
string
Example:
lastName
success
boolean
Example:
true
Examples
Response body - JSON Format
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_auth/companyID/userName/passWord HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"token": "2f8671b83821c5bc8c7307ef3eb6b238783bcbe13d68e995",
"data": {
"logo": "data:image/png;base64,...",
"cloud_presort": null,
"adminKey": null,
"distributor_id": 1,
"tenant_id": 123,
"user_name": "accuzip",
"distributorOptions": {
"chartColors": {
"color_line_chart": "00538D",
"color_inhome_not_scanned": "999999",
"color_chart_gradient_dark": "006600",
"color_chart_gradient_light": "D6EBE0",
"color_inhome_en_route": "FFCC33",
"color_inhome_on_time": "339933",
"color_inhome_late": "A30000",
"color_bar_chart": "00538D",
"color_inhome_early": "FFFF33"
}
},
"customerId": "123456789",
"name_first": "firstName",
"email": "theEmail@accuzip.com",
"api_key": "49F67CE8-ECB9-4252-B6FD-76B0EA183ED0",
"admin": false,
"distributorKey": null,
"user_id": 789,
"name_last": "lastName"
},
"success": true
}
POST
/ws_auth
Alternative POST option for authentication. If this is used, parameters don’t need URL encoded. Get user information as well as authentication token/keys to make other API requests.
Request body
Object
authenticate
boolean
Example:
true
customerId
string
Example:
{CompanyID}
username
string
Example:
{Username}
password
string
Example:
{Password}
POST
/ws_jobs/
{token}
PUT
/ws_jobs/
{token}
GET
/ws_jobs/
{token}
GET
/ws_jobs/
{token}
GET
/ws_jobs/
{token}/
DELETE
/ws_jobs/
{token}/{jobId}
POST
/ws_jobs/
{token}Creates a new job with the given values supplied in the request body.
Path variables
token
string
required
Request body
Object
jobid1
string
Example:
your unique jobid1
jobid2
string
custid
string
required customer id
Example:
7712345601
jobdescription
string
Example:
the jobdescription
classsize
string
Example:
Standard Mail Letters
email
string
Example:
yourEmail.@emailProvider.com
web_guid
string
Example:
30820CF2-0857-4505-B87C-85641E0446EB
lowserial
string
Example:
4444
highserial
string
Example:
88888888
originzip4
string
Example:
12345-9999
export_nightly
string
Example:
1
email_notifications
string
Example:
1
email_notifications_always
string
Example:
0
import_status
string
Example:
0
api_key
string
Example:
api_key_in
qr_code_url
string
Example:
qr_code_url_in
url_stats_include_geo
string
Example:
1
url_stats_include_params
string
Example:
1
qrtotal
string
Example:
2
email_notifications_msg
string
Example:
email_notifications_msg_in
last_report
string
Example:
last_report_in
livingmail_snd_msg_opt_1_dt
string
Example:
1
livingmail_snd_msg_opt_2_fst
string
Example:
1
livingmail_snd_msg_opt_3_del
string
Example:
1
livingmail_snd_msg_opt_4_qr
string
Example:
1
livingmail_msg_id_dt
string
Example:
1
livingmail_msg_id_fst_scan
string
Example:
1
livingmail_msg_id_qr_scan
string
Example:
1
livingmail_snd_msg_1_dt_offset
string
Example:
11
livingmail_snd_msg_2_dt_offset
string
Example:
22
livingmail_snd_msg_3_dt_offset
string
Example:
33
nightly_jobs
string
Example:
nightly_jobs_in
livingmail_msg_id
string
Example:
87
livingmail_send_msg_options
string
Example:
99
Responses
200
OK
Body
Object
jobId
number
The ID of the newly created job.
Example:
246010
data
Object
classsize
string
Example:
Standard Mail Letters
livingmail_snd_msg_opt_1_dt
number
Example:
1
livingmail_msg_id_fst_scan
number
Example:
1
calc_total_pieces
number
Example:
0
livingmail_snd_msg_3_dt
Object
javaClass
string
Example:
java.util.Date
time
number
maildate
Object
javaClass
string
Example:
java.util.Date
time
number
Example:
1422627077208
calc_serial_high
string
Example:
88888888
export_nightly
number
Example:
1
livingmail_snd_msg_opt_3_del
number
Example:
1
livingmail_snd_msg_3_dt_offset
number
Example:
33
livingmail_msg_id_dt
number
Example:
1
email_notifications_end
Object
javaClass
string
Example:
java.util.Date
time
string
originzip4
string
Example:
12345-9999
highserial
string
Example:
88888888
startclock
Object
javaClass
string
Example:
java.util.Date
time
number
Example:
1422885345720
endclock
Object
javaClass
string
Example:
java.util.Date
time
number
Example:
1422627077208
longitude
string
Example:
-120.69054
scan_percentage
number
Example:
0
calc_serial_low
string
Example:
4444
livingmail_snd_msg_opt_4_qr
number
Example:
1
mailtotal
number
Example:
0
livingmail_snd_msg_2_dt
Object
javaClass
string
Example:
java.util.Date
time
number
url_stats_include_params
number
Example:
1
last_report
string
Example:
last_report_in
qr_code_url
string
Example:
qr_code_url_in
livingmail_send_msg_options
number
Example:
99
web_guid
string
Example:
30820CF2-0857-4505-B87C-85641E0446EB
jobid1
string
Example:
postman 1010
jobid2
string
weblink
string
Example:
https://accuzip.iaccutrace.com/track/?uid=30820CF2-0857-4505-B87C-85641E0446EB
custid
string
Example:
7712345601
email_notifications
number
Example:
1
guid
string
nightly_jobs
string
Example:
nightly_jobs_in
livingmail_msg_id_qr_scan
number
Example:
1
tenant_id
number
Example:
5
lowserial
string
Example:
4444
last_nightly_export
Object
javaClass
string
Example:
java.util.Date
time
number
jobdescription
string
Example:
the jobdescription
latitude
string
Example:
35.504929
livingmail_snd_msg_opt_2_fst
number
Example:
1
livingmail_msg_id
number
Example:
87
livingmail_snd_msg_1_dt
Object
javaClass
string
Example:
java.util.Date
time
number
import_status
number
Example:
0
livingmail_snd_msg_1_server_dt
Object
javaClass
string
Example:
java.util.Date
time
number
livingmail_snd_msg_1_dt_offset
number
Example:
11
livingmail_send_msg_option
number
email
string
Example:
yourEmail.@emailProvider.com
livingmail_msg_id_out_del
number
livingmail_send_date_time
Object
javaClass
string
Example:
java.util.Date
time
number
url_stats_include_geo
number
Example:
1
api_key
string
Example:
api_key_in
job_id
number
Example:
246010
livingmail_snd_msg_2_dt_offset
number
Example:
22
qrtotal
number
Example:
2
email_notifications_msg
string
Example:
email_notifications_msg_in
email_notifications_always
number
Example:
0
success
boolean
Indicates status of the request.
Example:
true
Examples
POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token HTTP/1.1
Content-Type: application/json
{
"jobid1":"postman 1010",
"jobid2":"",
"custid":"{{cust_ID}}",
"jobdescription":"createDate:{{dateCreated}}",
"classsize":"Standard Mail Letters",
"email":"yourEmail.@emailProvider.com",
"web_guid":"30820CF2-0857-4505-B87C-85641E0446EB",
"lowserial":"4444",
"highserial":"88888888",
"originzip4":"93422-2500",
"export_nightly":"1",
"email_notifications":"1",
"email_notifications_always":"0",
"import_status": "0",
"api_key": "api_key_in",
"qr_code_url":"qr_code_url_in",
"url_stats_include_geo":"1",
"url_stats_include_params":"1",
"qrtotal":"2",
"email_notifications_msg":"email_notifications_msg_in",
"last_report":"last_report_in",
"nightly_jobs":"nightly_jobs_in",
"twilio_msg_id":"87",
"twilio_send_msg_options":"99"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"jobId": 713797,
"data": {
"email_notifications_always": 0,
"qr_code_url": "qr_code_url_in",
"endclock": {
"time": 1448206382909,
"javaClass": "java.util.Date"
},
"url_stats_include_params": 1,
"web_guid": "2BCC7136-13C3-4E70-A4B2-F89551CB0D21",
"last_report": "last_report_in",
"calc_serial_low": "4444",
"tenant_id": 371,
"startclock": {
"time": 1447601582909,
"javaClass": "java.util.Date"
},
"originzip4": "93422-2500",
"maildate": {
"time": 1447342382909,
"javaClass": "java.util.Date"
},
"calc_total_pieces": 0,
"url_stats_include_geo": 1,
"mailtotal": 0,
"classsize": "Standard Mail Letters",
"scan_percent_last_updated": null,
"import_status": 0,
"longitude": "-120.69054",
"email_notifications": 1,
"jobid1": "postman 1010",
"twilio_send_msg_options": 99,
"custid": "7700000701",
"jobid2": null,
"last_nightly_export": null,
"nightly_jobs": "nightly_jobs_in",
"dwh_status": null,
"calc_serial_high": "88888888",
"scan_percent": null,
"guid": null,
"jobdescription": "createDate:2015-11-12 9:34:15.866",
"email_notifications_end": null,
"lowserial": "4444",
"highserial": "88888888",
"twilio_msg_id": 87,
"weblink": "https://demo.iaccutrace.com/track/?uid=2BCC7136-13C3-4E70-A4B2-F89551CB0D21",
"email": "yourEmail.@emailProvider.com",
"scan_percentage": 0,
"api_key": "api_key_in",
"scanned_total": 0,
"export_nightly": 1,
"latitude": "35.504929",
"twilio_send_date_time": null,
"email_notifications_msg": "email_notifications_msg_in",
"qrtotal": 2,
"job_id": 713797
},
"success": true
}
PUT
/ws_jobs/
{token}Updates a job with the given job_id with the values supplied in the request body.
Path variables
token
string
required
Request body
Responses
200
OK
With PUT and DELETE requests, no response data is returned, only a HTTP 200 (success) or 404 (failure).
Examples
PUT https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token HTTP/1.1
Content-Type: application/json
{
"job_id":"246015",
"jobid1":"post man update",
"jobid2":"post man update2",
"jobdescription":"startclock Date input format MM-dd-yyyy.",
"startclock" : "01-09-2015",
"endclock" : "01-10-2015",
"classsize":"First Class Letters",
"latitude": "24.565617",
"longitude": "-81.7727",
"highserial": "01234567",
"lowserial" : "2222",
"highserial": "77777777",
"originzip4":"55555-4444",
"scan_percentage":"88",
"export_nightly":"0",
"email_notifications":"0",
"email_notifications_always":"1",
"import_status": "1",
"api_key": "api_key_update",
"qr_code_url":"qr_code_url_update",
"url_stats_include_geo":"0",
"url_stats_include_params":"0",
"qrtotal":"8",
"email_notifications_msg":"email_notifications_msg_update",
"last_report":"last_report_update",
"livingmail_snd_msg_opt_1_dt":"10",
"livingmail_snd_msg_opt_2_fst":"20",
"livingmail_snd_msg_opt_3_del":"30",
"livingmail_snd_msg_opt_4_qr":"40",
"livingmail_msg_id_dt":"0",
"livingmail_msg_id_fst_scan":"0",
"livingmail_msg_id_qr_scan":"0",
"livingmail_snd_msg_1_dt_offset":"1111",
"livingmail_snd_msg_2_dt_offset":"2222",
"livingmail_snd_msg_3_dt_offset":"3333",
"nightly_jobs":"nightly_jobs_update",
"livingmail_msg_id":"110",
"livingmail_send_msg_options":"120"
}
GET
/ws_jobs/
{token}Select job by job_id
Path variables
token
string
optional
Authentication token to make API requests.
Example:
d112bfdb7e25cdaa47867e942e783a979d6b2941b3029ee0
Request parameters
jobId
number
required
Example:
246008
Responses
200
OK
Body
Object
jobs
Array
Object
email_notifications_always
number
qr_code_url
string
endclock
url_stats_include_params
number
Example:
0
web_guid
string
Example:
6D92204C-B992-4D76-BD0B-4ECCEC45EFB2
last_report
string
calc_serial_low
string
Example:
533327732
tenant_id
number
Example:
371
startclock
originzip4
string
Example:
64127-9998
maildate
calc_total_pieces
number
Example:
4
url_stats_include_geo
number
Example:
0
mailtotal
number
Example:
4
classsize
string
Example:
Standard Mail Letters
scan_percent_last_updated
import_status
number
Example:
1
longitude
string
Example:
-94.555611
email_notifications
number
Example:
-1
jobid1
string
Example:
job_id:710063
twilio_send_msg_options
number
Example:
120
custid
string
Example:
7700000701
jobid2
string
last_nightly_export
unknown
nightly_jobs
string
dwh_status
number
Example:
2
calc_serial_high
string
Example:
533327736
scan_percent
number
Example:
0.75
guid
Object
leastSignificantBits
number
Example:
-5777073379877033000
javaClass
string
Example:
com.servoy.j2db.util.UUID
mostSignificantBits
number
Example:
-1996736948980202800
jobdescription
string
Example:
dwh_test_list_2
email_notifications_end
unknown
lowserial
string
Example:
533327732
highserial
string
Example:
533327736
twilio_msg_id
number
weblink
string
Example:
https://demo.iaccutrace.com/track/?uid=6D92204C-B992-4D76-BD0B-4ECCEC45EFB2
email
unknown
scan_percentage
number
Example:
0.75
api_key
string
Example:
49F67CE8-ECB9-4252-B6FD-76B0EA183ED0
scanned_total
number
Example:
3
export_nightly
number
latitude
string
Example:
39.094109
twilio_send_date_time
unknown
email_notifications_msg
string
qrtotal
number
job_id
number
Example:
710063
pageNumber
number
Example:
1
numberOfPages
number
Example:
1
success
boolean
Example:
true
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token/jobId=710063 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"jobs": [
{
"email_notifications_always": 0,
"qr_code_url": null,
"endclock": {
"time": 1446451200000,
"javaClass": "java.util.Date"
},
"url_stats_include_params": null,
"web_guid": "6D92204C-B992-4D76-BD0B-4ECCEC45EFB2",
"last_report": null,
"calc_serial_low": "533327732",
"tenant_id": 371,
"startclock": {
"time": 1446188400000,
"javaClass": "java.util.Date"
},
"originzip4": "64127-9998",
"maildate": {
"time": 1445929200000,
"javaClass": "java.util.Date"
},
"calc_total_pieces": 4,
"url_stats_include_geo": null,
"mailtotal": 4,
"classsize": "Standard Mail Letters",
"scan_percent_last_updated": {
"time": 1447330034704,
"javaClass": "java.util.Date"
},
"import_status": 1,
"longitude": "-94.555611",
"email_notifications": -1,
"jobid1": "job_id:710063",
"twilio_send_msg_options": null,
"custid": "7700000701",
"jobid2": null,
"last_nightly_export": null,
"nightly_jobs": null,
"dwh_status": 2,
"calc_serial_high": "533327736",
"scan_percent": 0.75,
"guid": {
"leastSignificantBits": -5777073379877033103,
"javaClass": "com.servoy.j2db.util.UUID",
"mostSignificantBits": -1996736948980202670
},
"jobdescription": "dwh_test_list_2",
"email_notifications_end": null,
"lowserial": "533327732",
"highserial": "533327736",
"twilio_msg_id": null,
"weblink": "https://demo.iaccutrace.com/track/?uid=6D92204C-B992-4D76-BD0B-4ECCEC45EFB2",
"email": null,
"scan_percentage": 0.75,
"api_key": "49F67CE8-ECB9-4252-B6FD-76B0EA183ED0",
"scanned_total": 3,
"export_nightly": 0,
"latitude": "39.094109",
"twilio_send_date_time": null,
"email_notifications_msg": null,
"qrtotal": null,
"job_id": 710063
}
],
"pageNumber": 1,
"numberOfPages": 1,
"success": true
}
GET
/ws_jobs/
{token}Select jobs by date range.
Path variables
token
string
optional
Authentication token to make API requests.
Example:
d112bfdb7e25cdaa47867e942e783a979d6b2941b3029ee0
Request parameters
startDate
string
required
Date String format:MM-dd-yyyy
Example:
02-10-2015
endDate
string
required
Date String format:MM-dd-yyyy
Example:
04-20-2015
Responses
200
OK
Examples
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token/startDate=11-12-2015&endDate=11-13-2015 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"jobs": [
{
"email_notifications_always": 1,
"qr_code_url": "qr_code_url_update",
"endclock": {
"time": 1448179200000,
"javaClass": "java.util.Date"
},
"url_stats_include_params": 0,
"web_guid": "5331354A-00A7-4B9C-8A67-3D96EBECF01B",
"last_report": "last_report_update",
"calc_serial_low": "2222",
"tenant_id": 371,
"startclock": {
"time": 1447401600000,
"javaClass": "java.util.Date"
},
"originzip4": "55555-4444",
"maildate": {
"time": 1447342800083,
"javaClass": "java.util.Date"
},
"calc_total_pieces": 0,
"url_stats_include_geo": 0,
"mailtotal": 0,
"classsize": "First Class Letters",
"scan_percent_last_updated": null,
"import_status": 1,
"longitude": "-81.7727",
"email_notifications": 0,
"jobid1": "post man update",
"twilio_send_msg_options": 120,
"custid": "7700000701",
"jobid2": "job_id:713802",
"last_nightly_export": null,
"nightly_jobs": "nightly_jobs_update",
"dwh_status": null,
"calc_serial_high": "01234567",
"scan_percent": null,
"guid": null,
"jobdescription": "startclock Date input format MM-dd-yyyy. see mod_rest ws_jobs.updateJobValues()",
"email_notifications_end": null,
"lowserial": "2222",
"highserial"