Interface IOrganizationSensorRelationships

Namespace

Meraki.Api.Interfaces.Products.Sensor

Assembly

Meraki.Api.dll

public interface IOrganizationSensorRelationships

Methods

GetDeviceSensorRelationshipsAsync(string, CancellationToken)

List the sensor roles for a given sensor or camera device.

[Get("/devices/{serial}/sensor/relationships")]
Task<List<SensorRelationship>> GetDeviceSensorRelationshipsAsync(string serial, CancellationToken cancellationToken = default)

Parameters

serial string

The device serial

cancellationToken CancellationToken

Returns

Task<List<SensorRelationship>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSensorRelationshipsAsync(string, CancellationToken)

List the sensor roles for devices in a given network

[Get("/networks/{networkId}/sensor/relationships")]
Task<List<NetworkSensorRelationship>> GetNetworkSensorRelationshipsAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<NetworkSensorRelationship>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateDeviceSensorRelationshipsAsync(string, SensorRelationship, CancellationToken)

Assign one or more sensor roles to a given sensor or camera device.

[Put("/devices/{serial}/sensor/relationships")]
Task<SensorRelationship> UpdateDeviceSensorRelationshipsAsync(string serial, SensorRelationship sensorRelationshipUpdateRequest, CancellationToken cancellationToken = default)

Parameters

serial string

The device serial

sensorRelationshipUpdateRequest SensorRelationship

Body for updating a sensor role

cancellationToken CancellationToken

Returns

Task<SensorRelationship>

Exceptions

ApiException

Thrown when fails to make API call