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
Base URI variables
your prefix
string required
Example:
https://demo.iaccutrace.com/servoy-service/rest_ws/mod_rest
Parameters
appDirectory
string optional

accutrace-html5

Documentation
General principals, patterns
  • 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
API Methods
Job Reports (version 3)
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}/
In Home Delivery Performances
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
}
Results by First Scan Date
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
}
Out for Delivery - by Date
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
}
Out for Delivery - Today
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
}
Out for Delivery - All
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
}
Results by State
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
}
Results by County
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
}
Results by NDC
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
}
Results by SCF
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
}
Results by 3-Digit ZIP Code
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
}
Results by 5-Digit ZIP Code
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
}
Results By Single Piece
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 
Results by Postal District
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&region=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&region=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
}
Results by Postal Area
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&region=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&region=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
}
Results by Postal Facility
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&region=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&region=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
}
Dashboard
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
        }
    ]
}
Results by First and Last Scan
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

Daily Stop Scan
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

pdf

Authenticate
GET /ws_auth/{CompanyID}/{Username}/{Password}
Login
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

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
}
Jobs
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}
Create Job
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
}
Update Job
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"
}
Select Jobs by job_id
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
}
Select Jobs by Date
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": "01234567",
            "twilio_msg_id": 110,
            "weblink": "https://demo.iaccutrace.com/track/?uid=5331354A-00A7-4B9C-8A67-3D96EBECF01B",
            "email": "yourEmail.@emailProvider.com",
            "scan_percentage": 0,
            "api_key": "api_key_update",
            "scanned_total": 0,
            "export_nightly": 0,
            "latitude": "24.565617",
            "twilio_send_date_time": null,
            "email_notifications_msg": "email_notifications_msg_update",
            "qrtotal": 8,
            "job_id": 713802
        }
    ],
    "pageNumber": 1,
    "numberOfPages": 1,
    "success": true
}
Select Jobs Advanced
GET /ws_jobs/{token}/

Path variables

token
string required

Request parameters

advanced
number required

Do an advanced search

Example:
1
jobid1
string optional

Search for jobid1 that contains search criteria.

Example:
abc jobID1
jobid2
string optional

Search for jobid2 that contains search criteria.

Example:
xyz jobID2
jobdescription
string optional

Search for jobdescription that contains search criteria.

Example:
the jobdescription
email
string optional

Search for email that contains search criteria.

Example:
myName@
classsize
string optional

Search for classsize that contains search criteria.

Example:
Standard Mail Letters
startDate
string optional

MM-dd-yyyy

Example:
10-28-2015
endDate
string optional

MM-dd-yyyy

Example:
11-18-2015
wildcardSearch
boolean optional

When set to true, jobs whose attibutes match all or part of the attribute search phrase will be returned. When set to false, only jobs with exact search attribute matches will be returned. Default value is false.

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token/advanced=1&jobid1=post man update&email=yourEmail.@emailProvider.com/ HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "pageNumber": 1,
    "numberOfPages": 1,
    "success": true,
    "jobs": [
        {
            "classsize": "First Class Letters",
            "twilio_snd_msg_opt_1_dt": 10,
            "twilio_msg_id_fst_scan": 0,
            "calc_total_pieces": 0,
            "twilio_snd_msg_3_dt": null,
            "maildate": {
                "javaClass": "java.util.Date",
                "time": 1425046425667
            },
            "calc_serial_high": "01234567",
            "export_nightly": 0,
            "twilio_snd_msg_opt_3_del": 30,
            "twilio_snd_msg_3_dt_offset": 3333,
            "twilio_msg_id_dt": 0,
            "email_notifications_end": null,
            "originzip4": "55555-4444",
            "highserial": "01234567",
            "startclock": {
                "javaClass": "java.util.Date",
                "time": 1425016800000
            },
            "endclock": {
                "javaClass": "java.util.Date",
                "time": 1425103200000
            },
            "longitude": null,
            "scan_percentage": 0,
            "calc_serial_low": "2222",
            "twilio_snd_msg_opt_4_qr": 40,
            "mailtotal": 0,
            "twilio_snd_msg_2_dt": null,
            "url_stats_include_params": 0,
            "last_report": "last_report_update",
            "qr_code_url": "qr_code_url_update",
            "twilio_send_msg_options": 120,
            "web_guid": "30820CF2-0857-4505-B87C-85641E0446EB",
            "jobid1": "post man update",
            "jobid2": "job_id:246029",
            "weblink": "https://accuzip.iaccutrace.com/track/?uid=30820CF2-0857-4505-B87C-85641E0446EB",
            "custid": "7712345601",
            "email_notifications": 0,
            "guid": null,
            "nightly_jobs": "nightly_jobs_update",
            "twilio_msg_id_qr_scan": 0,
            "tenant_id": 5,
            "lowserial": "2222",
            "last_nightly_export": null,
            "jobdescription": "startclock Date input format MM-dd-yyyy. see mod_rest ws_jobs.updateJobValues()",
            "latitude": null,
            "twilio_snd_msg_opt_2_fst": 20,
            "twilio_msg_id": 110,
            "twilio_snd_msg_1_dt": null,
            "import_status": 1,
            "twilio_snd_msg_1_server_dt": null,
            "twilio_snd_msg_1_dt_offset": 1111,
            "twilio_send_msg_option": null,
            "email": "yourEmail.@emailProvider.com",
            "twilio_msg_id_out_del": null,
            "twilio_send_date_time": null,
            "scan_percent_last_updated": null,
            "url_stats_include_geo": 0,
            "api_key": "api_key_update",
            "job_id": 246029,
            "twilio_snd_msg_2_dt_offset": 2222,
            "qrtotal": 8,
            "email_notifications_msg": "email_notifications_msg_update",
            "email_notifications_always": 1
        }
    ]
}
Delete Job
DELETE /ws_jobs/{token}/{jobId}

