Interface ProblemDetail

This is an API error based on Problem Detail RFC 7807.

See

RFC 7807

Hierarchy

  • ProblemDetail

Properties

correlationId: string

A unique identifier for the request, used for NWS debugging purposes. Please include this identifier with any correspondence to help us investigate your issue.

Example

493c3a1d-f87e-407f-ae2c-24483f5aab63
detail: string

A human-readable explanation specific to this occurrence of the problem.

Example

An unexpected problem has occurred.
instance: string

A URI reference (RFC 3986) that identifies the specific occurrence of the problem. This is only an identifier and is not necessarily a resolvable URL.

Example

urn:noaa:nws:api:request:493c3a1d-f87e-407f-ae2c-24483f5aab63
status: number

The HTTP status code (RFC 7231, Section 6) generated by the origin server for this occurrence of the problem.

It must be a minimum of 100 and maximum of 999.

Example

500
title: string

A short, human-readable summary of the problem type.

Example

Unexpected Problem
type: string

A URI reference (RFC 3986) that identifies the problem type. This is only an identifier and is not necessarily a resolvable URL.

Default

about:blank

Example

urn:noaa:nws:api:UnexpectedProblem

Generated using TypeDoc