GET /api/v0/submit_message/?format=api
HTTP 200 OK
Allow: GET, POST, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "message": "This endpoint is used to send a generic hermes message\n\n        Requests should be structured as below:\n\n        {title: <Title of the message>,\n         topic: <kafka topic to post message to>, \n         submitter: <submitter of the message>,\n         authors: <Full list of authors on a message>,\n         message_text: <Text of the message to send>,\n         submit_to_tns: <Boolean of whether or not to submit this message to TNS along with hop>\n         submit_to_mpc: <Boolean of whether or not to submit this message to MPC along with hop>\n         submit_to_gcn: <Boolean of whether or not to submit this message to GCN along with hop>\n         data: {\n            references: [\n                {\n                    source:\n                    citation:\n                    url:\n                },\n                ...\n            ],\n            extra_key1: value1,\n            extra_key2: value2,\n                ...\n            extra_keyn: <Any key within data not used by the hermes message format will be passed through in the message>\n            },\n            event_id: <Nonlocalized event_id this message relates to>,\n            targets: [\n                {\n                    name: <Target name>,\n                    ra: <Target ra in decimal or sexigesimal format>,\n                    dec: <Target dec in decimal or sexigesimal format>,\n                    ra_error: <Error of ra>,\n                    dec_error: <Error of dec>,\n                    ra_error_units: <Units for ra_error>,\n                    dec_error_units: <Units for dec_error>,\n                    pm_ra: <RA proper motion in arcsec/year>,\n                    pm_dec: <Dec proper motion in arcsec/year>,\n                    epoch: <Epoch of reference frame>,\n                    new_discovery: <Boolean if this target is for a new discovery or not>\n                    orbital_elements: {\n                        epoch_of_elements: <Epoch of Elements in MJD>,\n                        orbital_inclination: <Orbital Inclination (i) in Degrees>,\n                        longitude_of_the_ascending_node: <Longitude of the Ascending Node (Ω) in Degrees>,\n                        argument_of_the_perihelion: <Argument of Periapsis (ω) in Degrees>,\n                        eccentricity: <Orbital Eccentricity (e)>,\n                        semimajor_axis: <Semimajor Axis (a) in AU>,\n                        mean_anomaly: <Mean Anomaly (M) in Degrees>,\n                        perihperihelion_distancedist: <Distance to the Perihelion (q) in AU>,\n                        epoch_of_perihelion: <Epoch of Perihelion passage (tp) in MJD>\n                    },\n                    discovery_info: {\n                        date: <Discovery date for new discoveries>,\n                        reporting_group: <TNS reporting group for TNS new discoveries>,\n                        discovery_source: <TNS source group for TNS new discoveries>,\n                        transient_type: <Type of source, one of PSN, nuc, PNV, AGN, or Other>,\n                        proprietary_period: <Duration that this discovery should be kept private>,\n                        proprietary_period_units: <Units for proprietary period, Days, seconds, Years>,\n                        nondetection_source: <Source Catalog for the last nondetection of this target>,\n                        nondetection_comments: <Comments about the last nondetection of this target>,\n                    },\n                    redshift: <>,\n                    host_name: <Host galaxy name>,\n                    host_redshift: <Redshift (z) of Host Galaxy>,\n                    aliases: [\n                        'alias1',\n                        'alias2',\n                        ...\n                    ],\n                    group_associations: [\n                        'group one',\n                        'group two',\n                        ...\n                    ],\n                    file_info: [{\n                        name: <file name>,\n                        description: <file description>,\n                        url: <url to access file> (optional)\n                    }],\n                    comments: <String of comments for the target>,\n                }\n            ],\n            photometry: [\n                {\n                    target_index: <Index of target list that this photometry relates to. Can be left out if there is only one target>,\n                    date_obs: <Date of the observation, in a parseable format or JD>,\n                    telescope: <Observation telescope>,\n                    instrument: <Observation instrument>,\n                    bandpass: <Wavelength band of the observation>,\n                    brightness: <Brightness of the observation>,\n                    brightness_error: <Brightness error of the observation>,\n                    brightness_unit: <Brightness units for the observation,\n                                      current supported values: [AB mag, Vega mag, mJy, erg / s / cm² / Å]>,\n                    exposure_time: <Exposure time in seconds for this photometry>,\n                    observer: <The entity that observed this photometry data>,\n                    comments: <String of comments for the photometry>,\n                    limiting_brightness: <The minimum brightness at which the target is visible>,\n                    limiting_brightness_unit: <Unit for the limiting brightness>\n                    catalog: <Photometric catalog used to reduce this data>,\n                }\n            ],\n            spectroscopy: [\n                {\n                    target_index: <Index of target list that this specotroscopic datum relates to. Can be left out if there is only one target>,\n                    date_obs: <Date of the observation, in a parseable format or JD>,\n                    telescope: <specotroscopic datum telescope>,\n                    instrument: <specotroscopic datum instrument>,\n                    setup: <>,\n                    flux: [<Flux values of the specotroscopic datum>],\n                    flux_error: [ <Flux error values of the specotroscopic datum>],\n                    flux_units: <Flux units for the specotroscopic datum,\n                               current supported values: [AB mag, Vega mag, mJy, erg / s / cm² / Å]>\n                    wavelength: [<Wavelength values for this spectroscopic datum>],\n                    wavelength_units: <Units for the wavelength>,\n                    file_info: [{\n                        name: <file name>,\n                        description: <file description>,\n                        url: <url to access file> (optional)\n                    }]\n                    classification: <TNS classification for this specotroscopic datum>,\n                    proprietary_period: <>,\n                    proprietary_period_units: <>,\n                    exposure_time: <Exposure time in seconds for this spectroscopic datum>,\n                    observer: <The entity that observed this spectroscopic datum>,\n                    reducer: <The entity that reduced this spectroscopic datum>,\n                    comments: <String of comments for the spectroscopic datum>,\n                    spec_type: <>\n                }\n            ],\n            astrometry: [\n                {\n                    date_obs: <Date of the observation, in a parseable format or JD>,\n                    telescope: <Astrometry telescope>,\n                    instrument: <Astrometry instrument>,\n                    ra: <Target ra in decimal or sexigesimal format>,\n                    dec: <Target dec in decimal or sexigesimal format>,\n                    ra_error: <Error of ra>,\n                    dec_error: <Error of dec>,\n                    ra_error_units: <Units for ra error>,\n                    dec_error_units: <Units for dec error>,\n                    mpc_sitecode: <MPC Site code for this data>,\n                    catalog: <Astrometric catalog used to reduce this data>,\n                    comments: <String of comments for the astrometric datum>\n                }\n            ],\n         }\n        }\n        "
}
Data
References

Lists are not currently supported in HTML input.

Targets

Lists are not currently supported in HTML input.

Photometry

Lists are not currently supported in HTML input.

Spectroscopy

Lists are not currently supported in HTML input.

Astrometry

Lists are not currently supported in HTML input.