Deletes a job with the supplied jobId.

Path variables

token
string required
jobId
string required

Responses

200 OK

With PUT and DELETE requests, no response data is returned, only a HTTP 200 (success) or 404 (failure).

Examples

DELETE https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_jobs/token/246018 HTTP/1.1 
Tracking Codes
POST /ws_tracking/{token}
PUT /ws_tracking/{token}
GET /ws_tracking/{token}
GET /ws_tracking/{token}
DELETE /ws_tracking/{token}/{trackingCodeId}
Create Tracking Code
POST /ws_tracking/{token}

Creates a tracking code with the given values supplied in the request body.

Path variables

token
string required

Request body

Object
job_id
string
Example:
246014
guid
string
Example:
A182374E-47D1-41ED-B8E5-4B0F321959EA
useruniqueid
string
Example:
the useruniqueid
qr_code_url
string
Example:
the qr_code_url
email
string
Example:
theName@theEmail.com
barcode
string
Example:
12345678901
imbdigits
string
Example:
12345678901234567890
bar3
string
Example:
123
bar5
string
Example:
12345

Responses

200 OK
Body
Object
trackingCodeId
Object
javaClass
string
Example:
com.servoy.j2db.dataprocessing.ValueFactory$DbIdentValue
row
Object
PKHashKey
string
Example:
8.12620945;
javaClass
string
Example:
com.servoy.j2db.dataprocessing.Row
PK
Object
0
number

trackingcodeId

Example:
12620945
rawColumnData
Object
0
number

trackingCodeId

Example:
12620945
1
string

barcode

Example:
12345678901
2
string

imbdigits

Example:
12345678901234567000
3
string

useruniqueid

Example:
the useruniqueid
4
string

guid

Example:
A182374E-47D1-41ED-B8E5-4B0F321959EA
5
string

qr_code_url

Example:
the qr_code_url
6
string

email

Example:
theName@theEmail.com
7
string

bar3

Example:
123
8
number

job_id

Example:
246014
9
string

bar5

Example:
12345
rawOldColumnData
unknown
rowManager
Object
javaClass
string
Example:
com.servoy.j2db.dataprocessing.RowManager
changed
boolean
Example:
false
pkValue
number

trackingCodeId

Example:
12620945
success
boolean
Example:
true

Examples

POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token HTTP/1.1 

Content-Type: application/json

{
  "job_id":"246014",
  "guid":"A182374E-47D1-41ED-B8E5-4B0F321959EA",
  "useruniqueid":"the useruniqueid",
  "qr_code_url":"qr_code_url_in",
  "email":"theName@theEmail.com",
  "barcode":"01234567890",                   
  "imbdigits":"01234567890123456789",
  "bar3":"123",
  "bar5":"12345"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "trackingCodeId": {
        "javaClass": "com.servoy.j2db.dataprocessing.ValueFactory$DbIdentValue",
        "row": {
            "PKHashKey": "8.12620826;",
            "javaClass": "com.servoy.j2db.dataprocessing.Row",
            "PK": [
                12620826
            ],
            "rawColumnData": [
                12620826,
                "01234567890",
                "01234567890123456789",
                "the useruniqueid",
                "A182374E-47D1-41ED-B8E5-4B0F321959EA",
                "qr_code_url_in",
                "theName@theEmail.com",
                "123",
                246014,
                "12345"
            ],
            "rawOldColumnData": null,
            "rowManager": {
                "javaClass": "com.servoy.j2db.dataprocessing.RowManager"
            },
            "changed": false
        },
        "pkValue": 12620826
    },
    "success": true
}
Update Tracking Code
PUT /ws_tracking/{token}

Updates a tracking code with the corresponding trackingcode_id with the given 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_tracking/token HTTP/1.1 

Content-Type: application/json

{
  "trackingcode_id":"the trackingcode_id",
  "job_id":"the job_id",
  "guid":"A182374E-47D1-41ED-B8E5-4B0F321959EA",
  "useruniqueid":"the useruniqueid",
  "qr_code_url":"the qr_code_url",
  "email":"thatName@thatEmail.com",
  "barcode":"86868686868",                
  "imbdigits":"22222222222222222222",
  "bar3":"b3b",
  "bar5":"bar55"
}
Select Tracking Codes by job_id
GET /ws_tracking/{token}

Selects all tracking codes by the job_id.

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246014

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/jobId=246014 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true,
    "trackingCodes": [
        {
            "trackingcode_id": 12620834,
            "imbdigits": "01234567890123456789",
            "scans": null,
            "useruniqueid": "the useruniqueid",
            "job_id": 246014,
            "guid": "A182374E-47D1-41ED-B8E5-4B0F321959EA",
            "bar5": "12345",
            "tracking_url": null,
            "barcode": "01234567890",
            "qr_code_url": "qr_code_url_in",
            "bar3": "123",
            "email": "theName@theEmail.com"
        }
    ]
}
Select Tracking Codes by job_id and barcode
GET /ws_tracking/{token}

Selects tracking code by job_id and barcode.

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246014
barcode
number required

11 digit number

Example:
12345678901
simpleSearch
boolean required
Example:
true

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/jobId=246014&barcode=12345678901&simpleSearch=true HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true,
    "trackingCodes": {
        "columnNames": [
            "barcode",
            "imbdigits",
            "useruniqueid",
            "first_scan",
            "last_scan"
        ],
        "columnTypes": [
            12,
            12,
            12,
            93,
            93
        ],
        "javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
        "columnCount": 5,
        "rowCount": 1,
        "rows": [
            [
                "12345678901",
                "12345678901234567890",
                "created by postman",
                {
                    "javaClass": "java.sql.Timestamp",
                    "time": 1425139800000
                },
                {
                    "javaClass": "java.sql.Timestamp",
                    "time": 1425139800000
                }
            ]
        ]
    }
}
Select Tracking code by job_id and imbdigits
GET /ws_tracking/{token}

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246014
imbdigits
number required

