Class GatewayCandidate

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

Represents a Rexel gateway candidate discovered from the end-user directory API.

public sealed class GatewayCandidate

Inheritance

object

GatewayCandidate

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

ExternalId

Optional external identifier associated with the gateway; this is the Overkiz serial used in URL paths for Rexel cloud endpoints.

[JsonPropertyName("externalId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ExternalId { get; init; }

Property Value

string

GatewayId

Rexel gateway identifier required in the gatewayId header.

[JsonPropertyName("gatewayId")]
public required string GatewayId { get; init; }

Property Value

string

HomeId

Rexel home identifier that owns the gateway.

[JsonPropertyName("homeId")]
public required string HomeId { get; init; }

Property Value

string

Label

Optional human-readable home label.

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }

Property Value

string