Marine API Documentation - Version 1


Resources [1] are described individually along with their resource methods (see the resource methods section) and listed in the resources listing section.

[1] Defined here.

Resource methods

Each resource can have multiple methods specific to its needs. Typical methods include those to Create, Retrieve, Update and Delete resources (CRUD).

For convenience and organisation, resource methods are documented within their resource’s document, these are listed in the resources listing section.

Resource methods are functionality identical to regular API methods, including the use of traits and other features.

Note: There is no requirement for any resource to implement any methods if this isn’t appropriate to that resource.

Resources listing

This information may be out of date whilst this website is being redeveloped. Until then, if you have any problems using an API documented here, please contact the relevant project maintainer.