20 digit number

Example:
12345678901234567000
simpleSearch
boolean required
Example:
true

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/jobId=246014&simpleSearch=true&imbdigits=12345678901234567000 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true,
    "trackingCodes": {
        "columnNames": [
            "barcode",
            "imbdigits",
            "useruniqueid",
            "first_scan",
            "last_scan"
        ],
        "columnTypes": [
            12,
            12,
            12,
            93,
            93
        ],
        "javaClass": "com.servoy.j2db.dataprocessing.BufferedDataSet",
        "columnCount": 5,
        "rowCount": 1,
        "rows": [
            [
                "12345678901",
                "12345678901234567000",
                "created by postman",
                {
                    "javaClass": "java.sql.Timestamp",
                    "time": 1425139800000
                },
                {
                    "javaClass": "java.sql.Timestamp",
                    "time": 1425139800000
                }
            ]
        ]
    }
}
Select Tracking Codes and Include Scans
GET /ws_tracking/{token}

Path variables

token
string required

Request parameters

jobId
number required

246017

includeScans
boolean required

true

barcode
number required

11 digit number

imbDigits
number required

20 digit number

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/jobId=246017&includeScans=true&barcode=12345678901&imbDigits=12345678901234567000 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true,
    "trackingCodes": [
        {
            "trackingcode_id": 12620881,
            "imbdigits": "12345678901234567000",
            "scans": [
                {
                    "zip": "93422",
                    "mods": "919",
                    "scanned": {
                        "javaClass": "java.sql.Timestamp",
                        "time": 1422461400000
                    }
                }
            ],
            "useruniqueid": "the useruniqueid",
            "job_id": 246017,
            "guid": "A182374E-47D1-41ED-B8E5-4B0F321959EA",
            "bar5": "12345",
            "barcode": "12345678901",
            "qr_code_url": "the qr_code_url",
            "bar3": "123",
            "email": "theName@theEmail.com"
        }
    ]
}
Select Tracking Codes and include coordinates
GET /ws_tracking/{token}

Select tracking codes and include latitude and longitude of the postal facility of the scan.

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246017
includeCoords
boolean required
Example:
true
barcode
number required

11 digit number

Example:
12345678901
imbdigits
number required

20 digit number

Example:
12345678901234567000

Responses

200 OK

Examples

center coord => average of coordinates.

coords[0] => coordinates in job record.

coords[1, n] => coordinates of facilities.

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/jobId=246017&includeCoords=true&barcode=12345678901&imbdigits=12345678901234567000 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "altCoords": [],
    "success": true,
    "centerCoord": {
        "latitude": 34.457342499999996,
        "longitude": -116.31183999999999
    },
    "coords": [
        {
            "latitude": "33.449992",
            "longitude": "-111.97612"
        },
        {
            "mods": "919",
            "latitude": "35.464693",
            "longitude": "-120.64756"
        }
    ]
}
Delete Tracking Code
DELETE /ws_tracking/{token}/{trackingCodeId}

Path variables

token
string required
trackingCodeId
string required

Responses

200 OK

Examples

DELETE https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_tracking/token/trackingcode_id HTTP/1.1 
QR Scans
POST /ws_scans/{token}
GET /ws_scans/{token}
GET /ws_scans/{token}
DELETE /ws_scans/{token}/{scanId}
Create QR Scan
POST /ws_scans/{token}

Creates a QR Scan with the given values supplied in the request body.

Path variables

token
string required

The value received after a successful Auth request.

Example:
47a4a8bbe513455ae7703eed495d2563e178da63b80aa8c9

Request body

Responses

200 OK
Body
Object
success
boolean
Example:
true

Examples

POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_scans/token HTTP/1.1 

Content-Type: application/json

{
  "ipdomain":"ipdomain input",
  "dt_created" : "2014-03-06 10:13:56",
  "zipcode":"93422",
  "isp":"isp input",
  "barcode":"07016276540",
  "areacode":"805",
  "job_guid":"6ED88224-F77B-422D-9AB6-F7922FDC4509",
  "imbdigits":"30311201110998000001",
  "device_info":"info input",
  "city":"Atascadero",
  "country_short":"US",
  "timezone":"PST",
  "ip_address":"12.68.179.22",
  "longitude":"-117.90756",
  "latitude":"34.133618",
  "mobile_network":"mobile_network input",
  "mobile_brand":"mobile_brand input",
  "job_id":"246018"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "url_stat_id": 42,
  "success": true
}
Select QR scan by jobid
GET /ws_scans/{token}

Path variables

token
string optional
Example:
47a4a8bbe513455ae7703eed495d2563e178da63b80aa8c9

Request parameters

jobId
number required
Example:
246018

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_scans/token/jobId=246018 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "scans": [
        {
            "ipdomain": "create date => 2015-1-28 8:42:17.776",
            "city": "Atascadero",
            "timezone": "PST",
            "isp": "postman",
            "latitude": "34.133618",
            "mobile_network": "",
            "dt_created": {
                "javaClass": "java.util.Date",
                "time": 0
            },
            "ip_address": "12.68.179.22",
            "mobile_brand": "postman",
            "areacode": "805",
            "zipcode": "93422",
            "country_short": "US",
            "device_info": "postman",
            "imbdigits": "12345678901234567890",
            "job_id": 246018,
            "barcode": "12345678901",
            "job_guid": "6ED88224-F77B-422D-9AB6-F7922FDC4509",
            "longitude": "-117.90756"
        }
    ],
    "success": true
}
Select QR scan by barcode and imbdigits
GET /ws_scans/{token}

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246018
barcode
number optional

