Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

header-navigation
keyboard_arrow_up
close
keyboard_arrow_left
REST API Version 16.0 References
Table of Contents Expand all
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
keyboard_arrow_right

POST /scanner/profiles/start

date_range 04-Aug-21

SUMMARY Initiates a request to start an already created scanProfile. The request takes one parameter - scanProfileId. To get a list of scanProfileIds, simply get a list of the current scan profiles by initiating a 'profiles' request on the scanner endpoint. The scanProfileId will be validated and an appropriate message returned.

Table 1: POST /scanner/profiles/start resource details:

POST /scanner/profiles/start resource details

MIME Type

text/plain

Table 2: POST /scanner/profiles/start request parameter details:

POST /scanner/profiles/start request parameter details

Parameter Type Optionality Data Type MIME Type Description

scanProfileId

query

Required

String

text/plain

The unique id of the scan profile we want to start

Table 3: POST /scanner/profiles/start response codes:

POST /scanner/profiles/start response codes

HTTP Response Code Unique Code Description

200

The scan has been successfully started

422

1005

Occurs if the user does not have permission to start a scan, or the scan is in progress

500

1030

Occurs when an attempt is made to start a scan when certain conditions are not met, or when too many scan requests have been made

Response Description

An indicator of whether the scan has been started successfully or not.

Response Sample

content_copy zoom_out_map
String
footer-navigation