v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location

Stop a scan

Stop a previously created AP ranging scan. Only scans in the PENDING state can successfully be stopped. Once a scan has transitioned to the SCHEDULED or SCANNING states, the user will need to wait for the scan to complete before the network can be restored. Scans in the other states are already stopped, so stopping them will effectively be a no-op.

delete/network-services/v1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/{scan-id}

Path parameters

site-idstring uuid required

The Site ID associated with the device commonly in UUID format.

Site ID where the scan(s) were executed.

floor-idstring uuid required

The Floor ID associated with the device in UUID format.

Floor ID where the scan(s) were executed.

scan-idstring const required

A unique system generated identifier for an ftm scan. This is a string representation of a uint64.

The Scan ID.

Response

Scan was successfully stopped

result'SUCCESS' | 'INVALID_SCAN_STATE' enum