11 digit number

Example:
12345678901
imbDigits
number required

20 digit number

Example:
12345678901234567000

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_scans/token/jobId=246018&imbDigits=12345678901234567000&barcode=12345678901 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "scans": [
        {
            "ipdomain": "the ipdomain",
            "city": "Atascadero",
            "timezone": "PST",
            "isp": "the isp",
            "latitude": "34.133618",
            "mobile_network": "",
            "dt_created": {
                "javaClass": "java.util.Date",
                "time": 0
            },
            "ip_address": "12.68.179.22",
            "mobile_brand": "the mobile brand",
            "areacode": "805",
            "zipcode": "93422",
            "country_short": "US",
            "device_info": "the device info",
            "imbdigits": "12345678901234567000",
            "job_id": 246018,
            "barcode": "12345678901",
            "job_guid": "6ED88224-F77B-422D-9AB6-F7922FDC4509",
            "longitude": "-117.90756"
        }
    ],
    "success": true
}
Select QR Scan by date
GET /ws_scans/{token}

Select QR Scans where (startDate <= dt_created <= endDate)

Path variables

token
string optional

Request parameters

jobId
number required
Example:
246018
startDate
string required

fomat: MM-dd-yyyy

Example:
01-28-2015
endDate
string required

format: MM-dd-yyyy

Example:
02-20-2015

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_scans/token/jobId=246019&startDate=2-9-2015&endDate=2-10-2015 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "scans": [
        {
            "ipdomain": "create date => 2015-2-9 9:14:52.603",
            "city": "Atascadero",
            "timezone": "PST",
            "isp": "postman",
            "latitude": "34.133618",
            "mobile_network": "",
            "dt_created": {
                "javaClass": "java.util.Date",
                "time": 1423494892000
            },
            "ip_address": "12.68.179.22",
            "mobile_brand": "postman",
            "areacode": "805",
            "zipcode": "93422",
            "country_short": "US",
            "device_info": "postman",
            "imbdigits": "12345678901234567890",
            "job_id": 246019,
            "barcode": "12345678901",
            "job_guid": "6ED88224-F77B-422D-9AB6-F7922FDC4509",
            "longitude": "-117.90756"
        }
    ],
    "success": true
}
Delete QR Scan
DELETE /ws_scans/{token}/{scanId}

Deletes a QR scan with the corresponding scanId.

Path variables

token
string required

The value received after a successful Auth request.

Example:
47a4a8bbe513455ae7703eed495d2563e178da63b80aa8c9
scanId
string optional
Example:
984133

Responses

200 OK

With PUT and DELETE requests, no response data is returned, only a HTTP 200 (success) or 404 (failure).

Examples

DELETE https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_scans/token/984133 HTTP/1.1 
Job Detail
GET /ws_job_detail/{token}
Request New Job GUID
GET /ws_job_detail/{token}

Request a new GUID for the job associated with the supplied jobId.

Path variables

token
string required
Example:
d112bfdb7e25cdaa47867e942e783a979d6b2941b3029ee0

Request parameters

newJobGuid
boolean required
Example:
true
jobid
number required
Example:
246018

Responses

200 OK
Body
Object
success
boolean
Example:
true
message
string
data
Object
weblink
string
Example:
"https://accuzip.iaccutrace.com/track/?uid=4C2FEDD1-5723-40E9-B7BE-E1A7C15E7720"

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_detail/token/246018&newJobGuid=true HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "weblink": "https://accuzip.iaccutrace.com/track/?uid=4C2FEDD1-5723-40E9-B7BE-E1A7C15E7720"
    },
    "success": true,
    "message": null
}
Job Export and Upload

Export job & jobs in excel(for both), pdf, html

GET /ws_job_reports/{token}
GET /ws_job_export/{token}/
POST /beta2/jsp/ws_jobs_upload.jsp
get Job Export
GET /ws_job_reports/{token}

Generates report file and collects url of generated file via urlrewriter, csv files are zipped Pre-condition for reaching reporting section is to set exportType parameter

Path variables

token
string required

Request parameters

reportNumber
reportNumber required

Usage: reportNumber=reportName [1=Dashboard, 2=In Home Delivery Performance, ..., 19=Daily Stop Scan Results By State]

jobId
string required

PK of the job that the report will be generated for

Example:
123456789
exportType
string required

Format of download is pdf, csv or html.

Example:
pdf
getDataSet
boolean required
Example:
true
level
string required

Report level [1|2|3|4]

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=2&jobId=246018&exportType=pdf&getDataSet=true&level=1 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true,
    "fileURL": "/stream/EE9B1C3E-6EA8-4DF6-A39F-04AED27F6B35/export.pdf"
}
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=4&jobId=246018&exportType=html&getDataSet=true&level=1 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "fileURL": "/stream/513FDCBD-D01F-4E7B-B6D6-250310B54332/export.html",
    "success": true
}
GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_reports/token/reportNumber=10&jobId=246018&exportType=csv&getDataSet=true&level=1 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "fileURL": "/stream/D33DD803-0329-48A9-8295-81FE16262DC7/export.zip",
    "success": true
}
get All Jobs Export
GET /ws_job_export/{token}/

Exports all jobs for the date interval defined by startDate and endDate.

Path variables

token
string required

Request parameters

exportType
string required

csv or pdf

startDate
string required

format:MM-dd-yyyy (05-28-2015)

endDate
string required

