Interface INetworksFloorplans

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface INetworksFloorplans

Methods

BatchNetworkFloorPlansDevicesUpdateAsync(string, FloorPlanBatchDevicesUpdateRequest, CancellationToken)

Update floorplan assignments for a batch of devices

[Post("/networks/{networkId}/floorPlans/devices/batchUpdate")]
Task<FloorPlanBatchDevicesUpdateResponse> BatchNetworkFloorPlansDevicesUpdateAsync(string networkId, FloorPlanBatchDevicesUpdateRequest floorPlanBatchDevicesUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

floorPlanBatchDevicesUpdateRequest FloorPlanBatchDevicesUpdateRequest

The request body

cancellationToken CancellationToken

Returns

Task<FloorPlanBatchDevicesUpdateResponse>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkFloorPlanAsync(string, FloorPlanCreationRequest, CancellationToken)

Upload a floor plan

[Post("/networks/{networkId}/floorPlans")]
Task<FloorPlan> CreateNetworkFloorPlanAsync(string networkId, FloorPlanCreationRequest createNetworkFloorPlan, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFloorPlan FloorPlanCreationRequest

Body for uploading a network floor plan

cancellationToken CancellationToken

Returns

Task<FloorPlan>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkFloorPlanAsync(string, string, CancellationToken)

Destroy a floor plan

[Delete("/networks/{networkId}/floorPlans/{floorPlanId}")]
Task DeleteNetworkFloorPlanAsync(string networkId, string floorPlanId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

floorPlanId string

The floor plan id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFloorPlanAsync(string, string, CancellationToken)

Find a floor plan by ID

[Get("/networks/{networkId}/floorPlans/{floorPlanId}")]
Task<FloorPlan> GetNetworkFloorPlanAsync(string networkId, string floorPlanId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

floorPlanId string

The floor plan id

cancellationToken CancellationToken

Returns

Task<FloorPlan>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFloorPlansAsync(string, CancellationToken)

List the floor plans that belong to your network

[Get("/networks/{networkId}/floorPlans")]
Task<List<FloorPlan>> GetNetworkFloorPlansAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<FloorPlan>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkFloorPlanAsync(string, string, FloorPlanUpdateRequest, CancellationToken)

Update a floor plan's geolocation and other meta data

[Put("/networks/{networkId}/floorPlans/{floorPlanId}")]
Task<FloorPlan> UpdateNetworkFloorPlanAsync(string networkId, string floorPlanId, FloorPlanUpdateRequest updateNetworkFloorPlan, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

floorPlanId string

The floor plan id

updateNetworkFloorPlan FloorPlanUpdateRequest

Body for updating a network floor plan

cancellationToken CancellationToken

Returns

Task<FloorPlan>

Exceptions

ApiException

Thrown when fails to make API call