IWXXM AMQP Headers¶
The use of AMQP Properties is useful for gathering message information without having to parse the full message payload. The AMQP 1.0 protocol1 defines three types of properties: header, properties and application properties. While the header and properties are fixed keys standardized in the protocol, the application properties allow applications to define their own keys.
General headers¶
The lists below detail the usage of the AMQP headers and properties within the DWD SWIM Service.
| Key | Description |
|---|---|
| message-type | Describes the type of the message content. Can be one of business-notification-url, business-direct-data or technical. For technical the type of technical message is further specified in properties.technical-message-type |
| Key | Description |
|---|---|
| message-id | The universally unique ID (RFC41223 uuid4) of the message. |
| absolute-expiry-time | UNIX-like UTC timestamp in milliseconds, indicating when the message should expire in the broker and from durable queues. |
| creation-time | Unix-like UTC timestamps in milliseconds, indicating when the AMQP message was initially created. |
| subject | Represent the type of data transmitted, e.g., weather.aviation.metar for METARs. |
| content-type | MIME type of the message (e.g., application/xml; charset=utf-8) |
| content-encoding | Indicates whether the payload is gzip-compressed, in MIME type syntax |
| Key | Description |
|---|---|
| priority | SIGMET: 7SPECI: 6TAF AMD: 6TAF: 5METAR: 4All other messages: 3 (7 = highest, 3 = lowest) |
| ttl | Duration in milliseconds (set by the DWD) for which the message is to be considered “alive”. Business Message: The DWD will calculate a TTL per message type (payload-subject). Technical Message: TTL is one week. Heartbeat: TTL is 70 seconds for a heartbeat frequency of 1 per 60 seconds. |
Additional Headers
Please note that additional headers such as user-id and to may be present in the AMQP messages.
However, these headers are automatically set by the technical infrastructure used for message delivery.
Hence, the shall not be interpreted as part of the DWD SWIM service.
Application Properties for Business Messages¶
| Key | Description |
|---|---|
| conformsTo | Link to the SWIM service definition the data conforms to. |
| properties.report_status | One of the following values:NORMAL: Regular reportAMENDMENT: Amendment of the previous reportCORRECTION: Correction of the previous report |
| properties.icao_location_identifier | METAR/SPECI, TAF: The ICAO 4-letter location indicator of the respective aerodrome.SIGMET: The respective Flight Information Region (FIR) or Upper Flight Information Region (UIR) for which the SIGMET has been created. |
| properties.icao_location_type | Type of location identifier. Can be optionally used for disambiguation when the location referred to by the properties.icao_location_identifier is not clear. |
| properties.issue_datetime | RFC33392 formatted publication/issue time extracted from iwxxm:issueTime. |
| properties.datetime | RFC33392 formatted observation time. Only for METAR/SPECI. |
| properties.start_datetime | Start of validity in RFC33392 format. Only for TAF/SIGMET. |
| properties.end_datetime | End of validity in RFC33392 format. Only for TAF/SIGMET. |
| payload-subject | DWD specific identifier of data delivery for debugging (Product identifier/Filename for filtering: Subset LA (METAR), LC (Short TAF), LT (Long TAF), LP (SPECI), LS (SIGMET)) // Example: A_LADL31EDDT292250_C_EDZO_20170729225000). Please use the subject message property instead. |
| API-version | Indication of the actual API version. |
| Content-SHA256 | DEPRECATED: This value will also be provided in the future but the header will be renamed.SHA256 hash of the payload. |
Application Properties for Technical Messages¶
| Key | Description |
|---|---|
| technical-message-type | The type of technical message. Must be one of subscription-change, scheduled-maintenance, data-error or heartbeat. |
| event | The event type of the technical message. This is only sent for subscription-change technical messages and contains the event field of the json payload. |
-
https://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-header ↩
-
Standard date format of the form
YYYY-MM-DDThh:mmZhttps://datatracker.ietf.org/doc/html/rfc3339 ↩↩↩↩