format:MM-dd-yyyy (06-02-2015)

exportConfirmed
boolean optional

Used to acknowledge downloading of greater than 50 jobs.

Responses

200 OK (less than 50 jobs to download)
Body
Object
fileURL
string
Example:
/stream/D33DD803-0329-48A9-8295-81FE16262DC7/export.zip
success
boolean
Example:
true
200 OK (more than 50 jobs to download)
Body
Object
confirm_dialog
boolean
Example:
true
jobs_count
number
Example:
312
success
boolean
Example:
true

Examples

Number of jobs to be downloaded is less than 50.

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_export/token/startDate=1-1-2012&endDate=1-2-2012&exportType=csv/ HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "fileURL": "/stream/D33DD803-0329-48A9-8295-81FE16262DC7/export.zip",
    "success": true
}

Number of Jobs to be downloaded is greater than 50. Did not include &exportConfirmed=true in the request URL.

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_export/token/startDate=5-18-2015&endDate=5-19-2015&exportType=csv/ HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "confirm_dialog": true,
    "jobs_count": 312,
    "success": true
}

Request to download 50 jobs or more.

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_job_export/token/startDate=5-18-2015&endDate=5-19-2015&exportType=csv&exportConfirmed=true/ HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "fileURL": "/stream/0C21662A-5D71-4ECB-8B69-C378EEE1F881/export.zip",
    "success": true
}
get Job Upload File path
POST /beta2/jsp/ws_jobs_upload.jsp

multi-part form upload

Example

POST /beta2/jsp/ws_jobs_upload.jsp HTTP/1.1

Host: demo.iaccutrace.com

Cache-Control: no-cache Postman-Token: 61b45d8d-db77-f0de-6fc4-e07c7c0772c4 Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="tenant_id"

371

----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="user_id"

316

----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="token"

cb15069f280f1f484447595413514184d3182e6cb78c37e4

----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="files[]"; filename="trackingcodes_2gether.txt" Content-Type: text/plain

----WebKitFormBoundary7MA4YWxkTrZu0gW

Request parameters

tenant_id
string required

PK of the tenant for logged-in user

user_id
string required

PK of logged-in user

token
string required

session-level token

file
string required
Example:
see http://www.accuzip.com/files/accutracedoc.pdf link above

Responses

200 OK
Body
Object
response
string

{ "message": "File successfully uploaded", "success": "true" }

Settings

Company settings, further goals like Distributor settings

GET /ws_admin/{pToken}
get Company Settings
GET /ws_admin/{pToken}

Fills settings form for manipulation with combined data from tenant and user

Path variables

pToken
string required

Request parameters

pUser_id
string optional

PK of currently logged user

Responses

200 OK
Update Company Settings
PUT /ws_admin

depending on submitted params.action_name value: -saveSettings -testEmail -setPassword -testFTPSettings

Request body

Object
action_name
string

evaluated function server-side

Example:
saveSettings, testEmail, setPassword, testFTPSettings
token
string
Example:
3934da3d46cc0785a4089ffd80fc9036f6180b01df9e87a9
api_key
string
Example:
368BBDA8-4066-43EC-9DD5-714F302E138C
name_first
string
Example:
Steve
name_last
string
Example:
Belmonte
company_name
string
Example:
AccuZIP Inc.
address_1
string
Example:
3216 El Camino Real
address_2
string
city
string
Example:
Atascadero
state
string
Example:
CA
zip
string
Example:
93422-2500
phone_1
string
Example:
805-461-7300
phone_2
string
email
string
Example:
support@accuzip.com
email_acct_from
string
Example:
confirm@accuzip.com
email_acct_smtp_server
string
Example:
mail.accuzip.com
email_acct_smtp_port
string
Example:
25
email_acct_username
string
Example:
confirm@accuzip.com
email_acct_password
string
Example:
b0da6c5f56a39b1e1c2d4dc9f893935d
email_acct_advanced
string
Example:
some advanced values
email_acct_smtp_auth
string
Example:
0
limit_trackingcodes
string
Example:
157
domain_url
string
Example:
https://accuzip.iaccutrace.com
user_name
string
Example:
admin
user_password
string
ftp_mode
string
Example:
21
ckeditortitle
string
Example:
test %%jobDescription%% more
ckEditorImportSuccess
string
Example:
<p>test &nbsp;%%weblink%%&nbsp;&nbsp;import success</p>
ckEditorTitleError
string
Example:
%%mailtotal%% subject to test %%name_first%%
ckEditorImportError
string
Example:
<p>impor error message&nbsp;%%name_first%%&nbsp;</p>
user_id
number
Example:
5

Responses

200 OK

true / false

Distributor Settings

Methods to select and update distributor settings.

GET /ws_distributors/{token}/{key}/{options}
PUT /ws_distributors/{token}/{key}
Select Distributor Settings
GET /ws_distributors/{token}/{key}/{options}

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445
options
string required

The key/value query string pairs for passing in response options.

Example:
includeTenants=true

Responses

200 OK
Body
unknown
Update Distributor Settings
PUT /ws_distributors/{token}/{key}

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445

Request body

Responses

200 OK

Only a HTTP status of 200 (success) or 404 (failed) is returned with PUT and DELETE requests. Nothing is returned in the body.

Customers

Methods to select, add, edit and delete customers.

GET /ws_tenants/{token}/{key}/{filters}
POST /ws_tenants/{token}/{key}
PUT /ws_tenants/{token}/{key}
DELETE /ws_tenants/{token}/{key}/{customerId}
Select Customer(s)
GET /ws_tenants/{token}/{key}/{filters}

GET method to select one (with supplied tenant_id) or many (with or without filters) customers.

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445d6dd0db9738
filters
string required

The key/value query string pairs for filtering customer results.

