Raw FM-12 SYNOP entry form

This component allows a user to enter one or more FM-12 SYNOP messages into a form and to submit these to an API endpoint for further processing. The API is specified via the components props.

Context

The sequence diagram below shows the context of the “Raw FM-12 SYNOP entry from” component.

Requirements

Vue3 + Vuetify3

Installation

TBD

Usage

Props

• api: Host / base path to the API.

• path: relative path on the host to the API endpoint.

Example

<template>
  <div>
    <synop-form api="https://api.opencdms.org" path="/processes/submit_synop/execution"/>
  </div>
</template>

<script>
import SynopForm from '@/web-components/forms/synop-raw.vue';

export default {
  name: 'synop',
  components: {
    SynopForm
  },
};
</script>

API prototype

POST /raw_synop_entry_form

Definition of API that accepts POST request from this component

Request JSON Object:

• input (object, required) –

• input.year (numeric, required) – Year (UTC) of the SYNOP data

• input.month (numeric, required) – Month (UTC) of the SYNOP data

• input.bulletin (string, required) – String containing the SYNOP bulletin

Response JSON Object:

• output (object) –

• output.result (numeric) – HTTP response code for the API call

• output.errors[] (string) – One or more error messages raised in the case of error.

Status Codes:

• 200 OK – success