Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location

Get scan resource

Returns the status of the AP ranging scan identified by the scan-id.

get/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

Returned FTM scan resource.

idstring const required

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

type'FTM_SCAN' enum required

A string indicating the document type.

{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
siteIdstring uuid required

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

floorIdstring uuid required

The Floor ID associated with the device in UUID format.

status'PENDING' | 'ABORTED' | 'CANCELLED' | 'SCHEDULED' | 'SCANNING' | 'COMPLETE' enum required

The current scan state.

PENDING - Scan request was accepted and awaiting scheduling by the system. ABORTED - Scan request was delayed and could not be scheduled before the calculated start time CANCELLED - Scan request was cancelled by the user SCHEDULED - Scan request has been scheduled by the system and is awaiting the scan start time SCANNING - Scan is currently running (wifi network connectivity is currently unavailable) COMPLETE - Scan has completed

serialNumbersSerialNumberopen[] required
{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
dwellTimeMillisinteger required

The number of milliseconds that the scan spends on each channel to attempt ranging to other nearby APs.

errorMessagestring const

An error message (if applicable). Indicates the reason for the scan failure.