Example:
tenant_id=34509&basicInfo=true

Request parameters

tenant_id
number optional

Select a single customer by ID.

Example:
34509
basicInfo
boolean optional

If set to true, only basic info will be returned with the response. This is useful when expecting multiple customers to be returned and only need basic information, which speeds up response time. Will omit logos, email settings, FTP settings, and LIVINGMAIL settings if set to true.

Example:
true

Responses

200 OK
Body
Array of Customer
Create Customer
POST /ws_tenants/{token}/{key}

Create a customer by passing the new customer properties in the body of the request.

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445

Request body

Responses

200 OK

The default AccuTrace API response returns success, message, and data properties. You will find the newly created customer properties inside the data property.

Body
Update Customer
PUT /ws_tenants/{token}/{key}

Update an existing customer by providing the customer properties in the request body.

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445

Request body

Responses

200 OK

Only a HTTP status of 200 (success) or 404 (failed) is returned with PUT and DELETE requests. Nothing is returned in the body.

Delete Customer
DELETE /ws_tenants/{token}/{key}/{customerId}

Delete a customer by passing a valid token and distributor key, as well as the ID of the customer to be deleted.

Path variables

token
string required

The authorization token.

Example:
3a2cdb59384c3580b39f6f46ffa3826fb7349d7ad37adc68
key
string required

The distributor key. This is provided upon authorization for distributors.

Example:
b77t5425eeacb33b82a96fa96152967fj4e732af4bdb418f304e7a0c044a0487dc445
customerId
number required

The ID of the customer to delete.

Example:
852140

Responses

200 OK

Only a HTTP status of 200 (success) or 404 (failed) is returned with PUT and DELETE requests. Nothing is returned in the body.

LIVINGMAIL Admin

Messages nature, crucial property of every message: Play Text-To-Speech Play Recorded Audio Send SMS Send Email Conference Call, Text-To-Speech Conference Call, Recorded Audio

Messages purposes, when assigned to certain job in which context to be invoked: Send on Date/Time Send on First Scan Send on Out for Delivery Send on QR Code Scan

GET /ws_admin_livingmail/{token}
GET /ws_admin_livingmail/{token}
POST /ws_admin_livingmail/{token}
PUT /ws_admin_livingmail/{token}
POST /{appDirectory}/jsp/ws_admin_livingmail_upload.jsp
DELETE /ws_admin_livingmail/{token}
Select LIVINGMAIL by tenant_id
GET /ws_admin_livingmail/{token}

Path variables

token
string required

Responses

200 OK
Body
Array of LIVINGMAIL

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail/{token} HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "settingsMessages": [
    {
      "livingmail_msg": "another%20field%20name%20test",
      "allow_recording": "1",
      "livingmail_description": "id description2",
      "livingmail_id": "2",
      "tenant_id": "5",
      "upload_url": "",
      "sel_livingmail": "",
      "livingmail_nature_id": "1",
      "livingmail_gender": "1",
      "livingmail_nature_val": "Play Text-To-Speech"
    },
    {
      "livingmail_msg": "",
      "allow_recording": "0",
      "livingmail_description": "Classic and Modern Methods: Multi-Media is the way to bottle new wine business",
      "livingmail_id": "3",
      "tenant_id": "5",
      "upload_url": "",
      "sel_livingmail": "",
      "livingmail_nature_id": "4",
      "livingmail_gender": "",
      "livingmail_nature_val": "Send Email"
    },
    {
      "livingmail_msg": "another%20documentation%20builder",
      "allow_recording": "1",
      "livingmail_description": "",
      "livingmail_id": "4",
      "tenant_id": "5",
      "upload_url": "",
      "sel_livingmail": "",
      "livingmail_nature_id": "1",
      "livingmail_gender": "1",
      "livingmail_nature_val": "Play Text-To-Speech"
    },
    {
      "livingmail_msg": "",
      "allow_recording": "1",
      "livingmail_description": "mp3 upload",
      "livingmail_id": "5",
      "tenant_id": "5",
      "upload_url": "livingmail_uploads5_5_EAE679F7-1B36-44E7-9C20-07B50CFDCE4B.mp3",
      "sel_livingmail": "",
      "livingmail_nature_id": "2",
      "livingmail_gender": "",
      "livingmail_nature_val": "Play Recorded Audio"
    },
    {
      "livingmail_msg": "email",
      "allow_recording": "1",
      "livingmail_description": "mp3 upload",
      "livingmail_id": "7",
      "tenant_id": "5",
      "upload_url": "livingmail_uploads5_7_9F2DBF16-CE3A-41CB-BAAE-AB94D0FA70E6.mp3",
      "sel_livingmail": "",
      "livingmail_nature_id": "2",
      "livingmail_gender": "1",
      "livingmail_nature_val": "Play Recorded Audio"
    },
    {
      "livingmail_msg": "",
      "allow_recording": "1",
      "livingmail_description": "mp3 upload",
      "recorded_link": "http://localhost:8080/uploads/livingmail_uploads/5_8_B9B2B12E-7D37-412F-96C7-701735564198.mp3",
      "livingmail_id": "8",
      "tenant_id": "5",
      "upload_url": "livingmail_uploads5_8_B9B2B12E-7D37-412F-96C7-701735564198.mp3",
      "sel_livingmail": "",
      "livingmail_nature_id": "2",
      "livingmail_gender": "",
      "livingmail_nature_val": "Play Recorded Audio"
    }
  ],
  "settingsMessagesOptionsCaptions": [
    "",
    "Play Text-To-Speech",
    "Play Recorded Audio",
    "Send SMS",
    "Send Email",
    "Conference Call, Text-To-Speech",
    "Conference Call, Recorded Audio"
  ],
  "settingsMessagesOptionsValues": [
    "",
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "pageNumber": 1,
  "numberOfPages": 1,
  "success": true
}
Select LIVINGMAIL by id
GET /ws_admin_livingmail/{token}

