Scanning | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve information about RAS scanning settings.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve the RAS universal scanning settings (optional)

Responses

application/json; api-version=1.0

objectOptional

RAS Scanning Settings

application/json; api-version=1.0

get

GET /api/ScanningSettings HTTP/1.1
Host: 
Accept: */*

{
  "twainNamePattern": "text",
  "replicateTWAINPattern": true,
  "wiaNamePattern": "text",
  "replicateWIAPattern": true,
  "twainApps": [
    "text"
  ],
  "replicateTWAINApps": true
}

Update

put

Update scanning settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

SiteIdinteger · int32Optional

Site ID (optional)

Body

Update RAS Universal Scanning settings

wiaNamePatternstring | nullableOptional

WIA Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID%

replicateWIAPatternboolean | nullableOptional

Replicate WIA pattern.

twainNamePatternstring | nullableOptional

TWAIN Name Pattern. Default pattern: %SCANNERNAME% for %USERNAME% by Parallels Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Scanner

replicateTWAINPatternboolean | nullableOptional

Replicate TWAIN Pattern.

twainAppsstring[] | nullableOptional

Specifies items in the TWAIN Applications list.

replicateTWAINAppsboolean | nullableOptional

Replicate TWAIN Applications.

Responses

application/json; api-version=1.0

put

PUT /api/ScanningSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 154

{
  "wiaNamePattern": "text",
  "replicateWIAPattern": true,
  "twainNamePattern": "text",
  "replicateTWAINPattern": true,
  "twainApps": [
    "text"
  ],
  "replicateTWAINApps": true
}

No content