Skip to content

Commit b52e99b

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit ace92a5f
1 parent 1b8e404 commit b52e99b

File tree

3 files changed

+233
-17
lines changed

3 files changed

+233
-17
lines changed

‎articles/hello-world/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,6 @@ The Hello World web app covers the following features:
2121
3. [Specifying Scan Settings]({{site.hello-world}}scan-settings.html)
2222
4. [Editing Images]({{site.hello-world}}editing.html)
2323

24-
> Note: JavaScript in this section follows ECMAScript 5 for backward-compatibility reasons. Please modify the code to use modern features if you are targeting modern environments.
24+
<a href="{{site.baseurl}}assets/HelloWorld-Code.zip" class="orangeBgBtn">Download the Code of the Hello World</a>
25+
26+
> Note: JavaScript in this section follows ECMAScript 5 for backward-compatibility reasons. Please modify the code to use modern features if you are targeting modern environments.

‎assets/HelloWorld-Code.zip

2.53 KB
Binary file not shown.

‎info/api/restful.md

Lines changed: 230 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ fetch(url, requestOptions)
279279

280280
|HTTP Status Code |Meaning|Description|Data Schema|
281281
|---|---|---|---|
282-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation.|[`[Scanner]`](#scanner)|
282+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation.|[`Scanner[]`](#scanner)|
283283
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad request, e.g. parameter is invalid.|[`Error`](#error)|
284284
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
285285

@@ -513,7 +513,7 @@ fetch(url, requestOptions)
513513
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation.|[`ScannerJobInfo`](#scannerjobinfo)|
514514
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The provided job UID is invalid.|[`Error`](#error)|
515515
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
516-
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
516+
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job was deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
517517

518518
#### Response Examples
519519

@@ -552,7 +552,7 @@ fetch(url, requestOptions)
552552
```json
553553
{
554554
"code": -1034,
555-
"message": "Job deleted.",
555+
"message": "Job was deleted.",
556556
"statusCode": 410
557557
}
558558
```
@@ -609,7 +609,7 @@ fetch(url, requestOptions)
609609
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The provided job UID is invalid.|[`Error`](#error)|
610610
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
611611
|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Attempted to cancel non-pending or non-running job, or update a non-pending job to running.|[`Error`](#error)|
612-
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
612+
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job was deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
613613

614614
<!--#### Responses Data Schema
615615
@@ -674,7 +674,7 @@ HTTP Status Code **200**
674674
```json
675675
{
676676
"code": -1034,
677-
"message": "Job deleted.",
677+
"message": "Job was deleted.",
678678
"statusCode": 410
679679
}
680680
```
@@ -798,7 +798,7 @@ fetch(url, requestOptions)
798798
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The provided job UID is invalid.|[`Error`](#error)|
799799
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
800800
|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Cannot be called when job is not pending.|[`Error`](#error)|
801-
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
801+
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job was deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
802802

803803
#### Response Examples
804804

@@ -855,7 +855,7 @@ fetch(url, requestOptions)
855855
```json
856856
{
857857
"code": -1034,
858-
"message": "Job deleted.",
858+
"message": "Job was deleted.",
859859
"statusCode": 410
860860
}
861861
```
@@ -1015,7 +1015,7 @@ fetch(url, requestOptions)
10151015
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No more pages, scan done.|None|
10161016
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The provided job UID is invalid.|[`Error`](#error)|
10171017
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
1018-
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|Inline|
1018+
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job was deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|Inline|
10191019

10201020
#### Response Examples
10211021

@@ -1089,7 +1089,7 @@ fetch(url, requestOptions)
10891089
```json
10901090
{
10911091
"code": -1034,
1092-
"message": "Job deleted.",
1092+
"message": "Job was deleted.",
10931093
"statusCode": 410
10941094
}
10951095
```
@@ -1141,7 +1141,7 @@ fetch(url, requestOptions)
11411141
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad request, e.g. parameter is invalid.|[`Error`](#error)|
11421142
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The provided job UID is invalid.|[`Error`](#error)|
11431143
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
1144-
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
1144+
|410|[Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)|Job was deleted. Return 404 instead upon restart of the Dynamic Web TWAIN Service as that clears all job info.|[`Error`](#error)|
11451145

11461146
#### Response Examples
11471147

@@ -1182,7 +1182,7 @@ fetch(url, requestOptions)
11821182
```json
11831183
{
11841184
"code": -1034,
1185-
"message": "Job deleted.",
1185+
"message": "Job was deleted.",
11861186
"statusCode": 410
11871187
}
11881188
```
@@ -1861,7 +1861,7 @@ fetch(url, requestOptions)
18611861

18621862
|HTTP Status Code |Meaning|Description|Data Schema|
18631863
|---|---|---|---|
1864-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation.|[`OperationResult`](#operationresult)|
1864+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation.|[`BarcodeResult[]`](#barcoderesult)|
18651865
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad request, e.g. parameter is invalid.|[`Error`](#error)|
18661866
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|License is invalid.|[`Error`](#error)|
18671867
|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method not allowed.|[`Error`](#error)|
@@ -1879,9 +1879,112 @@ HTTP Status Code **200**
18791879
> 200 Response
18801880
18811881
```json
1882-
{
1883-
"result": true
1884-
}
1882+
[
1883+
{
1884+
"BarcodeFormat": 2,
1885+
"BarcodeFormatString": "CODE_128",
1886+
"LocalizationResult": {
1887+
"ResultPoints": [
1888+
"723, 274",
1889+
"1021, 275",
1890+
"1021, 375",
1891+
"723, 374"
1892+
],
1893+
"accompanyingTextBytes": [],
1894+
"angle": 0,
1895+
"barcodeFormat": 3147775,
1896+
"barcodeFormatString": "OneD",
1897+
"barcodeFormatString_2": "No Barcode Format in group 2",
1898+
"barcodeFormat_2": 0,
1899+
"confidence": 100,
1900+
"documentName": "{B683937D-B327-4488-A2C0-499760CB6BF0}",
1901+
"moduleSize": 2,
1902+
"pageNumber": 1,
1903+
"regionName": "",
1904+
"resultCoordinateType": 1,
1905+
"terminatePhase": 32,
1906+
"x1": 723,
1907+
"x2": 1021,
1908+
"x3": 1021,
1909+
"x4": 723,
1910+
"y1": 274,
1911+
"y2": 275,
1912+
"y3": 375,
1913+
"y4": 374
1914+
},
1915+
"barcodeBytes": [
1916+
67,
1917+
79,
1918+
68,
1919+
69,
1920+
49,
1921+
50,
1922+
56
1923+
],
1924+
"barcodeFormat": 2,
1925+
"barcodeFormatString": "CODE_128",
1926+
"barcodeFormatString_2": "No Barcode Format in group 2",
1927+
"barcodeFormat_2": 0,
1928+
"barcodeText": "CODE128",
1929+
"detailedResult": {
1930+
"checkDigitBytes": [],
1931+
"moduleSize": 2,
1932+
"startCharsBytes": [],
1933+
"stopCharsBytes": []
1934+
},
1935+
"localizationResult": {
1936+
"ResultPoints": [
1937+
"723, 274",
1938+
"1021, 275",
1939+
"1021, 375",
1940+
"723, 374"
1941+
],
1942+
"accompanyingTextBytes": [],
1943+
"angle": 0,
1944+
"barcodeFormat": 3147775,
1945+
"barcodeFormatString": "OneD",
1946+
"barcodeFormatString_2": "No Barcode Format in group 2",
1947+
"barcodeFormat_2": 0,
1948+
"confidence": 100,
1949+
"documentName": "{B683937D-B327-4488-A2C0-499760CB6BF0}",
1950+
"moduleSize": 2,
1951+
"pageNumber": 1,
1952+
"regionName": "",
1953+
"resultCoordinateType": 1,
1954+
"terminatePhase": 32,
1955+
"x1": 723,
1956+
"x2": 1021,
1957+
"x3": 1021,
1958+
"x4": 723,
1959+
"y1": 274,
1960+
"y2": 275,
1961+
"y3": 375,
1962+
"y4": 374
1963+
},
1964+
"results": [
1965+
{
1966+
"accompanyingTextBytes": [],
1967+
"barcodeFormat": 2,
1968+
"barcodeFormatString": "CODE_128",
1969+
"barcodeFormatString_2": "No Barcode Format in group 2",
1970+
"barcodeFormat_2": 0,
1971+
"bytes": [
1972+
67,
1973+
79,
1974+
68,
1975+
69,
1976+
49,
1977+
50,
1978+
56
1979+
],
1980+
"clarity": -1,
1981+
"confidence": 100,
1982+
"deformation": 0,
1983+
"resultType": 0
1984+
}
1985+
]
1986+
}
1987+
]
18851988
```
18861989

18871990
> 400 Response
@@ -2311,4 +2414,115 @@ Currently, only return log level.
23112414

23122415
|Name|Type|Required|Restrictions|Description|
23132416
|---|---|---|---|---|
2314-
|`result`|`boolean`|true|none|is blank image or not|
2417+
|`result`|`boolean`|true|none|is blank image or not|
2418+
2419+
2420+
### `BarcodeResult`
2421+
2422+
```json
2423+
{
2424+
"BarcodeFormat": 2,
2425+
"BarcodeFormatString": "CODE_128",
2426+
"LocalizationResult": {
2427+
"ResultPoints": [
2428+
"723, 274",
2429+
"1021, 275",
2430+
"1021, 375",
2431+
"723, 374"
2432+
],
2433+
"accompanyingTextBytes": [],
2434+
"angle": 0,
2435+
"barcodeFormat": 3147775,
2436+
"barcodeFormatString": "OneD",
2437+
"barcodeFormatString_2": "No Barcode Format in group 2",
2438+
"barcodeFormat_2": 0,
2439+
"confidence": 100,
2440+
"documentName": "{B683937D-B327-4488-A2C0-499760CB6BF0}",
2441+
"moduleSize": 2,
2442+
"pageNumber": 1,
2443+
"regionName": "",
2444+
"resultCoordinateType": 1,
2445+
"terminatePhase": 32,
2446+
"x1": 723,
2447+
"x2": 1021,
2448+
"x3": 1021,
2449+
"x4": 723,
2450+
"y1": 274,
2451+
"y2": 275,
2452+
"y3": 375,
2453+
"y4": 374
2454+
},
2455+
"barcodeBytes": [
2456+
67,
2457+
79,
2458+
68,
2459+
69,
2460+
49,
2461+
50,
2462+
56
2463+
],
2464+
"barcodeFormat": 2,
2465+
"barcodeFormatString": "CODE_128",
2466+
"barcodeFormatString_2": "No Barcode Format in group 2",
2467+
"barcodeFormat_2": 0,
2468+
"barcodeText": "CODE128",
2469+
"detailedResult": {
2470+
"checkDigitBytes": [],
2471+
"moduleSize": 2,
2472+
"startCharsBytes": [],
2473+
"stopCharsBytes": []
2474+
},
2475+
"localizationResult": {
2476+
"ResultPoints": [
2477+
"723, 274",
2478+
"1021, 275",
2479+
"1021, 375",
2480+
"723, 374"
2481+
],
2482+
"accompanyingTextBytes": [],
2483+
"angle": 0,
2484+
"barcodeFormat": 3147775,
2485+
"barcodeFormatString": "OneD",
2486+
"barcodeFormatString_2": "No Barcode Format in group 2",
2487+
"barcodeFormat_2": 0,
2488+
"confidence": 100,
2489+
"documentName": "{B683937D-B327-4488-A2C0-499760CB6BF0}",
2490+
"moduleSize": 2,
2491+
"pageNumber": 1,
2492+
"regionName": "",
2493+
"resultCoordinateType": 1,
2494+
"terminatePhase": 32,
2495+
"x1": 723,
2496+
"x2": 1021,
2497+
"x3": 1021,
2498+
"x4": 723,
2499+
"y1": 274,
2500+
"y2": 275,
2501+
"y3": 375,
2502+
"y4": 374
2503+
},
2504+
"results": [
2505+
{
2506+
"accompanyingTextBytes": [],
2507+
"barcodeFormat": 2,
2508+
"barcodeFormatString": "CODE_128",
2509+
"barcodeFormatString_2": "No Barcode Format in group 2",
2510+
"barcodeFormat_2": 0,
2511+
"bytes": [
2512+
67,
2513+
79,
2514+
68,
2515+
69,
2516+
49,
2517+
50,
2518+
56
2519+
],
2520+
"clarity": -1,
2521+
"confidence": 100,
2522+
"deformation": 0,
2523+
"resultType": 0
2524+
}
2525+
]
2526+
}
2527+
2528+
```

0 commit comments

Comments
 (0)