Selects LivingMail by livingmail_id

Path variables

token
string required
Example:

Request parameters

livingmail_id
number required
Example:
1

Responses

200 OK
Body

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail/{token}/livingil_id=2 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "settingsMessages": [
        {
            "livingmail_msg": "%3cp%3ehttps%3a%2f%2fwww.youtube.com%2fwatch%3fv%3dNRP6M_a8bnw%26amp%3bfeature%3dyoutu.be%3c%2fp%3e",
            "allow_recording": "0",
            "livingmail_description": "testmonial",
            "livingmail_id": "2",
            "tenant_id": "371",
            "upload_url": "",
            "sel_livingmail": "",
            "livingmail_nature_id": "4",
            "livingmail_gender": "",
            "livingmail_nature_val": "Send Email"
        }
    ],
    "settingsMessagesOptionsCaptions": [
        "",
        "Play Text-To-Speech",
        "Play Recorded Audio",
        "Send SMS",
        "Send Email",
        "Conference Call, Text-To-Speech",
        "Conference Call, Recorded Audio"
    ],
    "settingsMessagesOptionsValues": [
        "",
        1,
        2,
        3,
        4,
        5,
        6
    ],
    "pageNumber": 1,
    "numberOfPages": 1,
    "success": true
}
Create LIVINGMAIL
POST /ws_admin_livingmail/{token}

Path variables

token
string optional

Request body

Object
action_name
string
Example:
saveSettingsMessage
livingmail_nature_id
Example:
2
allow_recording
string

0 = false, 1 = true

Example:
1
livingmail_description
string
Example:
livingmail_description input
livingmail_gender
string

0 = male, 1 = female

Example:
0
livingmail_msg
string
Example:
livingmail_msg input
livingmail_val
string
Example:
email vs txt
tenant_id
string
Example:
5

Responses

200 OK

Examples

POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail/{token} HTTP/1.1 

Content-Type: application/json

{
    "action_name": "saveSettingsMessage",
    "livingmail_nature_id": "2",
    "allow_recording": "1",
    "livingmail_description": "livingmail_description input",
    "livingmail_gender": "0",
    "livingmail_msg": "livingmail_msg input",
    "livingmail_val": "email vs txt",
    "tenant_id": "5"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "livingmail_id": 29,
  "success": true
}
Update LIVINGMAIL
PUT /ws_admin_livingmail/{token}

Depends on action_name it invokes methods saveSettingsMessage or playbackSettingsMessage Further saveSettingsMessage can be invoked via ws_create

Path variables

token
string required

Request body

Object
livingmail_id
string
Example:
29
action_name
string
Example:
saveSettingsMessage
livingmail_nature_id
Example:
1
allow_recording
string

0 = false, 1 = true

Example:
1
livingmail_description
string
Example:
update description input
livingmail_gender
string

0 = male, 1 = female

Example:
0
livingmail_msg
string
Example:
update livingmail msg
livingmail_val
string
Example:
update livingmail_val
tenant_id
string
Example:
5

Responses

200 OK

Examples

PUT https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail/{token} HTTP/1.1 

Content-Type: application/json

{
  	"livingmail_id":"29",
    "action_name":"saveSettingsMessage",
    "livingmail_nature_id":"1",
    "allow_recording":"1",
    "livingmail_description":"update description input",
    "livingmail_gender":"0",
    "livingmail_msg":"update livingmail msg",
    "livingmail_val":"update livingmail_val ",
    "tenant_id":"5"
}

HTTP/1.1 200 OK 

Content-Type: application/json

Upload for Create or Update LIVINGMAIL
POST /{appDirectory}/jsp/ws_admin_livingmail_upload.jsp

Servoy's WS accessible via jsp/ws_admin_livingmail_upload.jsp as multi-part data is allowed

Path variables

appDirectory
string optional

Request parameters

appDirectory
string optional

accutrace-html5

livingmail_id
number required
Example:
1
tenant_id
number required
Example:
1
user_id
number optional
Example:
1
livingmail_description
string required
livingmail_nature_id
number required
Example:
1
sel_livingmail
boolean required
Example:
false
livingmail_msg_val
string required
allow_recording
boolean optional
Example:
false
file_size_to_upload
number required
file_extension_upload
number required
upload_livingmail_max_file_size
number required
files[]
string optional

input stream for upload

Responses

200 OK

link to upoaded .mp3

Body
string
Examples
demo.iaccutrace.com/livingmail_uploads/5_5_EAE679F7-1B36-44E7-9C20-07B50CFDCE4B.mp3

Examples

POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest//jsp/ws_admin_livingmail_upload.jsp?livingmail_id=1&tenant_id=1&livingmail_nature_id=1 HTTP/1.1 

Content-Type: application/json

------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="livingmail_msg_id"

------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="tenant_id"

5 ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="user_id"

5 ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="livingmail_msg_id_description"

docsupload ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="livingmail_msg_option"

3 ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="sel_livingmail_msg"

undefined ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="livingmail_msg_val"

------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="allow_recording"

1 ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="token"

960f665239fb752778e8001d89d27b43d980984b562df4f8 ------WebKitFormBoundaryXVX6DNA0pUxDXBes Content-Disposition: form-data; name="files[]"; filename="20_33.mp3" Content-Type: audio/mp3

------WebKitFormBoundaryXVX6DNA0pUxDXBes-

HTTP/1.1 200 OK 
Delete LIVINGMAIL
DELETE /ws_admin_livingmail/{token}

