simbrief docs

Errors

• types.APIError (Message, Code): SimBrief answered but the fetch failed. Message is the OFP’s fetch status; Code is the HTTP status, or 0 when the error came with a 200 reply.
• Wrapped errors (fmt.Errorf with %w): transport and decoding failures, e.g. a timeout or a body that is not an OFP. A non-200 reply without a fetch status is a plain error with the status and body.
• Sentinels from FlightPlanRequest.Validate(): types.ErrMissingOrigin, types.ErrMissingDestination, types.ErrMissingAircraft. (ErrMissingUserID, ErrInvalidUserID and ErrInvalidAPIKey are declared but not returned by the library.)
• ValidateFlightPlanRequest returns plain fmt.Errorf messages.

_, err := c.GetFlightPlan(&types.FetchRequest{UserID: "123456", JSON: true})
var apiErr types.APIError
if errors.As(err, &apiErr) {
	fmt.Println("SimBrief:", apiErr.Message, apiErr.Code) // fetch status text, HTTP status (0 on a 200)
}

err := types.NewFlightPlanRequest("LKPR", "", "A320").Validate()
if errors.Is(err, types.ErrMissingDestination) {
	fmt.Println("destination missing")
}

Common problems

Further reading

• SimBrief API documentation