Islands on the Air - API - XML Tag Specification
banner

The IOTA XML Tagset (Schema)

Note that, on this page, 'our' refers to communications from the IOTA server to client software, 'your' refers to communciations from the client software to the server.

<iotaxml>

This is the document level element.
Attributes: It has no attributes (but MUST refer to the namespace at http://www.rsgbiota.org/xml/, and may contain links to other namespaces as required by Namespaces in XML).
Children: Head (Required); Body (Required)
Occurs: Exactly once per document


<head>

This is a container for metadata about the communication.
Attributes: None
Child of: <iotaxml>
Children: <created> (Required); <copyright> (Required)
Occurs: Exactly once per document


<created>

This element has attributes indicating a version number (for static data) or communication ID number (for dynamic requests) and date that the file was built.
The element contains a datetime in W3C / ISO 8601 format.
Attributes: v: (Optional. Required if 'id' is not present.) String containing a file version number; id: (Required only if 'v' is not present.) String containing a unique ID for this message
Child of: <head>
Children: None
Occurs: Exactly once per document


<copyright>

This element contains a string with copyright information. This must be reproduced in any software using the API, as required in the documentation for the method.
Attributes: None
Child of: <head>
Children: None
Occurs: Exactly once per document


<body>

The container for the communication
Attributes: None
Child of <iotaxml>
Children: <groupInfo> (Optional); <iotaactiv> (Optional);
Occurs: Exactly once per document


<groupInfo>

Container for information about an IOTA group.
Attributes: None
Child of: <body>; <iotaactiv>; <spot>
Children: <grpRef> (Required); <grpName> (Required); <grpComment> (Optional); <grpContent> (Optional); <grpExcludes> (Optional); <useIsland> (Optional); <position> (Required); <prefixes> (Required); <dxcc> (Optional); <pc_credited> (Optional); <region> (Required)
Occurs: May occur any number of times in a document <body>. Must occur once in any <iotaactiv> tag. May occur once in any <spot> tag.


<grpRef>

IOTA Reference number - MUST have the following format: (AF|AN|AS|EU|NA|OC|SA)-(\d{3})
Attributes: activated (Optional) - Boolean value indicating whether or not the group has ever been activated. Assume TRUE if not present.
Child of: <groupInfo>
Children: None
Occurs: Must occur once in any <groupInfo> tag.


<grpName>

Name of the IOTA group
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: Must occur once in any <groupInfo> tag.


<grpComment>

Plain text comment about the IOTA group
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: May occur once in any <groupInfo> tag.


<grpContent>

Container for islands and sub-groups making up the island group
Attributes: None.
Child of: <groupInfo>
Children: <island> (Optional, required if no <subGrp> present); <subGrp> (Optional, required if no <island> is present)
Occurs: Must occur once in any <groupInfo> tag if no <useIsland> tag is present. If <useIsland> is present, must not occur.


<grpExcludes>

Container for islands and sub-groups explicitly not included in the island group
Attributes: None.
Child of: <groupInfo>
Children: <island> (Optional, required if no <subGrp> present); <subGrp> (Optional, required if no <island> is present)
Occurs: May occur once in any <groupInfo> tag if no <useIsland> tag is present. If <useIsland> is present, must not occur.


<subGrp>

Container for islands in a sub-group
Attributes: id (Required) - ID Format: (AF|AN|AS|EU|NA|OC|SA)-(\d{3})-(\d{1,2})-(\d{1})
Child of: <grpContent>; <grpExcludes>
Children: <island> (Required)
Occurs: May occur at least once in any <grpContent> tag. May occur at least once in any <grpExcludes> tag.


<useIsland>

One island in the group (used for indicating which island an activation is on, where a QSO was made from, etc.)
Attributes: See <island>
Child of: <groupInfo>
Children: None
Occurs: Must occur once in any <groupInfo> tag if no <grpContent> tag is present. If <grpContent> is present, must not occur.


<island>

An individual island name
Attributes: id (Required) - ID number (8-digit integer, leading zeros optional).
Child of: <grpContent>; <grpExcludes>; <subGrp>
Children: <isComment> (Optional) - Text comment
Occurs: Must occur at least once in any <grpContent> tag if no <subGrp> tag is present. Must occur at least once in any <grpExcludes> tag if no <subGrp> tag is present. Must occur at least once in any <subGrp> tag. Must occur once in any <useIsland> tag.


<isComment>

Text comment about an individual island
Attributes: None.
Child of: <island>
Children: None
Occurs: May occur once in any <island> tag.


<position>

Container for location information
Attributes: None. (But must import the GML namespace (http://www.opengis.net/gml) if not already done)
Child of: <groupInfo>
Children: Tags imported from GML
Occurs: Must occur once in any <groupInfo> tag.


<prefixes>

Semi-colon seperated string of callsign prefixes for which this group is valid. Alternatively, the word 'Various' for groups with many valid prefixes (mainly AN-)
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: Must occur once in any <groupInfo> tag.


<dxcc>

Plain-text name of the DXCC Entity for which the group is valid (Note that it may be valid for others, too)
Attributes: id (Required) The DXCC ID from the ARRL enumeration.
Child of: <groupInfo>
Children: None
Occurs: May occur once in any <groupInfo> tag.


<pc_credited>

Float to one decimal place. The percentage of IOTA participants who have scores over 100 who have claimed credit for this group. (A number equal to or less than 15.0 qualifies the group as 'rare' under the rules)
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: May occur once in any <groupInfo> tag.


<region>

Will be empty for most groups. Set to AI for those which qualify for the IOTA Arctic Islands award, BI for the British Isles award and WI for the West Indies award.
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: Must occur once in any <groupInfo> tag.


<status>

Optional. If not present, the group is a valid IOTA group. Otherwise, contains 'DELETED' for deleted groups or 'unactivated' for groups which are not thought to have ever been activated.
Attributes: None.
Child of: <groupInfo>
Children: None
Occurs: May occur once in any <groupInfo> tag.


<iotaactiv>

Container for information about an IOTA activation.
Attributes: None
Child of: <body>
Children: <startdate> (Required); <enddate> (Required); <groupInfo> (Required); <callsign> (Required); <operators> (Optional); <qslroute> (Optional); <url> (Optional); <comments> (Optional); <author> (Optional); <submitdate> (Optional); <uid> (Required); <qsosCredited> (Optional); <spots> (Optional)
Occurs: May occur any number of times in a document.


<startdate>

The date-time that an activation started, formatted in RFC 2822 format.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: Must occur once in any <iotaactiv> tag.


<enddate>

The date-time that an activation ended, formatted in RFC 2822 format.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: Must occur once in any <iotaactiv> tag.


<callsign>

The callsign of an activation.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: Must occur once in any <iotaactiv> tag.


<operators>

A list of the operators on the activation. Should be a semi-colon seperated list of callsign, but this is not always followed.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<qslroute>

Plain text description of QSL instructions.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<url>

Fully qualified URL path to the activation's website.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<comments>

Plain text comments about the activation.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<author>

The callsign of the author of the information. Will be 'SERVER' if the user was not logged-in when submitted, and 'IMPORTED FROM PREVIOUS SITE' for entries prior to June 2007.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<submitdate>

RFC 2822 formatted date of when the notification of the activation was received.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<uid>

A positive integer which forms a unique identifier for the activation information. XHTML formatted activation information can be found at http://www.rsgbiota.org/activations/details.php?activ_uid={uid}.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: Must occur once in any <iotaactiv> tag.


<qsosCredited>

A positive integer representing the number of times the QSO has been credited to IOTA participants. Be aware that, in case of any mistakes in the database, any number between 1-3 will return 0.
Attributes: None
Child of: <iotaactiv>
Children: None
Occurs: May occur once in any <iotaactiv> tag.


<spots>

A container for DX Spots
Attributes: None
Child of: <iotaactiv>
Children: <spot> (Required)
Occurs: May occur once in any <iotaactiv> tag.


<spot>

Container for a DX Spot
Attributes: None
Child of: <spots>
Children: <time> (Required); <spotter> (Required); <dx> (Required); <frequency> (Required)
Occurs: Must occur at least once in any <spots> tag.


<time>

Date-time of a DX Spot in yyyy-mm-dd hh:mm:ss format.
Attributes: None
Child of: <spot>
Children: None
Occurs: Must occur once in any <spot> tag.


<spotter>

Callsign of the station which made a DX Spot.
Attributes: None
Child of: <spot>
Children: None
Occurs: Must occur once in any <spot> tag.


<dx>

Callsign of a station spotted in a DX Spot.
Attributes: None
Child of: <spot>
Children: None
Occurs: Must occur once in any <spot> tag.


<frequency>

Float. Frequency in kHz of a station spotted in a DX Spot.
Attributes: None
Child of: <spot>
Children: None
Occurs: Must occur once in any <spot> tag.