Path variables

token
string required

application-level token

Request parameters

livingmail_id
number required

Responses

200 OK

Examples

DELETE https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail/{token}/livingmail_id=2 HTTP/1.1 

HTTP/1.1 200 OK 
LIVINGMAIL Admin Communication

ws_admin_livingmail_nature

GET /ws_admin_livingmail_nature/{token}
GET /ws_admin_livingmail_nature/{token}
POST /ws_admin_livingmail_nature/{token}
PUT /ws_admin_livingmail_nature/{token}
DELETE /ws_admin_livingmail_nature/{token}
Select LIVINGMAIL Communication methods
GET /ws_admin_livingmail_nature/{token}

Path variables

token
string required

Responses

200 OK
Body

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_nature/{token} HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "settingsMessagesNatures": [
        {
            "exec_api_description": "",
            "nature_name": "Play Text-To-Speech",
            "livingmail_nature_id": "1"
        },
        {
            "exec_api_description": "",
            "nature_name": "Play Recorded Audio",
            "livingmail_nature_id": "2"
        },
        {
            "exec_api_description": "",
            "nature_name": "Send SMS",
            "livingmail_nature_id": "3"
        },
        {
            "exec_api_description": "",
            "nature_name": "Send Email",
            "livingmail_nature_id": "4"
        },
        {
            "exec_api_description": "",
            "nature_name": "Conference Call, Text-To-Speech",
            "livingmail_nature_id": "5"
        },
        {
            "exec_api_description": "",
            "nature_name": "Conference Call, Recorded Audio",
            "livingmail_nature_id": "6"
        }
    ],
    "pageNumber": 1,
    "numberOfPages": 1,
    "success": true
}
Select LIVINGMAIL Communication method by id
GET /ws_admin_livingmail_nature/{token}

Path variables

token
string required

Request parameters

livingmail_nature_id

Responses

200 OK

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_nature/{token}/livingmail_nature_id=1 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "settingsMessagesNatures": [
        {
            "exec_api_description": "",
            "nature_name": "Play Text-To-Speech",
            "livingmail_nature_id": "1"
        }
    ],
    "pageNumber": 1,
    "numberOfPages": 1,
    "success": true
}
Create LIVINGMAIL Communication method
POST /ws_admin_livingmail_nature/{token}

Path variables

token
string optional

Request body

Responses

200 OK

Examples

POST https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_nature/{token} HTTP/1.1 

Content-Type: application/json

{
    "action_name":"saveSettingsMessage",
    "nature_name":"new LivingMail nature",
    "exec_api_description":""
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "livingmail_nature_id": 88,
  "success": true
}
Update LIVINGMAIL Communication method
PUT /ws_admin_livingmail_nature/{token}

Path variables

token
string optional

Request body

Responses

200 OK

Examples

PUT https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_nature/{token} HTTP/1.1 

Content-Type: application/json

{
    "livingmail_nature_id":"8",
    "action_name":"saveSettingsMessage",
    "nature_name":"updated info",
    "exec_api_description":""
}

HTTP/1.1 200 OK 
Delete LIVINGMAIL Communication method
DELETE /ws_admin_livingmail_nature/{token}

Path variables

token
string required

Request parameters

livingmail_nature_id
number required
Example:
2

Responses

200 OK

Examples

DELETE https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_nature/{token}/livingmail_nature_id=2 HTTP/1.1 
LIVINGMAIL Admin Triggers

ws_admin_livingmail_triggers

GET /ws_admin_livingmail_triggers/{token}
GET /ws_admin_livingmail_triggers/{token}
POST /ws_admin_livingmail_triggers/{token}
PUT /ws_admin_livingmail_triggers/{token}
DELETE /ws_admin_livingmail_triggers/{token}
Select LIVINGMAIL Triggers
GET /ws_admin_livingmail_triggers/{token}

Path variables

token
string required

Responses

200 OK
Body

Examples

GET https://{your prefix}.iaccutrace.com/servoy-service/rest_ws/mod_rest/ws_admin_livingmail_triggers/{token} HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "pageNumber": 1,
    "settingsMessagesTriggers": [
        {
            "is_query_or_event": "1",
            "livingmail_trigger_id": "1",
            "behave_description": "SELECT * FROM lm_date_time()",
            "trigger_name": "Message on Date Time"
        },
        {
            "is_query_or_event": "1",
            "livingmail_trigger_id": "2",
            "behave_description": "SELECT * FROM lm_first_scan() ",
            "trigger_name": "Message on First Scan"
        },
        {
            "is_query_or_event": "1",
            "livingmail_trigger_id": "3",
            "behave_description": "SELECT * FROM lm_out_for_delivery()",
            "trigger_name": "Message on Out Delivery"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "4",
            "behave_description": "afterInsertRecord_url_stats",
            "trigger_name": "Message on QR Scan"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "5",
            "behave_description": "",
            "trigger_name": "01 - Delivered (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "6",
            "behave_description": "",
            "trigger_name": "02 - Notice Left (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "7",
            "behave_description": "",
            "trigger_name": "03 - Accept or Pickup (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "8",
            "behave_description": "",
            "trigger_name": "04 - Refused (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "9",
            "behave_description": "",
            "trigger_name": "05 - Undeliverable as Addressed (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "10",
            "behave_description": "",
            "trigger_name": "06 - Forwarded (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "11",
            "behave_description": "",
            "trigger_name": "07 - Arrival at Unit (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "12",
            "behave_description": "",
            "trigger_name": "08 - Missent (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "13",
            "behave_description": "",
            "trigger_name": "09 - Return to Sender (IMpb only)"
        },
        {
            "is_query_or_event": "0",
            "livingmail_trigger_id": "14",
            "behave_description":