"Dive" object (full)

Contains full data of a dive log entry, including any samples that were recorded during the dive. A full dive object including samples can be of considerable size. Therefore, the use of compression is strongly recommended when requesting or sending Dive objects.

A Dive object contains the following attributes:

Id — not updateable

Unique, numeric identifier of the dive log entry. This identifier is unique across all users. Do not confuse with "DiveNumber"

DiverId — not updateable

Numeric identifier of the Diver

DiveDate — required, not updateable

Date of the dive in YYYY-MM-DD format

InTime — required

Local time at which the dive was started, in hh:mm:ss format (24 hours)

Duration — required, not updateable

Total duration of the dive, in hh:mm:ss format

MaxDepth — required, not updateable if dive contains depth samples

Maximum depth of the dive, in meters (eg. 7.8)

AvgDepth — not updateable if dive contains depth samples

Average depth of the dive, in meters (eg. 5.6)

Location

Textual representation of the location (City/Island/Lake name) of the dive, as entered by the user

LocationId

Numeric identifier of the location (City/Island/Lake .. name) of the dive. The identifier refers to a "Geoname", as used on geonames.org. This Id is either discovered by dive.io during entering the "Location" field, or can be added directly via the API

Site

Name of the dive site

InPressure — not updateable if dive contains pressure samples

Tank pressure at the start of the dive, in Bar

OutPressure — not updateable if dive contains pressure samples

Tank pressure at the end of the dive, in Bar

TankVolume

Volume of the dive cylinder, in liters

PercentageO2

Oxygen percentage in diving gas, eg. '21' for normal air

Entry

Abbreviated type of entry: 's' for shore dives, 'b' for boat dives

WaterType

Abbreviated type of water: 's' for saltwater, 'f' for freshwater dives

Visibility

Approximate visibility during the dive, in meters

SurfaceTemp

Temperature of the water near the surface in decimal degrees Celsius

BottomTemp

Temperature of the water near the bottom of the dive in decimal degrees Celsius

AirTemp

Air temperature before the dive

DiveNumber — not updateable, changes automatically

Number assigned to this dive in Divers logbook

AssignDiveNumber

Whether or not to assign a dive number to this dive record. Possible values are "yes" or "no". Other dives are automatically renumbered when a dive is changed.

Notes

Notes to this dive, as entered by the Diver. 500 characters maximum length.

Created — not updateable

Timestamp of creating of this log entry, in ISO 8601 format. Created by the server.

Modified — not updateable

Timestamp of last modification of this log entry, in ISO 8601 format. Created by the server.

Buddies — not directly updateable

If the dive record contains buddies, a list of "Buddy" elements is included. Each of those elements has the following elements:

RelationId

Unique identifier of the buddy record

Name

Name of the buddy

Type (optional)

One of 'buddy', 'instructor', 'diveguide'

Samples — not updateable

If a depth / pressure profile is included in the dive record, this element contains a list of "Sample" elements. Each of those contains the following elements:

Elapsed — required

Time of the sample, in seconds since the start of the dive. Note that the first sample always has "Elasped" set to 0, and its values may be set to 0 as well (Some dive computers do not provide a "0 second" sample

Depth

Depth of the dive profile at the given "Elapsed" time in meters.

Pressure

Pressure of the dive tank at the given "Elapsed" time in bar.

Example (XML)

  <Dive>
    <Id>30</Id>
    <DiverId>4</DiverId>
    <DiveDate>2010-09-18</DiveDate>
    <InTime>10:03:00</InTime>
    <Duration>00:39:50</Duration>
    <MaxDepth>30.7</MaxDepth>
    <AvgDepth>18.2445378151</AvgDepth>
    <Location>Okrug Gornji</Location>
    <Site>Zaparin</Site>
    <InPressure>202</InPressure>
    <OutPressure>47</OutPressure>
    <TankVolume>12</TankVolume>
    <PercentageO2>21</PercentageO2>
    <WaterType>s</WaterType>
    <Visibility>12</Visibility>
    <SurfaceTemp>19</SurfaceTemp>
    <BottomTemp>17</BottomTemp>
    <AirTemp>26</AirTemp>
    <DiveNumber>132</DiveNumber>
    <AssignDiveNumber>yes</AssignDiveNumber>
    <Notes>What a lovely dive!</Notes>
    <Created>2011-03-17 11:00:11.27922+01</Created>
    <Modified>2011-04-20 11:46:32.162026+02</Modified>
    <Buddies>
      <Buddy>
        <RelationId>20</RelationId>
        <Name>Jim</Name>
        <Type>buddy</Type>
        <Confirmed>no</Confirmed>
      </Buddy>
    </Buddies>
    <Samples>
      <Sample>
        <Elapsed>0</Elapsed>
        <Depth>0</Depth>
        <Pressure>0</Pressure>
      </Sample>
      <Sample>
        <Elapsed>20</Elapsed>
        <Depth>8</Depth>
        <Pressure>199</Pressure>
      </Sample>
      <!-- ... (more samples) -->
    </Samples>
  </Dive>