Class AddressUpdateResponse

Namespace

SEBT.Portal.Api.Models.Household

Assembly

SEBT.Portal.Api.dll

API response for an address update request, including the validation outcome.

public record AddressUpdateResponse

Inheritance

object

AddressUpdateResponse

Properties

Message

A user-facing error message when the address is invalid.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Message { get; init; }

Property Value

string

NormalizedAddress

The normalized address that was persisted when Status is "valid".

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public AddressResponse? NormalizedAddress { get; init; }

Property Value

AddressResponse

Reason

The specific reason for the validation outcome (e.g., "blocked", "too_long", "abbreviated").

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Reason { get; init; }

Property Value

string

Status

The validation status: "valid", "invalid", or "suggestion".

public required string Status { get; init; }

Property Value

string

SuggestedAddress

A suggested alternative address (e.g., abbreviated street for DC 30-char limit, or a Smarty-corrected address). Present only when Status is "suggestion".

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public AddressResponse? SuggestedAddress { get; init; }

Property Value

AddressResponse