`AppLoadResponse`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

AppLoadResponse

API response envelope containing Application Load data or errors.

app/interfaces/orionplace/transport.ts

TypeScript

export interface AppLoadResponse {
  // Field errors; null when no errors were recorded.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message; null or an empty string does not confirm success.
  success_message: string | null;
  // Application Load data inside the common API envelope.
  page_data: IAppLoad | null;
  // Response locale in debug metadata.
  locale?: string;
  // Endpoint name when supplied by the backend.
  url_name?: string;
  // Optional backend exception diagnostics. Do not display to customers.
  exc_stack?: JsonValue;
  // Optional backend debug metadata.
  debug?: JsonValue;
  // Debug information about the session groups.
  user_groups?: JsonValue;
  // Debug information about session permissions.
  user_perms?: JsonValue;
  // Total response preparation time in seconds, in debug mode.
  spent?: number;
}