Class MerakiQueryResponse

Namespace

Meraki.Api

Assembly

Meraki.Api.dll

The result of a generic QueryAsync(HttpMethod, string, string?, string?, bool, CancellationToken) call against an arbitrary Meraki Dashboard API v1 endpoint.

public class MerakiQueryResponse

Inheritance

object

MerakiQueryResponse

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This deliberately does NOT throw on a non-success HTTP status. It carries the status, reason phrase and headers of the final response so that callers (e.g. the ReportMagic Meraki.Query macro) can surface them and decide how to react - mirroring the shape of a raw HTTP call. Read-only violations and transport failures still throw.

Constructors

MerakiQueryResponse()

public MerakiQueryResponse()

Properties

Headers

The response headers of the final response.

public HttpResponseHeaders Headers { get; set; }

Property Value

HttpResponseHeaders

IsSuccessStatusCode

Whether the final response had a 2xx status code.

public bool IsSuccessStatusCode { get; set; }

Property Value

bool

Json

The parsed JSON of the response. This is a Newtonsoft.Json.Linq.JArray for list endpoints (concatenated across all pages), a Newtonsoft.Json.Linq.JObject for single-object endpoints, or null if the body could not be parsed as JSON (in which case see RawBody).

public JToken? Json { get; set; }

Property Value

JToken

PageCount

The number of pages retrieved (1 for a single request; greater than 1 when Link-header pagination was followed).

public int PageCount { get; set; }

Property Value

int

RawBody

The raw response body of the final response (unparsed).

public string RawBody { get; set; }

Property Value

string

ReasonPhrase

The reason phrase of the final response, if any.

public string? ReasonPhrase { get; set; }

Property Value

string

StatusCode

The HTTP status code of the final response (the last page, for paginated results).

public HttpStatusCode StatusCode { get; set; }

Property Value

HttpStatusCode