Interface IOrganizationsFloorPlansAutoLocate

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Floor Plans Auto Locate Interface

public interface IOrganizationsFloorPlansAutoLocate

Methods

BatchNetworkFloorPlansAutoLocateJobsAsync(string, FloorPlansAutoLocateJobsRequest, CancellationToken)

Schedule auto locate jobs for one or more floor plans in a network

[Post("/networks/{networkId}/floorPlans/autoLocate/jobs/batch")]
Task<FloorPlansAutoLocateJobsResponse> BatchNetworkFloorPlansAutoLocateJobsAsync(string networkId, FloorPlansAutoLocateJobsRequest floorPlansAutoLocateJobsRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

floorPlansAutoLocateJobsRequest FloorPlansAutoLocateJobsRequest

The list of auto locate jobs to be scheduled. Up to 100 jobs can be provided in a request.

cancellationToken CancellationToken

Returns

Task<FloorPlansAutoLocateJobsResponse>

Exceptions

ApiException

Thrown when fails to make API call

CancelNetworkFloorPlansAutoLocateJobAsync(string, string, CancellationToken)

Cancel Network Floor Plans Auto Locate Job

[Post("/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/cancel")]
Task CancelNetworkFloorPlansAutoLocateJobAsync(string networkId, string jobId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

jobId string

Job ID

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationFloorPlansAutoLocateDevicesAsync(string, CancellationToken)

List auto locate details for each device in your organization

[Get("/organizations/{organizationId}/floorPlans/autoLocate/devices")]
Task<FloorPlansAutoLocateDevices> GetOrganizationFloorPlansAutoLocateDevicesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<FloorPlansAutoLocateDevices>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationFloorPlansAutoLocateStatusesAsync(string, CancellationToken)

List the status of auto locate for each floorplan in your organization

[Get("/organizations/{organizationId}/floorPlans/autoLocate/statuses")]
Task<FloorPlansAutoLocateStatuses> GetOrganizationFloorPlansAutoLocateStatusesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<FloorPlansAutoLocateStatuses>

Exceptions

ApiException

Thrown when fails to make API call

PublishNetworkFloorPlansAutoLocateJobAsync(string, string, FloorPlansPublishAutoLocateJobRequest, CancellationToken)

Update the status of a finished auto locate job to be published, and update device locations

[Post("/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/publish")]
Task<FloorPlansPublishAutoLocateJobResponse> PublishNetworkFloorPlansAutoLocateJobAsync(string networkId, string jobId, FloorPlansPublishAutoLocateJobRequest floorPlansPublishAutoLocateJobRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

jobId string

Job ID

floorPlansPublishAutoLocateJobRequest FloorPlansPublishAutoLocateJobRequest

The list of auto locate jobs to be scheduled. Up to 100 jobs can be provided in a request.

cancellationToken CancellationToken

Returns

Task<FloorPlansPublishAutoLocateJobResponse>

Exceptions

ApiException

Thrown when fails to make API call

RecalculateNetworkFloorPlansAutoLocateJobAsync(string, string, FloorPlansRecalculateAutoLocateJobRequest, CancellationToken)

Trigger auto locate recalculation for a job, and optionally set anchors

[Post("/networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/recalculate")]
Task<FloorPlansRecalculateAutoLocateJobResponse> RecalculateNetworkFloorPlansAutoLocateJobAsync(string networkId, string jobId, FloorPlansRecalculateAutoLocateJobRequest floorPlansRecalculateAutoLocateJobRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

jobId string

Job ID

floorPlansRecalculateAutoLocateJobRequest FloorPlansRecalculateAutoLocateJobRequest

The list of auto locate jobs to be scheduled. Up to 100 jobs can be provided in a request.

cancellationToken CancellationToken

Returns

Task<FloorPlansRecalculateAutoLocateJobResponse>

Exceptions

ApiException

Thrown when fails to make API call