"Dive" object (concise)
When lists of dives are returned by the server, such lists might get rather large. For that reason, some responses (eg. the list of Dives of a certain Diver) contain just "concise" Dive objects. The full data for each dive can be fetched at the resource /dives/<id>.
A concise Dive object contains the following attributes (the definition of attributes is identical to the full Dive object):
- 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)
- DiveNumber — not updateable, changes automatically
- Number assigned to this dive in Divers logbook
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>
</Dive>